Skip to main content
GET
Retrieve position earnings (P&L)

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

position_id
string
required

Query Parameters

period
enum<string> | null

Predefined period over which earnings are computed. Takes precedence over period_start/period_end when provided.

Available options:
1d,
1w,
1m,
this-month,
3m,
6m,
ytd,
1y,
all
period_start
string<date-time>

The period start (in ISO 8601 format). If omitted, it defaults to the position opening date/time. Note that the period is interpreted as a half-open interval with period_start included and period_end excluded.

Examples:

"period_start=2025-11-12T00:00:00Z"

"period_start=2025-11-12"

period_end
string<date-time>

The period end (in ISO 8601 format). If omitted, it defaults to the current date/time. Note the period is interpreted as a half-open interval with period_start included and period_end excluded.

Examples:

"period_end=2025-11-12T00:00:00Z"

"period_end=2025-11-12"

Response

Successful Response

account
string
required

ID of the account holding the position.

period_end
string<date-time>
required

End date and time of the earnings period.

Example:

"2026-03-31T23:59:59Z"

period_start
string<date-time>
required

Start date and time of the earnings period.

Example:

"2026-01-01T00:00:00Z"

position
string
required

ID of the position the earnings were computed for.

reporting
PositionReportingEarnings · object
required

The position's earnings in the account's base currency, with a breakdown into what the investment earned and what exchange-rate movements added or took away. Summed over all positions, these give the account's positions figures.

trading
PositionTradingEarnings · object
required

The position's earnings in the instrument's own currency.