GET
cURL

Authorizations

Authorization
string
header
required

The authorization field takes the session bearer returned by sign-in, or an API key where the route allows keys. Paste the token itself into the authorization field. When invitation-only access is enabled, private operations require the account's sign-in email to be invited. Sign-in can complete without an invitation, but private HTTP, MCP and FIX operations refuse with access_not_allowlisted (HTTP 403): "Private access is limited to invited accounts. Contact support to request access." Public market data remains available. Invitation changes apply to the next private operation, including existing FIX sessions. Do not retry until support confirms access.

Path Parameters

accountId
string
required
Minimum string length: 1

Query Parameters

range
enum<string>

Optional chart range ending now: 1d, 7d, 14d, 30d, 3m, 6m or 1y. Defaults to 30d.

Available options:
1d,
7d,
14d,
30d,
3m,
6m,
1y

Response

Success

version
string
required
Allowed value: "account-portfolio-history/v1"
accountId
string
required
Minimum string length: 1
asset
string
required

The account asset every value is counted in.

Minimum string length: 1
method
string
required

The name of the method that built the values. Known today: live-equity-less-later-cash-flows/v1. A client must accept a name it does not know. live-equity-less-later-cash-flows/v1: the last point is the live account equity of the account snapshot, exact. A past point is that equity minus the account's cash flows after the point's time, in the account asset: credited deposits, settled withdrawals, transfers between an owner and its agents (in on the receiving account, out on the sending one, timed when the transfer's receipt was recorded), trading fees, the quote amount of spot fills (a spot buy lowers the value by the amount paid, a spot sell raises it by the amount received), and the realized profit and loss of each position plus the funding its record carries (positive when received, negative when paid), booked at the time the position closed. Position records carry no funding today, so every funding payment is untimed. A deposit held for a receipt check counts from the time it is credited. Account equity, and so every point, does not count the value of spot tokens held. A past point assumes that everything these records do not time was the same then as now: unrealized profit and loss, funding payments, liquidation fees, insurance fund cover and bad debt. A past point is off by how much those changed since then. Past points also assume the records are current: a cash flow the venue applied but has not yet recorded for this read makes every earlier point off by its amount until it is recorded; freshness reports that lag.

Minimum string length: 1
range
enum<string>
required
Available options:
1d,
7d,
14d,
30d,
3m,
6m,
1y
fromEpochMs
integer
required
Required range: x >= 0
toEpochMs
integer
required
Required range: x >= 0
bucketMs
integer
required
points
object[]
required
Required array length: 2 - 400 elements
freshness
object
required

The least fresh of the fill, transfer and position projections the cash flows come from.