AppBrain API specification

The AppBrain API allows automated interaction with AppBrain for fetching Google Play app information and AppBrain promotion campaign management.

This page gives an overview of the available methods and their parameters, and allows you to try out the API. Click on one of the methods to view its details, and use the Try it out button to make a request.

You can find the detailed technical specification for the AppBrain API in the the swagger API definition file.

Expand all

Devices

GET /device_stats/top_by_country Top devices by country

Returns the most used devices in a country. The API credential needs to be from an account that has a valid intelligence subscription.

Request endpoint

https://api.appbrain.com/v2/device_stats/top_by_country

Response 200: successful operation

Schema: summary | full

{
  "devices": [
    {
      "rank": "integer",
      "name": "string",
      "modelName": "string",
      "deviceName": "string",
      "manufacturerName": "string",
      "absolutePopularity": "number",
      "relativePopularity": "number"
    }
  ]
}

{
  "type": "object",
  "properties": {
    "devices": {
      "type": "array",
      "xml": {
        "wrapped": true
      },
      "description": "Device information",
      "items": {
        "type": "object",
        "properties": {
          "rank": {
            "type": "integer",
            "format": "int32",
            "description": "rank"
          },
          "name": {
            "type": "string",
            "description": "name of the device"
          },
          "modelName": {
            "type": "string",
            "description": "model name"
          },
          "deviceName": {
            "type": "string",
            "description": "device name"
          },
          "manufacturerName": {
            "type": "string",
            "description": "manufacturer"
          },
          "absolutePopularity": {
            "type": "number",
            "format": "double",
            "description": "absolute popularity (market share in country)"
          },
          "relativePopularity": {
            "type": "number",
            "format": "double",
            "description": "relative popularity (the share of the global market of a phone or tablet for this country)"
          }
        },
        "description": "Information about a device"
      }
    }
  },
  "description": "List of devices"
}

Other responses

400: Invalid request

401: Unauthorized request

429: Too many requests

Request

Query parameters
apikey		the API key, manage yours on the Dashboard
country		2-letter country code

Response content type: application/json application/xml

Hide response

Request URL

Show as: url | curl

Request body

Note that the AppBrain API also supports XML in the request body, but this demo always uses JSON, even when the response is XML.

Response status

Response headers

Response body

Information

GET /info/getcountries Countries information

Returns a list of countries.

Request endpoint

https://api.appbrain.com/v2/info/getcountries

Response 200: successful operation

Schema: summary | full

{
  "countries": [
    {
      "code": "string",
      "name": "string",
      "minCpiBid": "number"
    }
  ]
}

{
  "type": "object",
  "properties": {
    "countries": {
      "type": "array",
      "xml": {
        "wrapped": true
      },
      "description": "country information",
      "items": {
        "type": "object",
        "properties": {
          "code": {
            "type": "string",
            "description": "country code"
          },
          "name": {
            "type": "string",
            "description": "name of the country"
          },
          "minCpiBid": {
            "type": "number",
            "format": "double",
            "description": "minimum cost-per-install bid for app promotions in this country"
          }
        },
        "description": "Information about a country"
      }
    }
  },
  "description": "List of countries"
}

Request

Response content type: application/json application/xml

Hide response

Request URL

Show as: url | curl

Request body

Note that the AppBrain API also supports XML in the request body, but this demo always uses JSON, even when the response is XML.

Response status

Response headers

Response body

GET /info/getlibraries Libraries information

Returns a list of known libraries used in apps.

Request endpoint

https://api.appbrain.com/v2/info/getlibraries

Response 200: successful operation

Schema: summary | full

{
  "libraries": [
    {
      "id": "string",
      "name": "string",
      "description": "string",
      "types": [
        "string"
      ],
      "tags": [
        "string"
      ],
      "officialUrl": "string",
      "appBrainUrl": "string"
    }
  ]
}

{
  "type": "object",
  "properties": {
    "libraries": {
      "type": "array",
      "xml": {
        "wrapped": true
      },
      "description": "library information",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "description": "identifier for the library"
          },
          "name": {
            "type": "string",
            "description": "name of the library"
          },
          "description": {
            "type": "string",
            "description": "description of the library"
          },
          "types": {
            "type": "array",
            "description": "types of the library",
            "items": {
              "type": "string"
            }
          },
          "tags": {
            "type": "array",
            "description": "tags associated with the library",
            "items": {
              "type": "string"
            }
          },
          "officialUrl": {
            "type": "string",
            "description": "official URL of the library"
          },
          "appBrainUrl": {
            "type": "string",
            "description": "AppBrain URL of the library"
          }
        },
        "description": "Information about a library"
      }
    }
  },
  "description": "List of known libraries"
}

