Skip to main content
GET
Get historical balance snapshots

Authorizations

x-api-key
string
header
default:lhgfaslk21490FAScVPkdsb53F9dNkfHG4faZSG5vfjndfcfgdssdgsdHF4663
required

API key of the application. Only valid together with the x-user-key header — the pair is an alternative to OAuth bearer authentication, never sent alongside it. The pair is granted the same permissions the operation's OAuth scopes describe.

Demo credential for trying the API from these docs: lhgfaslk21490FAScVPkdsb53F9dNkfHG4faZSG5vfjndfcfgdssdgsdHF4663

x-user-key
string
header
default:eyJlYW4iOiJVbnJlZ2lzdGVyZWRBcHBsaWNhdGlvbiIsImVrIjoiOE5sZ2cwcW5EUVdROUFNWGpXT2lmOWktZnpidG5KcUlqWGJ3WHJZZkpZcldrbG90ZEhvLVBjSWhQaU8xU1ZtMW84aU1WZGZqN2xWNzFjLXFxLmcybXE1dnh4Q1hUT25xaWRUaTFlcEhmVk1fIn0_
required

User-specific authentication key. Only valid together with the x-api-key header — the pair is an alternative to OAuth bearer authentication, never sent alongside it.

Demo credential for trying the API from these docs: eyJlYW4iOiJVbnJlZ2lzdGVyZWRBcHBsaWNhdGlvbiIsImVrIjoiOE5sZ2cwcW5EUVdROUFNWGpXT2lmOWktZnpidG5KcUlqWGJ3WHJZZkpZcldrbG90ZEhvLVBjSWhQaU8xU1ZtMW84aU1WZGZqN2xWNzFjLXFxLmcybXE1dnh4Q1hUT25xaWRUaTFlcEhmVk1fIn0_

Headers

x-request-id
string<uuid>
required

A unique request identifier.

Example:

"cec796fa-45d3-4f2f-85dc-c093f84a96c6"

Query Parameters

displayCurrency
string
default:USD

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

fromDate
string<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.

toDate
string<date>

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

accountTypes
string

Optional comma-separated list of account types to include. Valid values: Trading, Cash, Options, Crypto, MoneyFarm, Spaceship (case-insensitive). Unrecognised values are silently ignored rather than rejected: if none of the supplied values are recognised the filter is dropped and all account types are returned, so verify the accountType values in the response rather than assuming the filter applied.

includeSubAccounts
boolean
default:false

Whether to also include the user's qualifying sub-accounts in the aggregated history. Their end-of-day snapshots are merged by date with the primary account's and the daily totals are recalculated across all accounts. Only effective when Trading is in scope. Defaults to false.

Response

Historical balance snapshots retrieved successfully.

Historical end-of-day balance snapshots for the authenticated user.

gcid
integer<int64>

The user's global customer ID.

displayCurrency
string | null

ISO 4217 currency code used for display values.

fromDate
string<date>

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

toDate
string<date>

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

snapshots
object[] | null

End-of-day balance snapshots, one entry per day in the requested range.