orderStatus

post
/info

Request order status.

Body

Request order status.

typeundefined · enumRequired

Type of request.

Possible values:
userstring · min: 42 · max: 42Required

User address.

Pattern: ^0[xX][0-9a-fA-F]+$
oidany ofRequired

Order ID or Client Order ID.

integerOptional
or
string · min: 34 · max: 34OptionalPattern: ^0[xX][0-9a-fA-F]+$
Responses
200

Order status response.

  • If the order is found, returns detailed order information and its current status.
  • If the order is not found, returns a status of "unknownOid".
application/json
Responseany of

Order status response.

  • If the order is found, returns detailed order information and its current status.
  • If the order is not found, returns a status of "unknownOid".
or
post
/info
POST /info HTTP/1.1
Host: api.hyperliquid.xyz
Content-Type: application/json
Accept: */*
Content-Length: 44

{
  "type": "orderStatus",
  "user": "text",
  "oid": 1
}
{
  "status": "order",
  "order": {
    "order": {
      "coin": "text",
      "side": "B",
      "limitPx": "text",
      "sz": "text",
      "oid": 1,
      "timestamp": 1,
      "origSz": "text",
      "triggerCondition": "text",
      "isTrigger": true,
      "triggerPx": "text",
      "children": [],
      "isPositionTpsl": true,
      "reduceOnly": true,
      "orderType": "Market",
      "tif": "Gtc",
      "cloid": "text"
    },
    "status": "open",
    "statusTimestamp": 1
  }
}

Last updated