Request

Response content type: application/json application/xml

Hide response

Request URL

Show as: url | curl

Request body

Note that the AppBrain API also supports XML in the request body, but this demo always uses JSON, even when the response is XML.

Response status

Response headers

Response body

GET /info/getapp App information

Returns all information about an app. More information about usage and charges is available at AppBrain API pricing.

Request endpoint

https://api.appbrain.com/v2/info/getapp

Response 200: successful operation

Schema: summary | full

{
  "package": "string",
  "versionString": "string",
  "versionCode": "integer",
  "name": "string",
  "shortDescription": "string",
  "description": "string",
  "marketCategory": "string",
  "price": "string",
  "apkSize": "integer",
  "maturityLevel": "string enum: EVERYONE, LOW, MEDIUM, HIGH",
  "minSdkVersion": "integer",
  "maxSdkVersion": "integer",
  "supportsApp2SD": "string enum: TRUE, FALSE",
  "launchTime": "integer",
  "lastAppUpdateTime": "integer",
  "infoRefreshTime": "integer",
  "downloadsCategory": "string",
  "estimatedDownloads": "integer",
  "estimatedRecentDownloads": "integer",
  "rating": "number",
  "recentRating": "number",
  "ratingCount": "integer",
  "rating1StarCount": "integer",
  "rating2StarCount": "integer",
  "rating3StarCount": "integer",
  "rating4StarCount": "integer",
  "rating5StarCount": "integer",
  "plusOneCount": "integer",
  "commentCount": "integer",
  "iconUrl": "string",
  "featureGraphicUrl": "string",
  "youtubeUrl": "string",
  "developerName": "string",
  "developerEmail": "string",
  "developerAddress": "string",
  "website": "string",
  "screenshotUrls": [
    "string"
  ],
  "permissions": [
    "string"
  ],
  "libraries": [
    "string"
  ]
}

{
  "type": "object",
  "properties": {
    "package": {
      "type": "string",
      "description": "package"
    },
    "versionString": {
      "type": "string",
      "description": "most recent version"
    },
    "versionCode": {
      "type": "integer",
      "format": "int32",
      "description": "most recent version code"
    },
    "name": {
      "type": "string",
      "description": "name of the app"
    },
    "shortDescription": {
      "type": "string",
      "description": "short one-line description of the app"
    },
    "description": {
      "type": "string",
      "description": "description of the app"
    },
    "marketCategory": {
      "type": "string",
      "description": "market category of the app"
    },
    "price": {
      "type": "string",
      "description": "price of the app"
    },
    "apkSize": {
      "type": "integer",
      "format": "int64",
      "description": "size of the APK"
    },
    "maturityLevel": {
      "type": "string",
      "description": "maturity level of the app",
      "enum": [
        "EVERYONE",
        "LOW",
        "MEDIUM",
        "HIGH"
      ]
    },
    "minSdkVersion": {
      "type": "integer",
      "format": "int32",
      "description": "minimum supported SDK version"
    },
    "maxSdkVersion": {
      "type": "integer",
      "format": "int32",
      "description": "maximum supported SDK version"
    },
    "supportsApp2SD": {
      "type": "string",
      "description": "whether the app can be installed on external storage",
      "enum": [
        "TRUE",
        "FALSE"
      ]
    },
    "launchTime": {
      "type": "integer",
      "format": "int32",
      "description": "timestamp of the app\u0027s launch in seconds since epoch"
    },
    "lastAppUpdateTime": {
      "type": "integer",
      "format": "int32",
      "description": "timestamp of the app\u0027s latest update in seconds since epoch"
    },
    "infoRefreshTime": {
      "type": "integer",
      "format": "int32",
      "description": "timestamp of the last refresh of the app information in seconds since epoch"
    },
    "downloadsCategory": {
      "type": "string",
      "description": "Google play category of the number of downloads"
    },
    "estimatedDownloads": {
      "type": "integer",
      "format": "int64",
      "description": "estimated number of downloads"
    },
    "estimatedRecentDownloads": {
      "type": "integer",
      "format": "int64",
      "description": "estimated number of downloads in the last 30 days"
    },
    "rating": {
      "type": "number",
      "format": "double",
      "description": "average rating"
    },
    "recentRating": {
      "type": "number",
      "format": "double",
      "description": "average rating (deprecated, present for historic reasons)"
    },
    "ratingCount": {
      "type": "integer",
      "format": "int32",
      "description": "number of ratings"
    },
    "rating1StarCount": {
      "type": "integer",
      "format": "int32",
      "description": "number of 1-star ratings"
    },
    "rating2StarCount": {
      "type": "integer",
      "format": "int32",
      "description": "number of 2-star ratings"
    },
    "rating3StarCount": {
      "type": "integer",
      "format": "int32",
      "description": "number of 3-star ratings"
    },
    "rating4StarCount": {
      "type": "integer",
      "format": "int32",
      "description": "number of 4-star ratings"
    },
    "rating5StarCount": {
      "type": "integer",
      "format": "int32",
      "description": "number of 5-star ratings"
    },
    "plusOneCount": {
      "type": "integer",
      "format": "int32",
      "description": "number of +1s"
    },
    "commentCount": {
      "type": "integer",
      "format": "int32",
      "description": "number of comments"
    },
    "iconUrl": {
      "type": "string",
      "description": "URL of the app\u0027s icon"
    },
    "featureGraphicUrl": {
      "type": "string",
      "description": "URL of the app\u0027s feature graphic"
    },
    "youtubeUrl": {
      "type": "string",
      "description": "YouTube URL of the app\u0027s promo video"
    },
    "developerName": {
      "type": "string",
      "description": "name of the developer of the app"
    },
    "developerEmail": {
      "type": "string",
      "description": "email address of the developer"
    },
    "developerAddress": {
      "type": "string",
      "description": "address of the developer"
    },
    "website": {
      "type": "string",
      "description": "official website of the app"
    },
    "screenshotUrls": {
      "type": "array",
      "xml": {
        "wrapped": true
      },
      "description": "URLs of the app\u0027s screenshots",
      "items": {
        "type": "string",
        "xml": {
          "name": "screenshotUrl"
        }
      }
    },
    "permissions": {
      "type": "array",
      "xml": {
        "wrapped": true
      },
      "description": "requested permissions",
      "items": {
        "type": "string",
        "xml": {
          "name": "permission"
        }
      }
    },
    "libraries": {
      "type": "array",
      "xml": {
        "wrapped": true
      },
      "description": "libraries used in the app",
      "items": {
        "type": "string",
        "xml": {
          "name": "library"
        }
      }
    }
  },
  "description": "Everything about an app"
}

