/qimai/keywords

POST /api/qimai/keywords

Price: 5 credits

Get an App Store keyword's Qimai metrics: search index, popularity, number of search results, estimated daily searches, related keywords and the apps bidding on it in Apple Search Ads

How to use it

search_index is Qimai's App Store search popularity score for the keyword. Use qimai/keywords/apps for the apps ranking under the keyword and qimai/keywords/history for the search index over time.

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")

Response

• @type string (default: "QimaiKeyword")
• id string required
• keyword string required
• country string required
• search_index integer nullable
• popularity integer nullable
• result_count integer nullable
• daily_searches_min integer nullable
• daily_searches_max integer nullable
• ad_app_count integer nullable
• new_app_count integer nullable
• dropped_app_count integer nullable
• related_keywords array (default: [])
  • @type string (default: "QimaiRelatedKeyword")
  • id string nullable
  • keyword string required
  • search_index integer nullable
  • popularity integer nullable
• ad_apps array (default: [])
  • @type string (default: "QimaiKeywordAdApp")
  • id string required
  • name string nullable
  • image string nullable
  • publisher string nullable
  • description string 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

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 — Qimai has no record of this keyword in that 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.