API Documentation

Everything you need to integrate Earn Protocol into your project.

Quick Start

Register your token with a single API call. Here's how:

bash
curl -X POST https://api.earnprotocol.io/earn/register \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"mint": "YOUR_TOKEN_MINT_ADDRESS",
"template": "creator",
"creatorWallet": "YOUR_WALLET_ADDRESS"
}'

Authentication

All API requests require an API key. Include it in the Authorization header:

bash
Authorization: Bearer YOUR_API_KEY

Get your API key by registering at earnprotocol.io/register

Register Token

POST/earn/register

Register a new token with Earn Protocol

Parameters

mint
string
required
Token mint address
template
string
required
degen | creator | community | lowfee | custom
creatorWallet
string
required
Wallet to receive creator fees
customSplits
object
Custom fee splits (if template is 'custom')

Request

json
{
"mint": "WojakZ9f1HJmG8vNj7CL4EyxTWDeMqJMdBZR5xV2Dpump",
"template": "creator",
"creatorWallet": "7xKL...9mVz"
}

Response

json
{
"success": true,
"token": {
"mint": "WojakZ9f1HJmG8vNj7CL4EyxTWDeMqJMdBZR5xV2Dpump",
"template": "creator",
"feePercent": 1.5,
"splits": {
"earn": 10,
"creator": 30,
"buyback": 30,
"stakers": 30
},
"registeredAt": "2026-02-03T00:00:00Z"
}
}

Get Token

GET/earn/token/{mint}

Get token configuration and metadata

Parameters

mint
string
required
Token mint address

Response

json
{
"mint": "WojakZ9f1HJmG8vNj7CL4EyxTWDeMqJMdBZR5xV2Dpump",
"name": "Wojak",
"symbol": "$WOJAK",
"template": "degen",
"feePercent": 2.0,
"splits": {
"earn": 10,
"creator": 25,
"buyback": 30,
"stakers": 35
},
"creatorWallet": "7xKL...9mVz",
"registeredAt": "2026-01-15T00:00:00Z"
}

Get Stats

GET/earn/stats/{mint}

Get token statistics and metrics

Parameters

mint
string
required
Token mint address

Response

json
{
"mint": "WojakZ9f1HJmG8vNj7CL4EyxTWDeMqJMdBZR5xV2Dpump",
"totalVolume": 15420690,
"totalFees": 308413,
"totalBuybacks": 92523,
"totalStaked": 4250000,
"price": 0.00042069,
"priceChange24h": 15.3,
"volume24h": 523000,
"fees24h": 10460,
"stakerApy": 127.5
}

Staking

POST/earn/stake

Stake tokens to earn rewards

Parameters

mint
string
required
Token mint address
amount
number
required
Amount to stake
wallet
string
required
Staker wallet address
POST/earn/unstake

Unstake tokens

Parameters

mint
string
required
Token mint address
amount
number
required
Amount to unstake
wallet
string
required
Staker wallet address
POST/earn/claim

Claim pending staking rewards

Parameters

mint
string
required
Token mint address
wallet
string
required
Staker wallet address

Templates

Pre-configured fee structures for different use cases:

TemplateFeeCreatorBuybackStakers
degen2.0%25%30%35%
creator1.5%30%30%30%
community1.0%15%35%40%
lowfee0.5%20%35%35%

Error Codes

CodeDescription
400Bad request - Invalid parameters
401Unauthorized - Invalid API key
404Not found - Token not registered
409Conflict - Token already registered
500Server error - Try again later