App Store App Rank History API


Get app rank history data for an iOS app available on Apple App Store.

Definition

Endpoint:

GET https://data.42matters.com/api/v2.0/ios/apps/ranks.json

Hits per request:

3

Rate limit:

5 QPS

Required plan:

basic or above.

Parameters

Name Required Description Available Values Default
access_token required Your access token for using this API. You can get it for FREE by signing up .
id required The app ID on the iTunes store - (e.g for Facebook the ID is 284882215). Existing App ID on iTunes Store
start_date optional The start date of the report. A valid date in the format yyyy-MM-dd, for example: 2016-05-24
end_date optional The end date of the report. A valid date in the format yyyy-MM-dd, for example: 2016-05-30
days optional Set the date range from yesterday to the specified number of days in the past. 1-30
list_names optional Comma-separated list of list_name values. If no list_name is specified, all available list_names will be returned.
Name Description
topselling_free Top Selling Free
topselling_paid Top Selling Paid
device_types optional Comma-separated list of Device Types. If no device_type is specified, all available device_types will be returned.
Value Information
iphone iPhone devices
ipad iPad devices
primaryGenreIds optional Comma-separated list of App Primary Genre Ids. If no primaryGenreId is specified, all available primaryGenreIds will be returned. ID of App Store Genres
countries optional Comma-separated list of countries (ISO code). If no country is specified, all available countries will be returned. ID of Supported Countries
lang optional Return language-specific metadata. If no translation is available the default language of the app is used. Internationalized fields include t​itle, short_desc, description, what_is_new, screenshots. ID of Supported Languages en
app_country optional Return country-specific app metadata. Country-specific fields are include currency, price, formattedPrice. If the country is not supported, then the default metadata of the app is returned. ID of Supported Countries US
callback optional If supplied, the response will use the JSONP format with a callback of the given name.

Responses

Status Code Indication Content-Type Body
200 Everything is OK application/json
Attribute Type Description
trackId String Numeric unique identifier for the app assigned by Apple
trackCensoredName String App title
sellerName String Seller company name
userRatingCount Integer Number of ratings of the app for all versions
averageUserRating Double The average rating of the app for all versions (from 0 to 5, 5 highest)
artworkUrl512 URL Icon image with 512px square sizes
artworkUrl100 URL Icon image with 100px square sizes
formattedPrice String Price and currency of the app
trackViewUrl URL Link to the app on the Apple App Store
start_date Date A date in the format: yyyy-MM-dd
end_date Date A date in the format: yyyy-MM-dd
max_position Integer The maximum position among all ranks. Useful to set custom ranges in your charts.
number_dates Integer Number of dates in the response
dates Array of dates Sorted list of dates in the response
ranks Array of Objects Sorted list of rank objects in the response. Each rank contains: country, country_name, primary_genre_id, primary_genre_name, list_name, list_title, positions (in the returned dates). If a position is null, it means the app is not in this chart on that day.
404 The track id/bundle id is not found application/json Error object
402 Your request exceeds what's allowed by your current subscription plan application/json Error object
403 Your access token is not valid application/json Error object
429 Your request rate is over the limit application/json Error object

Example Request

Example Response

