apple_music.charts

stable Standard

Apple Music most-played songs chart for a storefront country.

GET /v1/apple_music/charts

What you get#

A list of Apple Music 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
`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/apple_music/charts?country=us" \
  -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 Apple Music response, recorded and returned in Onekey's shape. Fields the platform does not provide are null.

json

{
  "success": true,
  "data": [
    {
      "entity": {
        "id": "6814997425",
        "name": "Patient Zero",
        "url": "https://music.apple.com/us/album/patient-zero/6814997249?i=6814997425",
        "category": "Pop",
        "releaseDate": "2026-09-24T00:00:00Z"
      },
      "author": {
        "displayName": "Taylor Swift"
      },
      "media": {
        "thumbnailUrl": "https://is1-ssl.mzstatic.com/image/thumb/Music221/v4/a0/dd/fd/a0ddfd72-ee9e-f046-6466-a5dbefc696fa/26UM1IM21436.rgb.jpg/100x100bb.jpg"
      }
    },
    {
      "entity": {
        "id": "1844932150",
        "name": "Choosin' Texas",
        "url": "https://music.apple.com/us/album/choosin-texas/1844932149?i=1844932150",
        "category": "Country",
        "releaseDate": "2025-10-17T00:00:00Z"
      },
      "author": {
        "displayName": "Ella Langley"
      },
      "media": {
        "thumbnailUrl": "https://is1-ssl.mzstatic.com/image/thumb/Music221/v4/e2/91/4d/e2914d0a-7f1d-f04c-fbf4-c50b38548838/196873638690.jpg/100x100bb.jpg"
      }
    }
  ],
  "metadata": {
    "platform": "apple_music",
    "endpoint": "charts",
    "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`	`entity.id`	-
`name`	`entity.name`	-
`url`	`entity.url`	`safeUrl`
`artistName`	`author.displayName`	-
`artworkUrl100`	`media.thumbnailUrl`	`safeUrl`
`genres.0.name`	`entity.category`	-
`releaseDate`	`entity.releaseDate`	`toIsoDate`

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).