Get Real-time Orders

Retrieve real-time orders for a specific instrument type, with optional inclusion of closed orders.

GET /v1/orders

Get Real-time Orders

cURL

curl --request GET \
  --url https://api.roxom.com/v1/orders \
  --header 'X-API-Key: <api-key>' \
  --header 'X-API-Signature: <api-key>'

200

{
  "data": {
    "orders": [
      {
        "accountId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "amountFilled": "<string>",
        "createdAt": 123,
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "px": "<string>",
        "qty": "<string>",
        "size": "<string>",
        "symbol": "<string>",
        "cancelAt": 123,
        "clientOrderId": "<string>",
        "triggerPx": "<string>",
        "triggeredAt": 123
      }
    ]
  },
  "error": true
}

Authorizations

X-API-Key · string · header · required

Your API key

X-API-Signature · string · header · required

The signature of the request

Query Parameters

includeClosed · boolean | null

instType · enum<string> · required

Available options: perpetual, spot, btc, digital, stock, index

symbol · string | null

unit · enum<string>

Available options: sats, btc

Response

200 - application/json

Represents a successful API response wrapper

data · object · required

Show child attributes

error · boolean · required