Skip to main content
POST
Get Pnl History
This endpoint provides unrealized and realized PnL for wallet addresses at specified time periods and granularities.

Time Range Parameters

  • start_timestamp - Beginning of the time range (inclusive)
  • end_timestamp - End of the time range (exclusive)
  • Both timestamps are assumed to be in UTC if no timezone is specified
  • All returned data is in UTC

Granularity Options

  • 1d - Daily intervals
  • 1h - Hourly intervals
  • 5m - 5-minute intervals
  • 1m - 1-minute intervals
  • 15s - 15-second intervals

Granularity Constraints

The allowed granularity depends on the requested time range:
Time RangeFinest Granularity Allowed
0 - 24 hours15s
1 - 7 days5m
1 week - 1 year1h
Over 1 year1d

Supported Chains

Authorizations

X-API-KEY
string
header
required

Query Parameters

min_liquidity
number

Minimum liquidity of which tokens must have to be included in the response.

Body

application/json
start_timestamp
string<date-time>
required

Start of time range (UTC ISO 8601)

end_timestamp
string<date-time>
required

End of time range (UTC ISO 8601)

granularity
enum<string>
required

Time interval granularity (1d, 1h, 5m, 1m, 15s)

Available options:
1h,
1d,
1m,
5m,
15s
addresses
PayloadAddress · object[]
required

List of wallet chain+address pairs

Required array length: 1 - 20 elements

Response

Successful Response

data
HistoricalPnl · object

Single item response data of type T

Example:
items
(HistoricalPnl · object | PnlError · object)[] | null

Response items of type T

Example:
error
string | null

Error message

cursor
string | null

Pagination cursor for next page