Other responses

400: Invalid request

401: Unauthorized request

429: Too many requests

Request

Query parameters
apikey		the API key, manage yours on the Dashboard
package		package

Response content type: application/json application/xml

Hide response

Request URL

Show as: url | curl

Request body

Note that the AppBrain API also supports XML in the request body, but this demo always uses JSON, even when the response is XML.

Response status

Response headers

Response body

GET /info/browse Apps information

Returns a list of apps and everything about those apps. More information about usage and charges is available at AppBrain API pricing.

Request endpoint

https://api.appbrain.com/v2/info/browse

Response 200: successful operation

Schema: summary | full

{
  "apps": [
    {
      "package": "string",
      "versionString": "string",
      "versionCode": "integer",
      "name": "string",
      "shortDescription": "string",
      "description": "string",
      "marketCategory": "string",
      "price": "string",
      "apkSize": "integer",
      "maturityLevel": "string enum: EVERYONE, LOW, MEDIUM, HIGH",
      "minSdkVersion": "integer",
      "maxSdkVersion": "integer",
      "supportsApp2SD": "string enum: TRUE, FALSE",
      "launchTime": "integer",
      "lastAppUpdateTime": "integer",
      "infoRefreshTime": "integer",
      "downloadsCategory": "string",
      "estimatedDownloads": "integer",
      "estimatedRecentDownloads": "integer",
      "rating": "number",
      "recentRating": "number",
      "ratingCount": "integer",
      "rating1StarCount": "integer",
      "rating2StarCount": "integer",
      "rating3StarCount": "integer",
      "rating4StarCount": "integer",
      "rating5StarCount": "integer",
      "plusOneCount": "integer",
      "commentCount": "integer",
      "iconUrl": "string",
      "featureGraphicUrl": "string",
      "youtubeUrl": "string",
      "developerName": "string",
      "developerEmail": "string",
      "developerAddress": "string",
      "website": "string",
      "screenshotUrls": [
        "string"
      ],
      "permissions": [
        "string"
      ],
      "libraries": [
        "string"
      ]
    }
  ]
}

