Docs
View as Markdown

itunes.top_albums

stable Advanced

Apple Music most-played albums chart.

GET /v1/itunes/top_albums

What you get#

A list of Itunes 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#

  • Advanced · 5 credits 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#

NameTypeRequiredDefaultWhat it isConstraints
countrystringnous2-letter store country, e.g. usmax 2 chars; must match [a-z]{2}; trimmed, lowercased
limitstringno10Chart size (10, 25, 50, 100)max 3 chars; must match (?:10|25|50|100); trimmed

Request#

curl "https://api.onekey.dev/v1/itunes/top_albums" \
  -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 Itunes response, recorded and returned in Onekey's shape. Fields the platform does not provide are null.

json
{
  "success": true,
  "data": [
    {
      "content": {
        "id": "1838810949",
        "title": "The Life of a Showgirl",
        "url": "https://music.apple.com/us/album/the-life-of-a-showgirl/1838810949",
        "category": "Pop",
        "createdAt": "2025-10-03T00:00:00Z"
      },
      "author": {
        "displayName": "Taylor Swift"
      },
      "media": {
        "thumbnailUrl": "https://is1-ssl.mzstatic.com/image/thumb/Music221/v4/58/8f/a9/588fa9a2-7cc5-f02c-9ce6-c986e0dc1c15/25UM1IM19577.rgb.jpg/100x100bb.jpg"
      }
    },
    {
      "content": {
        "id": "6810715695",
        "title": "Westside Whimsy",
        "url": "https://music.apple.com/us/album/westside-whimsy/6810715695",
        "category": "R&B/Soul",
        "createdAt": "2026-09-11T00:00:00Z"
      },
      "author": {
        "displayName": "Jhené Aiko"
      },
      "media": {
        "thumbnailUrl": "https://is1-ssl.mzstatic.com/image/thumb/Music221/v4/5f/51/9f/5f519f49-44c1-6aeb-f289-5b14c677abb1/26UM1IM17017.rgb.jpg/100x100bb.jpg"
      }
    }
  ],
  "metadata": {
    "platform": "itunes",
    "endpoint": "top_albums",
    "cached": false,
    "stale": false,
    "age_s": 0,
    "fetched_at": "2026-01-01T12:00:00+00:00",
    "credits_charged": 5,
    "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 pathOnekey fieldTransform
idcontent.id-
namecontent.title-
artistNameauthor.displayName-
urlcontent.urlsafeUrl
artworkUrl100media.thumbnailUrlsafeUrl
genres.0.namecontent.category-
releaseDatecontent.createdAttoIsoDate

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 10 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#

StatusCodeWhat to do
401unauthorizedCheck the x-api-key header.
402insufficient_creditsAdd credits; your balance must cover the price.
404not_foundUnknown endpoint path.
422invalid_paramsFix the parameters using the table above. Free.
429rate_limitedWait Retry-After seconds, then retry.
502upstream_errorThe source failed. Refunded; retry with backoff.

See Errors for the full list and retry guidance.

Status: stable (verified against the live source).