# /xiaomigetapps/apps/search

`POST /api/xiaomigetapps/apps/search`

Price: 5 credits

Search apps on the global Xiaomi GetApps storefront by keyword

## How to use it

Find apps on the global GetApps storefront by keyword. The storefront answers with a keyword-seeded recommendation feed rather than a matcher: the leading entries are the real matches and relevance trails off down the list, and a keyword nothing matches still returns apps instead of an empty set, so never read a non-empty response as proof the app exists. Results are region-scoped — the same keyword returns a different feed per region — and the feed occasionally ends early, so fewer rows than count does not mean the storefront has no more; ask again. Rows are a thin listing card with no category at all; pass package_name to the app endpoint for description, screenshots, version, category and rating detail.

## Parameters

- `access-token` (string, required)

## Request body

- `timeout` (integer) — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
- `keyword` (string, required) — Search term — an app name, a developer name, or a topic (examples: "whatsapp", "photo editor", "mobile bank"; minLength: 1)
- `count` (integer, required) — Max number of results (min: 1)
- `region` (string) — Storefront region as an ISO 3166-1 alpha-2 code. Results differ per region (default: "ID"; examples: "ID", "IN", "BR", "RU", "DE"; minLength: 2; maxLength: 2)
- `language` (string) — Which store-listing localisation to return. Each row's name comes back in this language where the developer published a listing in it, and falls back to the developer's default otherwise. Indonesian is the legacy code in, not id (default: "en"; examples: "en", "ru"; minLength: 2)

## Response

### 200 — Successful Response

- `@type` (string) (default: "XiaomigetappsAppShort")
- `package_name` (string, required)
- `app_id` (string, nullable)
- `name` (string, nullable)
- `developer` (string, nullable)
- `publisher` (string, nullable)
- `category` (string, nullable)
- `category_id` (string, nullable)
- `region` (string, nullable)
- `url` (string, nullable)
- `image` (string, nullable)

## Errors

### 422 — Validation Error

The request body did not validate

What to do: Check the fields against this schema. A URN with the wrong prefix is the most common cause.

- `detail` (array)
  - `loc` (array, required)
  - `msg` (string, required)
  - `type` (string, required)
  - `input` (any)
  - `ctx` (object)

### 408

The request ran past its time limit

What to do: Raise `timeout` in the request body, up to the maximum this endpoint documents. Lowering `count` or turning off the `with_*` flags also helps, because less work finishes sooner.

### 412

The entity was not found, or a precondition failed

What to do: Retrying will not help: either the entity does not exist, or the input points at a different one.

### 429

Too many requests: a rate limit or a usage window is exhausted

What to do: When the response carries an X-Retry-After header, wait that many seconds and retry: the same number is in the body as `detail.retry_after`, and the limit clears once that window passes. The message in the body names the limit that was hit.

### 500

Something broke on our side

What to do: Retrying will not help. If it keeps happening, send us the X-Request-ID from the response headers.

### 529

Rate limit reached, or the endpoint is overloaded

What to do: Wait at least 30 seconds, then retry.

## Response envelope

Success: Array of objects (may be empty if no results)

Error: Error may coexist with partial results if it occurs mid-execution. Check X-Error header and status code.

Every response carries these headers:

- `X-Error` — Error message text (present only on error)
- `X-Request-ID` — Unique request identifier
- `X-Execution-Time` — Execution time in seconds
- `X-Result-Count` — How many records the body carries. 0 means an empty result, which is a normal answer and not by itself an error. A non-zero count can come back together with X-Error when the failure happened partway through — read this header and X-Error independently.
- `X-Total-Available-Results` — How many records exist for this query, when the endpoint can say. On a `dry_run` request this is the answer and the body is empty. It saturates: the endpoint's documented maximum means 'at least that many', any smaller number is exact.
- `X-Warning` — Present when the request body carried keys this endpoint does not document. They were ignored, so any filter you meant to apply through them did not apply. Check the spelling against this schema and retry.
- `X-Retry-After` — Seconds to wait before retrying. Present only on 429.