Trader

Get user PnL

Handles GET /v1/users/{user_pubkey}/pnl via get.v1.users.by_user_pubkey.pnl.

get/v1/users/{user_pubkey}/pnl

Request

Base URL
https://perp-api.phoenix.trade
Auth
HTTP bearer
TypeScript
https://skmtc.dev/phoenix/apis/phoenix-eternal-api/docs/v1/users/:user_pubkey/pnl/get.ts
A function with typed inputs. Its response is checked against the schema.

user_pubkeystring required

User public key (base58 encoded)

resolutionstring required

Resolution/timeframe: 1m, 1d

startTimeinteger

Start time in milliseconds since Unix epoch (max range: 1 year)

endTimeinteger

End time in milliseconds since Unix epoch (max range: 1 year)

limitinteger

Max number of data points (default: 1000, max: 1440)

cumulativeFundingPaymentnumber double required

Cumulative funding payment up to this point

cumulativePnlnumber double required

Cumulative realized PnL up to this point

cumulativeTakerFeenumber double required

Cumulative taker fees paid up to this point

endTimeinteger required

End time in seconds since Unix epoch

startTimeinteger required

Start time in seconds since Unix epoch

timestampinteger required

Deprecated: Unix timestamp in seconds.

unrealizedPnlnumber double required

unrealized PnL up to this point

No recorded changes to this operation across all 2 revisions of this API.