Skip to main content
POST
app-store.apps.top-charts

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string

Optional. A retry with the same key returns the stored result.

Maximum string length: 255
Pramaan-Max-Price-Micro
string

Optional. The most this request may be priced at, in micro-USD (a whole number above 0). It replaces the capability's own price ceiling for this request, lower or higher. Sources that could cost more are left out; when none is left the answer is 400 with the lowest limit that would work.

Pattern: ^[1-9]\d{0,14}$

Body

application/json
appCollection
enum<string>
required

Chart to return, e.g. top_free_ios for free iPhone apps or top_paid_ios for paid iPhone apps.

Available options:
top_free_ios,
top_paid_ios,
top_grossing_ios,
new_ios,
new_free_ios,
new_paid_ios
appCategory
string

Application category on the App Store.

Required string length: 1 - 512
language
string

Two-letter language code, e.g. "en", or a supported language name such as English. Default "en".

Pattern: ^(?:[a-z]{2}|english|french|german|spanish|italian|portuguese|japanese|korean|chinese|dutch|swedish|polish|russian|arabic|hindi|turkish)$
location
string

Location in English, e.g. United States or London,England,United Kingdom. Default United States.

Required string length: 1 - 128

Response

The result

results
object[]
required

The matching items.

nextCursor
string

Pass as cursor to get the next page; absent on the last page.