/appbrain/apps/ranking

POST /api/appbrain/apps/ranking

Price: 10 credits

Get the Google Play top-chart ranking for a list type, category and country

How to use it

Get the current Google Play top-chart ranking as tracked by AppBrain, for a given list type (top free, top paid, top grossing, top new free, top new paid), app category, and country. Returns a ranked list of apps, each with its rank, position movement, package name, name, developer, category, rating, total and recent install estimates, and icon.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• list_type string — Google Play chart list type (default: "top_free"; one of: "top_free", "top_paid", "top_grossing", "top_new_free", "top_new_paid")
• category string — App category (all = overall chart) (default: "all"; one of: "all", "application", "game", "art_design", "auto", "beauty", "books_reference", "business", "comics", "communication", "dating", "education", "entertainment", "events", "finance", "food_drink", "health_fitness", "house_home", "libraries_demo", "lifestyle", "transportation", "medical", "music_audio", "news_magazines", "parenting", "personalization", "photography", "productivity", "shopping", "social", "sports", "tools", "travel_local", "media_video", "weather", "action", "adventure", "arcade", "board", "card", "casino", "casual", "educational", "music", "puzzle", "racing", "role_playing", "simulation", "sports_games", "strategy", "trivia", "word")
• country string — Country of the Google Play chart (default: "us"; one of: "au", "at", "be", "br", "ca", "cz", "dk", "fi", "fr", "de", "in", "id", "ir", "it", "jp", "mx", "nl", "no", "pl", "pt", "ru", "sa", "sk", "kr", "es", "se", "ch", "tr", "gb", "us")
• count integer required — Max number of ranked apps to return (min: 1)

Response

• @type string (default: "AppbrainRankingApp")
• rank integer required
• movement integer nullable
• package_name string required
• name string required
• alias string nullable
• developer string nullable
• developer_url string nullable
• category string nullable
• rating number nullable
• install_count integer nullable
• recent_install_count integer nullable
• image string nullable
• google_play_url string 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.