Skip to content

Get order

GET
/accounts/{address}/subaccounts/{subaccount_id}/orders/{client_order_id}

A single order by client order id, active or historical.

Parameters

Path Parameters

address*

Owner address (20-byte Ethereum-style, 0x-hex).

Required
subaccount_id*
Type
integer
Required
Format
"uint16"
Minimum
0
Maximum
65535
client_order_id*

Client order id (uint64, decimal string).

Type
string
Required
Pattern
"^[0-9]+$"

Responses

The order.

application/json
JSON
{
  
"market_type": "string",
  
"market_id": 0,
  
"client_order_id": "1000000",
  
"order_id": "string",
  
"is_bid": true,
  
"price": "1000000",
  
"quantity_left": "1000000",
  
"total_quantity": "1000000",
  
"order_type": "string",
  
"time_in_force": "string",
  
"tick_offset": 0,
  
"trigger_price": "string",
  
"max_price": "string"
}

Playground

Variables
Key
Value

Samples

Powered by VitePress OpenAPI