GET
/
api
/
v1
/
orders
curl -X GET "https://api.roxom.com/api/v1/orders?instType=perpetual" \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json"

{
  "error": false,
  "data": {
    "orders": [
      {
        "id": "01234567-89ab-7def-8123-456789abcdef",
        "symbol": "US500-BTC",
        "instType": "perpetual",
        "accountId": "01234567-89ab-7def-8123-456789abcdef",
        "orderType": "limit",
        "timeInForce": "gtc",
        "side": "buy",
        "quantity": "0.001",
        "price": "50000",
        "triggerPx": null,
        "status": "submitted",
        "clientOrderId": "my_order_001",
        "createdAt": 1640995200000000000,
        "cancelAt": null,
        "isTriggered": null,
        "size": "0.001",
        "unit": "BTC"
      },
      {
        "id": "01234567-89ab-7def-8123-456789abcdea",
        "symbol": "GOLD-BTC",
        "instType": "perpetual",
        "accountId": "01234567-89ab-7def-8123-456789abcdef",
        "orderType": "market",
        "timeInForce": "ioc",
        "side": "sell",
        "quantity": "0.002",
        "price": null,
        "triggerPx": null,
        "status": "filled",
        "clientOrderId": null,
        "createdAt": 1640995100000000000,
        "cancelAt": null,
        "isTriggered": null,
        "size": "0.000",
        "unit": "BTC"
      }
    ]
  }
}

​
List Orders

Retrieve orders for your account filtered by instrument type and optionally by symbol.

​
Endpoint

GET /api/v1/orders

​
Parameters

​
X-API-Key
string
required
API key for authentication
​
instType
string
required
Instrument type: “perpetual” or “btc”
​
symbol
string
Filter by trading symbol (e.g., “US500-BTC”, “GOLD-BTC”, “OIL-BTC”, “US100-BTC”)
​
unit
string
Display unit: “sats” or “btc” (default: “btc”)
​
includeClosed
boolean
Include closed orders in the response (default: false)

​
Example Requests

curl -X GET "https://api.roxom.com/api/v1/orders?instType=perpetual" \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json"

​
Response

{
  "error": false,
  "data": {
    "orders": [
      {
        "id": "01234567-89ab-7def-8123-456789abcdef",
        "symbol": "US500-BTC",
        "instType": "perpetual",
        "accountId": "01234567-89ab-7def-8123-456789abcdef",
        "orderType": "limit",
        "timeInForce": "gtc",
        "side": "buy",
        "quantity": "0.001",
        "price": "50000",
        "triggerPx": null,
        "status": "submitted",
        "clientOrderId": "my_order_001",
        "createdAt": 1640995200000000000,
        "cancelAt": null,
        "isTriggered": null,
        "size": "0.001",
        "unit": "BTC"
      },
      {
        "id": "01234567-89ab-7def-8123-456789abcdea",
        "symbol": "GOLD-BTC",
        "instType": "perpetual",
        "accountId": "01234567-89ab-7def-8123-456789abcdef",
        "orderType": "market",
        "timeInForce": "ioc",
        "side": "sell",
        "quantity": "0.002",
        "price": null,
        "triggerPx": null,
        "status": "filled",
        "clientOrderId": null,
        "createdAt": 1640995100000000000,
        "cancelAt": null,
        "isTriggered": null,
        "size": "0.000",
        "unit": "BTC"
      }
    ]
  }
}
​
data
object
Order response container

​
Filter Examples

​
Order Status Values

  • pendingsubmit
  • waitingtrigger
  • submitted
  • pendingcancel
  • partiallyfilled
  • partiallyfilledcancelled
  • filled
  • cancelled
  • rejected
  • inactive

​
Units Display

  • sats: Quantities displayed in satoshis
  • btc: Quantities displayed in Bitcoin (Default)

Order Status

Get detailed order information

Cancel Orders

Cancel active orders