apple.top_books
stable Advanced
Top free books chart.
GET /v1/apple/top_books
What you get#
A list of Apple 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#
| 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/top_books" \
-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 response, recorded and returned in Onekey's shape. Fields the platform does not provide are null.
{
"success": true,
"data": [
{
"entity": {
"id": "6742456783",
"name": "Death By Chocolate (A Millie Swiss Cozy Mystery—Book 2)",
"url": "https://books.apple.com/us/book/death-by-chocolate-a-millie-swiss-cozy-mystery-book-2/id6742456783"
},
"ext": {
"artist": "Fiona Grace"
},
"media": {
"thumbnailUrl": "https://is1-ssl.mzstatic.com/image/thumb/Publication221/v4/b3/d0/8d/b3d08dbf-5d37-da6e-078b-16f74c260190/9798894826561.jpg/100x150bb.png"
},
"content": {
"createdAt": "2025-06-10T00:00:00Z"
}
},
{
"entity": {
"id": "1044068356",
"name": "Cherished By You",
"url": "https://books.apple.com/us/book/cherished-by-you/id1044068356"
},
"ext": {
"artist": "Steph Nuss"
},
"media": {
"thumbnailUrl": "https://is1-ssl.mzstatic.com/image/thumb/Publication62/v4/92/5d/0f/925d0fd8-e869-7498-2f9c-c3a403f27cb2/mzm.dopqldxs.jpg/100x154bb.png"
},
"content": {
"createdAt": "2015-10-07T00:00:00Z"
}
}
],
"metadata": {
"platform": "apple",
"endpoint": "top_books",
"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 path | Onekey field | Transform |
|---|---|---|
id | entity.id | toString |
name | entity.name | - |
artistName | ext.artist | - |
url | entity.url | safeUrl |
artworkUrl100 | media.thumbnailUrl | safeUrl |
releaseDate | content.createdAt | 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: truewhile 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#
| 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).