v3

OpenAPI 3.0.02026-07-31103181312.8 KB

portfolio

Get Settlements

Endpoint for getting the member's settlements historical track.

get/portfolio/settlements

Query parameters

limitinteger

Number of results per page. Defaults to 100.

cursorstring

Pagination cursor. Use the cursor value returned from the previous response to get the next page of results. Leave empty for the first page.

tickerstring

Filter by market ticker

event_tickerstring

Event ticker to filter by. Only a single event ticker is supported.

min_tsinteger

Filter items after this Unix timestamp

max_tsinteger

Filter items before this Unix timestamp

subaccountinteger

Subaccount number (0 for primary, 1-63 for subaccounts). If omitted, defaults to all subaccounts.

Response

Settlements retrieved successfully

cursorstring

Example response

{
  "settlements": [
    {
      "yes_count_fp": "10.00",
      "yes_total_cost_dollars": "0.5600",
      "no_count_fp": "10.00",
      "no_total_cost_dollars": "0.5600",
      "fee_cost": "0.5600"
    }
  ]
}