v1

latestOpenAPI 3.0.12026-07-26171200932.8 KB

Balances

Get historical balance snapshots

Rate limit: 60 requests per 60 seconds. This is the default shared quota — it is shared with every other endpoint that has no dedicated limit, so requests across those endpoints all draw from the same budget.

Returns end-of-day balance snapshots across all account types for the authenticated user. History is available for the last 12 months. The maximum date range per request is 365 days.

get/api/v1/balances/history

Query parameters

displayCurrencystring

ISO 4217 currency code for totals and conversions. Defaults to USD.

fromDatestring date

Start of the date range (inclusive). Format: YYYY-MM-DD (ISO 8601). Defaults to toDate minus 30 days. Must be within the last 12 months. Maximum range with toDate: 365 days.

toDatestring date

End of the date range (inclusive). Format: YYYY-MM-DD (ISO 8601). Defaults to today (UTC). Maximum range with fromDate: 365 days.

accountTypesstring

Optional comma-separated list of account types to include. Valid values: Trading, Cash, Options, Crypto, MoneyFarm, Spaceship.

Headers

x-request-idstring uuid required

Example:581ddf23-9a12-4c4e-8c42-4e0a97b61802

A unique request identifier.

x-api-keystring password required

Example:lhgfaslk21490FAScVPkdsb53F9dNkfHG4faZSG5vfjndfcfgdssdgsdHF4663

API key for authentication.

x-user-keystring password required

Example:eyJlYW4iOiJVbnJlZ2lzdGVyZWRBcHBsaWNhdGlvbiIsImVrIjoiOE5sZ2cwcW5EUVdROUFNWGpXT2lmOWktZnpidG5KcUlqWGJ3WHJZZkpZcldrbG90ZEhvLVBjSWhQaU8xU1ZtMW84aU1WZGZqN2xWNzFjLXFxLmcybXE1dnh4Q1hUT25xaWRUaTFlcEhmVk1fIn0_

User-specific authentication key.

Response

Historical balance snapshots retrieved successfully.

gcidinteger

The user's global customer ID.

displayCurrencystring nullable

ISO 4217 currency code used for display values.

fromDatestring date

Start of the returned date range (inclusive, ISO 8601).

toDatestring date

End of the returned date range (inclusive, ISO 8601).