csid_platform_leaderboard
Ranking of the users of YOUR platform (white-label) by their trades on one
chain: realized PnL, volume, win rate and trade count for a period, each entry
with your own user id (external_id). Use for "Who are the top traders on my
platform this week?" when your users are imported into a CabalSpy ID instance.
For users who sign in with CabalSpy ID themselves use csid_leaderboard.
Needs your own CabalSpy API key with a CabalSpy ID instance (no demo).
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| sort | No | pnl_usd (default), pnl (native currency), volume, win_rate or trades. | pnl_usd |
| limit | No | How many traders (1-50, default 10). | |
| cursor | No | Pagination cursor taken from the previous response. Leave empty for the first page. | |
| period | No | Statistics window: 6h, 1d, 7d or 30d. Longer windows return far more data and get trimmed harder, so prefer the shortest window that answers the question. | 7d |
| instance | No | Your CabalSpy ID instance (its client_id, e.g. 'csid_1a2b…'). Only needed when your account has several instances. Leave empty otherwise. | |
| blockchain | Yes | Blockchain. One of: solana, bnb, base, eth, rh. solana has kol, smart and whale wallets; bnb, base, eth and rh have kol and smart. rh is Robinhood Chain, an Ethereum L2. | |
| verified_only | No | True ranks only payment-verified wallets. The instance setting leaderboard_trust can already enforce this. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||