v3

latestOpenAPI 3.0.02026-07-311784111.3 MB
Trading
Private

Retrieves a list of all open orders for a specific currency. Open orders are orders that have been placed but not yet filled or cancelled.

Results can be filtered by instrument kind and order type. This method provides a view of all active orders within a currency.

Scope: trade:read

Try in API console

get/private/get_open_orders_by_currency

Query parameters

currency'BTC' | 'ETH' | 'USDC' | 'USDT' | 'EURR' required

Currency, i.e "BTC", "ETH", "USDC"

The currency symbol

kind'future' | 'option' | 'spot' | 'future_combo' | 'option_combo'

Instrument kind: "future", "option", "spot", "future_combo", "option_combo"

Instrument kind, if not provided instruments of all kinds are considered

type'all' | 'limit' | 'trigger_all' | 'stop_all' | 'stop_limit' | 'stop_market' | 'take_all' | 'take_limit' | 'take_market' | 'trailing_all' | 'trailing_stop'

Order type: "all", "limit", "trigger_all", "stop_all", "stop_limit", "stop_market", "take_all", "take_limit", "take_market", "trailing_all", "trailing_stop"

Order type, default - all

Response

Success response

jsonrpc'2.0' required

The JSON-RPC version (2.0)

idinteger

The id that was sent in the request

Example response

{
  "result": [
    {
      "order_id": "ETH-100234",
      "starbase_order_id": 103148386170,
      "instrument_name": "BTC-PERPETUAL",
      "creation_timestamp": 1536569522277,
      "last_update_timestamp": 1536569522277,
      "starbase_last_update_timestamp": 1536569522277000000,
      "block_trade": true,
      "trigger_order_id": "SLIB-370",
      "combo_order_id": "103148386169",
      "app_name": "Example Application",
      "mmp_cancelled": true,
      "oto_order_ids": [
        "ETH-100234"
      ],
      "primary_order_id": "ETH-100234"
    }
  ]
}