/qimai/rankings

POST /api/qimai/rankings

Price: 5 credits

Get a live App Store top chart (free, paid or grossing) for a storefront, device and genre, with each app's overall, category and genre rank and their change, rating and keyword coverage

How to use it

rank is the position in the requested chart; overall_chart, category_chart and genre_chart give the app's rank in the wider charts, positive rank_change meaning it moved up.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• chart string — Top chart (default: "free"; one of: "free", "paid", "grossing")
• genre string — Chart genre (default: "all"; one of: "all", "apps", "business", "weather", "utilities", "travel", "sports", "social_networking", "reference", "productivity", "photo_and_video", "news", "navigation", "music", "lifestyle", "health_and_fitness", "finance", "entertainment", "education", "books", "medical", "magazines_and_newspapers", "food_and_drink", "shopping", "developer_tools", "graphics_and_design", "kids", "games", "games_action", "games_adventure", "games_casual", "games_board", "games_card", "games_casino", "games_family", "games_music", "games_puzzle", "games_racing", "games_role_playing", "games_simulation", "games_sports", "games_strategy", "games_trivia", "games_word")
• device string — Device chart (default: "iphone"; one of: "iphone", "ipad")
• 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")
• count integer required — Max number of apps to return, top rank first (min: 1; max: 200)

Response

• @type string (default: "QimaiChartApp")
• id string required
• rank integer required
• chart string required
• country string required
• device string required
• name string nullable
• subtitle string nullable
• image string nullable
• publisher string nullable
• company object nullable
  • @type string (default: "QimaiCompany")
  • id string required
  • name string nullable
• price number nullable
• rating number nullable
• rating_count integer nullable
• keyword_count integer nullable
• top3_keyword_count integer nullable
• days_at_first integer nullable
• last_release_date integer nullable
• overall_chart object nullable
  • @type string (default: "QimaiChartPosition")
  • chart string nullable
  • rank integer nullable
  • rank_change integer nullable
• category_chart object nullable
  • @type string (default: "QimaiChartPosition")
  • chart string nullable
  • rank integer nullable
  • rank_change integer nullable
• genre_chart object nullable
  • @type string (default: "QimaiChartPosition")
  • chart string nullable
  • rank integer nullable
  • rank_change 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 — 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.