API Documentation
Automate your tasks by integrating with our powerful API.
api
Format
JSON POST
info Connection Details
HTTP Method
POST
API Url
Response Format
JSON
code
Code Example
Download our sample PHP implementation to get started quickly.
Download PHP Example downloadService list
Request Parameters
| Parameters | Description |
|---|---|
| key | Your API key |
| action | services |
Example Response
[
{
"service": 1,
"name": "Followers",
"type": "Default",
"category": "First Category",
"rate": "0.90",
"min": "50",
"max": "10000",
"desc" : "Some Description",
"refill": "1"
},
{
"service": 2,
"name": "Comments",
"type": "Custom Comments",
"category": "Second Category",
"rate": "8",
"min": "10",
"desc" : "Some Description",
"max": "1500",
"refill": "0"
}
]
Add order
Request Parameters
| Parameters | Description |
|---|---|
| key | Your API key |
| action | add |
| service | Service ID |
| link | Link |
| quantity | Quantity |
| runs (optional) | Runs to deliver |
| interval (optional) | Interval in minutes |
Example Response
{
"status": 200,
"order": 23501
}
Order status
Request Parameters
| Parameters | Description |
|---|---|
| key | Your API key |
| action | status |
| order | Order ID |
Example Response
{
"charge": "0.27819",
"start_count": "3572",
"status": "Partial",
"remains": "157",
"currency": "USD"
}
Multiple orders status
Request Parameters
| Parameters | Description |
|---|---|
| key | Your API key |
| action | status |
| orders | Order IDs separated by comma |
Example Response
{
"1": {
"charge": "0.27819",
"start_count": "3572",
"status": "Partial",
"remains": "157",
"currency": "USD"
},
"10": {
"error": "Incorrect order ID"
},
"100": {
"charge": "1.44219",
"start_count": "234",
"status": "In progress",
"remains": "10",
"currency": "USD"
}
}
Create refill
Request Parameters
| Parameters | Description |
|---|---|
| key | Your API key |
| action | refill |
| order | Order ID |
Example Response
{
"refill": 1,
"status": 200,
"message": "Refill has been placed successfully!"
}
Get refill status
Request Parameters
| Parameters | Description |
|---|---|
| key | Your API key |
| action | refill_status |
| refill | Refill ID |
Example Response
{
"status": "Completed"
}
Cancel order
Request Parameters
| Parameters | Description |
|---|---|
| key | Your API key |
| action | cancel |
| order | Order ID |
Example Response
{
"status": "success",
"message": "Cancellation request added, we'll try our best to cancel it."
}
User balance
Request Parameters
| Parameters | Description |
|---|---|
| key | Your API key |
| action | balance |
Example Response
{
"balance": "100.84292",
"currency": "USD"}