> 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/overview.md).

# Overview

Read market data and launch tokens over plain HTTP. There is no API key and nothing to sign up for.

![The developer API reference](https://2634848750-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FfCxPyGLkCWEEYzj4BueG%2Fuploads%2Fgit-blob-5578517f8fe47358caefc43c14d38ee53bc364ab%2Fdevelopers-header.png?alt=media)

```
Base URL   https://www.stonkfun.xyz/api/public/v1
```

## Quickstart

```bash
# No key, no signup, no plan. Just call it.
curl 'https://www.stonkfun.xyz/api/public/v1/tokens?sort=newest'

# Launching is the same. What authorises it is your own
# signature on the launch fee, not a token we hand you.
curl 'https://www.stonkfun.xyz/api/public/v1/pairs?launchable=true'
```

Every endpoint is open, launching included, behind a per-minute rate limit per IP address.

## Response shape

Success:

```json
{
  "data": { },
  "meta": { }
}
```

Failure:

```json
{
  "error": {
    "code": "invalid_request",
    "message": "...",
    "retryable": false,
    "retryAfterSeconds": 30
  }
}
```

Branch on `code`, which is stable. Messages are written for humans and may be reworded.

## Endpoint index

### Data

| Method | Path                     | Summary                    |
| ------ | ------------------------ | -------------------------- |
| GET    | `/tokens`                | List and search tokens     |
| GET    | `/tokens/{mint}`         | Get one token              |
| GET    | `/tokens/{mint}/burns`   | Token burn history         |
| GET    | `/tokens/{mint}/rewards` | Token holder rewards       |
| GET    | `/tokens/{mint}/airdrop` | Token launch airdrop       |
| GET    | `/launches`              | List launches              |
| GET    | `/pairs`                 | List launchable pairs      |
| GET    | `/rewards`               | Rewards overview           |
| GET    | `/revenue`               | Platform revenue and burns |
| GET    | `/revenue/history`       | Daily revenue series       |
| GET    | `/stats`                 | Platform stats and config  |

### Launch

| Method | Path                           | Summary                           |
| ------ | ------------------------------ | --------------------------------- |
| POST   | `/launches/prepare`            | Step 1: prepare a launch          |
| POST   | `/launches/submit`             | Step 2: submit payment and launch |
| GET    | `/launches/{paymentSignature}` | Launch status                     |

### Fees

| Method | Path                                | Summary                         |
| ------ | ----------------------------------- | ------------------------------- |
| GET    | `/tokens/{mint}/fees`               | Creator claimable fees          |
| POST   | `/tokens/{mint}/fees/claim/prepare` | Step 1: prepare a fee claim     |
| POST   | `/tokens/{mint}/fees/claim/submit`  | Step 2: submit the signed claim |

### Outside the versioned path

| Method | Path                          | Summary                                             |
| ------ | ----------------------------- | --------------------------------------------------- |
| GET    | `/api/public/total-assets`    | Flat index of every token the platform has launched |
| GET    | `/api/public/v1/openapi.json` | Machine-readable OpenAPI 3.1 spec                   |

## Optional features

Some parameters exist only when the platform currently offers the feature behind them. Dev buys require atomic bundling to be available, reward-launch tax rates require the current reward model, and the airdrop parameters and the airdrop read endpoint require airdrops to be enabled.

When a feature is unavailable, its parameters disappear from this reference and from the OpenAPI spec together, and the endpoint refuses them. That is deliberate: a generated client should never be handed a parameter the platform would reject, because you would write the call, sign a payment, and only then find out.

Read `GET /stats` for what is currently on rather than hardcoding it.

## Caching

Read responses are CDN-cached, and a cache hit never reaches the origin, so it costs nothing against your rate limit.

## Reporting problems

Spotted something wrong or unclear? [Tell us on X](https://x.com/launchonsf).


---

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