Introduction - Clanker

Clanker is a token deployment protocol on Base, BNB Chain, Monad, Robinhood Chain, X Layer, Arc, Elysium and other EVM chains. These docs cover token deployments, rewards, the API, the SDK and the protocol’s contracts. You can launch a token from clanker.world, by tagging @clanker_world on X or @clanker on Farcaster, through the API or with the SDK. Each token launches with its own liquidity pool, and the fees or tax from trading flow back to the creator as rewards.

Clanker v5

Clanker v5 is the current version of Clanker, live on Base, BNB Chain, Monad, Robinhood Chain, X Layer, Arc and Elysium. A v5 token charges a buy and sell tax on every trade instead of an LP fee. The tax pays the creator’s rewards and can also fund holder dividends, a burn and an integrator share. You can launch a v5 token on clanker.world, through the API or with the SDK. See clanker.world Deployments, API Deployments and the SDK v5 reference. The v5 contracts page covers the contracts, launch policy and permissions.

Tokens

Start with Token Deployments. It explains how a v5 token works and where you can deploy one:

Earlier versions are covered in v4 Deployments and v3 Deployments. After launch:

Creator Rewards & Fees: how fees or tax are split and how you claim rewards.
Unclaimed Rewards Balance: how to check what you can claim.
Holder Dividends: how v5 holders earn and claim dividends.
Token Burns: how a v5 token burns part of its tax.
Managing a Token: metadata, reward recipients and admins after launch.

API Reference

The Clanker REST API is available at https://www.clanker.world/api.

Auth method	Header	Description
Public	None	No authentication required
Partner API key	`x-api-key: <key>`	Issued per partner by the Clanker team
User auth	`Authorization: Bearer <token>`	Farcaster or Privy authentication

Public API: token search, trending, users, presales, airdrops and market data.
Authenticated API: partner endpoints for tokens, deployment and fees.
User API: saved tokens and image upload.

SDK Reference

The clanker-sdk is a TypeScript library for launching and managing Clanker tokens on-chain. It launches v5 tokens, and its v3 and v4 clients manage existing tokens. To launch without code, use clanker.world or the API (see API Deployments).

npm install clanker-sdk viem

V5: launch v5 tokens, claim rewards and update metadata.
Core Utilities: types, constants, vanity addresses and Merkle tree helpers.
V4 Clanker Class: manage existing v4 tokens, claim rewards and update metadata.
V3 Clanker Class: manage existing v3 tokens.
V4 Extensions: airdrops, existing presales and allowlist management.
Legacy Fee Claims: fee claims for v0 to v3.1 tokens.

References

Core Contracts: contract reference for v5, v4 and v3.1.
Deployed Contracts: contract addresses for every version and chain.
Supported Quote Tokens: the tokens a Clanker token can be paired with.
Audits, Brand Assets, Compatible Trading Platforms and Contact.

Safety

Warning Tags: what the warning tags on clanker.world token pages mean.
Verifying Social Context: how to check who launched a token.

Resources

Educational Resources: pair-token guidance, videos and the LP position simulator.
FAQ: answers to common questions.

Contributing

The API and SDK sections are generated from source code:

API docs come from clanker.world/docs/api-registry.ts. Update the registry to change the API documentation.
SDK docs are generated with TypeDoc from JSDoc comments in clanker-sdk/src/. Update the JSDoc in source to change the SDK documentation.

Both repos have GitHub Actions that regenerate the docs and push them here on every merge to main.

​Clanker v5

​Tokens

​API Reference

​SDK Reference

​References

​Safety

​Resources

​Contributing