/xiaomigetapps/apps

POST /api/xiaomigetapps/apps

Price: 1 credit

Get a Xiaomi GetApps app by its Android package name

How to use it

Look up one app on the global GetApps storefront by Android package name; a GetApps details URL is accepted and the package is taken out of it. The record is region-scoped: rating, install count and category rank all change with region, and an app that is not distributed to the region you ask for answers 412 rather than an empty record, so a miss in one region does not mean the app is absent from the storefront. Read region_ratings for the per-region scores the storefront holds, including the Google Play score it shows alongside its own. GetApps publishes no user reviews at all.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• package_name string required — Android package name, or a GetApps app URL (examples: "com.instagram.android", "com.zhiliaoapp.musically", "https://global.app.mi.com/details?id=com.whatsapp"; minLength: 1)
• region string — Storefront region as an ISO 3166-1 alpha-2 code. Every app is distributed to its own set of regions, and the record is returned only for a region that app is distributed to (default: "ID"; examples: "ID", "IN", "BR", "RU", "DE"; minLength: 2; maxLength: 2)
• language string — Which store-listing localisation to return. It selects the category label, and also the name, summary, description and changelog where the developer published a listing in that language; everything else falls back to the developer's default. Indonesian is the legacy code in, not id (default: "en"; examples: "en", "de", "ru"; minLength: 2)

Response

• @type string (default: "XiaomigetappsApp")
• package_name string required
• app_id string nullable
• name string nullable
• summary string nullable
• description string nullable
• changelog string nullable
• developer string nullable
• developer_id string nullable
• publisher string nullable
• category string nullable
• category_id string nullable
• category_rank integer nullable
• version string nullable
• version_code string nullable
• apk_size integer nullable
• updated_at integer nullable
• rating number nullable
• editor_rating number nullable
• download_count integer nullable
• region string nullable
• regions array (default: [])
• region_ratings array (default: [])
  • @type string (default: "XiaomigetappsRegionRating")
  • region string required
  • rating number nullable
  • google_play_rating number nullable
• permissions array (default: [])
• web_url string nullable
• url string nullable
• image string nullable
• screenshots array (default: [])
• package object nullable
  • @type string (default: "XiaomigetappsAppPackage")
  • apk_hash string nullable
  • apk_size integer nullable
  • release_key_hash string nullable
  • version string nullable
  • version_code 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 — No app with this package name is distributed to the requested region 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.