Clanker is a token deployment protocol on Base, Arbitrum, and other EVM chains. This repository is the source for the Clanker Gitbook documentation and is auto-generated from the SDK and API.
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, market data
- Authenticated API — Partner endpoints for tokens, deployment, fees
- User API — Preclank management, UI token saves
The clanker-sdk is a TypeScript library for deploying and managing Clanker tokens on-chain.
npm install clanker-sdk- Core Utilities — Types, constants, vanity address, merkle tree helpers
- V4 Clanker Class — Deploy, claim rewards, update metadata (current version)
- V3 Clanker Class — V3 token deployment and management
- V4 Extensions — Airdrops, presales, allowlist management
- Legacy Fee Claims — Fee claims for V0–V3.1 tokens
Documentation is auto-generated from source code:
- API docs are generated from
clanker.world/docs/api-registry.ts— update the registry to change API documentation - SDK docs are generated via TypeDoc from JSDoc comments in
clanker-sdk/src/— update JSDoc in source to change SDK documentation
Both repos have GitHub Actions that regenerate and push docs here on every merge to main.