# Apple on Onekey

> 14 endpoints for Apple (13 stable, 1 beta), 1 to 5 credits each. Category: Music & audio. One key, one JSON shape.

Base URL: https://api.onekey.dev
Auth: header `x-api-key: <key>`. Call shape: `GET /v1/{platform}/{endpoint}?{params}`.
Every response is `{success, data, metadata, error}`; check `success` first. Cost is in `metadata.credits_charged`. Free when served from cache (0.2 credit for a cached response over 100 KB). Failed and not-found calls are refunded.
Status: stable = verified against the live source; beta = not yet verified, fields may be missing.

Page: https://onekey.dev/platforms/apple
Reference (Markdown): https://onekey.dev/docs/api/apple.md
All docs: https://onekey.dev/llms.txt

## Canonical fields returned

Unified-schema fields (same names on every platform), with how many of the 14 mapped Apple endpoints return each:

- `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
- plus 10 platform-specific fields under `ext.`

## Endpoints

### apple.app

App Store app details by numeric id (iTunes lookup).
- Price: 1 credit per fresh call. Status: stable. Returns: one record.
- Request: `GET https://api.onekey.dev/v1/apple/app?id=284882215` with header `x-api-key: YOUR_API_KEY`
- Parameters:
  - `id` (string, required): Numeric Apple id
  - `country` (string, optional, default us): Two-letter storefront country code
- Fields returned: `entity.id`, `entity.name`, `entity.description`, `package.version`, `entity.url`, `listing.price`, `listing.currency`, `entity.category`, `entity.stats.rating`, `entity.stats.ratingCount`, `content.createdAt`, `content.updatedAt`, `media.thumbnailUrl`, `ext.bundleId`, `ext.developer`, `ext.contentRating`, `ext.sizeBytes`, `ext.minimumOs`
- Reference: https://onekey.dev/docs/api/apple/app.md

### apple.app_by_bundle

App Store app details by bundle id (iTunes lookup).
- Price: 1 credit per fresh call. Status: stable. Returns: one record.
- Request: `GET https://api.onekey.dev/v1/apple/app_by_bundle?bundle_id=com.facebook.Facebook` with header `x-api-key: YOUR_API_KEY`
- Parameters:
  - `bundle_id` (string, required): Bundle id, e.g. com.spotify.client
  - `country` (string, optional, default us): Two-letter storefront country code
- Fields returned: `entity.id`, `entity.name`, `entity.description`, `package.version`, `entity.url`, `listing.price`, `listing.currency`, `entity.category`, `entity.stats.rating`, `entity.stats.ratingCount`, `content.createdAt`, `content.updatedAt`, `media.thumbnailUrl`, `ext.bundleId`, `ext.developer`, `ext.contentRating`, `ext.sizeBytes`, `ext.minimumOs`
- Reference: https://onekey.dev/docs/api/apple/app_by_bundle.md

### apple.artist

Apple Music/iTunes artist by numeric id.
- Price: 1 credit per fresh call. Status: stable. Returns: one record.
- Request: `GET https://api.onekey.dev/v1/apple/artist?id=909253` with header `x-api-key: YOUR_API_KEY`
- Parameters:
  - `id` (string, required): Numeric Apple id
- Fields returned: `entity.id`, `entity.name`, `entity.url`, `entity.category`, `entity.type`
- Reference: https://onekey.dev/docs/api/apple/artist.md

### apple.reviews

Most recent customer reviews of an App Store app, US storefront first page (RSS JSON).
- Price: 5 credits per fresh call. Status: beta. Returns: a list.
- Request: `GET https://api.onekey.dev/v1/apple/reviews?id=284882215` with header `x-api-key: YOUR_API_KEY`
- Parameters:
  - `id` (string, required): Numeric Apple id
- Fields returned: `content.id`, `content.title`, `content.text`, `content.createdAt`, `author.username`, `entity.stats.rating`, `package.version`, `engagement.likes`
- Reference: https://onekey.dev/docs/api/apple/reviews.md

### apple.search_albums

Search albums in Apple Music/iTunes.
- Price: 5 credits per fresh call. Status: stable. Returns: a list.
- Request: `GET https://api.onekey.dev/v1/apple/search_albums?q=coldplay` with header `x-api-key: YOUR_API_KEY`
- Parameters:
  - `q` (string, required): Search query
  - `country` (string, optional, default us): Two-letter storefront country code
- Fields returned: `entity.id`, `entity.name`, `entity.url`, `media.thumbnailUrl`, `listing.price`, `listing.currency`, `entity.category`, `content.createdAt`, `entity.stats.itemCount`, `ext.artist`
- Reference: https://onekey.dev/docs/api/apple/search_albums.md

### apple.search_apps

Search iOS apps in the App Store.
- Price: 5 credits per fresh call. Status: stable. Returns: a list.
- Request: `GET https://api.onekey.dev/v1/apple/search_apps?q=chess` with header `x-api-key: YOUR_API_KEY`
- Parameters:
  - `q` (string, required): Search query
  - `country` (string, optional, default us): Two-letter storefront country code