{
  "type": "object",
  "properties": {
    "apps": {
      "type": "array",
      "xml": {
        "wrapped": true
      },
      "description": "List of apps",
      "items": {
        "type": "object",
        "properties": {
          "package": {
            "type": "string",
            "description": "package"
          },
          "versionString": {
            "type": "string",
            "description": "most recent version"
          },
          "versionCode": {
            "type": "integer",
            "format": "int32",
            "description": "most recent version code"
          },
          "name": {
            "type": "string",
            "description": "name of the app"
          },
          "shortDescription": {
            "type": "string",
            "description": "short one-line description of the app"
          },
          "description": {
            "type": "string",
            "description": "description of the app"
          },
          "marketCategory": {
            "type": "string",
            "description": "market category of the app"
          },
          "price": {
            "type": "string",
            "description": "price of the app"
          },
          "apkSize": {
            "type": "integer",
            "format": "int64",
            "description": "size of the APK"
          },
          "maturityLevel": {
            "type": "string",
            "description": "maturity level of the app",
            "enum": [
              "EVERYONE",
              "LOW",
              "MEDIUM",
              "HIGH"
            ]
          },
          "minSdkVersion": {
            "type": "integer",
            "format": "int32",
            "description": "minimum supported SDK version"
          },
          "maxSdkVersion": {
            "type": "integer",
            "format": "int32",
            "description": "maximum supported SDK version"
          },
          "supportsApp2SD": {
            "type": "string",
            "description": "whether the app can be installed on external storage",
            "enum": [
              "TRUE",
              "FALSE"
            ]
          },
          "launchTime": {
            "type": "integer",
            "format": "int32",
            "description": "timestamp of the app\u0027s launch in seconds since epoch"
          },
          "lastAppUpdateTime": {
            "type": "integer",
            "format": "int32",
            "description": "timestamp of the app\u0027s latest update in seconds since epoch"
          },
          "infoRefreshTime": {
            "type": "integer",
            "format": "int32",
            "description": "timestamp of the last refresh of the app information in seconds since epoch"
          },
          "downloadsCategory": {
            "type": "string",
            "description": "Google play category of the number of downloads"
          },
          "estimatedDownloads": {
            "type": "integer",
            "format": "int64",
            "description": "estimated number of downloads"
          },
          "estimatedRecentDownloads": {
            "type": "integer",
            "format": "int64",
            "description": "estimated number of downloads in the last 30 days"
          },
          "rating": {
            "type": "number",
            "format": "double",
            "description": "average rating"
          },
          "recentRating": {
            "type": "number",
            "format": "double",
            "description": "average rating (deprecated, present for historic reasons)"
          },
          "ratingCount": {
            "type": "integer",
            "format": "int32",
            "description": "number of ratings"
          },
          "rating1StarCount": {
            "type": "integer",
            "format": "int32",
            "description": "number of 1-star ratings"
          },
          "rating2StarCount": {
            "type": "integer",
            "format": "int32",
            "description": "number of 2-star ratings"
          },
          "rating3StarCount": {
            "type": "integer",
            "format": "int32",
            "description": "number of 3-star ratings"
          },
          "rating4StarCount": {
            "type": "integer",
            "format": "int32",
            "description": "number of 4-star ratings"
          },
          "rating5StarCount": {
            "type": "integer",
            "format": "int32",
            "description": "number of 5-star ratings"
          },
          "plusOneCount": {
            "type": "integer",
            "format": "int32",
            "description": "number of +1s"
          },
          "commentCount": {
            "type": "integer",
            "format": "int32",
            "description": "number of comments"
          },
          "iconUrl": {
            "type": "string",
            "description": "URL of the app\u0027s icon"
          },
          "featureGraphicUrl": {
            "type": "string",
            "description": "URL of the app\u0027s feature graphic"
          },
          "youtubeUrl": {
            "type": "string",
            "description": "YouTube URL of the app\u0027s promo video"
          },
          "developerName": {
            "type": "string",
            "description": "name of the developer of the app"
          },
          "developerEmail": {
            "type": "string",
            "description": "email address of the developer"
          },
          "developerAddress": {
            "type": "string",
            "description": "address of the developer"
          },
          "website": {
            "type": "string",
            "description": "official website of the app"
          },
          "screenshotUrls": {
            "type": "array",
            "xml": {
              "wrapped": true
            },
            "description": "URLs of the app\u0027s screenshots",
            "items": {
              "type": "string",
              "xml": {
                "name": "screenshotUrl"
              }
            }
          },
          "permissions": {
            "type": "array",
            "xml": {
              "wrapped": true
            },
            "description": "requested permissions",
            "items": {
              "type": "string",
              "xml": {
                "name": "permission"
              }
            }
          },
          "libraries": {
            "type": "array",
            "xml": {
              "wrapped": true
            },
            "description": "libraries used in the app",
            "items": {
              "type": "string",
              "xml": {
                "name": "library"
              }
            }
          }
        },
        "description": "Everything about an app"
      }
    }
  },
  "description": "List of apps"
}

