Xbox
Get ratings and reviews for an Xbox catalog product
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.
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
Query parameters
product_idstring required
Xbox catalog product id
item_countinteger
Number of reviews to return (1-25)
order_by'MostHelpful' | 'MostRecent'
Review sort order
star_filterinteger
Only return reviews with this exact star rating (1-5); omit for all ratings
localestring
Display locale (BCP-47)
Headers
x-api-keystring required
API key required
Response
OK
Example response
{
"code": 200,
"data": {
"product_id": "BT5P2X999VH2",
"ratings": {
"average_rating": 3.3,
"star1_count": 82702,
"star2_count": 8799,
"star3_count": 9863,
"star4_count": 12807,
"star5_count": 112007,
"total_count": 226178
},
"reviews": [
{
"device_family": "Windows.Xbox",
"helpful_negative": 647,
"helpful_positive": 16025,
"rating": 5,
"submitted_date_time": "2024-04-19T18:53:50Z",
"title": "Great game",
"user_name": "Ryder2010676"
}
],
"total_reviews": 91078
},
"msg": "OK"
}Changes
No recorded changes to this operation across all 2 revisions of this API.