Skip to main content
GET
Get PnL

Authentication

Read authentication required — X-Public-Key header. See the Authentication guide.

Query parameters

string
Predefined time window. If omitted and no custom range is provided, defaults to all time.Rolling windows: 12H, 24H, 1W, 1M, 1Y — relative to current time (e.g. 1M = last 30 days).Calendar windows: THIS_WEEK, THIS_MONTH, THIS_YEAR — from the start of the current week/month/year to now.
string
Custom start time in ISO 8601 format. Overrides timePeriod. Must be paired with end.
string
Custom end time in ISO 8601 format. Overrides timePeriod. Must be paired with start.
string
Currency filter — USD or NGN. Defaults to USD if omitted. PnL is computed per currency, so if you traded only in NGN and query USD, all values will be zero.
boolean
Include per-event breakdown (top 30 events by most recent activity). Defaults to false.

Example request

Response

number
Total realized PnL — the sum of settlementPnl and tradePnl.
number
Realized PnL as a percentage of total cost basis. 0 when no cost basis exists in the queried period.
number
PnL from resolved markets. Computed as total payouts received minus total cost basis of settled positions.
number
PnL from selling shares before market resolution. Computed as proceeds minus cost basis for each sell.
integer
Number of settled positions that received a payout.
integer
Number of settled positions that received zero payout.
string
Currency the PnL is denominated in.
array
Per-event PnL breakdown. Only present when breakdown=true.