Docs
View as Markdown

itunes.search_music

stable Advanced

Search iTunes music tracks.

GET /v1/itunes/search_music

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.

Also known as: /apple_music/search on APIs that nest their paths. See Alternatives and equivalents.

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
qstringyes(required)Search termmax 150 chars; must match [^\x00-\x1f\x7f]{1,150}; trimmed, repeated spaces collapsed
countrystringnous2-letter store country, e.g. usmax 2 chars; must match [a-z]{2}; trimmed, lowercased

Request#

curl "https://api.onekey.dev/v1/itunes/search_music?q=radiohead" \
  -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": "1097861834",
        "title": "Let Down",
        "category": "Alternative",
        "url": "https://music.apple.com/us/album/let-down/1097861387?i=1097861834&uo=4",
        "createdAt": "1997-05-21T07:00:00Z"
      },
      "author": {
        "displayName": "Radiohead"
      },
      "ext": {
        "album": "OK Computer",
        "durationMs": 299560
      },
      "media": {
        "thumbnailUrl": "https://is1-ssl.mzstatic.com/image/thumb/Music116/v4/07/60/ba/0760ba0f-148c-b18f-d0ff-169ee96f3af5/634904078164.png/100x100bb.jpg",
        "previewUrl": "https://audio-ssl.itunes.apple.com/itunes-assets/AudioPreview221/v4/cd/65/58/cd6558df-2ba2-6f8e-25a0-d2db94494f74/mzaf_5583409847288875892.plus.aac.p.m4a"
      }
    },
    {
      "content": {
        "id": "1109715293",
        "title": "All I Need",
        "category": "Alternative",
        "url": "https://music.apple.com/us/album/all-i-need/1109714933?i=1109715293&uo=4",
        "createdAt": "2007-10-10T07:00:00Z"
      },
      "author": {
        "displayName": "Radiohead"
      },
      "ext": {
        "album": "In Rainbows",
        "durationMs": 228747
      },
      "media": {
        "thumbnailUrl": "https://is1-ssl.mzstatic.com/image/thumb/Music126/v4/dd/50/c7/dd50c790-99ac-d3d0-5ab8-e3891fb8fd52/634904032463.png/100x100bb.jpg",
        "previewUrl": "https://audio-ssl.itunes.apple.com/itunes-assets/AudioPreview221/v4/8e/c3/d5/8ec3d546-17d7-3322-662d-e09a89fbefd8/mzaf_7126755987197906481.plus.aac.p.m4a"
      }
    }
  ],
  "metadata": {
    "platform": "itunes",
    "endpoint": "search_music",
    "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
trackIdcontent.idtoString
trackNamecontent.title-
artistNameauthor.displayName-
collectionNameext.album-
primaryGenreNamecontent.category-
trackViewUrlcontent.urlsafeUrl
artworkUrl100media.thumbnailUrlsafeUrl
previewUrlmedia.previewUrlsafeUrl
trackTimeMillisext.durationMstoNumber
releaseDatecontent.createdAttoIsoDate

Caching and freshness#

  • Fresh for about 2 minutes. Repeat calls in that window are served from cache and are free.
  • Between 2 minutes and 15 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 1 hour 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).