API Documentation
Integrate ETH Volume Bot into your platform with our powerful RESTful API. Automate volume generation, manage campaigns, and access real-time analytics programmatically.
Getting Started
Base URL
https://api.ethvolumebot.com/v1
Authentication
All API requests require authentication using an API key. Include your API key in the request header:
Authorization: Bearer YOUR_API_KEY
Rate Limits
API requests are limited to 100 requests per minute per API key. Rate limit information is included in response headers.
API Endpoints
POST
/campaigns
Create a new volume boosting campaign
Request Body
{
"tokenAddress": "0x...",
"volumeTarget": 100.5,
"walletMakers": 500,
"duration": 60,
"features": {
"smartWalletDistribution": true,
"antiWhaleProtection": true,
"liquidityOptimization": true
}
}Response
{
"campaignId": "camp_abc123",
"status": "pending",
"estimatedCost": "0.5234 ETH",
"createdAt": "2024-01-15T10:30:00Z"
}GET
/campaigns/:id
Get campaign details and status
Response
{
"campaignId": "camp_abc123",
"status": "running",
"progress": {
"volumeGenerated": 45.2,
"volumeTarget": 100.5,
"walletsCreated": 250,
"transactionsExecuted": 1250,
"percentComplete": 45
},
"startedAt": "2024-01-15T10:35:00Z",
"estimatedCompletion": "2024-01-15T11:35:00Z"
}GET
/campaigns
List all campaigns for your account
Query Parameters
?status=running&limit=10&offset=0
Response
{
"campaigns": [...],
"total": 25,
"limit": 10,
"offset": 0
}DELETE
/campaigns/:id
Cancel a running campaign
Response
{
"campaignId": "camp_abc123",
"status": "cancelled",
"volumeGenerated": 45.2,
"refundAmount": "0.2617 ETH"
}GET
/analytics/:campaignId
Get detailed analytics for a campaign
Response
{
"volumeByHour": [...],
"transactionSizes": [...],
"walletDistribution": [...],
"priceImpact": 0.023,
"averageGasPrice": "0.00002 ETH"
}Webhooks
Configure webhooks to receive real-time notifications about campaign events. Webhook payloads are sent as POST requests to your specified URL.
Available Events
- campaign.started - Campaign has started executing
- campaign.completed - Campaign finished successfully
- campaign.failed - Campaign encountered an error
- campaign.progress - Progress update (every 10%)
Webhook Payload Example
{
"event": "campaign.completed",
"campaignId": "camp_abc123",
"timestamp": "2024-01-15T11:35:00Z",
"data": {
"volumeGenerated": 100.5,
"transactionsExecuted": 2500,
"walletsCreated": 500
}
}Code Examples
JavaScript / Node.js
const response = await fetch('https://api.ethvolumebot.com/v1/campaigns', {
method: 'POST',
headers: {
'Authorization': 'Bearer YOUR_API_KEY',
'Content-Type': 'application/json'
},
body: JSON.stringify({
tokenAddress: '0x...',
volumeTarget: 100.5,
walletMakers: 500,
duration: 60
})
});
const campaign = await response.json();
console.log('Campaign created:', campaign.campaignId);Python
import requests
response = requests.post(
'https://api.ethvolumebot.com/v1/campaigns',
headers={
'Authorization': 'Bearer YOUR_API_KEY',
'Content-Type': 'application/json'
},
json={
'tokenAddress': '0x...',
'volumeTarget': 100.5,
'walletMakers': 500,
'duration': 60
}
)
campaign = response.json()
print(f"Campaign created: {campaign['campaignId']}")cURL
curl -X POST https://api.ethvolumebot.com/v1/campaigns \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"tokenAddress": "0x...",
"volumeTarget": 100.5,
"walletMakers": 500,
"duration": 60
}'Ready to Integrate?
Start building with ETH Volume Bot API today. Contact us for API access and developer support.