/xiaomigetapps/apps/categories

POST /api/xiaomigetapps/apps/categories

Price: 5 credits

List apps in one category of the global Xiaomi GetApps storefront

How to use it

Walk one category of the global GetApps storefront, roughly in the order the storefront ranks it. The catalogue is region-scoped and a category can be empty in a region that does not carry it — game_casino is empty in ID, for instance — which is 200 with an empty list. The storefront serves the category from two backends holding different slices, so two calls with the same arguments return overlapping but not identical sets, and a row's name can come back in a language nobody asked for and change on the next call; ask for more than you need if you want coverage, and key on package_name. A listing can also include apps the region does not serve, which then answer 412 from the app endpoint. Each row is a thin listing card, not the full record — pass its package_name to the app endpoint for description, screenshots, version and rating detail.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• category string required — Storefront category. Members prefixed with game_ belong to the games vertical (one of: "art_and_design", "auto_and_vehicles", "beauty", "books_and_reference", "business", "comics", "communication", "dating", "education", "entertainment", "events", "finance", "food_and_drink", "health_and_fitness", "house_and_home", "libraries_and_demo", "lifestyle", "maps_and_navigation", "medical", "music_and_audio", "news_and_magazines", "parenting", "personalization", "photography", "productivity", "shopping", "social", "sports", "tools", "travel_and_local", "video_players_and_editors", "weather", "game_action", "game_adventure", "game_arcade", "game_board", "game_card", "game_casino", "game_casual", "game_educational", "game_music", "game_puzzle", "game_racing", "game_role_playing", "game_simulation", "game_sports", "game_strategy", "game_trivia", "game_word")
• count integer required — Max number of results (min: 1)
• region string — Storefront region as an ISO 3166-1 alpha-2 code. Each region has its own catalogue (default: "ID"; examples: "ID", "IN", "BR", "RU", "DE"; minLength: 2; maxLength: 2)
• language string — Which store-listing localisation to ask for. This category listing honours it only partly — one of the two backends serving it returns a row's name in whatever language it holds, so read package_name rather than matching on name. Indonesian is the legacy code in, not id (default: "en"; examples: "en", "ru"; minLength: 2)

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 — The request body did not validate Check the fields against this schema. A URN with the wrong prefix is the most common cause.
• 408 — The request ran past its time limit 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 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 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 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 Wait at least 30 seconds, then retry.

Response 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.