Xbox API endpoint
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.
/xbox/reviewsQuery parameters:
product_id (required) — Xbox catalog product id.item_count (optional, default 10) — number of reviews to return, 1-25.order_by (optional, default MostHelpful) — one of MostHelpful, MostRecent.star_filter (optional) — only return reviews with this exact star rating, 1-5. Omit for all ratings.locale (optional, default en-US) — display locale (BCP-47).Returns product_id, ratings (omitted entirely when the product has no reviews yet: average_rating, total_count, star1_count..star5_count), total_reviews, and reviews[] (review_id, title, text, rating, user_name, helpful_positive, helpful_negative, submitted_date_time, device_family).
Example response (truncated):
{"code":200,"msg":"OK","data":{"product_id":"BT5P2X999VH2","ratings":{"average_rating":3.3,"total_count":226178,"star1_count":82702,"star2_count":8799,"star3_count":9863,"star4_count":12807,"star5_count":112007},"total_reviews":91078,"reviews":[{"review_id":"abc","title":"Great","text":"Fun game","rating":5,"user_name":"Foo","helpful_positive":10,"helpful_negative":1,"submitted_date_time":"2024-04-19T18:53:50.895337","device_family":"Windows.Xbox"}]}}
| Field | In the sample | Value in the sample |
|---|---|---|
| product_id | Has a value | |
| total_reviews | Has a value | 0 |
| reviews | Empty |
| Parameter | Type | Required | Default | Description | Example |
|---|---|---|---|---|---|
| product_id | string | Yes | Xbox catalog product id | BT5P2X999VH2 | |
| item_count | integer | No | Number of reviews to return (1-25) | ||
| order_by | string | No | Review sort order Allowed values: MostHelpful, MostRecent. | ||
| star_filter | integer | No | Only return reviews with this exact star rating (1-5); omit for all ratings | ||
| locale | string | No | Display locale (BCP-47) | ||
| x-api-key (header) | string | Yes | API key required |
curl -X GET "https://api.crawlora.net/api/v1/xbox/reviews?product_id=BT5P2X999VH2&order_by=MostHelpful" \ -H "x-api-key: $CRAWLORA_API_KEY"
{
"code": 200,
"msg": "OK",
"data": {
"product_id": "BT5P2X999VH2",
"ratings": {
"average_rating": 3.3,
"total_count": 226178,
"star1_count": 82702,
"star2_count": 8799,
"star3_count": 9863,
"star4_count": 12807,
"star5_count": 112007
},
"total_reviews": 91078,
"reviews": [
{
"review_id": "abc",
"title": "Great",
"text": "Fun game",
"rating": 5,
"user_name": "Foo",
"helpful_positive": 10,
"helpful_negative": 1,
"submitted_date_time": "2024-04-19T18:53:50.895337",
"device_family": "Windows.Xbox"
}
]
}
}Request schema
No body schema
Response schema
#/definitions/xbox.reviewsResponseDoc
| Field | Type | Required | Enum | Bounds | Example | Description |
|---|---|---|---|---|---|---|
| code | integer | No | 200 | |||
| data | xbox.ReviewsResponse | No | ||||
| data.product_id | string | No | BT5P2X999VH2 | |||
| data.ratings | xbox.RatingsSummary | No | ||||
| data.ratings.average_rating | number | No | 3.3 | |||
| data.ratings.star1_count | integer | No | 82702 | |||
| data.ratings.star2_count | integer | No | 8799 | |||
| data.ratings.star3_count | integer | No | 9863 | |||
| data.ratings.star4_count | integer | No | 12807 | |||
| data.ratings.star5_count | integer | No | 112007 | |||
| data.ratings.total_count | integer | No | 226178 | |||
| data.reviews | array | No | ||||
| data.reviews[].device_family | string | No | Windows.Xbox | |||
| data.reviews[].helpful_negative | integer | No | 647 | |||
| data.reviews[].helpful_positive | integer | No | 16025 | |||
| data.reviews[].rating | integer | No | 5 | |||
| data.reviews[].review_id | string | No | ||||
| data.reviews[].submitted_date_time | string | No | 2024-04-19T18:53:50Z | |||
| data.reviews[].text | string | No | ||||
| data.reviews[].title | string | No | Great game | |||
| data.reviews[].user_name | string | No | Ryder2010676 | |||
| data.total_reviews | integer | No | 91078 | |||
| msg | string | No | OK |
| Status | Description | Schema |
|---|---|---|
| 400 | Bad Request | #/definitions/app.Response |
| 503 | Service Unavailable | #/definitions/app.Response |
Use environment variables for secrets and keep Crawlora API keys server-side.
curl -X GET "https://api.crawlora.net/api/v1/xbox/reviews?product_id=BT5P2X999VH2&order_by=MostHelpful" \
-H "x-api-key: $CRAWLORA_API_KEY"