Android Installs

API Documentation

Would you like to run your own business using our services? Here is the API documentation for you! With our API support, you can list or create CPI, Keyword or High Retention campaigns easily.

Check your API key on your profile.

Apps

Apps - ADD

Adds new application

get 
http://api.androidinstalls.com/apps

Parameter

Field Type Description
apikey String

Unique API key.
add String

URL of your application
country String

2 digit country code

The add parameter's value can be two form of value. Either the App Store/Google Play URL or more preferably only the bundle ID com.facebook.katana or 284882215. For example: https://api.androidinstalls.com/apps?apikey=[YOUR_API_KEY]&add=284882215&country=ca

Success 200

Field Type Description
success String

The App has been created or it's informations refreshed.
id Number

ID of the app

Success-Response:

{
   "success": "The App has been successfully created.",
   "id": 185212
}

Error 4xx

Field Type Description
error Array[]

Error parameters.
  code Number

HTTP error code for the current error.
  message String

Description of error.

Apps - LIST

Retrieves all applications

get 
http://api.androidinstalls.com/apps

Parameter

Field Type Description
apikey String

Unique API key.

Success 200

Field Type Description
id Number

ID of the app
title String

The title of the app
type Number

0 = Android, 1 = iOS
country String

2 digit country code

Success-Response:

[
   {
      "id": 185212,
      "title": "Facebook",	  
      "type": 1,
      "country": "fr"  
   }
]

Error 4xx

Field Type Description
error Array[]

Error parameters.
  code Number

HTTP error code for the current error.
  message String

Description of error.

Regular Campaigns

Regular Campaigns - ADD

Adds new Android or iOS regular campaign

post 
http://api.androidinstalls.com/addcampaign

Parameter

Field Type Description
apikey String

Unique API key.
appid Number

APPID (you will got this ID when you added the app)
volume Number

Install volume. Cannot be smaller than 50 (Android) or 10 (iOS).
countries optional for Android Array[]

A country or multiple countries. Add full country names or country codes. WW or Worldwide by default for Android. You must target country for iOS promotion. In case you are adding full text names, make sure they have exact match in our reference list. More details COUNTRIES/LIST

dil optional Number

Daily Installs limit. Cannot be smaller than 50 (Android) or 10 (iOS).
keywords optional String

Prefered keyword or keywords. Separate multiple keywords by comma.

Success 200

Field Type Description
success String

Campaign has been created.
id Number or Array

ID of the campaign or several IDs

Success-Response:

{
   "success": "Campaign has been successfully created.",
   "id": 185212
}

Error 4xx

Field Type Description
error Array[]

Error parameters.
  code Number

HTTP error code for the current error.
  message String

Description of error.

Regular Campaigns - GET

Retrieves a single campaign's data

get 
http://api.androidinstalls.com/campaigns

Parameter

Field Type Description
apikey String

Unique API key.
id Number

ID of campaign

Success 200

Field Type Description
id Number

ID of the campaign
country String

Country
installs Number

Number of Installs
status String

Status of the campaign
country_list Array[]

List of countries and their install numbers.
  Country as key Number

Country as key and the install number is the value.

Success-Response:

[
   {
      "id": 12,
      "country": "WORLDWIDE",
      "installs": 22,
      "status": "COMPLETED",
      "country_list": {
         "Russia": 20,
         "India": 12
      }
   }
]

Error 4xx

Field Type Description
error Array[]

Error parameters.
  code Number

HTTP error code for the current error.
  message String

Description of error.

Regular Campaigns - LIST

Retrieves all campaigns

get 
http://api.androidinstalls.com/campaigns

Parameter

Field Type Description
apikey String

Unique API key.

Success 200

Field Type Description
id Number

ID of the campaign
country String

Country
installs Number

Number of Installs
status String

Status of the campaign
country_list Array[]

List of countries and their install numbers.
  Country as key Number

Country as key and the install number is the value.

Success-Response:

[
   {
      "id": 12,
      "country": "WORLDWIDE",
      "installs": 22,
      "status": "COMPLETED",
      "country_list": {
         "Russia": 20,
         "India": 12
      }
   }
]

Error 4xx

Field Type Description
error Array[]

Error parameters.
  code Number

HTTP error code for the current error.
  message String

Description of error.

Regular Campaigns - CANCEL

Cancel campaign

get 
http://api.androidinstalls.com/cancelcampaign

Parameter

Field Type Description
apikey String

