latestOpenAPI 3.1.02026-08-1051108155.9 KB

6e6f8dad92bf

Order

Returns a filtered array of orders by the subaccount

get/v1/order

Query parameters

order'asc' | 'desc'

Direction to paginate through objects

limitinteger

Limit the number of objects to return

cursorstring

Pointer to the current object in pagination dataset

subaccountIdstring uuid required

Id of the subaccount to query for

clientOrderIdstring

Client-generated order id to query for (either a valid UUID or alphanumeric string up to 32 characters)

productIdsstring[]

Array of product ids to filter for

createdAfterinteger

Filter by orders created after timestamp exclusive (ms since Unix epoch)

createdBeforeinteger

Filter by orders created before timestamp inclusive (ms since Unix epoch)

side0 | 1

Side of the order to filter for

closeboolean

Whether the order is a position close order

stopTypesStopType[]

Array of StopTypes to filter by

isWorkingtrue

Example:true

Filter by orders that are working: NEW, FILLED_PARTIAL

isPendingtrue

Example:true

Filter by orders that are PENDING

orderBy'createdAt'

Example:createdAt

Order by field

Response

hasNextboolean required

Whether there are more objects to paginate through

nextCursorstring

Pointer to the next page in pagination dataset

Example response

{
  "data": [
    {
      "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
    }
  ],
  "hasNext": true
}