Sign in

v1

latestOpenAPI 3.0.02026-08-04134348905.1 KB
Trading

List orders

Permissions required: Execute trades or Read trade activity

List all orders. With the permission Read trade activity all orders of the organization may be read. With the permission Execute trades only the orders created by this API key may be read.

Orders are sorted in a descending order by their timestamp, i.e. the most recent order or the order with a timestamp closest to endDate is listed first.

When filtering by subaccountId, the allocation information is included but filtered to show only the allocation for the requested subaccount. For multi-order requests without a subaccount filter, allocation information is not included. To get complete allocation information, use GET /v2/trading/orders/{orderId}

Filters

You may optionally supply filters for the list of orders using query parameters below

get/trading/orders

Query parameters

accountIdstring

The ID of the account to filter orders by. If provided, only orders for this account will be returned.

subaccountIdstring

The ID of the subaccount to filter orders by. If provided, only orders for this subaccount will be returned.

startDateTimestring date-time

The start date-time of the trades (exclusive) in YYYY-MM-DDTHH:MM:SS.nnnnnnnnn format. The earliest valid start date-time is '2017-01-01T00:00:00.000000000'. The last valid start date-time is the current date-time. Date-times are always in UTC RFC 3339 'date-time'.

endDateTimestring date-time

The end date-time of the trades (exclusive) in YYYY-MM-DDTHH:MM:SS.nnnnnnnnn format. The latest valid end date-time is the current date-time. The earliest valid end date-time is '2017-01-01T00:00:00.000000000'. Date-times are always in UTC RFC 3339 'date-time'.

statusstring[]

One or more statuses to filter orders. If provided, only orders matching these statuses will be returned. If OPEN status is specified, the call returns all orders in [PENDING,NEW,PENDING_CANCEL,PARTIALLY_FILLED] states.

orderIdsstring[]

A list of orderIds to return. Invalid orderIds will be ignored. A maximum number of unique 500 order ids are enforced per call.

clientOrderIdsstring[]

A list of clientOrderIds to return. Invalid clientOrderIds will be ignored. A maximum number of unique 500 order ids are enforced per call.

limitinteger

Maximum number of results to return per query

orderTypesstring[]

One or more types to filter orders. If provided, only orders matching these types will be returned.

Response

A list of Orders and their last status

Example response

{
  "data": [
    {
      "accountId": "0e2b2f9d-8d10-4f1e-960b-28567255045f",
      "allocation": [
        {
          "counterQtyAllIn": "10000",
          "counterQtyAllInToSettle": "10000",
          "cumQty": "10000",
          "executionId": "6290d9bd-494f-11ed-975e-2e567b4c0e09",
          "fee": "10000",
          "quantity": "10000",
          "subaccountId": "905272f0-52f9-404e-b6cd-ad879e671790"
        }
      ],
      "avgPx": "21005.4",
      "avgPxAllIn": "21006.00",
      "cancelQty": "10000.00",
      "clOrderId": "6fb5fc79-0bb4-446d-82dd-d4687fb56a02",
      "counterQty": "0.001",
      "counterQtyAllIn": "0.0012",
      "cumQty": "10000.00",
      "currency": "USD",
      "feeCurrency": "BTC",
      "leavesQty": "10000.00",
      "limitPrice": "21005.5",
      "orderId": "a94c8d75-6c9d-4903-95f3-5b0893e76cb7",
      "orderQty": "10000.00",
      "strategyParams": {
        "data": {
          "endTime": "2019-01-02T12:34:56.000Z",
          "triggerPrice": "10000.00"
        }
      },
      "subaccountId": "0e2b2f9d-8d10-4f1e-960b-28567255045f",
      "subaccountTransactionId": "af2b2f9d-9d1a-4e2e-76ab-2756725dffdf",
      "symbol": "BTC-USD",
      "totalFee": "10.0"
    }
  ],
  "page": {
    "next": "<next page url>"
  }
}