Sign in

v1

latestOpenAPI 3.0.02026-08-04134348905.1 KB
Trading

Get settlement by ID

Permissions required: Execute trades or Read trade activity

Get settlement details by ID.

get/trading/settlements/{settlementId}

Path parameters

settlementIdstring required

The ID of the settlement to get details for

Query parameters

excludeTradesboolean

If true, trades property will be excluded from the response. If false, trades will be included in the response as demonstrated in the example. In order to get the full list of trades for a settlement, favor the usage of the list trades by settlement API endpoint.

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.

Response

Metadata about a specific settlement

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"
    }
  }
}