Sign in
latestOpenAPI 3.1.02026-08-1051108155.9 KB

6e6f8dad92bf

Order

Returns an order by their id

get/v1/order/{id}

Path parameters

idstring required

Response

availableQuantitystring decimal required

Remaining quantity (if modified or reduced) in native units expressed as a decimal (precision: 9)

clientOrderIdstring

A subaccount scoped unique client-generated order id (either a UUID or alphanumeric string up to 32 characters)

closeboolean required

Order closes the entire current position

createdAtinteger required

Order creation timestamp (ms since Unix Epoch)

expiresAtinteger required

Order expiry timestamp (seconds since Unix Epoch)

filledstring decimal required

Filled amount in native units expressed as a decimal (precision: 9)

groupContingencyType0 | 1
groupIdstring uuid

Id of the group this order belongs to

idstring uuid required

Id representing the order

postOnlyboolean

Only add order if it does not immediately fill (limit only)

pricestring decimal required

Limit price in native units expressed as a decimal, zero if market order (precision: 9)

productIdstring uuid required

Id of product this order was placed against

quantitystring decimal required

Original quantity (as per order submission) in native units expressed as a decimal (precision: 9)

reduceOnlyboolean required

Indicates if the order is reduce only

rejectedReason'AccountSuspended' | 'CausesImmediateLiquidation' | 'DuplicateSameSideOco' | 'ExchangeSuspended' | 'ImmediateMatchPostOnly' | 'InstrumentOpenValueCapExceeded' | 'InsufficientBalance' | 'Liquidation' | 'MarketOrderReachedMaxSlippage' | 'OcoFilled' | 'OrderIncreasesPosition' | 'RiskLimitExceeded' | 'SignerRevoked' | 'TriggerCanceled' | 'QuantityAboveMaximum' | 'UnfilledFillOrKill' | 'UnfilledImmediateOrCancel' | 'UnfilledMarketOrder' | 'MakerCanceledByTaker' | 'CloseOrder'

Reason the order was rejected, if applicable

senderstring hex required

Account or linked signer address that placed this order

side0 | 1 required
status'NEW' | 'PENDING' | 'FILLED_PARTIAL' | 'FILLED' | 'REJECTED' | 'CANCELED' | 'EXPIRED' required

Status of the order

stopPricestring decimal required

Stop price expressed as a decimal (zero if not a stop order, precision: 9)

stopPriceType0 | 1

Type of stop price (stop orders only)

stopType0 | 1
subaccountIdstring uuid required

Id of the subaccount associated to order

timeInForce'GTD' | 'IOC' | 'FOK'

How long an order will remain until executed/expired (required if limit)

triggered'NOT_TRIGGERED' | 'TRIGGERED' | 'STOP_ORDER_TRIGGERED' | 'OCO_ORDER_TRIGGERED' | 'OTO_ORDER_TRIGGERED' required

Indicates order trigger conditions which have or have not been met: NOT_TRIGGERED (waiting for stop/OTO condition), TRIGGERED (immediately active), STOP_ORDER_TRIGGERED (stop price condition met), OCO_ORDER_TRIGGERED (canceled because OCO sibling filled), OTO_ORDER_TRIGGERED (activated by OTO parent filling)

type'MARKET' | 'LIMIT' required

Trade order type e.g. MARKET or LIMIT

updatedAtinteger required

Order last updated timestamp (ms since Unix Epoch)

Example response

{
  "availableQuantity": "10.5",
  "clientOrderId": "28850555-0968-44ca-bdee-b51e286656d9",
  "createdAt": 1712019600000,
  "expiresAt": 1712019600,
  "filled": "0.5",
  "groupId": "9036443a-441a-4a66-87f2-bd5c44cdca7a",
  "id": "9036443a-441a-4a66-87f2-bd5c44cdca7a",
  "postOnly": true,
  "price": "4200.5",
  "productId": "9c6bf870-a8ce-4de3-820b-542fd5c049ba",
  "quantity": "10.5",
  "reduceOnly": true,
  "sender": "0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045",
  "status": "FILLED",
  "stopPrice": "4200.5",
  "subaccountId": "c25c39d9-ce2b-4753-960c-c5ad558aace8",
  "timeInForce": "GTD",
  "triggered": "TRIGGERED",
  "type": "LIMIT",
  "updatedAt": 1712019600000
}