Build on the CPIDroid Network.
Use the REST API to retrieve live offers, serve offerwalls, and manage campaigns. Every request uses your API key and returns JSON.
Base URLhttps://api.cpidroid.com
Advertiser API
Advertiser endpoints use an API key for authentication. Use the method shown for each action.
| Method | Endpoint | Purpose | Parameters | Postman | Docs |
|---|---|---|---|---|---|
| POST |
/campaign/add
|
Adds a new campaign | name, platform, type, bid, budget, packageName, appName, targetCountries, device, os, status, start, stop, daily_cap, eventDescription |
Postman Collection | View Docs |
| GET |
/campaign/list
|
Retrieves a list of campaigns | status, limit |
Postman Collection | View Docs |
| GET |
/campaign/get
|
Retrieves details of a specific campaign | id |
Postman Collection | View Docs |
| POST |
/campaign/start
|
Starts a specific campaign | id |
Postman Collection | View Docs |
| POST |
/campaign/pause
|
Pauses a specific campaign | id |
Postman Collection | View Docs |
| POST |
/campaign/edit
|
Edits a specific campaign | id, name, budget, bid, status, targetCountries, start, stop, eventDescription |
Postman Collection | View Docs |
List campaigns
curl -G 'https://api.cpidroid.com/campaign/list' \
+ --data-urlencode 'apikey=YOUR_API_KEY' \
+ --data-urlencode 'status=running' \
+ --data-urlencode 'limit=25'Get campaign
curl -G 'https://api.cpidroid.com/campaign/get' \
+ --data-urlencode 'apikey=YOUR_API_KEY' \
+ --data-urlencode 'campaign_id=12345'Add campaign
curl -X POST 'https://api.cpidroid.com/campaign/add' \
+ --data-urlencode 'apikey=YOUR_API_KEY' \
+ --data-urlencode 'platform=android' \
+ --data-urlencode 'app_url=https://play.google.com/store/apps/details?id=com.example.app' \
+ --data-urlencode 'type=cpi' \
+ --data-urlencode 'budget=100' \
+ --data-urlencode 'bid=0.50' \
+ --data-urlencode 'tracker=appsflyer' \
+ --data-urlencode 'redirect_url=https://example.com/install' \
+ --data-urlencode 'country=US' \
+ --data-urlencode 'event_name=install' \
+ --data-urlencode 'event_conversion_time=86400' \
+ --data-urlencode 'event_description=First app install' \
+ --data-urlencode 'confirm=1'Edit campaign
curl -X POST 'https://api.cpidroid.com/campaign/edit' \
+ --data-urlencode 'apikey=YOUR_API_KEY' \
+ --data-urlencode 'action=budget.add' \
+ --data-urlencode 'campaign_id=12345' \
+ --data-urlencode 'budget=50'Start campaign
curl -X POST 'https://api.cpidroid.com/campaign/start' \
+ --data-urlencode 'apikey=YOUR_API_KEY' \
+ --data-urlencode 'campaign_id=12345'Pause campaign
curl -X POST 'https://api.cpidroid.com/campaign/pause' \
+ --data-urlencode 'apikey=YOUR_API_KEY' \
+ --data-urlencode 'campaign_id=12345'Publisher API
Retrieve offers for an active API or offerwall placement. Send credentials as query parameters with a GET request.
| Method | Endpoint | Purpose | Parameters | Docs |
|---|---|---|---|---|
| GET | /offer/get | Get an offer | apikey, placement_id, country, os, gaid, idfa | View docs |
| GET | /offerwall/get | Get an offerwall | apikey, placement_id, uid, country, os, gaid, idfa | View docs |
API placement request
curl -G 'https://api.cpidroid.com/offer/get' \
+ --data-urlencode 'apikey=YOUR_API_KEY' \
+ --data-urlencode 'placement_id=YOUR_API_PLACEMENT_ID' \
+ --data-urlencode 'country=US' \
+ --data-urlencode 'os=android'Offerwall request
curl -G 'https://api.cpidroid.com/offerwall/get' \
+ --data-urlencode 'apikey=YOUR_API_KEY' \
+ --data-urlencode 'placement_id=YOUR_OFFERWALL_PLACEMENT_ID' \
+ --data-urlencode 'uid=user-123' \
+ --data-urlencode 'country=US' \
+ --data-urlencode 'os=android'Authentication and responses
Keep your API key private. Create an API token in your dashboard and send it as the
apikey query parameter. Do not commit keys to source control or expose them in client-side applications.Response shape
Successful requests return status: "success", a count where applicable, and a data payload. Validation and authorization failures return status: "error" with a human-readable message.