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

# Quickstart

> From sign-up to your first trader in four steps.

![Four steps: create an account, generate a key, find a trader, check your balance. The call GET /v3/traders/lookup?handle=tradername returns 200 OK for 100 credits, and you keep the tdr\_ id it returns](https://mintcdn.com/socialscan/IovDmO5aKwtscGfq/images/art/v3-quickstart.webp?fit=max\&auto=format\&n=IovDmO5aKwtscGfq\&q=85\&s=ec612bbd4f462fa4bf02434e8ffe06c8)

**1. Create an account**

Sign up at [partner.fomoscan.sh/signup](https://partner.fomoscan.sh/signup)
with Google or an email address, then confirm the code we email you.
Verifying the email activates your free credits. A v2 key works on v3, so
skip to step 3 if you have one.

**2. Generate your API key**

On the dashboard, select **Generate your API key**. Copy it right away: the
portal shows the full key once. Keys look like `fsk_live_…`.

**3. Find a trader**

```bash theme={null}
export KEY=fsk_live_...
curl -s -H "Authorization: Bearer $KEY" \
  "https://api.fomoscan.sh/v3/traders/lookup?handle=frankdegods"
```

The answer is a page of traders. Each one is an envelope, trimmed here:

```json theme={null}
{
  "items": [
    {
      "kind": "trader",
      "id": "tdr_01m5qhae6sf5v91189b6sejnzq",
      "canonical": {
        "display": { "handle": "frankdegods", "name": "frank", "avatarUrl": "…" },
        "platforms": ["fomo", "hyperliquid"],
        "walletAvailable": true
      },
      "sources": {
        "fomo": {
          "profile": { "handle": "frankdegods", "xHandle": "frankdegods", "observedAt": "…" },
          "followGraph": { "followers": 396600, "following": 331, "observedAt": "…" }
        }
      }
    }
  ],
  "hasMore": false,
  "nextCursor": null,
  "match": "exact"
}
```

Store the `id`. Every other trader call takes it, and it stays the same when
the trader renames. [Objects and ids](https://docs.fomoscan.sh/v3/concepts/objects.md) explains the shape.

> [!NOTE]
>
> A lookup costs 100 credits when it finds a trader and 200 when it does not.
> Answers that show who owns a wallet or what a trader earned take a reveal. A
> key on a free plan without reveals gets `403 PERMISSION_DENIED` for them until
> you pick a plan. `canonical.walletAvailable` says, without a reveal, whether
> the trader's wallets will come back.

**4. Check your balance**

`GET /v3/me` is free and returns your plan, the credits and reveals left this
month, and your rate limit. v2 and v3 spend from the same balance.

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

When the free credits run out, pick a plan or buy a credit pack in the portal.
See [Credits and pricing](https://docs.fomoscan.sh/concepts/credits.md).

## Next

> [card] [Traders, wallets and PnL](https://docs.fomoscan.sh/v3/guides/traders.md)
>
> From a handle to wallets and profit.

> [card] [Posts](https://docs.fomoscan.sh/v3/guides/posts.md)
>
> Calls and positions, per trader and per token.

> [card] [Live posts](https://docs.fomoscan.sh/v3/websocket/overview.md)
>
> Every new post on one socket.


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