Unique API key.
id Number

Campaign ID.

Example: https://api.androidinstalls.com/cancelcampaign?apikey=[YOUR_API_KEY]&id=569357

Success 200

Field Type Description
success String

Campaign is pending. Cancelling a campaign takes time, it can take between few minutes and several hours until the campaign fully terminated. You will be notified by email (if the notification is turned on).
id Number

ID of the campaign

Success-Response:

{
   "success": "Campaign is pending! Will be cancelled soon.",
   "id": 569357
}

Error 4xx

Field Type Description
error Array[]

Error parameters.
  code Number

HTTP error code for the current error.
  message String

Description of error.

High Retention Campaigns (Android)

High Retention Campaigns - ADD

Adds new high retention campaign. This service is only for Android.

post 
http://api.androidinstalls.com/addhrcampaign

Parameter

Field Type Description
apikey String

Unique API key.
appid Number

APPID (you will got this ID when you added the app)
volume Number

Install volume. Cannot be smaller than 50.
countries optional Array[]

A country or multiple countries. Add full country names or country codes. WW or Worldwide by default. In case you are adding full text names, make sure they have exact match in our reference list. More details COUNTRIES/LIST

dil optional Number

Daily Installs limit. Cannot be smaller than 50.
keywords optional String

Prefered keyword or keywords. Separate multiple keywords by comma.
rdaysoptional Number

Retention days. 1 by default. When the retention time has ended we will mark your campaign as 'completed' and you will get a partial refund.

Success 200

Field Type Description
success String

Campaign has been created.
id Number or Array

ID of the campaign or several IDs

Success-Response:

{
   "success": "High Retention Campaign has been successfully created.",
   "id": 12
}

Error 4xx

Field Type Description
error Array[]

Error parameters.
  code Number

HTTP error code for the current error.
  message String

Description of error.

High Retention Campaigns - GET

Retrieves a single high retention campaign's data

get 
http://api.androidinstalls.com/hrcampaigns

Parameter

Field Type Description
apikey String

Unique API key.
id Number

ID of campaign

Success 200

Field Type Description
id Number

ID of the campaign
country String

Country
installs Number

Number of Installs
retention_done Number

Number of retention installs completed
status String

Status of the campaign
country_list Array[]

List of countries and their install numbers.
  Country as key Number

Country as key and the install number is the value.

Success-Response:

[
   {
      "id": 12,
      "country": "WORLDWIDE",
      "installs": 22,
      "retention_done": 10,
      "status": "COMPLETED",
      "country_list": {
         "Russia": 20,
         "India": 12
      }
   }
]

Error 4xx

Field Type Description
error Array[]

Error parameters.
  code Number

HTTP error code for the current error.
  message String

Description of error.

High Retention Campaigns - LIST

Retrieves all high retention campaigns

get 
http://api.androidinstalls.com/hrcampaigns

Parameter

Field Type Description
apikey String

Unique API key.

Success 200

Field Type Description
id Number

ID of the campaign
country String

Country
installs Number

Number of Installs
retention_done Number

Number of retention installs completed
status String

Status of the campaign
country_list Array[]

List of countries and their install numbers.
  Country as key Number

Country as key and the install number is the value.

Success-Response:

[
   {
      "id": 12,
      "country": "WORLDWIDE",
      "installs": 22,
      "retention_done": 10,
      "status": "COMPLETED",
      "country_list": {
         "Russia": 20,
         "India": 12
      }
   }
]

Error 4xx

Field Type Description
error Array[]

Error parameters.
  code Number

HTTP error code for the current error.
  message String

Description of error.

High Retention Campaigns - CANCEL

Cancel campaign

get 
http://api.androidinstalls.com/cancelcampaign

Parameter

Field Type Description
apikey String

Unique API key.
id Number

Campaign ID.
type String

The type parameter's value must be premium to cancel high retention campaigns.

Example: https://api.androidinstalls.com/cancelcampaign?apikey=[YOUR_API_KEY]&id=10569357&type=premium

Success 200

Field Type Description
success String

Campaign is pending. Cancelling a campaign takes time, it can take between few minutes and several hours until the campaign fully terminated. You will be notified by email (if the notification is turned on).
id Number

ID of the campaign

Success-Response:

{
   "success": "Campaign is pending! Will be cancelled soon.",
   "id": 10569357
}

Error 4xx

Field Type Description
error Array[]

Error parameters.
  code Number

HTTP error code for the current error.
  message String

