---
title: "Retrieve App Store ratings histogram"
method: GET
path: "/appstore/ratings"
tags: ["AppStore"]
---

# Retrieve App Store ratings histogram

`GET /appstore/ratings`

## Request

- Base URL: `https://api.crawlora.net/api/v1`
- URL: `https://api.crawlora.net/api/v1/appstore/ratings`
- Auth: API key in header `x-api-key`

Returns the total `ratings` count and the 1 to 5 star `histogram` for an App Store app. Identify it with either the numeric track `id` or the bundle ID `app_id`; a bundle ID is resolved to the track ID first, and a non-numeric `id` returns 400. `country` and `lang` are optional.

## Query parameters

- `id` string
- `app_id` string
- `country` string
- `lang` string

## Headers

- `x-api-key` string, required

## Response `200`

OK

- AppstoreRatingsResponseDoc
  - `code` integer
  - `data` AppstoreRatingsResult
    - `histogram` object: Number of ratings for each star value, keyed by star value.
    - `ratings` integer: Total number of user ratings.
  - `msg` string

## Other responses

- `400`: Missing or invalid parameters
- `404`: App not found
- `429`: Rate limit exceeded
- `500`: Internal server error

---

[API](https://skmtc.dev/crawlora/apis/crawlora-api.md) · [All operations](https://skmtc.dev/crawlora/apis/crawlora-api/llms.txt) · [OpenAPI document](https://skmtc.dev/crawlora/apis/crawlora-api/revisions/0497899e2016?raw)