Sign in

v1

latestOpenAPI 3.0.02026-08-04134348905.1 KB
Trading

List settlements

Permissions required: Execute trades or Read trade activity

List of all settlements. With permission Read trade activity all settlements of the organization may be read. With permission Execute trades only settlements this api key has created may be read.

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

Filters

You may optionally supply the following filters:

  • Specify a one or multiple status to filter settlements. Multiple statuses should be separated by commas.
get/trading/settlements

Query parameters

startDatestring date

The start date (inclusive) in YYYY-MM-DD format. The earliest valid start date is 2017-01-01. The last valid start date is the current date. Dates are always in UTC RFC 3339 'full-date'.

endDatestring date

The end date (inclusive) in YYYY-MM-DD format. The latest valid end date is the current date. Dates are always in UTC RFC 3339 'full-date'.

statusstring[]

One or more statuses to filter settlements. If provided, only settlements matching these statuses will be returned.

vaultIDstring

Filter by the vault ID of a settlement. If provided, only settlements linked to this vault ID will be returned.

limitinteger

Maximum number of results to return per query

excludePositionsboolean

If true, positions property will be excluded from the response. If false, positions will be included in the response as demonstrated in the example.

excludeSettlementInstructionsboolean

If true, instructionsCrypto property will be excluded from the response. If false, it will be included in the response as demonstrated in the example.

accountIdstring

Filter by the trading account ID of a trade. If provided, only trades linked to this account ID will be returned.

Response

A list of Settlements and their metadata

Example response

{
  "data": [
    {
      "account": {
        "accountId": "6290d9bd-494f-11ed-975e-2e567b4c0e09"
      },
      "positions": [
        {
          "positionAmount": {
            "quantity": "10.45234733",
            "assetType": "BTC",
            "currentPrice": "9751.01",
            "currentUSDValue": "101920.94"
          }
        }
      ],
      "vault": {
        "vaultID": "1c920f4241b78a1d483a29f3c24b6c4c"
      }
    }
  ],
  "page": {
    "next": "<next page url>"
  }
}