/similarweb/apps

POST /api/similarweb/apps

Price: 1 credit

Google Play or Apple App Store app with its country ranks, 28-day rank history and audience interests

How to use it

Looks up one app by store id or app URL; the store is taken from the id, numeric for the App Store and a package name for Google Play. Rankings cover only the United States, Germany and Brazil, so for other markets use similarweb/apps/search charts. Use similarweb/apps/autocomplete to turn an app name into an id first.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• app string required — Google Play package name, App Store app id or app page URL (examples: "com.roblox.client", "431946152", "https://play.google.com/store/apps/details?id=com.roblox.client", "https://apps.apple.com/us/app/roblox/id431946152", "https://www.similarweb.com/app/google/com.roblox.client/germany/"; minLength: 1)
• country string — Country of the rankings (default: "united-states"; one of: "united-states", "germany", "brazil"; examples: "united-states", "germany", "brazil")

Response

• @type string (default: "SimilarwebApp")
• id string required
• store string required
• name string nullable
• publisher string nullable
• image string nullable
• rating_count integer nullable
• url string required
• country_code string nullable
• category string nullable
• store_rank integer nullable
• category_store_rank integer nullable
• category_store_rank_change integer nullable
• usage_rank integer nullable
• category_usage_rank integer nullable
• rank_history array (default: [])
  • @type string (default: "SimilarwebAppRankPoint")
  • date string required
  • store_rank integer nullable
  • category_store_rank integer nullable
  • usage_rank integer nullable
  • category_usage_rank integer nullable
• interests array (default: [])
  • @type string (default: "SimilarwebAppInterest")
  • category string required
  • affinity number nullable
  • app_count integer nullable
  • top_apps array (default: [])
    • @type string (default: "SimilarwebAppInterestApp")
    • id string required
    • name string nullable
    • image string nullable
    • affinity number 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 id exists in the store the id belongs to. 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.