> For the complete documentation index, see [llms.txt](https://cabalspy.gitbook.io/cabalspy-docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://cabalspy.gitbook.io/cabalspy-docs/wallet-activity/leaderboard.md).

# Leaderboard

Ranked list of tracked wallets for a chain, wallet type and period. Each entry includes profile, period\_stats (native + USD volume and PnL, win rate, average hold time) and a win-rate distribution. Results are sorted by volume.

## Get the wallet leaderboard

> Returns the ranked wallet leaderboard for the given chain, type and period.\
> \
> \*\*Parameters / settings\*\*\
> \- \`blockchain\` (required) — one of: \`solana\`, \`bnb\`, \`base\`, \`eth\`\
> \- \`type\` (optional, default \`kol\`) — one of: \`kol\`, \`smart\`, \`whale\` (availability depends on chain)\
> \- \`period\` (optional, default \`1d\`) — one of: \`6h\`, \`1d\`, \`7d\`, \`30d\`\
> \- \`limit\` (optional) — number of entries to return. Omit it to get ALL entries (no cap).\
> \- \`cursor\` (optional) — wallet address from a previous page for pagination\
> \- \`api\_key\` (optional if Bearer header is used)\
> \
> Alias: \`GET /v1/wallets/leaderboard\` is identical.<br>

```json
{"openapi":"3.0.3","info":{"title":"CabalSpy API — Leaderboard","version":"1.0.0"},"tags":[{"name":"Leaderboard","description":"Ranked list of tracked wallets for a chain, wallet type and period. Each entry includes profile, period_stats (native + USD volume and PnL, win rate, average hold time) and a win-rate distribution. Results are sorted by volume.\n"}],"servers":[{"url":"https://api.cabalspy.xyz"}],"security":[{"bearerAuth":[]},{"apiKeyQuery":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Authorization: Bearer YOUR_KEY"},"apiKeyQuery":{"type":"apiKey","in":"query","name":"api_key"}},"schemas":{"LeaderboardEnvelope":{"type":"object","properties":{"success":{"type":"boolean"},"data":{"type":"object","properties":{"blockchain":{"type":"string"},"type":{"type":"string"},"period":{"type":"string"},"currency":{"type":"string"},"pagination":{"type":"object"},"leaderboard":{"type":"array","items":{"type":"object"}}}},"meta":{"type":"object"}}},"ErrorEnvelope":{"type":"object","properties":{"success":{"type":"boolean"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"request_id":{"type":"string"},"docs":{"type":"string"}}}}}}},"paths":{"/v1/wallet/leaderboard":{"get":{"tags":["Leaderboard"],"summary":"Get the wallet leaderboard","operationId":"getLeaderboard","description":"Returns the ranked wallet leaderboard for the given chain, type and period.\n\n**Parameters / settings**\n- `blockchain` (required) — one of: `solana`, `bnb`, `base`, `eth`\n- `type` (optional, default `kol`) — one of: `kol`, `smart`, `whale` (availability depends on chain)\n- `period` (optional, default `1d`) — one of: `6h`, `1d`, `7d`, `30d`\n- `limit` (optional) — number of entries to return. Omit it to get ALL entries (no cap).\n- `cursor` (optional) — wallet address from a previous page for pagination\n- `api_key` (optional if Bearer header is used)\n\nAlias: `GET /v1/wallets/leaderboard` is identical.\n","parameters":[{"name":"blockchain","in":"query","required":true,"schema":{"type":"string","enum":["solana","bnb","base","eth"]}},{"name":"type","in":"query","required":false,"schema":{"type":"string","enum":["kol","smart","whale"],"default":"kol"}},{"name":"period","in":"query","required":false,"schema":{"type":"string","enum":["6h","1d","7d","30d"],"default":"1d"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":1}},{"name":"cursor","in":"query","required":false,"schema":{"type":"string"}},{"name":"api_key","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Ranked leaderboard.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LeaderboardEnvelope"}}}},"400":{"description":"Missing or invalid parameter.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"401":{"description":"Missing API key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"Invalid or exhausted API key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"429":{"description":"Rate limit exceeded.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}}}}}}
```