Description of error.

Rating Campaigns (iOS)

Rating Campaigns - ADD

Adds new rating campaign. This service is only for iOS.

post 
http://api.androidinstalls.com/addratingcampaign

Parameter

Field Type Description
apikey String

Unique API key.
appid Number

APPID (you will got this ID when you added the app)
volume Number

Install volume. Cannot be smaller than 5.
stars Number

Rating between 3 and 5 stars.
country Array[]

Only 1 country allowed for rating campaign. Add full country name or country code. Worldwide targeting is not allowed. In case you are adding full text name, make sure that have exact match in our reference list. More details COUNTRIES/LIST

dil optional Number

Daily rating limit. Cannot be smaller than 5.

Success 200

Field Type Description
success String

Campaign has been created.
id Number

ID of the campaign

Success-Response:

{
   "success": "Rating campaign has been successfully created.",
   "id": 12
}

Error 4xx

Field Type Description
error Array[]

Error parameters.
  code Number

HTTP error code for the current error.
  message String

Description of error.

Rating Campaigns (iOS) - GET

Retrieves a single rating campaign's data

get 
http://api.androidinstalls.com/campaigns

Parameter

Field Type Description
apikey String

Unique API key.
id Number

ID of campaign

Success 200

Field Type Description
id Number

ID of the campaign
country String

Country
installs Number

Number of ratings
status String

Status of the campaign
country_list Array[]

1 country with install numbers.
  Country as key Number

Country as key and the install number is the value.

Success-Response:

[
   {
      "id": 12,
      "country": "Brazil",
      "installs": 20,
      "status": "COMPLETED",
      "country_list": {
         "Russia": 20
      }
   }
]

Error 4xx

Field Type Description
error Array[]

Error parameters.
  code Number

HTTP error code for the current error.
  message String

Description of error.

Rating Campaigns (iOS) - LIST

Retrieves all campaigns

get 
http://api.androidinstalls.com/campaigns

Parameter

Field Type Description
apikey String

Unique API key.

Success 200

Field Type Description
id Number

ID of the campaign
country String

Country
installs Number

Number of Installs
status String

Status of the campaign
country_list Array[]

1 country with install numbers.
  Country as key Number

Country as key and the install number is the value.

Success-Response:

[
   {
      "id": 12,
      "country": "Brazil",
      "installs": 20,
      "status": "COMPLETED",
      "country_list": {
         "Russia": 20
      }
   }
]

Error 4xx

Field Type Description
error Array[]

Error parameters.
  code Number

HTTP error code for the current error.
  message String

Description of error.

Rating Campaigns (iOS) - CANCEL

Cancel campaign

get 
http://api.androidinstalls.com/cancelcampaign

Parameter

Field Type Description
apikey String

Unique API key.
id Number

Campaign ID.

Example: https://api.androidinstalls.com/cancelcampaign?apikey=[YOUR_API_KEY]&id=569357

Success 200

Field Type Description
success String

Campaign is pending. Cancelling a campaign takes time, it can take between few minutes and several hours until the campaign fully terminated. You will be notified by email (if the notification is turned on).
id Number

ID of the campaign

Success-Response:

{
   "success": "Campaign is pending! Will be cancelled soon.",
   "id": 569357
}

Error 4xx

Field Type Description
error Array[]

Error parameters.
  code Number

HTTP error code for the current error.
  message String

Description of error.

Wallet

Wallet - GET

Retrieves your balance and spending.

get 
http://api.androidinstalls.com/wallet

Parameter

Field Type Description
apikey String

Unique API key.

Success 200

Field Type Description
balance String

Your current balance.
spending String

Your money spent on our services.

Success-Response:

[
   {
      "balance": "1725.86",
      "spending": "25661.10"
   }
]

Error 4xx

Field Type Description
error Array[]

Error parameters.
  code Number

HTTP error code for the current error.
  message String

Description of error.

Countries

Countries - LIST

Retrieves a dedicated list of countries for the API. You can use it if you need for adding new Campaigns via the API.

get 
http://api.androidinstalls.com/countries

Parameter

Field Type Description
apikey String

Unique API key.

Success 200

Field Type Description
cc String

Country Code
name String

Name of country

Success-Response:

[
   {
      "cc": "US",
      "name": "United States"
   }
]

Error 4xx

Field Type Description
error Array[]

Error parameters.
  code Number

HTTP error code for the current error.
  message String

Description of error.