- Fields returned: `entity.id`, `entity.name`, `package.version`, `entity.url`, `listing.price`, `listing.currency`, `entity.category`, `entity.stats.rating`, `entity.stats.ratingCount`, `content.createdAt`, `content.updatedAt`, `media.thumbnailUrl`, `ext.bundleId`, `ext.developer`, `ext.contentRating`, `ext.sizeBytes`, `ext.minimumOs`
- Reference: https://onekey.dev/docs/api/apple/search_apps.md

### apple.search_podcasts

Search podcasts in Apple Podcasts.
- Price: 5 credits per fresh call. Status: stable. Returns: a list.
- Request: `GET https://api.onekey.dev/v1/apple/search_podcasts?q=history` with header `x-api-key: YOUR_API_KEY`
- Parameters:
  - `q` (string, required): Search query
  - `country` (string, optional, default us): Two-letter storefront country code
- Fields returned: `entity.id`, `entity.name`, `entity.url`, `media.thumbnailUrl`, `entity.category`, `content.createdAt`, `ext.artist`, `ext.feedUrl`, `ext.episodeCount`
- Reference: https://onekey.dev/docs/api/apple/search_podcasts.md

### apple.search_songs

Search songs in Apple Music/iTunes.
- Price: 1 credit per fresh call. Status: stable. Returns: a list.
- Request: `GET https://api.onekey.dev/v1/apple/search_songs?q=coldplay` with header `x-api-key: YOUR_API_KEY`
- Parameters:
  - `q` (string, required): Search query
  - `country` (string, optional, default us): Two-letter storefront country code
- Fields returned: `entity.id`, `entity.name`, `entity.url`, `media.url`, `media.thumbnailUrl`, `listing.price`, `listing.currency`, `entity.category`, `content.createdAt`, `ext.artist`, `ext.album`, `ext.durationMs`
- Reference: https://onekey.dev/docs/api/apple/search_songs.md

### apple.top_audiobooks

Top audiobooks chart.
- Price: 5 credits per fresh call. Status: stable. Returns: a list.
- Request: `GET https://api.onekey.dev/v1/apple/top_audiobooks` with header `x-api-key: YOUR_API_KEY`
- Parameters:
  - `country` (string, optional, default us): Two-letter storefront country code
- Fields returned: `entity.id`, `entity.name`, `entity.url`, `media.thumbnailUrl`, `content.createdAt`, `ext.artist`
- Reference: https://onekey.dev/docs/api/apple/top_audiobooks.md

### apple.top_books

Top free books chart.
- Price: 5 credits per fresh call. Status: stable. Returns: a list.
- Request: `GET https://api.onekey.dev/v1/apple/top_books` with header `x-api-key: YOUR_API_KEY`
- Parameters:
  - `country` (string, optional, default us): Two-letter storefront country code
- Fields returned: `entity.id`, `entity.name`, `entity.url`, `media.thumbnailUrl`, `content.createdAt`, `ext.artist`
- Reference: https://onekey.dev/docs/api/apple/top_books.md

### apple.top_free_apps

Top free iOS apps chart.
- Price: 5 credits per fresh call. Status: stable. Returns: a list.
- Request: `GET https://api.onekey.dev/v1/apple/top_free_apps` with header `x-api-key: YOUR_API_KEY`
- Parameters:
  - `country` (string, optional, default us): Two-letter storefront country code
- Fields returned: `entity.id`, `entity.name`, `entity.url`, `media.thumbnailUrl`, `content.createdAt`, `ext.artist`
- Reference: https://onekey.dev/docs/api/apple/top_free_apps.md

### apple.top_paid_apps

Top paid iOS apps chart.
- Price: 5 credits per fresh call. Status: stable. Returns: a list.
- Request: `GET https://api.onekey.dev/v1/apple/top_paid_apps` with header `x-api-key: YOUR_API_KEY`
- Parameters:
  - `country` (string, optional, default us): Two-letter storefront country code
- Fields returned: `entity.id`, `entity.name`, `entity.url`, `media.thumbnailUrl`, `content.createdAt`, `ext.artist`
- Reference: https://onekey.dev/docs/api/apple/top_paid_apps.md

### apple.top_podcasts

Top podcasts chart.
- Price: 5 credits per fresh call. Status: stable. Returns: a list.
- Request: `GET https://api.onekey.dev/v1/apple/top_podcasts` with header `x-api-key: YOUR_API_KEY`
- Parameters:
  - `country` (string, optional, default us): Two-letter storefront country code
- Fields returned: `entity.id`, `entity.name`, `entity.url`, `media.thumbnailUrl`, `content.createdAt`, `ext.artist`
- Reference: https://onekey.dev/docs/api/apple/top_podcasts.md

### apple.top_songs

Most-played songs chart.
- Price: 5 credits per fresh call. Status: stable. Returns: a list.
- Request: `GET https://api.onekey.dev/v1/apple/top_songs` with header `x-api-key: YOUR_API_KEY`
- Parameters:
  - `country` (string, optional, default us): Two-letter storefront country code
- Fields returned: `entity.id`, `entity.name`, `entity.url`, `media.thumbnailUrl`, `content.createdAt`, `ext.artist`
- Reference: https://onekey.dev/docs/api/apple/top_songs.md

## Sample request

```bash
curl "https://api.onekey.dev/v1/apple/app?id=284882215" \
  -H "x-api-key: YOUR_API_KEY"
```