Standard Deployment

Deploy a new token with Clanker's standard configuration.

The main Clanker Standard Deployment endpoint has been upgraded to v0.3.1 on March 18, 2025. There are not any immediate breaking changes. Please refer see below for updated parameters and an example payload.

v0.3.1 (Current Release)

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

Headers:

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

Request Body Parameters:

Parameter	Type	Requirement	Description
name	string	Required	The name of your token
symbol	string	Required	Token symbol (usually 3-5 characters)
image	string	Required	URL to the token's image
requestorAddress	string	Required	Ethereum address where creator rewards will be sent
requestKey	string	Required	Generate a 32-character identifier for idempotency
creatorRewardsPercentage	number	Optional	Sets % of fees to the requestorAddress from 0 to 80, defaults to 40. Interfaces receive 80 minus the creatorRewardsPercentage
requestorFid	number	Optional	Legacy version of requestorId
requestorId	number	Optional	ID of requestor on any given platform
tokenPair	string	Optional	Symbol of token from Supported Quote Tokens. Defaults to WETH
description	string	Optional	Description of token for creators to provide
socialMediaUrls	string[]	Optional	URLs for external pages related to the token
platform	string	Optional	Platform launch name for social context
castHash	string	Optional	Legacy version of messageId
messageId	string	Optional	ID of message on any given platform
vaultUnlockTimestamp	number	Optional	UNIX timestamp of the creator vault unlock. Must be at least 30 days from time of deployment
vaultPercentage	number	Optional	% of supply to place in the creator vault
creatorRewardsAdmin	string	Optional	Address with admin control over the creator rewards and creator vault. Defaults to requestorAddress

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 '{
  "name": "My Token",
  "symbol": "MTK",
  "image": "https://example.com/token-image.png",
  "requestorAddress": "0x1234567890abcdef1234567890abcdef12345678",
  "requestKey": "unique_request_identifier",
  "creatorRewardsPercentage": 40,
  "requestorFid": 12345,
  "tokenPair": "WETH",
  "description": "This is my awesome token",
  "socialMediaUrls": [
    "https://x.com/mytoken",
    "https://discord.gg/mytoken"
  ],
  "platform": "myPlatform",
  "messageId": "0xabcdef1234567890",
  "vaultUnlockTimestamp": 1735689600,
  "vaultPercentage": 25,
  "creatorRewardsAdmin": "0x1234567890abcdef1234567890abcdef12345678"
}'

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

Creator / Interface Rewards

• creatorRewardsPercentage % of rewards will be directed to the requestorAddress

  • This can range from 0 to 80

• At this time, interfaces will receive 80 minus creatorRewardsPercentage % of rewards

Creator Vaults

• The CreatorVault contract has a minimum lock time of exactly 30 days. If you are including creator vault features on your interface, we suggest offering 31 days as the minimum vault time to avoid running into deployment issues.

Creator Buys

• Creator buys are not supported via API deployments at this time

v0.3.0 (Deprecated)

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

Headers:

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

Request Body Parameters:

Parameter	Type	Description
name	string	The name of your token
symbol	string	Token symbol (usually 3-5 characters)
image	string	URL to the token's image
requestorAddress	string	Ethereum address where creator rewards will be sent
requestKey	string	Generate a 32-character identifier for idempotency

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 '{
  "name": "My Token",
  "symbol": "MTK",
  "image": "https://example.com/token-image.png",
  "requestorAddress": "0x1234567890abcdef1234567890abcdef12345678",
  "requestKey": "unique_request_identifier"
}'

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

Creator Rewards

• 40% of creator rewards will accrue to the requestorAddress

• Ensure the provided address is correct and accessible