Application Metadata

GET 1 Credits / Request /ios/applications/{APPLICATION_ID}/metadata.json

Application Metadata allows you to fetch all the information that AppTweak has been able to gather about a specific app on the App Store.

Please note that the example has been stripped of redundant data to keep the documentation as concise as possible. The API might return additional, undocumented fields in the JSON, which your App should not rely upon.

Application Metadata Request

In AppTweak, you always fetch an app, in a specific country, in a specific language, on a specific device. We reply with all the information we have for this app.

Header parameters
X-AppTweak-Key:
Your AppTweak API Key.
Path parameters
APPLICATION_ID:
Application ID for which you want to get the metadata.
Query parameters
country: string us

The two letter country code (ISO Alpha-2) you want to fetch the app in.

us. Get the list of our country codes, here.

language: string en

The two letter language (ISO Alpha-2) you want to fetch the application in.

en. Get the list of our language codes, here.

device: string iphone

The device you want to fetch the application for.

iphone or ipad

max-age: number 94608000

Maximum age of the metadata, expressed in seconds. Lower max-age will give fresher results, but will slow down the request as we have a higher chance of having to refresh the data.

604800 seconds (one week)

GET /ios/applications/{APPLICATION_ID}/metadata.json

Request example
GET /ios/applications/1323966646/informations.json?country=gb&language=en&device=iphone&max-age=86400
cURL example
curl -X GET -H "X-Apptweak-Key: ${API_KEY}" https://api.apptweak.com/ios/applications/1323966646/informations.json?country=gb&language=en&device=iphone&max-age=86400

Application Metadata Response

The response to the application metadata request is a deep JSON hash containing all necessary data to get an overview of the application state on the App Store in the last 30 days.

Object properties
id: number

The ID that Apple has given to the application.

competitors: array

A list of app ids that Apple advertises as alternatives for this app in the Others also bought section in the Related tab in the App Store.

description: string

The app description as it appears on the App Store, in the chosen language.

developer: hash

Key/value pairs describing the developer.

device: array

The list of devices the app is available on. Can contain : ipad, ipod and iphone.

features: hash

Key/boolean pairs describing if the App is compatible with passbook and the game center and if it has in app purchases.

genres: array

The list of category the app is listed on. See the supported categories list to match the category_id to it's human friendly name. The special category_id 0 is used to refer to the global rankings across all categories combined.

icon: string

The URL of the icon as it appears on the App Store.

price: string

Price of the application as displayed in the App Store in the target country.

promotionalText: string

The Promotional Text should reflect the app’s new features, promotions or highlighted content.

rating: hash

Key/value pairs describing the average rating for the application.

release_date: datetime

The release date of the first version of the app on the App Store.

screenshots: hash

Key/value pairs describing the screenshot for each device. The keys are the device types recognized by apple: iphone, ipad, ipadPro, iphone5, iphone6, iphone6plus and appleWatch. The values are lists of screenshot entries. Each screenshot entry contains the screenshot id, a technical path_component and the complete screenshot url.

size: hash

Key/value pairs describing the size of the app.

slug: string

URL friendly version of the app name.

subtitle: string

The subtitle explaining the purpose of the app (introduced in iOS 11).

title: string

The App name as it appears on the App Store, in the chosen language.

versions: array

A list of version hash. Each version hash specifies the version number, the date on when it was released and the release notes in the chosen language.

videos: hash

Key/value pairs describing the videos for each device. The keys are the device types recognized by apple: iphone, ipad, ipadPro, iphone5, iphone6, iphone6plus and appleWatch. The values are lists of video entries.

Response Example

{
  "content": {
    "id": 454638411,
    "versions": [
      {
        "version": "99.0",
        "release_date": "2016-12-07 00:00:00 UTC",
        "release_notes": "We update the app regularly so we can make it better for you. Get the latest version for all of the available features and improvements. Thanks for using Messenger!\n\n"
      },
      {
        "version": "10.0",
        "release_date": "2014-08-19 00:00:00 UTC",
        "release_notes": "Better Photo Sharing: Choose even more photos to send all at once. \nImprovements for viewing photos and videos. \nFixed issues with videos."
      }
    ],
    "icon": "https://is5-ssl.mzstatic.com/image/thumb/Purple128/v4/c8/59/86/c859862d-bccf-8ca7-b708-ab2c4d8fb133/Icon-Production-1x_U007emarketing-85-220-0-6.png/180x180bb.png",
    "genres": [
      6005,
      6007
    ],
    "title": "Messenger",
    "slug": "messenger",
    "description": "Instantly reach the people in your life—for free. Messenger is just like texting, but you ...",
    "features": {
      "game_center": false,
      "passbook": false,
      "in_apps": false
    },
    "devices": [
      "iphone",
      "ipad",
      "ipod"
    ],
    "competitors": [

    ],
    "price": "£0.00",
    "screenshots": {
      "iphone6": [

      ],
      "iphone": [

      ],
      "iphone5": [

      ],
      "ipad": [

      ],
      "ipadPro": [
        {
          "id": "3a0caad5-ce42-ea9d-3301-42ae47c06499",
          "path_component": "image/thumb/Purple128/v4",
          "filename": "mzl.dqhlzhnl.png/2732x2048bb.png",
          "url": "https://is4-ssl.mzstatic.com/image/thumb/Purple128/v4/3a/0c/aa/3a0caad5-ce42-ea9d-3301-42ae47c06499/mzl.dqhlzhnl.png/2732x2048bb.png"
        }
      ],
      "iphone6plus": [
        {
          "id": "40d87574-3805-81bc-db7b-42d58d61b1d6",
          "path_component": "image/thumb/Purple128/v4",
          "filename": "pr_source.png/2208x2208bb.png",
          "url": "https://is4-ssl.mzstatic.com/image/thumb/Purple128/v4/40/d8/75/40d87574-3805-81bc-db7b-42d58d61b1d6/pr_source.png/2208x2208bb.png"
        }
      ],
      "appleWatch": [

      ]
    },
    "videos": {
      "ipad": [

      ],
      "ipadPro": [

      ],
      "iphone": [

      ],
      "iphone5": [

      ],
      "iphone6": [

      ],
      "iphone6plus": [

      ]
    },
    "release_date": "2011-10-19 00:00:00 UTC",
    "size": {
      "current": {
        "data": 251281408
      }
    },
    "subtitle": "Text and Video Chat",
    "promotionalText": "",
    "rating": {
      "average": 4.4
    }
  },
  "metadata": {
    "request": {
      "path": "/applications/454638411/metadata.json",
      "store": "ios",
      "params": {
        "country": "gb",
        "language": "en",
        "device": "iphone",
        "max-age": 86400,
        "id": "454638411",
        "format": "json"
      },
      "performed_at": "2018-11-05 13:16:42 UTC"
    },
    "content": {
    }
  }
}