> ## 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.

# FomoScan API v3

> Traders across platforms, their wallets, posts and PnL, in one shape, over REST and one WebSocket.

![API v3 in one shape for every platform: traders across platforms, wallets with proven owners, whole-wallet PnL, posts with calls and positions, platform boards and our rankings, and live posts on one stream](https://mintcdn.com/socialscan/IovDmO5aKwtscGfq/images/art/v3-overview.webp?fit=max\&auto=format\&n=IovDmO5aKwtscGfq\&q=85\&s=b0527ddc418dc575bf80b23979cb3a0c)

v3 follows one trader across trading platforms. A trader carries their profile on
each platform, the wallets we verified for them, their posts and their PnL, and
every object has the same shape whichever platform it comes from.

> [!NOTE]
>
> Coming from v2? Your key works on v3 and spends from the same balance.
> [Moving from v2](https://docs.fomoscan.sh/v3/migration.md) maps every v2 route to its v3 operation and price.

## Get started

> [card] [Quickstart](https://docs.fomoscan.sh/v3/quickstart.md)
>
> Create a key and find your first trader in four steps.

> [card] [Credits and reveals](https://docs.fomoscan.sh/v3/concepts/credits.md)
>
> What each call costs, and which answers take a reveal.

## Build

> [card] [API reference](https://docs.fomoscan.sh/v3/api-reference/introduction.md)
>
> Every endpoint, with a live playground.

> [card] [Live posts](https://docs.fomoscan.sh/v3/websocket/overview.md)
>
> One socket for every new post, filtered by platform and token.

> [card] [Objects and ids](https://docs.fomoscan.sh/v3/concepts/objects.md)
>
> The envelope every answer uses, and the ids to store.

## What you can ask

| Question | Endpoint |
| - | - |
| Who is this trader, and on which platforms? | `GET /v3/traders/lookup?handle={handle}` |
| Which wallets are theirs? | `GET /v3/traders/{traderId}/wallets` |
| Who is behind this wallet? | `GET /v3/wallets/{family}/{address}` |
| How much has this trader made over 24 hours, 7 days or 30 days? | `GET /v3/traders/{traderId}/pnl` |
| What are traders posting about this token? | `GET /v3/tokens/{network}/{address}/posts` |
| What did this trader post, and how did the call do? | `GET /v3/traders/{traderId}/posts` |
| What are the traders we follow buying and selling? | `GET /v3/trades` |
| Who leads a platform's leaderboard? | `GET /v3/leaderboards/{platform}/{board}` |
| Who leads our rankings? | `GET /v3/rankings/{key}` |
| What is being posted right now? | `wss://stream.fomoscan.sh/v3` |

`GET /v3/capabilities` lists which platform fills which part of an object, and
which fields each platform leaves empty. It costs nothing.

## Need help?

> [card] [Telegram](https://t.me/fomoscan_support)
>
> Talk to the team.

> [card] [Email](mailto:fomoscan-support@proton.me)
>
> [fomoscan-support@proton.me](mailto:fomoscan-support@proton.me)


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