v2
OpenAPI 3.0.02026-07-311824171.4 MBRetrieves the order history for a specific instrument. 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 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
Query parameters
Unique instrument identifier
Instrument name
Number of requested items, default - 20, maximum - 1000
The offset for pagination, default - 0
Include in result orders older than 2 days, default - false
Include in result fully unfilled closed orders, default - false
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.
Continuation token for pagination
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
Example response
{
"result": [
{
"order_id": "ETH-100234",
"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",
"starbase_order_id": 103148386170,
"app_name": "Example Application",
"mmp_cancelled": true,
"oto_order_ids": [
"ETH-100234"
],
"primary_order_id": "ETH-100234"
}
]
}