/qimai/keywords/apps

POST /api/qimai/keywords/apps

Price: 5 credits

List the apps App Store search returns for a keyword, in search order, with each app's chart ranks, keyword coverage and in-app event

How to use it

position is the place in App Store search results; a kind other than software is an editorial story with its apps in story_apps. keyword_count is how many keywords the app ranks for.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• keyword string required — App Store search keyword (examples: "微信", "vpn"; minLength: 1)
• 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 results to return (min: 1; max: 250)

Response

• @type string (default: "QimaiKeywordApp")
• id string required
• kind string required
• position integer required
• keyword string required
• country string required
• name string nullable
• subtitle string nullable
• image string nullable
• publisher string nullable
• genre string nullable
• size_mb number nullable
• position_change integer nullable
• is_new boolean nullable
• is_online boolean nullable
• is_pre_order boolean nullable
• is_game boolean 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
• keyword_count integer nullable
• top3_keyword_count integer nullable
• event object nullable
  • @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
• label string nullable
• story_app_count integer nullable
• story_apps array (default: [])
  • @type string (default: "QimaiStoryApp")
  • id string required
  • name string nullable
  • subtitle string nullable
  • description string nullable
  • image string nullable
  • genre string nullable
  • price number nullable
  • rating number nullable
  • rating_count integer nullable
  • language string nullable
  • size_mb number nullable
  • is_online boolean nullable
  • release_date integer nullable
  • updated_at 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.