Introduction
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.
Droids
A Droid is an AI agent that ships with your token — own Farcaster account, personality you design, compute funded by the token itself via a carve-out of its LP rewards.
Droids Overview — What a Droid is and the two ways to create one
Droid Funding & Runway — How a droid pays for its own compute
Create a Droid — Launch a droid with a token (or standalone)
Manage your Droid — The Droid panel and chat flow
Writing a Droid Voice — Designing a personality worth tagging
API Reference
The Clanker REST API is available at https://www.clanker.world/api.
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
SDK Reference
The clanker-sdk is a TypeScript library for deploying and managing Clanker tokens on-chain.
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
Contributing
Documentation is auto-generated from source code:
API docs are generated from
clanker.world/docs/api-registry.ts— update the registry to change API documentationSDK 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.
Last updated