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

# API

The Cinder Burn API is live. Base URL: `https://api.cindereth.com`.

The API builds ready-to-sign burn, revoke, and sell transactions for Robinhood Chain (chain id 4663), scans wallets for spam and dust, and relays signed transactions. Non-custodial by construction: every build endpoint returns an unsigned transaction, your user signs in their own wallet, and the API never holds a private key and never signs anything.

## Get a key

1. Open [api.cindereth.com](https://api.cindereth.com) and connect your wallet.
2. Sign the sign-in message. The signature costs nothing and sends no transaction.
3. Create a key. The full key appears once. Store the key immediately: the server keeps only a hash.

Keys are wallet-bound. Each wallet holds up to 5 active keys, revocable any time from the portal. Keys are free at launch, with all usage metered per key in the portal dashboard.

Send the key on every request as an `x-api-key` header, or as `Authorization: Bearer`.

## Endpoints

All endpoints are POST with JSON bodies. Full parameter reference: [OpenAPI spec](https://api.cindereth.com/openapi.json), [integration guide](https://api.cindereth.com/llms.md), and the [docs page](https://api.cindereth.com/docs.html).

**Burn.** `/v1/burn`, `/v1/burn/preview`, `/v1/burn-instructions`. Ready-to-sign transfers to `0xdEaD`, with preview and raw-calldata variants.

**Revoke.** `/v1/revoke`, `/v1/revoke/preview`, `/v1/revoke-instructions`. Set a stale ERC-20 allowance to zero. The security hygiene EVM wallets need.

**Sell.** `/v1/sell/quote`, `/v1/sell`, `/v1/sell/preview`. Uniswap v3 and v2 routed dust sells with an on-chain minimum output. Approvals are exact-amount only, never unlimited. Partner fees of 1 to 100 bips ride the router's fee mechanism.

**Wallet.** `/v1/wallet/scan`, `/v1/wallet/approvals`. Full inventory with hostile-metadata classification, dust valuation, and live approvals against known routers.

**Batch and cleanup.** `/v1/batch/burn-all`, `/v1/batch/revoke-all`, `/v1/cleanup/all`, plus `/preview` and `/summary` variants. One call assembles a full cleanup.

**Execution.** `/v1/transactions/send`, `/v1/transactions/send-batch`, `/v1/transactions/status`. Relay signed transactions with optional confirmation polling. The relay accepts only fully signed chain-4663 transactions and broadcasts them verbatim.

## Rate limits and errors

240 requests per minute standard, 60 per minute for heavy endpoints (scan, batch, cleanup, approvals). 429 responses carry a `Retry-After` header. Errors always use one shape: `{"error": {"code", "message", "requestId"}}`.

## Fees

No protocol fee at launch. Fees never touch burns. Sells support optional partner fees (`partnerFeeRecipient` + `partnerFeeBps`, 1 to 100 bips) paid from swap output to the integrator.

## For AI agents

Machine-readable surface: [`/openapi.json`](https://api.cindereth.com/openapi.json), [`/llms.txt`](https://api.cindereth.com/llms.txt), [`/llms.md`](https://api.cindereth.com/llms.md).

## Still planned

Public read access to the site's activity log (the data behind the leaderboard) remains planned and is not part of this API yet. This page will say so when it ships.

Questions, use cases, or security reports: <security@cindereth.com>.


---

# 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://docs.cindereth.com/api.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.
