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

# Data endpoints

All reads. No key required, CDN-cached, and counted against the 300 per minute budget.

***

## `GET /tokens`

Every token with a live platform pool, with market data.

| Parameter   | In    | Type                                        | Description                                   |
| ----------- | ----- | ------------------------------------------- | --------------------------------------------- |
| `q`         | query | string                                      | Search name, symbol or mint                   |
| `sort`      | query | `'marketCap' \| 'newest' \| 'volume'`       | Defaults to `marketCap`                       |
| `mode`      | query | `'standard' \| 'reward'`                    | Filter by fee model                           |
| `status`    | query | `'new' \| 'aboutToGraduate' \| 'graduated'` | Filter by graduation status                   |
| `quoteMint` | query | string                                      | Filter by paired token                        |
| `category`  | query | string                                      | Filter by pair category, for example `xstock` |
| `page`      | query | integer                                     | Defaults to `1`                               |
| `pageSize`  | query | integer                                     | 1 to 100, defaults to `25`                    |

Reward tokens additionally carry `transferFee.bps`, the transfer tax paid to holders. Use the Token-2022 program for their accounts. While a token is in the buyback rankings it also carries `flywheel.active`.

```bash
curl 'https://www.stonkfun.xyz/api/public/v1/tokens?sort=volume&category=xstock&pageSize=50'
```

***

## `GET /tokens/{mint}`

Live market data plus the launch record, when the platform launched it.

| Parameter | In   | Required | Description        |
| --------- | ---- | -------- | ------------------ |
| `mint`    | path | Yes      | Token mint address |

Carries the same optional `transferFee` and `flywheel` fields as `/tokens`.

***

## `GET /tokens/{mint}/burns`

Totals and recent burns of this token by the platform fee sweep.

| Parameter | In    | Required | Description                |
| --------- | ----- | -------- | -------------------------- |
| `mint`    | path  | Yes      | Token mint address         |
| `limit`   | query | No       | 1 to 100, defaults to `25` |

***

## `GET /tokens/{mint}/rewards`

Distribution totals for a reward coin.

| Parameter | In   | Required | Description        |
| --------- | ---- | -------- | ------------------ |
| `mint`    | path | Yes      | Token mint address |

Standard launches answer with `mode: "standard"` and a null rewards object, which is not an error.

***

## `GET /tokens/{mint}/airdrop`

{% hint style="info" %}
Available only where the platform currently offers [Airdrop mode](/stonkfun-docs/launching/airdrop-mode.md). Elsewhere this route `404`s and is omitted from the OpenAPI spec.
{% endhint %}

The airdrop a token launched with, if any: what share of supply was carved out of the pool, how many wallets received it, and where those wallets came from.

This reads the snapshot frozen when the launch was quoted, so it is the drop that was actually paid for rather than a live balance scan.

A token that launched without one answers `airdrop: null`. That is not an error, and most tokens have no airdrop.

***

## `GET /launches`

The launch ledger, newest first. Filter by creator to find your own.

| Parameter  | In    | Type                     | Description                         |
| ---------- | ----- | ------------------------ | ----------------------------------- |
| `creator`  | query | string                   | Filter by creator wallet            |
| `mode`     | query | `'standard' \| 'reward'` | Filter by fee model                 |
| `since`    | query | ISO 8601                 | Only launches at or after this time |
| `page`     | query | integer                  | Defaults to `1`                     |
| `pageSize` | query | integer                  | 1 to 100, defaults to `25`          |

***

## `GET /pairs`

Quote tokens a new launch can be paired against.

{% hint style="warning" %}
Call this first. The `quoteMint` you pass to `/launches/prepare` has to be one of these.
{% endhint %}

| Parameter    | In    | Type    | Description                              |
| ------------ | ----- | ------- | ---------------------------------------- |
| `category`   | query | string  | Filter by category                       |
| `launchable` | query | boolean | Set `true` to exclude retired categories |

```bash
curl 'https://www.stonkfun.xyz/api/public/v1/pairs?launchable=true'
```

***

## `GET /rewards`

Lifetime payout totals per reward coin, plus recent distribution transactions.

| Parameter | In    | Type    | Description                |
| --------- | ----- | ------- | -------------------------- |
| `limit`   | query | integer | 1 to 100, defaults to `25` |

***

## `GET /revenue`

Fee revenue, buybacks and burns.

| Parameter | In    | Type    | Description                |
| --------- | ----- | ------- | -------------------------- |
| `limit`   | query | integer | 1 to 100, defaults to `25` |

***

## `GET /revenue/history`

The whole daily history in one response, keyed by UTC day, in USD.

There is no date parameter by design. Fetch it once and index it locally.

| Field                  | Meaning                                                        |
| ---------------------- | -------------------------------------------------------------- |
| `dailyRevenue`         | Quote-token fees claimed to the treasury, valued at claim time |
| `dailyHoldersRevenue`  | The share spent buying the platform token back and burning it  |
| `dailyProtocolRevenue` | The remainder                                                  |
| `coverage`             | Rows carrying no USD price, which therefore count as zero      |

Fees earned by creator positions and by reward-holder positions are claimed directly from Raydium and are not included.

***

## `GET /stats`

Aggregate totals plus the thresholds and switches a client needs, so your interface tracks the platform instead of hardcoding it.

Use this rather than hardcoding graduation thresholds, dev-buy caps, airdrop maximums, or which features are currently available.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://stonkfun.gitbook.io/stonkfun-docs/developer-api/data-endpoints.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
