PnL Leaderboard

circle-exclamation

Get TGM PnL Leaderboard Data

post

Rank traders by their profit/loss performance for a specific token. Shows both realized profits (from completed trades) and unrealized profits (from current holdings), along with ROI percentages and trading patterns. This endpoint can be used to analyze the realized and unrealized profit for each trader who traded the input token.

Label Tier Control (premium_labels): The premium_labels parameter is now available to all users. When omitted, it defaults to true (premium labels). In a future release, the default will change to false. Pass premium_labels=true explicitly to preserve premium label behavior.

Authorizations
apiKeystringRequired

API key for authentication

Body

Request model for TGM PnL leaderboard endpoint. This endpoint provides a token PnL leaderboard showing the most profitable traders for a specific token within a given date range.

chainstring · enumRequired

Blockchain chain

Example: ethereumPossible values:
token_addressstringRequired

Token address

Example: 0x6982508145454ce325ddbe47a25d4ec3d2311933
filtersany ofOptional

Additional filters to apply to the query.

Example: {"holding_usd":{"min":1000},"pnl_usd_realised":{"min":1000}}
premium_labelsany ofOptional

Controls label tier in the response. When null/omitted, defaults to true (premium labels filtered by subscription plan). When false, returns free-tier labels for all users. When true, returns premium labels (filtered by subscription plan). Note: In a future release, the default will change from true to false — pass premium_labels=true explicitly to preserve premium label behavior.

booleanOptional
order_byany ofOptional

Custom sort order to override the endpoint's default ordering

Responses
chevron-right
200

TGM PnL leaderboard data

application/json
post
/api/v1/tgm/pnl-leaderboard

Last updated

Was this helpful?