Skip to main content
GET
Retrieve 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

OK

cost_basis
string
required

Total acquisition cost of the position.

Example:

"2000.00"

currency
enum<string>
required

Currency of the earnings amounts.

Available options:
EUR,
USD,
GBP
gross_capital
string
required

Capital earnings before fees and taxes.

Example:

"175.00"

gross_income
string
required

Income earnings before fees and taxes.

Example:

"34.75"

gross_realized
string
required

Realized earnings before fees and taxes.

Example:

"125.50"

gross_total
string
required

Total realized and unrealized gross earnings.

Example:

"209.75"

gross_unrealized
string
required

Unrealized earnings before fees and taxes.

Example:

"84.25"

gross_unrealized_percentage
string
required

Unrealized gross earnings as a proportion of cost basis.

Example:

"0.0421"

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.

realized_capital
string
required

Realized earnings from capital appreciation.

Example:

"100.00"

realized_income
string
required

Realized earnings from income.

Example:

"25.50"

unrealized_capital
string
required

Unrealized earnings from capital appreciation.

Example:

"75.00"

unrealized_income
string
required

Unrealized earnings from income.

Example:

"9.25"