app_store.app_chart

stable Standard

App Store chart for a storefront, including top grossing and new apps.

GET /v1/app_store/app_chart

What you get#

A list of App Store results in Onekey's unified shape, in data (an array). An empty array is a normal, successful answer and is charged like any other; a source that reports "nothing found" as an error returns a free 404 not_found instead.

What it costs#

Standard · 1 credit for a fresh fetch, charged only when it succeeds.
Free when served from cache (0.2 credit for a cached response over 100 KB).
Free if the request is invalid (never charged) or the source fails or reports not found (refunded).

Parameters#

Name	Type	Required	Default	What it is	Constraints
`app_collection`	string	no	`topgrossingapplications`	Chart: topfreeapplications, toppaidapplications, topgrossingapplications, newapplications, newfreeapplications or newpaidapplications	max 24 chars; must match `topfreeapplications\|toppaidapplications\|topgrossingapplications\|newapplications\|newfreeapplications\|newpaidapplications`; trimmed, lowercased
`country`	string	no	`us`	Two-letter storefront country code	max 2 chars; must match `[a-z]{2}`; trimmed, lowercased

Request#

curl "https://api.onekey.dev/v1/app_store/app_chart?app_collection=topgrossingapplications" \
  -H "x-api-key: YOUR_API_KEY"

Try it

Add your key to run this call right here. No key? Get one free. The key stays in this tab.

Recorded response#

A real App Store response, recorded and returned in Onekey's shape. Fields the platform does not provide are null.

json

{
  "success": true,
  "data": [
    {
      "entity": {
        "id": "6448311069",
        "name": "ChatGPT",
        "url": "https://apps.apple.com/us/app/chatgpt/id6448311069?uo=2",
        "category": "Productivity",
        "releaseDate": "2023-05-18T00:00:00Z",
        "description": "Introducing ChatGPT for iOS: OpenAI’s latest advancements at your fingertips.\n\nThis official app is free, syncs your history across devices, and brings you the latest from OpenAI, including the new im"
      },
      "author": {
        "displayName": "OpenAI OpCo, LLC"
      },
      "media": {
        "thumbnailUrl": "https://is1-ssl.mzstatic.com/image/thumb/Purple211/v4/eb/c5/b3/ebc5b3a0-618f-6c84-492f-05d113191648/AppIcon-0-0-1x_U007epad-0-0-0-1-0-85-220.png/100x100bb.png"
      },
      "listing": {
        "price": 0,
        "currency": "USD"
      },
      "ext": {
        "bundleId": "com.openai.chat"
      }
    },
    {
      "entity": {
        "id": "544007664",
        "name": "YouTube",
        "url": "https://apps.apple.com/us/app/youtube/id544007664?uo=2",
        "category": "Photo & Video",
        "releaseDate": "2012-09-11T00:00:00Z",
        "description": "Get the official YouTube app on iPhones and iPads. See what the world is watching -- from the hottest music videos to what’s popular in gaming, fashion, beauty, news, learning and more. Subscribe to c"
      },
      "author": {
        "displayName": "Google"
      },
      "media": {
        "thumbnailUrl": "https://is1-ssl.mzstatic.com/image/thumb/Purple221/v4/77/86/1c/77861cb6-0f87-5220-d6a5-5f11c8fcad7f/logo_youtube_2024_q4_color-0-0-1x_U007emarketing-0-0-0-7-0-0-0-85-220.png/100x100bb.png"
      },
      "listing": {
        "price": 0,
        "currency": "USD"
      },
      "ext": {
        "bundleId": "com.google.ios.youtube"
      }
    }
  ],
  "metadata": {
    "platform": "app_store",
    "endpoint": "app_chart",
    "cached": false,
    "stale": false,
    "age_s": 0,
    "fetched_at": "2026-01-01T12:00:00+00:00",
    "credits_charged": 1,
    "request_id": "7f3a9c2e5b1d4c8fa2e6d0b9c4f18e37"
  },
  "error": null
}

Field mapping#

How this endpoint's source fields become Onekey's unified schema. Fields the source lacks come back as null.

Source path	Onekey field	Transform
`id.attributes.im:id`	`entity.id`	-
`im:name.label`	`entity.name`	-
`id.label`	`entity.url`	`safeUrl`
`im:artist.label`	`author.displayName`	-
`im:image.2.label`	`media.thumbnailUrl`	`safeUrl`
`category.attributes.term`	`entity.category`	-
`im:price.attributes.amount`	`listing.price`	`toNumber`
`im:price.attributes.currency`	`listing.currency`	-
`im:releaseDate.attributes.label`	`entity.releaseDate`	`toIsoDate`
`summary.label`	`entity.description`	-
`id.attributes.im:bundleId`	`ext.bundleId`	-

Caching and freshness#

Fresh for about 30 seconds. Repeat calls in that window are served from cache and are free.
Between 30 seconds and 5 minutes the cached copy is still served instantly and marked stale: true while Onekey refreshes it in the background.
If the source is down when a refresh is needed, the last copy can be served for up to 15 minutes more (marked stale).
A "not found" is remembered for 1 minute and is free.
The cache is shared across all customers, which is what keeps repeat calls cheap.

What can go wrong#

Status	Code	What to do
401	`unauthorized`	Check the `x-api-key` header.
402	`insufficient_credits`	Add credits; your balance must cover the price.
404	`not_found`	Unknown endpoint path.
422	`invalid_params`	Fix the parameters using the table above. Free.
429	`rate_limited`	Wait `Retry-After` seconds, then retry.
502	`upstream_error`	The source failed. Refunded; retry with backoff.

See Errors for the full list and retry guidance.

Status: stable (verified against the live source).