---
title: "Get ratings and reviews for an Xbox catalog product"
method: GET
path: "/xbox/reviews"
tags: ["Xbox"]
---

# Get ratings and reviews for an Xbox catalog product

`GET /xbox/reviews`

## Request

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

Returns a product's aggregate star-rating breakdown (average, total, and per-star counts) and up to item_count written reviews, optionally sorted and/or filtered to one star rating. A product with no reviews yet (e.g. a pre-order) returns a null ratings summary and an empty reviews list, not an error.

## Query parameters

- `product_id` string, required
- `item_count` integer
- `order_by` 'MostHelpful' | 'MostRecent'
- `star_filter` integer
- `locale` string

## Headers

- `x-api-key` string, required

## Response `200`

OK

- XboxReviewsResponseDoc
  - `code` integer
  - `data` XboxReviewsResponse
    - `product_id` string
    - `ratings` XboxRatingsSummary
      - `average_rating` number
      - `star1_count` integer
      - `star2_count` integer
      - `star3_count` integer
      - `star4_count` integer
      - `star5_count` integer
      - `total_count` integer
    - `reviews` XboxReview[]
      - `device_family` string
      - `helpful_negative` integer
      - `helpful_positive` integer
      - `rating` integer
      - `review_id` string
      - `submitted_date_time` string
      - `text` string
      - `title` string
      - `user_name` string
    - `total_reviews` integer
  - `msg` string

## Other responses

- `400`: Bad Request
- `503`: Service Unavailable

---

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