# app_store.app_list

**stable** **Standard**

Apple App Store top charts for a storefront (free or paid).

`GET /v1/app_store/app_list`

## What you get

A list of App Store 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.

**Also known as:** `/app_store/app-list` on APIs that nest their paths. See [Alternatives and equivalents](https://onekey.dev/docs/alternatives.md).

## What it costs

- **Standard · 1 credit** 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 |
| --- | --- | --- | --- | --- | --- |
| `app_collection` | string | no | `top-free` | Chart: top-free or top-paid | max 12 chars; must match `top-free\|top-paid`; trimmed, lowercased |
| `country` | string | no | `us` | Two-letter storefront country code | max 2 chars; must match `[a-z]{2}`; trimmed, lowercased |

## Request

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

```python
import requests

res = requests.get(
    "https://api.onekey.dev/v1/app_store/app_list",
    params={"app_collection": "top-free"},
    headers={"x-api-key": "YOUR_API_KEY"},
)
body = res.json()

if body["success"]:
    print(body["data"])
else:
    print(body["error"]["code"], body["error"]["message"])
```

```javascript
const params = new URLSearchParams({ app_collection: "top-free" });
const res = await fetch(`https://api.onekey.dev/v1/app_store/app_list?${params}`, {
  headers: { "x-api-key": "YOUR_API_KEY" },
});
const body = await res.json();

if (body.success) console.log(body.data);
else console.error(body.error.code, body.error.message);
```

## Recorded response

A real App Store response, recorded and returned in Onekey's shape. Fields the platform does not provide are `null`.

```json
{
  "success": true,
  "data": [
    {
      "entity": {
        "id": "6760173601",
        "name": "Muse from Meta",
        "url": "https://apps.apple.com/us/app/muse-from-meta/id6760173601",
        "category": null,
        "releaseDate": "2026-09-08T00:00:00Z"
      },
      "media": {
        "thumbnailUrl": "https://is1-ssl.mzstatic.com/image/thumb/Purple211/v4/14/f4/82/14f482a9-e97f-ae33-f898-253dea69396b/HatchAppIconPublic-0-0-1x_U007ephone-0-1-0-sRGB-0-85-220.png/100x100bb.png"
      },
      "author": {
        "displayName": "Meta Platforms, Inc."
      }
    },
    {
      "entity": {
        "id": "6448311069",
        "name": "ChatGPT",
        "url": "https://apps.apple.com/us/app/chatgpt/id6448311069",
        "category": null,
        "releaseDate": "2023-05-18T00:00:00Z"
      },
      "media": {
        "thumbnailUrl": "https://is1-ssl.mzstatic.com/image/thumb/Purple211/v4/eb/c5/b3/ebc5b3a0-618f-6c84-492f-05d113191648/AppIcon-0-0-1x_U007epad-0-0-0-1-0-85-220.png/100x100bb.png"
      },
      "author": {
        "displayName": "OpenAI OpCo, LLC"
      }
    }
  ],
  "metadata": {
    "platform": "app_store",
    "endpoint": "app_list",
    "cached": false,
    "stale": false,
    "age_s": 0,
    "fetched_at": "2026-01-01T12:00:00+00:00",
    "credits_charged": 1,
    "request_id": "7f3a9c2e5b1d4c8fa2e6d0b9c4f18e37"
  },
  "error": null
}
```

## Field mapping

How this endpoint's source fields become Onekey's [unified schema](https://onekey.dev/docs/schema.md). Fields the source lacks come back as `null`.

| Source path | Onekey field | Transform |
| --- | --- | --- |
| `id` | `entity.id` | - |
| `name` | `entity.name` | - |
| `url` | `entity.url` | `safeUrl` |
| `artworkUrl100` | `media.thumbnailUrl` | `safeUrl` |
| `artistName` | `author.displayName` | - |
| `genres.0.name` | `entity.category` | - |
| `releaseDate` | `entity.releaseDate` | `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: 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 15 minutes 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](https://onekey.dev/pricing); 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](https://onekey.dev/docs/errors.md) for the full list and retry guidance.

Status: stable (verified against the live source).