/qimai/apps

POST /api/qimai/apps

Price: 20 credits

Get an App Store app's Qimai profile: store listing, genre and live chart rank, ratings by star, yesterday's download estimate, in-app purchases, screenshots, App Store in-app events and its Android and Google Play listings

How to use it

yesterday_download_count is Qimai's estimate. store_listings[].qimai_android_id is the id qimai/rankings/android rows carry, not a Google Play package. qimai/apps/versions, qimai/apps/reviews and qimai/apps/change-log take the same app id.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• app string required — App Store app id or app link (examples: "414478124", "https://apps.apple.com/cn/app/id414478124")
• country string — App Store storefront (default: "cn"; one of: "ae", "af", "ag", "ai", "al", "am", "ao", "ar", "at", "au", "az", "ba", "bb", "be", "bf", "bg", "bh", "bj", "bm", "bn", "bo", "br", "bs", "bt", "bw", "by", "bz", "ca", "cg", "ch", "ci", "cl", "cm", "cn", "co", "cr", "cv", "cy", "cz", "de", "dk", "dm", "do", "dz", "ec", "ee", "eg", "es", "fi", "fj", "fm", "fr", "ga", "gb", "gd", "ge", "gh", "gm", "gr", "gt", "gw", "gy", "hk", "hn", "hr", "hu", "id", "ie", "il", "in", "is", "it", "jm", "jo", "jp", "ke", "kg", "kh", "kn", "kr", "kw", "ky", "kz", "la", "lb", "lc", "lk", "lr", "lt", "lu", "lv", "ly", "ma", "md", "me", "mg", "mk", "ml", "mm", "mn", "mo", "mr", "ms", "mt", "mu", "mv", "mw", "mx", "my", "mz", "na", "ne", "ng", "ni", "nl", "no", "np", "nr", "nz", "om", "pa", "pe", "pg", "ph", "pk", "pl", "pt", "pw", "py", "qa", "ro", "rs", "ru", "rw", "sa", "sb", "sc", "se", "sg", "si", "sk", "sl", "sn", "sr", "st", "sv", "sz", "tc", "td", "th", "tj", "tm", "tn", "to", "tr", "tt", "tw", "tz", "ua", "ug", "us", "uy", "uz", "vc", "ve", "vg", "vn", "vu", "ye", "yk", "za", "zm", "zw")

Response

• @type string (default: "QimaiApp")
• id string required
• country string required
• name string nullable
• subtitle string nullable
• image string nullable
• url string nullable
• description string nullable
• promotional_text string nullable
• release_notes string nullable
• genre string nullable
• genre_id string nullable
• genre_rank integer nullable
• live_chart object nullable
  • @type string (default: "QimaiChartPosition")
  • chart string nullable
  • rank integer nullable
  • rank_change integer nullable
• price number nullable
• is_game boolean nullable
• is_online boolean nullable
• is_pre_order boolean nullable
• publisher string nullable
• publisher_id string nullable
• seller string nullable
• company object nullable
  • @type string (default: "QimaiCompany")
  • id string required
  • name string nullable
• copyright string nullable
• bundle_id string nullable
• version string nullable
• size string nullable
• age_rating string nullable
• compatibility string nullable
• languages array (default: [])
• storefronts array (default: [])
• supports_apple_watch boolean nullable
• supports_vision_pro boolean nullable
• has_family_sharing boolean nullable
• privacy_policy_url string nullable
• support_url string nullable
• release_date integer nullable
• last_release_date integer nullable
• in_app_purchase_count integer nullable
• in_app_purchases array (default: [])
  • @type string (default: "QimaiInAppPurchase")
  • name string required
  • price number nullable
  • currency string nullable
• yesterday_download_count integer nullable
• ratings object nullable
  • @type string (default: "QimaiRatingBreakdown")
  • rating number nullable
  • rating_count integer nullable
  • one_star_count integer nullable
  • two_star_count integer nullable
  • three_star_count integer nullable
  • four_star_count integer nullable
  • five_star_count integer nullable
• current_version_ratings object nullable
  • @type string (default: "QimaiRatingBreakdown")
  • rating number nullable
  • rating_count integer nullable
  • one_star_count integer nullable
  • two_star_count integer nullable
  • three_star_count integer nullable
  • four_star_count integer nullable
  • five_star_count integer nullable
• ratings_updated_at integer nullable
• screenshots array (default: [])
  • @type string (default: "QimaiScreenshotSet")
  • device string required
  • images array (default: [])
• videos array (default: [])
  • @type string (default: "QimaiVideo")
  • device string nullable
  • url string required
  • thumbnail string nullable
• similar_apps array (default: [])
  • @type string (default: "QimaiRelatedApp")
  • id string required
  • name string nullable
  • image string nullable
• store_listings array (default: [])
  • @type string (default: "QimaiStoreListing")
  • store string required
  • qimai_android_id string required
  • name string nullable
  • image string nullable
  • developer string nullable
• events array (default: [])
  • @type string (default: "QimaiAppEvent")
  • name string required
  • label string nullable
  • badge string nullable
  • kind string nullable
  • subtitle string nullable
  • description string nullable
  • image string nullable
  • url string nullable
  • starts_at integer nullable
  • ends_at integer nullable
  • start_date integer nullable
  • end_date integer 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 Store app with that id in this storefront. 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.