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

# Quickstart

> Try a sample request, get an API key, and read a live trader profile and market activity.

Use `curl` in your terminal to try the API. Start with sample data, then use a Pro or Max API key to read live data.

<span id="0-before-you-have-an-account" />

## 1. Try a request without a key

```bash theme={null}
curl "https://0xinsider.com/sandbox/api/v1/leaderboard?limit=5"
```

You receive an example leaderboard response. The [sandbox](/sandbox) uses sample data, so you can learn the format without an account or subscription.

If you want to try real public data, read the pick ledger:

```bash theme={null}
curl "https://api.0xinsider.com/api/v1/pick-of-the-day/ledger"
```

The ledger includes published picks and their commitment states. It does not reveal the side of a live sealed pick; [the ledger reference](/api-reference/endpoint/get-pick-of-the-day-ledger) explains how to check the proof.

<span id="get-a-key" />

## 2. Get an API key

1. Subscribe to [Pro or Max](https://0xinsider.com/pricing) for protected live data.
2. Open [Developers](https://0xinsider.com/developers) and choose **Create key**.
3. Save the key when it appears. The full value is shown once.
4. Store it in an environment variable:

```bash theme={null}
export OXINSIDER_API_KEY="oxi_sk_live_..."
```

Replace the placeholder with your own key. Keep it out of source code, browser code, logs, and screenshots. See [Authentication](/authentication) for OAuth and integration keys.

<span id="1-check-the-key" />

## 3. Check the key and account

```bash theme={null}
curl -H "Authorization: Bearer $OXINSIDER_API_KEY" \
  "https://api.0xinsider.com/api/v1/me"
```

A `200` response means the credential is valid. Check `data.entitlement` to confirm the account can read paid data; a valid key can still belong to an account whose paid access has expired.

If you receive an error:

| Response | Next action |
| - | - |
| `401` | Check that the key is present, complete, and valid. |
| `402` on a data route | Check the account's Pro or Max subscription. |
| `403` | Check that the key or OAuth grant has the required scope. |
| `429` | Wait as directed by `Retry-After` before trying again. |

[Errors](/errors) covers the error body and recovery steps. [Account identity](/api-reference/endpoint/get-account-identity) explains the diagnostic fields.

<span id="2-read-the-leaderboard" />

## 4. Read the leaderboard

```bash theme={null}
curl -H "Authorization: Bearer $OXINSIDER_API_KEY" \
  "https://api.0xinsider.com/api/v1/leaderboard?limit=5"
```

The response's `data` array contains tracked `S`, `A`, and `B` wallets. Each row includes an `id`, `grade`, `score`, and P\&L information.

Copy one `id` for the next request. An empty array is a valid response; do not assume a first row exists.

<span id="3-open-one-wallet" />

## 5. Open a trader profile

Replace `<trader_id>` with the `id` you copied:

```bash theme={null}
curl -H "Authorization: Bearer $OXINSIDER_API_KEY" \
  "https://api.0xinsider.com/api/v1/trader/<trader_id>?expand=strategy"
```

The path also accepts a wallet address or known Polymarket username. The response includes `sync_status`, P\&L, statistics, and a grade when one is available.

Check `sync_status` before using the numbers. An untracked wallet address returns `200` with `sync_status: "unknown"` and missing analytics; an unknown username or trader ID returns `404`.

`expand=strategy` adds strategy details. Other optional groups include `category_strengths`, `quant_metrics`, and `trust`; [Expand](/concepts/expand) explains how to request them.

<span id="4-list-the-a-grade-large-trades" />

<span id="5-read-one-market" />

## 6. Find a large trade and its market

```bash theme={null}
curl -H "Authorization: Bearer $OXINSIDER_API_KEY" \
  "https://api.0xinsider.com/api/v1/large-trades?min_grade=A&min_size=10000&limit=5"
```

This requests large trades of at least \$10,000 from `S` or `A` wallets. Copy a row's `market.condition_id`, then replace `<condition_id>` below:

```bash theme={null}
curl -H "Authorization: Bearer $OXINSIDER_API_KEY" \
  "https://api.0xinsider.com/api/v1/market/<condition_id>/flow"
```

`sharp_money.net_flow_usd` describes signed flow from tracked large trades in the selected time window. `sharp_money.top_positions` lists the largest positions held by graded `S`, `A`, and `B` wallets.

These fields describe observed activity. They do not predict the next price move. See [Market flow](/api-reference/endpoint/get-market-flow) for parameters and response details.

<span id="the-same-requests-in-code" />

## Use a client in your application

The [Python](/integrations/python-client), [Go](/integrations/go-client), [TypeScript](/integrations/typescript-client), and [Rust](/integrations/rust-client) pages show installation and complete examples. For a terminal workflow, use the [CLI](/integrations/cli).

Here is the leaderboard request in JavaScript without an SDK:

```javascript theme={null}
const key = process.env.OXINSIDER_API_KEY;
if (!key) throw new Error("Set OXINSIDER_API_KEY before running this script");

const response = await fetch(
  "https://api.0xinsider.com/api/v1/leaderboard?limit=5",
  { headers: { Authorization: `Bearer ${key}` } }
);
const body = await response.json();
if (!response.ok) {
  throw new Error(`${response.status}: ${body.error.message}`);
}

for (const trader of body.data) {
  console.log(trader.id, trader.grade, trader.pnl);
}
```

Run authenticated requests on a server or in a local script. Never send your API key to a public browser bundle.

## Look up several wallets at once

Use [batch trader lookup](/api-reference/endpoint/batch-get-traders) to read up to 25 profiles in one request. Each item returns its own `status`, so an unknown wallet or username does not fail every other item. Each item uses one unit of the [batch budget](/rate-limits).

```bash theme={null}
curl -H "Authorization: Bearer $OXINSIDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"traders": ["swisstony", "0x0000000000000000000000000000000000000000"], "expand": ["strategy"]}' \
  "https://api.0xinsider.com/api/v1/traders/batch"
```

<span id="what-this-does-not-give-you" />

<span id="go-next" />

## Continue from here

[Pagination](/concepts/pagination) explains how to read more than one page. [Rate limits](/rate-limits) explains budgets and response headers. The [API reference](/api-reference/introduction) lists every operation and the rules they share.


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