Sign in

v3

latestOpenAPI 3.0.02026-07-311784111.3 MB
Trading
Private

Retrieves the order history for a specific currency. The history includes orders that have been partially or fully filled, as well as cancelled orders (if include_unfilled_orders is set to true).

Results can be filtered by instrument kind and paginated using offset and count parameters, or using continuation tokens. Use include_old_orders to include orders from before a certain date, and historical to retrieve historical order data.

📖 Related Article: Accessing Historical Trades and Orders Using API

Scope: trade:read

Try in API console

get/private/get_order_history_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' | 'combo' | 'any'

Instrument kind: "future", "option", "spot", "future_combo", "option_combo", "combo" for any combo or "any" for all

Instrument kind, "combo" for any combo or "any" for all. If not provided instruments of all kinds are considered

countinteger

Number of requested items, default - 20, maximum - 1000

offsetinteger
Example:10

The offset for pagination, default - 0

include_oldboolean

Include in result orders older than 2 days, default - false

include_unfilledboolean

Include in result fully unfilled closed orders, default - false

with_continuationboolean

When set to true, the API response format changes from a simple list of orders to an object containing the orders and a continuation token.

continuationstring
Example:xY7T6cutS3t2B9YtaDkE6TS379oKnkzTvmEDUnEUP2Msa9xKWNNaT

Continuation token for pagination

historicalboolean

Determines whether historical trade and order records should be retrieved.

  • false (default): Returns recent records: orders for 30 min, trades for 24h.
  • true: Fetches historical records, available after a short delay due to indexing. Recent data is not included.

📖 Related Article: Accessing Historical Trades and Orders Using API

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"
    }
  ]
}