Get settlement by ID

get

https://api.anchorage-staging.com/v2/trading/settlements/{settlementId}

Permissions required: Execute trades or Read trade activity

Get settlement details by ID.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

settlementId

string

required

The ID of the settlement to get details for

Query Params

excludeTrades

boolean

Defaults to false

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.

excludePositions

boolean

Defaults to false

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

excludeSettlementInstructions

boolean

Defaults to false

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

Responses

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Metadata about a specific settlement

400Bad Request

401Unauthenticated

403Forbidden

404Not Found

429Too Many Requests

500Internal Server Error