# app_store.app_listings_search

**stable** **Standard**

Search Apple App Store apps by title: rating, price, developer, category, version.

`GET /v1/app_store/app_listings_search`

## 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-search`, `/app_store/app-listings-search` 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 |
| --- | --- | --- | --- | --- | --- |
| `title` | string | yes | (required) | App title or keywords | max 200 chars; must match `[^\r\n]{1,200}`; trimmed, repeated spaces collapsed |
| `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_listings_search?title=photo%20editor" \
  -H "x-api-key: YOUR_API_KEY"
```

```python
import requests

res = requests.get(
    "https://api.onekey.dev/v1/app_store/app_listings_search",
    params={"title": "photo editor"},
    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({ title: "photo editor" });
const res = await fetch(`https://api.onekey.dev/v1/app_store/app_listings_search?${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": 587366035,
        "name": "Picsart AI Photo Editor, Video",
        "url": "https://apps.apple.com/us/app/picsart-ai-photo-editor-video/id587366035?uo=4",
        "description": "Ignite your creative potential with Picsart — the all-in-one AI photo editor, AI video editor, and design studio that’s free and easy to use. From business designs to AI art, go from inspiration to cr",
        "category": "Photo & Video",
        "stats": {
          "rating": 4.66533,
          "ratingCount": 1195576
        }
      },
      "author": {
        "displayName": "PicsArt, Inc."
      },
      "media": {
        "thumbnailUrl": "https://is1-ssl.mzstatic.com/image/thumb/Purple211/v4/90/74/ad/9074ad22-9ac6-8a59-364c-14ea2ada5608/AppIcon-0-0-1x_U007emarketing-0-8-0-sRGB-85-220.png/100x100bb.jpg"
      },
      "listing": {
        "price": 0,
        "currency": "USD"
      },
      "package": {
        "version": "30.9.1"
      },
      "ext": {
        "bundleId": "com.picsart.studio"
      }
    },
    {
      "entity": {
        "id": 998411110,
        "name": "Airbrush: Face Photo Editor",
        "url": "https://apps.apple.com/us/app/airbrush-face-photo-editor/id998411110?uo=4",
        "description": "Master Your Selfie Game with Airbrush – The Ultimate Photo and Video Editor! With our easy-to-use features, you can master your selfie and photo with tools designed to enhance your natural beauty whil",
        "category": "Photo & Video",
        "stats": {
          "rating": 4.79643,
          "ratingCount": 203105
        }
      },
      "author": {
        "displayName": "PIXOCIAL TECHNOLOGY (SINGAPORE) PTE. LTD."
      },
      "media": {
        "thumbnailUrl": "https://is1-ssl.mzstatic.com/image/thumb/Purple211/v4/84/13/99/84139961-ba84-c40c-3112-f50348bdfccc/AppIcon-0-0-1x_U007emarketing-0-11-0-85-220.png/100x100bb.jpg"
      },
      "listing": {
        "price": 0,
        "currency": "USD"
      },
      "package": {
        "version": "8.17.0"
      },
      "ext": {
        "bundleId": "com.magicv.AirBrush"
      }
    }
  ],
  "metadata": {
    "platform": "app_store",
    "endpoint": "app_listings_search",
    "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 |
| --- | --- | --- |
| `trackId` | `entity.id` | `toNumber` |
| `trackName` | `entity.name` | - |
| `trackViewUrl` | `entity.url` | `safeUrl` |
| `description` | `entity.description` | - |
| `primaryGenreName` | `entity.category` | - |
| `averageUserRating` | `entity.stats.rating` | `toNumber` |
| `userRatingCount` | `entity.stats.ratingCount` | `toNumber` |
| `sellerName` | `author.displayName` | - |
| `artworkUrl100` | `media.thumbnailUrl` | `safeUrl` |
| `price` | `listing.price` | `toNumber` |
| `currency` | `listing.currency` | - |
| `version` | `package.version` | - |
| `bundleId` | `ext.bundleId` | - |

## Caching and freshness

- Fresh for about 2 minutes. Repeat calls in that window are served from cache and are free.
- Between 2 minutes and 15 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 1 hour 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).