This page will help you get started with AppTweak's App Store API.

Intro

AppTweak’s API allows you to access the Apple App Store & Google Play Store programmatically in 100+ countries. Use our API to visualize mobile app data the way you want, build custom reports, automate part of your processes, or integrate AppTweak data into your product.

Getting Started

In order to use the AppTweak Public API, you must obtain an API token which will be used for authentication and billing purposes.

This token can be automatically obtained by subscribing to an AppTweak account with a Pro, Guru, Power, or Enterprise plan. Once subscribed, you will find your API dashboard - which includes your API token and links to this documentation - in the "API" section of AppTweak.

API Dashboard within AppTweakAPI Dashboard within AppTweak

API Dashboard within AppTweak

Pricing

The AppTweak Public API is a commercial product provided by AppTweak. Each AppTweak subscription ("Pro" plans and above) comes with 25,000 included monthly credits which can be used to query the API.

The final price of a request is based on the kind of data that you are requesting and the amount of data queried. AppTweak only charges for returned data— any queried data point(s) that cannot be returned by AppTweak will not be charged.
The complete list of data point prices, as well as some pricing examples can be found in the Pricing Table.

On top of the included 25,000 API credits, dedicated API add-on plans are available if you wish to increase this number:

API Plans Pricing TableAPI Plans Pricing Table

API Plans Pricing Table

Clients are also able to buy additional packages of API credits. As opposed to the API plans, credit packages are one-off purchases (instead of subscription-based). Additionally, credits bought through an Additional API Credits package are not reset at the end of a billing cycle— they remain available on your account until you need them. The API will always use the recurring monthly credits first before using any additional credits. The price of these additional API credits depends on the API plan you are subscribed to when making the purchase. Bigger API plans offer discounts on the price of additional credits:

No API Add-On

API Small

API Medium

API Large

$80 / 25,000 Credits

$40 / 25,000 Credits

$30 / 25,000 Credits

$20 / 25,000 Credits

Data format

Depending on the data you’d like to fetch, you will need to indicate a series of parameters to define your request. All successful responses return a valid minified JSON document. The JSON document is a hash which contains the response content and metadata about the request and the response itself. Our responses always follows the same structure: a hash “result” that contains one or multiple “resources”. These resources can be an app, a keyword, or a category. Each of these resources will contain a response hash that varies according to the request.

Example request

curl --request GET \
     --url 'https://app.demo.apptweak.com/api/public/store/apps/metrics/current.json?apps=880178264&metrics=downloads%2Crevenues%2Cpower%2Cratings&country=us&device=iphone' \
     --header 'Accept: application/json' \
     --header 'x-apptweak-key: YOUR API TOKEN'

Example response

{
  "result": {
    "880178264": {
      "downloads": {
        "value": 3772,
        "precision": 0.25,
        "date": "2022-03-03"
      },
      "revenues": {
        "value": 15971,
        "precision": 0.25,
        "date": "2022-03-03",
        "currency": "USD"
      },
      "power": {
        "value": 86.6,
        "date": "2022-03-03"
      },
      "ratings": {
        "value": null,
        "breakdown": null,
        "date": "2022-03-03"
      }
    }
  },
  "metadata": {
    "request": {
      "path": "/api/public/store/apps/metrics/current.json",
      "params": {
        "device": "iphone",
        "country": "us",
        "language": "us",
        "apps": [
          "880178264"
        ],
        "metrics": [
          "downloads",
          "revenues",
          "power",
          "ratings"
        ]
      },
      "cost": 210,
      "max_credit_cost": 220,
      "status": 200
    },
    "response": null
  }
}

Authentication

You authenticate the AppTweak API by providing your secret API token in the request. Any request performed using your API token will be billed to your account, so be sure to keep it secret!

Authentication to the API occurs using HTTP Headers. Provide your API token in the X-Apptweak-Key Header.

All API requests must be made over HTTPS. Calls made over plain HTTP will fail. You must authenticate for all requests.

How to make requests

You can make requests directly from the documentation. Under the GOOGLE & APPLE APP STORE API section on the left sidebar you can find all the available API endpoints. On each of the endpoints definition page you can make requests by:

  1. Completing the query parameters
  2. Making sure your API key is in the authentication header
  3. Clicking on the "Try it!" button

You can also follow a step by step guide to find how to make your first requests in the next section.

The available API endpoints can be found on the left section Google and Apple App Store API (highlighted in green). The different input fields and the "Try it!" button to make a request are highlighted in orange.The available API endpoints can be found on the left section Google and Apple App Store API (highlighted in green). The different input fields and the "Try it!" button to make a request are highlighted in orange.

The available API endpoints can be found on the left section Google and Apple App Store API (highlighted in green). The different input fields and the "Try it!" button to make a request are highlighted in orange.