# App Store on Onekey

> 7 endpoints for App Store (5 stable, 2 beta), 1 to 2 credits each. Category: E-commerce & marketplaces. 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.
Access: 2 of 7 endpoints are marked "needs a pack" or "may need a pack": free-grant credits reach only the open fetch path; a verified email and a purchased pack unlock the rest.

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

## Canonical fields returned

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

- `entity.id` (string): 6
- `entity.name` (string): 6
- `entity.url` (URL): 4
- `author.displayName` (string): 3
- `entity.category` (string): 3
- `media.thumbnailUrl` (URL): 3
- `entity.description` (string): 2
- `entity.releaseDate` (ISO 8601 date): 2
- `listing.currency` (string): 2
- `listing.price` (number): 2
- `content.title` (string): 1
- `content.url` (URL): 1
- `entity.country` (string): 1
- `entity.stats.rating` (number): 1
- `entity.stats.ratingCount` (integer): 1
- `entity.type` (string): 1
- `package.version` (string): 1
- plus 1 platform-specific field under `ext.`

## Endpoints

### app_store.app_chart

App Store chart for a storefront, including top grossing and new apps.
- Price: 1 credit per fresh call. Status: stable. Returns: a list.
- Request: `GET https://api.onekey.dev/v1/app_store/app_chart?app_collection=topgrossingapplications` with header `x-api-key: YOUR_API_KEY`
- Parameters:
  - `app_collection` (string, optional, default topgrossingapplications): Chart: topfreeapplications, toppaidapplications, topgrossingapplications, newapplications, newfreeapplications or newpaidapplications
  - `country` (string, optional, default us): Two-letter storefront country code
- Fields returned: `entity.id`, `entity.name`, `entity.url`, `author.displayName`, `media.thumbnailUrl`, `entity.category`, `listing.price`, `listing.currency`, `entity.releaseDate`, `entity.description`, `ext.bundleId`
- Reference: https://onekey.dev/docs/api/app_store/app_chart.md

### app_store.app_list

Apple App Store top charts for a storefront (free or paid).
- Price: 1 credit per fresh call. Status: stable. Returns: a list.
- Request: `GET https://api.onekey.dev/v1/app_store/app_list?app_collection=top-free` with header `x-api-key: YOUR_API_KEY`
- Parameters:
  - `app_collection` (string, optional, default top-free): Chart: top-free or top-paid
  - `country` (string, optional, default us): Two-letter storefront country code
- Fields returned: `entity.id`, `entity.name`, `entity.url`, `media.thumbnailUrl`, `author.displayName`, `entity.category`, `entity.releaseDate`
- Reference: https://onekey.dev/docs/api/app_store/app_list.md

### app_store.app_listings_search

Search Apple App Store apps by title: rating, price, developer, category, version.
- Price: 1 credit per fresh call. Status: stable. Returns: a list.
- Request: `GET https://api.onekey.dev/v1/app_store/app_listings_search?title=photo%20editor` with header `x-api-key: YOUR_API_KEY`
- Parameters:
  - `title` (string, required): App title or keywords
  - `country` (string, optional, default us): Two-letter storefront country code
- Fields returned: `entity.id`, `entity.name`, `entity.url`, `entity.description`, `entity.category`, `entity.stats.rating`, `entity.stats.ratingCount`, `author.displayName`, `media.thumbnailUrl`, `listing.price`, `listing.currency`, `package.version`, `ext.bundleId`
- Reference: https://onekey.dev/docs/api/app_store/app_listings_search.md

### app_store.categories

App Store app categories (genre ids and names) for a storefront.
- Price: 1 credit per fresh call. Status: stable. Returns: a list.
- Request: `GET https://api.onekey.dev/v1/app_store/categories?country=us` 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`
- Reference: https://onekey.dev/docs/api/app_store/categories.md

### app_store.languages

Languages supported for App Store lookups (code and name).
- Price: 2 credits per fresh call. Status: beta. Access: needs a pack. Returns: a list.
- Request: `GET https://api.onekey.dev/v1/app_store/languages` with header `x-api-key: YOUR_API_KEY`
- Parameters: none
- Fields returned: `entity.id`, `entity.name`
- Reference: https://onekey.dev/docs/api/app_store/languages.md

### app_store.locations

Storefront locations supported for App Store lookups (code, name, country).
- Price: 2 credits per fresh call. Status: beta. Access: needs a pack. Returns: a list.
- Request: `GET https://api.onekey.dev/v1/app_store/locations` with header `x-api-key: YOUR_API_KEY`
- Parameters: none
- Fields returned: `entity.id`, `entity.name`, `entity.country`, `entity.type`
- Reference: https://onekey.dev/docs/api/app_store/locations.md

### app_store.search_suggestions

App Store search autocomplete suggestions for a partial keyword.
- Price: 1 credit per fresh call. Status: stable. Returns: a list.
- Request: `GET https://api.onekey.dev/v1/app_store/search_suggestions?query=pho` with header `x-api-key: YOUR_API_KEY`
- Parameters:
  - `query` (string, required): Partial search keyword to autocomplete
- Fields returned: `content.title`, `content.url`
- Reference: https://onekey.dev/docs/api/app_store/search_suggestions.md

## Sample request

```bash
curl "https://api.onekey.dev/v1/app_store/app_chart?app_collection=topgrossingapplications" \
  -H "x-api-key: YOUR_API_KEY"
```