What you get#
Onekey exposes Apple as 14 endpoints behind one API key: 3 endpoints return one record (data is an object) and 11 endpoints return a list (data is an array). Every answer uses the same envelope (success, data, metadata, error), the cost is reported in metadata.credits_charged, and fields are mapped onto the unified schema so the code you write for Apple also works for the rest of the music & audio category.
Endpoints#
| Endpoint | What it does | Parameters | Credits | Status |
|---|---|---|---|---|
app | App Store app details by numeric id (iTunes lookup). | id*, country | 1 | stable |
app_by_bundle | App Store app details by bundle id (iTunes lookup). | bundle_id*, country | 1 | stable |
artist | Apple Music/iTunes artist by numeric id. | id* | 1 | stable |
reviews | Most recent customer reviews of an App Store app, US storefront first page (RSS JSON). | id* | 5 | beta |
search_albums | Search albums in Apple Music/iTunes. | q*, country | 5 | stable |
search_apps | Search iOS apps in the App Store. | q*, country | 5 | stable |
search_podcasts | Search podcasts in Apple Podcasts. | q*, country | 5 | stable |
search_songs | Search songs in Apple Music/iTunes. | q*, country | 1 | stable |
top_audiobooks | Top audiobooks chart. | country | 5 | stable |
top_books | Top free books chart. | country | 5 | stable |
top_free_apps | Top free iOS apps chart. | country | 5 | stable |
top_paid_apps | Top paid iOS apps chart. | country | 5 | stable |
top_podcasts | Top podcasts chart. | country | 5 | stable |
top_songs | Most-played songs chart. | country | 5 | stable |
A * marks a required parameter. Each endpoint name links to its reference page with the full parameter table, caching window and a recorded response.
Make a request#
This calls apple.app (1 credit, stable). Replace YOUR_API_KEY with your key; sign up, no card. 1,000 free credits cover the open-platform endpoints. Hard-to-reach platforms (X, TikTok, Instagram, Reddit, and others marked on their page) need a verified email and a purchased pack.
curl "https://api.onekey.dev/v1/apple/app?id=284882215" \
-H "x-api-key: YOUR_API_KEY"Fields you get back#
These unified fields come back from Apple, with the same names as on every other platform. The count is how many of its 14 mapped endpoints return the field; a field the source lacks is null, never missing. 10 platform-specific fields (ext.<name>) come on top, documented on each endpoint page.
| Field | Type | Endpoints |
|---|---|---|
content.createdAt | ISO 8601 date | 13 |
entity.id | string | 13 |
entity.name | string | 13 |
entity.url | URL | 13 |
media.thumbnailUrl | URL | 12 |
entity.category | string | 7 |
listing.currency | string | 5 |
listing.price | number | 5 |
entity.stats.rating | number | 4 |
package.version | string | 4 |
content.updatedAt | ISO 8601 date | 3 |
entity.stats.ratingCount | integer | 3 |
entity.description | string | 2 |
author.username | string | 1 |
content.id | string | 1 |
content.text | string | 1 |
content.title | string | 1 |
engagement.likes | integer | 1 |
entity.stats.itemCount | integer | 1 |
entity.type | string | 1 |
media.url | URL | 1 |
The full schema is in Unified schema.
Pricing#
Apple calls cost 1 to 5 credits, flat per endpoint. Free when served from cache (0.2 credit for a cached response over 100 KB). Invalid, failed or not-found calls are not charged. See pricing for credit packs.