> ## Documentation Index
> Fetch the complete documentation index at: https://docs.fomoscan.sh/llms.txt
> Use this file to discover all available pages before exploring further.

# Leaderboards and rankings

> The boards platforms publish, and the rankings we compute.

v3 keeps two kinds of board apart. A **leaderboard** is a board a platform
publishes, as the platform showed it. A **ranking** is ours, computed over the
traders we map. The two never mix.

| Endpoint | Answers | Price |
| - | - | - |
| [`GET /v3/leaderboards`](https://docs.fomoscan.sh/v3/api-reference/leaderboards/list-the-leaderboards-platforms-publish) | every platform board, with its windows | free |
| [`GET /v3/leaderboards/{platform}/{board}`](https://docs.fomoscan.sh/v3/api-reference/leaderboards/read-one-capture-of-a-platform-leaderboard) | one board, whole | 500 credits; 10 on FOMO's token boards and pump.fun's trader board |
| [`GET /v3/rankings`](https://docs.fomoscan.sh/v3/api-reference/rankings/list-our-rankings) | every ranking we compute | free |
| [`GET /v3/rankings/{key}`](https://docs.fomoscan.sh/v3/api-reference/rankings/read-the-newest-snapshot-of-one-of-our-rankings) | the newest snapshot of one ranking | 500 credits |

## Leaderboards

Start from `GET /v3/leaderboards`: it lists each board with its `platform`,
`board`, `category`, `metric` and `windows`. Boards today include the trader
boards of FOMO, pump.fun, Hyperliquid, Polymarket and other platforms, the clan
boards of FOMO and pump.fun, and FOMO's token boards.

```bash theme={null}
curl -s -H "Authorization: Bearer $KEY" \
  "https://api.fomoscan.sh/v3/leaderboards/hyperliquid/traders?window=7d"
```

* `window` takes one of the board's `windows`. Without it you get the board's
  `defaultWindow`.
* `at` returns the board as it stood at that time: the newest snapshot at or
  before it. Older snapshots thin out to one per hour, then one per day.
* Each entry holds its rank, its subject (a trader, token or group envelope)
  and the figures the platform publishes in `measures`. A figure the platform
  does not publish is absent.
* `entries` arrives whole, without paging. An entry whose subject we cannot read
  is left out, so `entries` can hold fewer rows than `entryCount`.

## Rankings

`GET /v3/rankings` lists each ranking with its `key`, `title`, `metric` and
`window`, for example `traders_net_flow_7d`, traders by net flow over 7 days.

```bash theme={null}
curl -s -H "Authorization: Bearer $KEY" \
  "https://api.fomoscan.sh/v3/rankings/traders_net_flow_7d"
```

* `order=best` (the default) returns rank 1 first. `order=worst` returns the
  bottom entries, lowest value first.
* Ties share a rank on both orders.
* `total` counts every ranked subject. `entries` holds at most `size` of them,
  not paged.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.