For the complete documentation index, see llms.txt. This page is also available as Markdown.

Orders

Query Order States

get
/info/order/states
Query parameters
userAddrstringRequired
symbolinteger · int64Optional

Symbol code filter

statusstringOptional

Order status filter

sideintegerOptional

Side filter (1=BUY, 2=SELL)

typeintegerOptional

Type filter (1=LIMIT, 2=MARKET)

orderIdstringOptional
clientOrderIdstringOptional
parentOrderIdstringOptional
pageintegerOptionalDefault: 1
pageSizeintegerOptionalDefault: 20
startTimeinteger · int64Optional
endTimeinteger · int64Optional
Responses
200

Paginated order states

application/json
codeintegerOptional
get/info/order/states
const resp = await fetch(
  `${BASE_URL}/info/order/states?userAddr=0xabc...&symbol=1`
);
200

Paginated order states

{
  "code": 1,
  "data": [
    {
      "id": 1,
      "blockHeight": 1,
      "ordId": "text",
      "clOrdId": "text",
      "parentOrdId": "text",
      "userAddr": "text",
      "symbol": 1,
      "side": 1,
      "type": 1,
      "price": "text",
      "qty": "text",
      "filledQty": "text",
      "leaveQty": "text",
      "cumFilledValue": "text",
      "cumFee": "text",
      "triggerPx": "text",
      "status": "text",
      "timeInForce": "text",
      "reduceOnly": 1,
      "conditionalOrderTriggerType": 1,
      "blockTime": 1
    }
  ]
}

Query Order Events

get
/info/order/events
Query parameters
userAddrstringRequired
orderIdstringOptional
clientOrderIdstringOptional
symbolinteger · int64Optional
execStatusstringOptional
sideintegerOptional
pageintegerOptionalDefault: 1
pageSizeintegerOptionalDefault: 20
startTimeinteger · int64Optional
endTimeinteger · int64Optional
Responses
200

Paginated order events

application/json
codeintegerOptional
get/info/order/events
const resp = await fetch(
  `${BASE_URL}/info/order/events?userAddr=0xabc...&orderId=12345`
);
200

Paginated order events

{
  "code": 1,
  "data": [
    {
      "id": 1,
      "blockHeight": 1,
      "userAddr": "text",
      "ordId": "text",
      "clOrdId": "text",
      "symbol": 1,
      "side": "text",
      "execStatus": "text",
      "ordPx": "text",
      "filledPx": "text",
      "execQty": "text",
      "leavesQty": "text",
      "execId": "text",
      "realizedPnl": "text",
      "openFee": "text",
      "closeFee": "text",
      "blockTime": 1,
      "txHash": "text",
      "ordType": 1,
      "timeInForce": "text",
      "ordQty": "text",
      "triggerPx": "text"
    }
  ]
}

Last updated