Overview
The AdMove Provider API allows authorized external platforms to retrieve available services, submit orders, check order statuses and retrieve their account balance.
| Property | Value |
|---|---|
| API Version | v2 |
| Protocol | HTTPS |
| HTTP Method | POST |
| Response Format | JSON |
| Authentication | API Key |
Authentication
Every request requires the API key assigned to your integration.
| Parameter | Required | Description |
|---|---|---|
| key | Yes | Your assigned AdMove API key. |
| action | Yes | The API operation to perform. |
Keep your API key private. Each integration should use its own dedicated key.
POSTServices
Returns the currently available services for your integration.
key=YOUR_API_KEY action=services
Example response
[
{
"service": 1,
"name": "Example Service",
"type": "Default",
"category": "Example Category",
"rate": "0.05",
"min": "1",
"max": "10000000",
"refill": false,
"cancel": false
}
]
POSTAdd Order
| Parameter | Required | Description |
|---|---|---|
| key | Yes | API key |
| action | Yes | add |
| service | Yes | Service ID |
| link | Yes | Target URL |
| quantity | Yes | Requested quantity |
key=YOUR_API_KEY action=add service=1 link=https://example.com/ quantity=1000
Example response
{
"order": 123
}
POSTOrder Status
key=YOUR_API_KEY action=status order=123
Example response
{
"charge": "50.0000",
"start_count": "0",
"status": "Processing",
"remains": "1000",
"currency": "INR"
}
Possible status values
Pending Processing In progress Completed Partial Canceled
POSTMultiple Order Status
Check multiple AdMove order IDs in a single request.
key=YOUR_API_KEY action=status orders=123,124,125
POSTBalance
key=YOUR_API_KEY action=balance
Example response
{
"balance": "10000.0000",
"currency": "INR"
}
Error Responses
API errors are returned as JSON. Authentication failures may also return an appropriate HTTP status code.
{
"error": "API key is required"
}
Refill & Cancel
When these operations are unavailable, applicable services advertise refill: false and cancel: false.