Other responses

400: Invalid request

401: Unauthorized request

429: Too many requests

Request

Query parameters
apikey		the API key, manage yours on the Dashboard
sort	ALLTIME_DOWNLOADS HOT-DAY POPULAR_AUSTRALIA POPULAR_BRAZIL POPULAR_CANADA POPULAR_DENMARK POPULAR_FINLAND POPULAR_FRANCE POPULAR_GERMANY POPULAR_HONGKONG POPULAR_HUNGARY POPULAR_INDIA POPULAR_ITALY POPULAR_JAPAN POPULAR_KOREA POPULAR_NETHERLANDS POPULAR_NORWAY POPULAR_POLAND POPULAR_PORTUGAL POPULAR_RUSSIA POPULAR_SPAIN POPULAR_SWEDEN POPULAR_THAILAND POPULAR_UK POPULAR_USA RATING RECENT_DOWNLOADS TIME	sort order of the results (default: POPULAR)
filter	FREE NEW PAID PRICE_REDUCED UPDATED	optional filter of the results
category	APPLICATION GAME ACTION ADVENTURE ARCADE ART_DESIGN AUTO BEAUTY BOARD BOOKS_REFERENCE BUSINESS CARD CASINO CASUAL COMICS COMMUNICATION DATING EDUCATION EDUCATIONAL ENTERTAINMENT EVENTS FINANCE FOOD_DRINK HEALTH_FITNESS HOUSE_HOME LIBRARIES_DEMO LIFESTYLE MEDIA_VIDEO MEDICAL MUSIC MUSIC_AUDIO NEWS_MAGAZINES PARENTING PERSONALIZATION PHOTOGRAPHY PRODUCTIVITY PUZZLE RACING ROLE_PLAYING SHOPPING SIMULATION SOCIAL SPORTS SPORTS_GAMES STRATEGY TOOLS TRANSPORTATION TRAVEL_LOCAL TRIVIA WEATHER WORD	optional filter for the Google Play category
offset		offset of the browse results (default 0; max 500)
limit		number of the browse results (default 10; max 50)

Response content type: application/json application/xml

Hide response

Request URL

Show as: url | curl

Request body

Note that the AppBrain API also supports XML in the request body, but this demo always uses JSON, even when the response is XML.

Response status

Response headers

Response body

GET /info/search Apps information

Returns a list of apps and everything about those apps. More information about usage and charges is available at AppBrain API pricing.

Request endpoint

https://api.appbrain.com/v2/info/search

Response 200: successful operation

Schema: summary | full

{
  "apps": [
    {
      "package": "string",
      "versionString": "string",
      "versionCode": "integer",
      "name": "string",
      "shortDescription": "string",
      "description": "string",
      "marketCategory": "string",
      "price": "string",
      "apkSize": "integer",
      "maturityLevel": "string enum: EVERYONE, LOW, MEDIUM, HIGH",
      "minSdkVersion": "integer",
      "maxSdkVersion": "integer",
      "supportsApp2SD": "string enum: TRUE, FALSE",
      "launchTime": "integer",
      "lastAppUpdateTime": "integer",
      "infoRefreshTime": "integer",
      "downloadsCategory": "string",
      "estimatedDownloads": "integer",
      "estimatedRecentDownloads": "integer",
      "rating": "number",
      "recentRating": "number",
      "ratingCount": "integer",
      "rating1StarCount": "integer",
      "rating2StarCount": "integer",
      "rating3StarCount": "integer",
      "rating4StarCount": "integer",
      "rating5StarCount": "integer",
      "plusOneCount": "integer",
      "commentCount": "integer",
      "iconUrl": "string",
      "featureGraphicUrl": "string",
      "youtubeUrl": "string",
      "developerName": "string",
      "developerEmail": "string",
      "developerAddress": "string",
      "website": "string",
      "screenshotUrls": [
        "string"
      ],
      "permissions": [
        "string"
      ],
      "libraries": [
        "string"
      ]
    }
  ]
}

