Docs
View as Markdown

itunes.search_ebooks

stable Advanced

Search Apple Books ebooks.

GET /v1/itunes/search_ebooks

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
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_ebooks?q=dune" \
  -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": [
    {
      "entity": {
        "id": "597944491",
        "name": "Dune",
        "description": "Frank Herbert’s classic masterpiece—a triumph of the imagination and one of the bestselling science fiction novels of all time. Set on the desert planet Arrakis, Dune is the story of Paul Atreides—who would become known as Muad'Dib—and of a great family's ambition to bring to fruition mankind's most ancient and unattainable dream. A stunning blend of adventure and mysticism, environmentalism and politics, Dune won the first Nebula Award, shared t",
        "url": "https://books.apple.com/us/book/dune/id597944491?uo=4",
        "stats": {
          "rating": 4.5
        }
      },
      "author": {
        "displayName": "Frank Herbert"
      },
      "media": {
        "thumbnailUrl": "https://is1-ssl.mzstatic.com/image/thumb/Publication122/v4/85/70/2f/85702f34-2982-e2ee-d883-b5ffc3ae0897/9781101658055.d.jpg/100x100bb.jpg"
      },
      "listing": {
        "price": 9.99
      }
    },
    {
      "entity": {
        "id": "357914731",
        "name": "Dune Messiah",
        "description": "COMING SOON • DUNE: PART THREE • THE MAJOR MOTION PICTURE Directed by Denis Villeneuve, screenplay by Denis Villeneuve and Brian K. Vaughan, based on the novels written by Frank Herbert • Starring Timothée Chalamet, Zendaya, Jason Momoa, Florence Pugh, Rebecca Ferguson, Isaach De Bankolé, with Charlotte Rampling, with Anya Taylor-Joy, and Robert Pattinson, and Javier Bardem Book Two in the Magnificent Dune Chronicles—the Bestselling Science Fiction Adventure of All Time <",
        "url": "https://books.apple.com/us/book/dune-messiah/id357914731?uo=4",
        "stats": {
          "rating": 4
        }
      },
      "author": {
        "displayName": "Frank Herbert"
      },
      "media": {
        "thumbnailUrl": "https://is1-ssl.mzstatic.com/image/thumb/Publication113/v4/89/bc/8d/89bc8d21-8dd7-75a0-ea6e-8ae136e87318/9781101157879.jpg/100x100bb.jpg"
      },
      "listing": {
        "price": 9.99
      }
    }
  ],
  "metadata": {
    "platform": "itunes",
    "endpoint": "search_ebooks",
    "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
trackIdentity.idtoString
trackNameentity.name-
artistNameauthor.displayName-
descriptionentity.descriptionstripHtml
trackViewUrlentity.urlsafeUrl
artworkUrl100media.thumbnailUrlsafeUrl
averageUserRatingentity.stats.ratingtoNumber
pricelisting.pricetoNumber

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