{
	"trackId": "343200656",
	"start_date": "2017-10-08",
	"end_date": "2017-10-17",
	"max_position": 564,
	"number_dates": 10,
	"dates": [
		"2017-10-08",
		"2017-10-09",
		"2017-10-10",
		"2017-10-11",
		"2017-10-12",
		"2017-10-13",
		"2017-10-14",
		"2017-10-15",
		"2017-10-16",
		"2017-10-17"
	],
	"ranks": [
		{
			"country": "US",
			"country_name": "United States",
			"primary_genre_id": "36",
			"primary_genre_name": "Mobile Software Applications",
			"list_name": "topselling_free",
			"list_title": "Top Selling Free",
			"device_type": "iphone",
			"positions": [
				{
					"date": "2017-10-08",
					"position": 443
				},
				{
					"date": "2017-10-09",
					"position": 437
				},
				{
					"date": "2017-10-10",
					"position": 469
				},
				{
					"date": "2017-10-11",
					"position": 516
				},
				{
					"date": "2017-10-12",
					"position": 534
				},
				{
					"date": "2017-10-13",
					"position": 564
				},
				{
					"date": "2017-10-14",
					"position": 534
				},
				{
					"date": "2017-10-15",
					"position": 459
				},
				{
					"date": "2017-10-16",
					"position": 448
				},
				{
					"date": "2017-10-17",
					"position": 503
				}
			]
		},
		{
			"country": "US",
			"country_name": "United States",
			"primary_genre_id": "6014",
			"primary_genre_name": "Games",
			"list_name": "topselling_free",
			"list_title": "Top Selling Free",
			"device_type": "iphone",
			"positions": [
				{
					"date": "2017-10-08",
					"position": 147
				},
				{
					"date": "2017-10-09",
					"position": 151
				},
				{
					"date": "2017-10-10",
					"position": 152
				},
				{
					"date": "2017-10-11",
					"position": 147
				},
				{
					"date": "2017-10-12",
					"position": 147
				},
				{
					"date": "2017-10-13",
					"position": 152
				},
				{
					"date": "2017-10-14",
					"position": 150
				},
				{
					"date": "2017-10-15",
					"position": 155
				},
				{
					"date": "2017-10-16",
					"position": 154
				},
				{
					"date": "2017-10-17",
					"position": 151
				}
			]
		},
		{
			"country": "US",
			"country_name": "United States",
			"primary_genre_id": "7001",
			"primary_genre_name": "Action",
			"list_name": "topselling_free",
			"list_title": "Top Selling Free",
			"device_type": "iphone",
			"positions": [
				{
					"date": "2017-10-08",
					"position": 59
				},
				{
					"date": "2017-10-09",
					"position": 62
				},
				{
					"date": "2017-10-10",
					"position": 63
				},
				{
					"date": "2017-10-11",
					"position": 58
				},
				{
					"date": "2017-10-12",
					"position": 56
				},
				{
					"date": "2017-10-13",
					"position": 57
				},
				{
					"date": "2017-10-14",
					"position": 58
				},
				{
					"date": "2017-10-15",
					"position": 59
				},
				{
					"date": "2017-10-16",
					"position": 58
				},
				{
					"date": "2017-10-17",
					"position": 54
				}
			]
		},
		{
			"country": "US",
			"country_name": "United States",
			"primary_genre_id": "7003",
			"primary_genre_name": "Arcade",
			"list_name": "topselling_free",
			"list_title": "Top Selling Free",
			"device_type": "iphone",
			"positions": [
				{
					"date": "2017-10-08",
					"position": 58
				},
				{
					"date": "2017-10-09",
					"position": 58
				},
				{
					"date": "2017-10-10",
					"position": 57
				},
				{
					"date": "2017-10-11",
					"position": 53
				},
				{
					"date": "2017-10-12",
					"position": 51
				},
				{
					"date": "2017-10-13",
					"position": 53
				},
				{
					"date": "2017-10-14",
					"position": 58
				},
				{
					"date": "2017-10-15",
					"position": 61
				},
				{
					"date": "2017-10-16",
					"position": 58
				},
				{
					"date": "2017-10-17",
					"position": 57
				}
			]
		}
	],
	"trackCensoredName": "Angry Birds",
	"sellerName": "Rovio Entertainment Ltd",
	"userRatingCount": 824518,
	"averageUserRating": 4.5,
	"artworkUrl512": "http://is4.mzstatic.com/image/thumb/Purple118/v4/cb/1e/28/cb1e28c2-8c23-53dd-aa9a-a39d91bd1fa2/source/512x512bb.jpg",
	"artworkUrl100": "http://is4.mzstatic.com/image/thumb/Purple118/v4/cb/1e/28/cb1e28c2-8c23-53dd-aa9a-a39d91bd1fa2/source/100x100bb.jpg",
	"trackViewUrl": "https://itunes.apple.com/us/app/angry-birds/id343200656?mt=8&uo=4&at=10l9yE",
	"formattedPrice": "Free"
}

Last Modified: 2016-09-26


Get Free Support


We offer free email support to all our customers, with the 42matters team glad to provide you prompt, professional support. We’re here to help.


CONTACT US    KNOWLEDGE BASE