{
  "type": "object",
  "properties": {
    "apps": {
      "type": "array",
      "xml": {
        "wrapped": true
      },
      "description": "List of apps",
      "items": {
        "type": "object",
        "properties": {
          "package": {
            "type": "string",
            "description": "package"
          },
          "versionString": {
            "type": "string",
            "description": "most recent version"
          },
          "versionCode": {
            "type": "integer",
            "format": "int32",
            "description": "most recent version code"
          },
          "name": {
            "type": "string",
            "description": "name of the app"
          },
          "shortDescription": {
            "type": "string",
            "description": "short one-line description of the app"
          },
          "description": {
            "type": "string",
            "description": "description of the app"
          },
          "marketCategory": {
            "type": "string",
            "description": "market category of the app"
          },
          "price": {
            "type": "string",
            "description": "price of the app"
          },
          "apkSize": {
            "type": "integer",
            "format": "int64",
            "description": "size of the APK"
          },
          "maturityLevel": {
            "type": "string",
            "description": "maturity level of the app",
            "enum": [
              "EVERYONE",
              "LOW",
              "MEDIUM",
              "HIGH"
            ]
          },
          "minSdkVersion": {
            "type": "integer",
            "format": "int32",
            "description": "minimum supported SDK version"
          },
          "maxSdkVersion": {
            "type": "integer",
            "format": "int32",
            "description": "maximum supported SDK version"
          },
          "supportsApp2SD": {
            "type": "string",
            "description": "whether the app can be installed on external storage",
            "enum": [
              "TRUE",
              "FALSE"
            ]
          },
          "launchTime": {
            "type": "integer",
            "format": "int32",
            "description": "timestamp of the app\u0027s launch in seconds since epoch"
          },
          "lastAppUpdateTime": {
            "type": "integer",
            "format": "int32",
            "description": "timestamp of the app\u0027s latest update in seconds since epoch"
          },
          "infoRefreshTime": {
            "type": "integer",
            "format": "int32",
            "description": "timestamp of the last refresh of the app information in seconds since epoch"
          },
          "downloadsCategory": {
            "type": "string",
            "description": "Google play category of the number of downloads"
          },
          "estimatedDownloads": {
            "type": "integer",
            "format": "int64",
            "description": "estimated number of downloads"
          },
          "estimatedRecentDownloads": {
            "type": "integer",
            "format": "int64",
            "description": "estimated number of downloads in the last 30 days"
          },
          "rating": {
            "type": "number",
            "format": "double",
            "description": "average rating"
          },
          "recentRating": {
            "type": "number",
            "format": "double",
            "description": "average rating (deprecated, present for historic reasons)"
          },
          "ratingCount": {
            "type": "integer",
            "format": "int32",
            "description": "number of ratings"
          },
          "rating1StarCount": {
            "type": "integer",
            "format": "int32",
            "description": "number of 1-star ratings"
          },
          "rating2StarCount": {
            "type": "integer",
            "format": "int32",
            "description": "number of 2-star ratings"
          },
          "rating3StarCount": {
            "type": "integer",
            "format": "int32",
            "description": "number of 3-star ratings"
          },
          "rating4StarCount": {
            "type": "integer",
            "format": "int32",
            "description": "number of 4-star ratings"
          },
          "rating5StarCount": {
            "type": "integer",
            "format": "int32",
            "description": "number of 5-star ratings"
          },
          "plusOneCount": {
            "type": "integer",
            "format": "int32",
            "description": "number of +1s"
          },
          "commentCount": {
            "type": "integer",
            "format": "int32",
            "description": "number of comments"
          },
          "iconUrl": {
            "type": "string",
            "description": "URL of the app\u0027s icon"
          },
          "featureGraphicUrl": {
            "type": "string",
            "description": "URL of the app\u0027s feature graphic"
          },
          "youtubeUrl": {
            "type": "string",
            "description": "YouTube URL of the app\u0027s promo video"
          },
          "developerName": {
            "type": "string",
            "description": "name of the developer of the app"
          },
          "developerEmail": {
            "type": "string",
            "description": "email address of the developer"
          },
          "developerAddress": {
            "type": "string",
            "description": "address of the developer"
          },
          "website": {
            "type": "string",
            "description": "official website of the app"
          },
          "screenshotUrls": {
            "type": "array",
            "xml": {
              "wrapped": true
            },
            "description": "URLs of the app\u0027s screenshots",
            "items": {
              "type": "string",
              "xml": {
                "name": "screenshotUrl"
              }
            }
          },
          "permissions": {
            "type": "array",
            "xml": {
              "wrapped": true
            },
            "description": "requested permissions",
            "items": {
              "type": "string",
              "xml": {
                "name": "permission"
              }
            }
          },
          "libraries": {
            "type": "array",
            "xml": {
              "wrapped": true
            },
            "description": "libraries used in the app",
            "items": {
              "type": "string",
              "xml": {
                "name": "library"
              }
            }
          }
        },
        "description": "Everything about an app"
      }
    }
  },
  "description": "List of apps"
}

Other responses

400: Invalid request

401: Unauthorized request

429: Too many requests

Request

