v4.0.0 - Standard Deployment

Deploy a new token on Clanker v4

Endpoint

POST https://www.clanker.world/api/tokens/deploy

Headers

x-api-key: your_api_key
Content-Type: application/json

Request Body Parameters

Parameter	Type	Required	Description
token.name	string	Required	The name of your token
token.symbol	string	Required	Token symbol (usually 3-5 characters)
token.image	string	Optional	URL to the token's image
token.tokenAdmin	0x${string}	Required	Token admin address with control over vaulted tokens and updating token metadata
token.description	string	Optional	Description of token for creators to provide
token.socialMediaUrls	array	Optional	URLs for external pages related to the token
token.auditUrls	array	Optional	Links to any audits, reports, etc.
token.requestKey	string	Required	32 character unique request identifier
rewards	array	Required	Array of reward configuration objects (at least one required)
rewards.admin	0x${string}	Required	Address that can change the paired recipient
rewards.recipient	0x${string}	Required	Address that will receive the rewards once claimed
rewards.allocation	number	Required	Percentage of rewards (total across all recipients should sum to 100)
pool.type	strings	Optional	Either "standard" or "project"
pool.pairedToken	0x${string}	Optional	Token address to pair the new token with (typically WETH). Only for standard pool.type
pool.initialMarketCap	number	Optional	Starting market cap denominated in pairedToken. Only for standard pool.type
fees.type	string	Optional	Fee type: either "static" or "dynamic"
fees.clankerFee	number	Optional	Fee percentage on Clanker token inputs, max 5 (5%). Only for static fees.type
fees.pairedFee	number	Optional	Fee percentage on pairedToken inputs, max 5 (5%). Only for static fees.type
fees.baseFee	number	Optional	Base fee charged on every swap, minimum 0.25 (0.25%). Only for dynamic fees.type
fees.maxLpFee	number	Optional	Maximum LP fee including base + variable fee, maximum 5 (5%). Only for dynamic fees.type
vault.percentage	number	Optional	Percentage of tokens to vault (max 90% total across all extensions)
vault.lockupDuration	number	Conditional	Lockup duration in seconds, minimum 604800 (7 days). Required if vault.percentage is provided
vault.vestingDuration	number	Conditional	Vesting duration in seconds, can be 0 for instant vesting. Required if vault.percentage is provided

Example Request:

curl -X POST 'https://www.clanker.world/api/tokens/deploy' \
-H 'Content-Type: application/json' \
-H 'x-api-key: your_api_key' \
-d '{
  "token": {
    "name": "My Token",
    "symbol": "MTK",
    "image": "https://example.com/token-image.png",
    "tokenAdmin": "0x1234567890abcdef1234567890abcdef12345678",
    "description": "This is my awesome token",
    "socialMediaUrls": [
      "https://x.com/mytoken",
      "https://discord.gg/mytoken"
    ],
    "auditUrls": [
      "https://audit.com/mytoken"
    ],
    "requestKey": "unique_request_identifier_32chars"
  },
  "rewards": [
    {
      "admin": "0x1234567890abcdef1234567890abcdef12345678",
      "recipient": "0x1234567890abcdef1234567890abcdef12345678",
      "allocation": 70
    },
    {
      "admin": "0xabcdefabcdefabcdefabcdefabcdefabcdefabcd",
      "recipient": "0xabcdefabcdefabcdefabcdefabcdefabcdefabcd",
      "allocation": 30
    }
  ],
  "pool": {
    "type": "standard",
    "pairedToken": "0x4200000000000000000000000000000000000006",
    "initialMarketCap": 10
  },
  "fees": {
    "type": "static",
    "clankerFee": 1,
    "pairedFee": 1
  },
  "vault": {
    "percentage": 10,
    "lockupDuration": 604800,
    "vestingDuration": 0
  }
}'

Notes

Request Key Generation

• Generate a unique 32-character string for each request

• This is used as an idempotency key to prevent duplicate token deployments

Rewards Configuration

• At least one reward configuration is required

• Up to 7 total reward recipients are allowed

• Total allocation across all recipients must sum to 100 (100%)

• Admin addresses can change the recipient address but allocation percentages are immutable

With the v4.0.0 deployment endpoint, token creation interfaces must include their own reward configuration if they wish to receive any rewards for v4.0.0 tokens.

Pool Configuration (optional)

• Choose a paired token from the list of Supported Quote Tokens along with the starting market cap of the token, denominated in the paired token

• Defaults

  • "Standard" pool configuration with single LP position

  • Quote token is set to WETH (0x4200000000000000000000000000000000000006) if no pairedToken is provided

  • Starting market cap is set to the Approximate Starting Market Cap column in the Supported Quote Tokens table if no initialMarketCap is provided

Fee Configuration (optional)

• Choose either static or dynamic fee type, not both

  • Static fees apply fixed percentages to specific token inputs (no min, 5% max)

  • Dynamic fees include a base fee plus variable fees based on volatility and are applied to equally to both token inputs (0.25% min, 5% max)

• Defaults

  • Fee configuration defaults to a 1% static fee on both token inputs if not provided

  • If static is selected, the static fee configuration defaults to a 1% static fee on both token inputs if not specified

  • If dynamic is selected, the dynamic fee configuration defaults to a 0.5% base fee and 5% max LP fee if not specified

Vault Extension (optional)

• Optional feature for locking tokens with configurable lockup and vesting periods

• Maximum 90% of total supply can be allocated across all extensions

• Minimum lockupDuration is 7 days (604,800 seconds), no minimum vesting duration

  • Setting vestingDuration to 0 allows all vaulted tokens to be claimed once lockupDuration ends