List Orders

curl -X GET "https://api.roxom.com/api/v1/orders?instType=perpetual" \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "X-API-Signature: your_rsa_signature_here" \
  -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"
      }
    ]
  }
}

GET

api

orders

curl -X GET "https://api.roxom.com/api/v1/orders?instType=perpetual" \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "X-API-Signature: your_rsa_signature_here" \
  -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"
      }
    ]
  }
}

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

Endpoint

GET /api/v1/orders

Parameters

X-API-Key

string

required

RSA public key identifier for authentication

X-API-Signature

string

required

Base64-encoded RSA signature of the request payload. Payload format: GET:/api/v1/orders?query_params

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 "X-API-Signature: your_rsa_signature_here" \
  -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

Show Data properties

orders

array

Array of order objects

Show Order properties

string

Unique order identifier (UUID)

symbol

string

Trading symbol for this order

instType

string

Type of instrument: “perpetual” or “btc”

accountId

string

Account that owns this order

orderType

string

Order type: “limit”, “market”, “stop”, “stoplimit”

timeInForce

string

Time in force: “gtc”, “ioc”, “fok”

side

string

Order side: “buy” or “sell”

quantity

string

Order quantity as decimal string

price

string | null

Order price in satoshis (null for market orders)

triggerPx

string | null

Trigger price for stop orders (if applicable)

status

string

Order status: “pendingsubmit”, “waitingtrigger”, “submitted”, “pendingcancel”, “partiallyfilled”, “partiallyfilledcancelled”, “filled”, “cancelled”, “rejected”, “inactive”

clientOrderId

string | null

Client-provided order identifier (if specified)

createdAt

integer

Order creation timestamp in nanoseconds

cancelAt

integer | null

Order expiration timestamp in nanoseconds (if applicable)

isTriggered

boolean | null

Whether stop order has been triggered (if applicable)

size

string

Remaining quantity to be filled

unit

string

Display unit: “sats” or “btc”

Filter Examples

All Perpetual Orders

Get all orders for perpetual contracts:

GET /api/v1/orders?instType=perpetual

Use case: Monitor all leveraged positions

Symbol-Specific Orders

Get orders for a specific trading symbol:

GET /api/v1/orders?instType=perpetual&symbol=US500-BTC

Use case: Track orders for a specific asset

Bitcoin Unit Display

Get orders with quantities displayed in BTC:

GET /api/v1/orders?instType=perpetual&unit=btc

Use case: Easier reading for Bitcoin-denominated quantities

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

Order Status Cancel Orders

⌘I

Overview

Getting Started

Market Data

Order Management

Account & Portfolio

Positions

List Orders

List Orders

Endpoint

Parameters

Example Requests

Response

Filter Examples

Order Status Values

Units Display

Order Status

Cancel Orders

Overview

Getting Started

Market Data

Order Management

Account & Portfolio

Positions

​List Orders

​Endpoint

​Parameters

​Example Requests

​Response

​Filter Examples

​Order Status Values

​Units Display

Order Status

Cancel Orders

List Orders

Endpoint

Parameters

Example Requests

Response

Filter Examples

Order Status Values

Units Display