Query parameters
apikey		the API key, manage yours on the Dashboard
query		search query
sort	ALLTIME_DOWNLOADS HOT-DAY POPULAR_AUSTRALIA POPULAR_BRAZIL POPULAR_CANADA POPULAR_DENMARK POPULAR_FINLAND POPULAR_FRANCE POPULAR_GERMANY POPULAR_HONGKONG POPULAR_HUNGARY POPULAR_INDIA POPULAR_ITALY POPULAR_JAPAN POPULAR_KOREA POPULAR_NETHERLANDS POPULAR_NORWAY POPULAR_POLAND POPULAR_PORTUGAL POPULAR_RUSSIA POPULAR_SPAIN POPULAR_SWEDEN POPULAR_THAILAND POPULAR_UK POPULAR_USA RATING RECENT_DOWNLOADS RELEVANCY TIME	sort order of the results (default: RELEVANCY)
filter	FREE NEW PAID PRICE_REDUCED UPDATED	optional filter of the results
category	APPLICATION GAME ACTION ADVENTURE ARCADE ART_DESIGN AUTO BEAUTY BOARD BOOKS_REFERENCE BUSINESS CARD CASINO CASUAL COMICS COMMUNICATION DATING EDUCATION EDUCATIONAL ENTERTAINMENT EVENTS FINANCE FOOD_DRINK HEALTH_FITNESS HOUSE_HOME LIBRARIES_DEMO LIFESTYLE MEDIA_VIDEO MEDICAL MUSIC MUSIC_AUDIO NEWS_MAGAZINES PARENTING PERSONALIZATION PHOTOGRAPHY PRODUCTIVITY PUZZLE RACING ROLE_PLAYING SHOPPING SIMULATION SOCIAL SPORTS SPORTS_GAMES STRATEGY TOOLS TRANSPORTATION TRAVEL_LOCAL TRIVIA WEATHER WORD	optional filter for the Google Play category
offset		offset of the browse results (default 0; max 500)
limit		number of the browse results (default 10; max 50)

Response content type: application/json application/xml

Hide response

Request URL

Show as: url | curl

Request body

Note that the AppBrain API also supports XML in the request body, but this demo always uses JSON, even when the response is XML.

Response status

Response headers

Response body

Promotion Campaigns

GET /campaigns/get Retrieves a promotion campaign

Retrieves the details of a promotion campaign.

Request endpoint

https://api.appbrain.com/v2/campaigns/get

Response 200: successful operation

Schema: summary | full

{
  "campaign": "string",
  "state": "string",
  "name": "string",
  "title": "string",
  "subtitle": "string",
  "dailyBudget": "number",
  "remainingBudget": "number",
  "installTracking": "string enum: APPBRAIN, ADJUST, APPSFLYER, SINGULAR, KOCHAVA, TUNE, BRANCH",
  "clickthroughUrl": "string",
  "countries": [
    {
      "code": "string",
      "cpi": "number"
    }
  ],
  "allowedSubIds": [
    "string"
  ],
  "blockedSubIds": [
    "string"
  ]
}

{
  "type": "object",
  "properties": {
    "campaign": {
      "type": "string",
      "description": "identifier of the promotion campaign"
    },
    "state": {
      "type": "string",
      "description": "state of the promotion campaign"
    },
    "name": {
      "type": "string",
      "description": "name/description of the promotion campaign"
    },
    "title": {
      "type": "string",
      "description": "promotion title of the promotion campaign"
    },
    "subtitle": {
      "type": "string",
      "description": "promotion subtitle of the promotion campaign"
    },
    "dailyBudget": {
      "type": "number",
      "format": "double",
      "description": "daily budget of the promotion campaign in dollars"
    },
    "remainingBudget": {
      "type": "number",
      "format": "double",
      "description": "total remaining budget the promotion campaign in dollars"
    },
    "installTracking": {
      "type": "string",
      "description": "attribution partner that is used for install tracking",
      "enum": [
        "APPBRAIN",
        "ADJUST",
        "APPSFLYER",
        "SINGULAR",
        "KOCHAVA",
        "TUNE",
        "BRANCH"
      ]
    },
    "clickthroughUrl": {
      "type": "string",
      "description": "clickthrough URL of the promotion campaign"
    },
    "countries": {
      "type": "array",
      "xml": {
        "wrapped": true
      },
      "description": "list of settings for each country where the campaign is running",
      "items": {
        "type": "object",
        "properties": {
          "code": {
            "type": "string",
            "description": "the two-letter ISO country code"
          },
          "cpi": {
            "type": "number",
            "format": "double",
            "description": "the maximum cost-per-install for a country in dollars"
          }
        },
        "description": "Settings for a country in the promotion campaign"
      }
    },
    "allowedSubIds": {
      "type": "array",
      "xml": {
        "wrapped": true
      },
      "description": "list of publisher subIDs to allow for this campaign",
      "items": {
        "type": "string",
        "xml": {
          "name": "allowedSubId"
        }
      }
    },
    "blockedSubIds": {
      "type": "array",
      "xml": {
        "wrapped": true
      },
      "description": "list of publisher subIDs to block for this campaign",
      "items": {
        "type": "string",
        "xml": {
          "name": "blockedSubId"
        }
      }
    }
  },
  "description": "All details of a promotion campaign"
}

