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

# Deployment

Endpoints for deploying tokens and triggering indexing.

### POST `/api/tokens/deploy`

Deploy a new Clanker V5 token. V5 is the only launch protocol: a request without tax settings launches with a 1% buy and 1% sell tax. V4 launches are no longer available.

**Authentication:** Partner API Key (`x-api-key` header)

**Body Parameters**

| Parameter  | Type      | Required | Default                   | Description                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
| ---------- | --------- | -------- | ------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `protocol` | `"v5"`    | No       | v5                        | Launch protocol. Only v5 is accepted; protocol: v4 gives 400.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
| `tax`      | `object`  | No       | { buyFee: 1, sellFee: 1 } | { buyFee?, sellFee?, dividends?, burn?, minimumDividendHolding?, antiSnipeEnabled?, integrator?, metadataEditable? }. buyFee and sellFee (0-99, default 1) are the total trade tax in percent, including the protocol fee. Each must be in taxPolicy.taxFeeBounds of GET /api/metadata/factories. dividends and burn (0-100, default 0) are shares in percent of the tax after the protocol fee. minimumDividendHolding (default "10000") is the holder minimum for dividends, as a decimal string of whole tokens; the server adds 18 decimals. It applies only when dividends is above 0. It must not be below taxPolicy.minimumDividendHolding or above taxPolicy.launchSupply (both in base units). antiSnipeEnabled (default true) turns on the sniper tax in taxPolicy.antiSnipeConfiguration. integrator is { address, share? }: the integrator gets share percent (0-100, default 0) of the tax after the protocol fee and claims it from the FeeEscrow. Burn, dividends, and the integrator share together must not exceed 100. metadataEditable (default true) lets the creator change the image and metadata after launch, and verify the token. When taxPolicy.launchCreationEnabled is false, the deploy returns 400. |
| `token`    | `object`  | Yes      | —                         | Token config: { name, symbol, image, tokenAdmin, description?, socialMediaUrls?, auditUrls?, requestKey }.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
| `rewards`  | `array`   | No       | —                         | Reward splits: \[{ recipient, admin, allocation, rewardsToken? }]. Allocations must sum to 100. Rewards are paid in the pair currency (native coin for the wrapped native token), so rewardsToken must be Paired or unset. Defaults to tokenAdmin with 100.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
| `pool`     | `object`  | No       | —                         | { pairedToken? }: the wrapped native token (launches against the native coin), the chain stable, or another quote that the V5 factory registers. Defaults to the native coin, or the stable on a chain without a native quote. Other pool settings give 400.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
| `context`  | `object`  | No       | —                         | Social context. Only Bankr sets its own; other partners get their label and FID.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
| `chainId`  | `number`  | No       | 8453                      | Chain to deploy on: Base (8453), BNB Chain (56), Monad (143), Robinhood Chain (4663), X Layer (196) or Arc (5042), when V5 is open there, or Base Sepolia (84532) for tests.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
| `dryRun`   | `boolean` | No       | false                     | Build the launch without sending it. Returns nativeLaunchFee.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |

**Response:** Deployment result with expected token address.

```json
{
  "message": "Token deployment enqueued. Expected address: 0x...",
  "expectedAddress": "0x...",
  "success": true
}
```

> V4-only fields give 400 with a fields list: protocol v4, fees, vault, airdrop, poolExtension, devBuy, any pool field other than pairedToken, and rewardsToken Both or Clanker. Each API key can launch 20 tokens per UTC day and 1 per minute unless the Clanker team set other limits for it; over a limit the deploy returns 429 with Retry-After. A key with no launch in 60 days (and older than 60 days) gets 403 until the Clanker team turns it back on. Max duration: 120 s.

***

### POST `/api/tokens/deploy/v4`

> **Deprecated**: V4 launches are no longer available. Use POST /api/tokens/deploy (V5).

Removed. Returns 410 Gone. Use POST /api/tokens/deploy, which launches V5 tokens.

**Authentication:** Partner API Key (`x-api-key` header)

***

### POST `/api/tokens/index`

Triggers token indexing by transaction hash. Use after deploying a token outside the API.

**Authentication:** Partner API Key (`x-api-key` header)

**Body Parameters**

| Parameter | Type     | Required | Default | Description                              |
| --------- | -------- | -------- | ------- | ---------------------------------------- |
| `txHash`  | `string` | Yes      | —       | Hex-encoded deployment transaction hash. |
| `chainId` | `number` | Yes      | —       | Chain ID.                                |

**Response:** Indexing result.

```json
{
  "success": true,
  "address": "0x...",
  "url": "https://clanker.world/clanker/0x..."
}
```

> Rate limited to 10 requests per minute per IP.

***
