Last updated
Last updated
Headers:
Request Body Parameters:
Example Request:
POST https://www.clanker.world/api/tokens/deploy/split
x-api-key: your_api_key
Content-Type: application/json
name
string
The name of your token
symbol
string
Token symbol (usually 3-4 characters)
image
string
URL to the token's image
requestorAddress
string
Ethereum address where 40% of creator rewards will be sent
requestKey
string
Unique 32-character identifier for idempotency
requestorId
string
ID of requestor on any given platform
description
string
Description of token for creators to provide
socialMediaUrls
string[]
URLs for external pages related to the token
platform
string
Platform launch name for social context
castHash
string
Legacy version of messageId
messageId
string
ID of message on any given platform
vaultUnlockTimestamp
number
UNIX timestamp of the creator vault unlock. Must be at least 30 days from time of deployment
vaultPercentage
number
% of supply to place in the creator vault
creatorRewardsAdmin
string
Address with admin control over the creator rewards and creator vault. Defaults to requestorAddress
initialMarketCap
number
Starting market cap in ETH. Only works for WETH-paired tokens. Minimum value of 1 (1 ETH market cap) and defaults to 10 (10 ETH market cap). There is no maximum value.
groupAddresses
JSON
Object to designate creator rewards by address and percentage. Total must equal 100. Example:
[{"address": "0x1eaf444ebDf6495C57aD52A04C61521bBf564ace",
"allocation": 34
},
{
"address": "0x1eaf444ebDf6495C57aD52A04C61521bBf564ace",
"allocation": 66
}]
{
"name": "Test Token",
"symbol": "TEST",
"image": "https://example.com/image.png",
"requestorAddress": "0x1234567890123456789012345678901234567890",
"requestKey": "unique_request_identifier",
"requestorFid": "12345",
"creatorAdmin": "0x1234567890123456789012345678901234567890",
"tokenPair": "WETH",
"description": "A test token for demonstration",
"socialMediaUrls": ["https://twitter.com/test", "https://discord.gg/test"],
"platform": "test_platform",
"castHash": "0x1234567890123456789012345678901234567890",
"vaultUnlockTimestamp": 1735689600000, // Optional: Unix timestamp
"vaultPercentage": 30, // Optional: Must be between 0 and 30
"creatorRewardsPercentage": 40, // Optional: Defaults to 40
"groupAddresses": [
{
"address": "0x1eaf444ebDf6495C57aD52A04C61521bBf564ace",
"allocation": 34
},
{
"address": "0x742d35Cc6634C0532925a3b844Bc454e4438f44e",
"allocation": 66
}
],
"initialMarketCap": 10 // Optional: Defaults to 10
}
Deploy a new token with Clanker's standard configuration and custom split configurations (via Splits) for reward distribution.