Sign in

v1

latestOpenAPI 3.0.02026-08-04134348905.1 KB
Trading

List trades by settlement

Permissions required: Execute trades or Read trade activity

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

Trades are sorted in a descending order by their timestamp (i.e. the most recent trade or the trade with a timestamp closest to endDateTime is listed first).

get/trading/settlements/{settlementId}/trades

Path parameters

settlementIdstring required

The ID of the settlement to retrieve

Query parameters

startDateTimestring date-time

The start date-time of the trades in YYYY-MM-DDTHH:MM:SS.nnnnnnnnn format. The earliest valid start date-time is '2017-01-01T00:00:00.000000000'. 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. Defaults to the current date-time if not specified. endDateTime must be after startDateTime. Date-times are always in UTC RFC 3339 'date-time'.

side'BUY' | 'SELL'

Filter by the side of a trade. If provided, only trades matching this side will be returned.

tradingPairstring

Filter by the trading pair of a trade. If provided, only trades matching this pair of assets will be returned.

afterIdstring

When paginating this is used to provide the starting point for the page to fetch (retrieved from the previous response body)

limitinteger

Maximum number of results to return per query

Response

A list of Trades and their metadata

Example response

{
  "data": [
    {
      "account": {
        "accountId": "6290d9bd-494f-11ed-975e-2e567b4c0e09",
        "subaccountId": "5490d9bd-494f-11ed-975e-2e567b4c0e09"
      },
      "side": "BUY",
      "vault": {
        "vaultID": "1c920f4241b78a1d483a29f3c24b6c4c"
      }
    }
  ],
  "page": {
    "next": "<next page url>"
  }
}