Other responses

400: Invalid request

401: Unauthorized request

429: Too many requests

Request

Query parameters
apikey		the API key, manage yours on the Dashboard
campaign		campaign

Response content type: application/json application/xml

Hide response

Request URL

Show as: url | curl

Request body

Note that the AppBrain API also supports XML in the request body, but this demo always uses JSON, even when the response is XML.

Response status

Response headers

Response body

POST /campaigns/update Creates or updates a promotion campaign

Creates a new promotion campaign or updates an existing one.

Request endpoint

https://api.appbrain.com/v2/campaigns/update

Response 200: successful operation

Schema: summary | full

"string"

{
  "type": "string"
}

Other responses

400: Invalid request

401: Unauthorized request

429: Too many requests

Request

Query parameters
apikey		the API key, manage yours on the Dashboard
lowbidaction	ERROR RAISE STOP	what to do if a country bid is lower than the minimum allowed bid (ERROR: throw an error, RAISE: raise the country bid, STOP: stop campaign in the country)
Body parameters
campaign		identifier of the promotion campaign (i.e. the package of the promoted app, eventually followed by a dash and an index for multiple campaigns per app.)
state	RUNNING STOPPED	state of the promotion campaign
name		name/description of the promotion campaign
title		promotion title of the promotion campaign
subtitle		promotion subtitle of the promotion campaign
dailyBudget		daily budget of the promotion campaign in dollars (a negative value indicates no budget limit)
remainingBudget		total remaining budget the promotion campaign in dollars (a negative value indicates no budget limit)
installTracking	APPBRAIN ADJUST APPSFLYER SINGULAR KOCHAVA TUNE BRANCH	attribution partner that is used for install tracking
clickthroughUrl		clickthrough URL of the promotion campaign
countries	list of settings for each country where the campaign is running; setting this list overwrites all country settings for the promotion campaign (can't be used simultaneously with updateCountries or removeCountries)
	Add Remove
updateCountries	updates the provided settings for the countries (can't be used simultaneously with countries)
	Add Remove
removeCountries	removes the provided countries from the promotion campaign (can't be used simultaneously with countries)
	Add Remove
allowedSubIds	list of publisher subIDs to allow for this campaign; setting this list overwrites all existing allowed subIDs (can't be used simultaneously with addAllowedSubIds)
	Add Remove
addAllowedSubIds	adds publisher subIDs to the list of allowed subIDs (can't be used simultaneously with allowedSubIds)
	Add Remove
blockedSubIds	list of publisher subIDs to block for this campaign; setting this list overwrites all existing blocked subIDs (can't be used simultaneously with addBlockedSubIds)
	Add Remove
addBlockedSubIds	adds publisher subIDs to the list of blocked subIDs (can't be used simultaneously with blockedSubIds)
	Add Remove

Response content type: application/json application/xml

Hide response

Request URL

Show as: url | curl

Request body

Note that the AppBrain API also supports XML in the request body, but this demo always uses JSON, even when the response is XML.

Response status

Response headers

Response body

GET /campaigns/list Lists all promotion campaigns

Returns a list of identifiers of all promotion campaigns.

Request endpoint

https://api.appbrain.com/v2/campaigns/list

Response 200: successful operation

Schema: summary | full

{
  "campaigns": [
    "string"
  ]
}

{
  "type": "object",
  "properties": {
    "campaigns": {
      "type": "array",
      "xml": {
        "wrapped": true
      },
      "description": "identifiers of existing promotion campaigns",
      "items": {
        "type": "string",
        "xml": {
          "name": "campaign"
        }
      }
    }
  },
  "description": "List of promotion campaigns"
}

Other responses

400: Invalid request

401: Unauthorized request

429: Too many requests

Request

Query parameters
apikey		the API key, manage yours on the Dashboard
includeArchived		include archived campaigns

Response content type: application/json application/xml

Hide response

Request URL

Show as: url | curl

Request body

Note that the AppBrain API also supports XML in the request body, but this demo always uses JSON, even when the response is XML.

Response status

Response headers

Response body