# google_play.app_list

**beta** **7 credits** **needs a pack**

Google Play top chart (top free, top paid, top grossing, movers and new releases) for a store country.

`GET /v1/google_play/app_list`

> [!NOTE] **Beta.** This endpoint has not yet been verified against the live source, so fields may be missing or differ until it becomes stable. Failed calls are refunded.

> [!NOTE] **Needs a pack.** Needs a purchased pack and a verified email; free credits do not reach this endpoint. See [pricing](https://onekey.dev/pricing).

## What you get

A list of Google Play 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

- **7 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 |
| --- | --- | --- | --- | --- | --- |
| `app_collection` | string | yes | (required) | Chart: topselling_free, topselling_paid, topgrossing, movers_shakers, topselling_new_free or topselling_new_paid | max 24 chars; must match `topselling_free\|topselling_paid\|topgrossing\|movers_shakers\|topselling_new_free\|topselling_new_paid`; trimmed, lowercased |
| `location_name` | string | no | `United States` | Location to search from, as an English place name (country, region or city) | max 100 chars; must match `[A-Za-z0-9 ,.'()-]{2,100}`; trimmed, repeated spaces collapsed |
| `language_code` | string | no | `en` | Result language, ISO code (en, de, fr-CA ...) | max 8 chars; must match `[a-z]{2}(-[a-z]{2,4})?`; trimmed, lowercased |

## Request

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

```python
import requests

res = requests.get(
    "https://api.onekey.dev/v1/google_play/app_list",
    params={"app_collection": "topselling_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: "topselling_free" });
const res = await fetch(`https://api.onekey.dev/v1/google_play/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 Google Play response, recorded and returned in Onekey's shape. Fields the platform does not provide are `null`.

```json
{
  "success": true,
  "data": [
    {
      "entity": {
        "id": "com.example.photoeditor",
        "name": "Example Photo Editor",
        "url": "https://play.google.com/store/apps/details?id=com.example.photoeditor",
        "stats": {
          "rating": 4.6,
          "ratingCount": 120000,
          "rank": 1
        }
      },
      "media": {
        "thumbnailUrl": "https://play-lh.googleusercontent.com/example1"
      },
      "author": {
        "displayName": "Example Studio",
        "url": "https://play.google.com/store/apps/dev?id=1"
      }
    },
    {
      "entity": {
        "id": "com.example.notes",
        "name": "Example Notes",
        "url": "https://play.google.com/store/apps/details?id=com.example.notes",
        "stats": {
          "rating": 4.2,
          "ratingCount": 8000,
          "rank": 2
        }
      },
      "media": {
        "thumbnailUrl": "https://play-lh.googleusercontent.com/example2"
      },
      "author": {
        "displayName": "Notes Inc",
        "url": "https://play.google.com/store/apps/dev?id=2"
      }
    }
  ],
  "metadata": {
    "platform": "google_play",
    "endpoint": "app_list",
    "cached": false,
    "stale": false,
    "age_s": 0,
    "fetched_at": "2026-01-01T12:00:00+00:00",
    "credits_charged": 7,
    "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 |
| --- | --- | --- |
| `app_id` | `entity.id` | - |
| `title` | `entity.name` | - |
| `url` | `entity.url` | `safeUrl` |
| `icon` | `media.thumbnailUrl` | `safeUrl` |
| `rating.value` | `entity.stats.rating` | `toNumber` |
| `rating.votes_count` | `entity.stats.ratingCount` | `toNumber` |
| `rank_group` | `entity.stats.rank` | `toNumber` |
| `developer` | `author.displayName` | - |
| `developer_url` | `author.url` | `safeUrl` |

## Caching and freshness

- Fresh for about 30 minutes. Repeat calls in that window are served from cache and are free.
- Between 30 minutes and 6 hours 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 1 day more (marked stale).
- A "not found" is remembered for 2 minutes 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: beta (not yet verified against the live source).
