Xbox API endpoint
Returns Xbox catalog details for a single product id: title, description, publisher, categories, supported platforms, content rating, price, preorder status, media (box art, poster, hero art), trailers, and which subscriptions (e.g. Game Pass) include it.
/xbox/gameQuery parameters:
product_id (required) — Xbox catalog product id: a 12-character alphanumeric StoreId (e.g. 9PK3G146XXVF). This is the same id format the Microsoft Store family uses — Xbox and Microsoft Store share the same underlying catalog.locale (optional, default en-US) — display locale (BCP-47).Returns every field /xbox/browse returns for a catalog item, plus:
description — full listing description.short_description — the shorter promotional blurb.has_add_ons — whether the product has purchasable add-on content.included_with_subscription_ids[] — product ids of the subscriptions (e.g. Game Pass Ultimate, Game Pass for PC, EA Play, Ubisoft+) that include this title, if any.videos[] — trailers/gameplay clips, each with title, url (an HLS .m3u8 manifest), preview_image_url, width, height.An unknown product_id returns 404.
Example response (truncated):
{"code":200,"msg":"OK","data":{"product_id":"9PK3G146XXVF","title":"Call of Duty®: Modern Warfare® 4 - Vault Edition","publisher":"Activision Publishing Inc.","product_kind":"Game","categories":["Shooter"],"available_on":["PC"],"content_rating":{"board":"ESRB","rating":"MATURE 17+","age":17,"descriptors":["Blood and Gore","Intense Violence"]},"price":{"list_price":99.99,"msrp":99.99,"currency":"USD","is_free":false},"is_preorder":true,"box_art_url":"https://store-images.s-microsoft.com/image/apps.46360...","description":"Pre-order loyalty discount...","has_add_ons":true,"included_with_subscription_ids":[],"url":"https://www.xbox.com/en-US/games/store/game/9pk3g146xxvf"}}
| Field | Filled in, of 7 checked | Values in the sample |
|---|---|---|
| title | 7 | “Call of Duty: Modern Warfare 4 - Campaign Early Access” and 6 other values |
| url | 7 | cdn.trailers.xboxservices.com |
| preview_image_url | 7 | store-images.s-microsoft.com |
| width | 7 | |
| height | 7 |
| Parameter | Type | Required | Default | Description | Example |
|---|---|---|---|---|---|
| product_id | string | Yes | Xbox catalog product id | 9PK3G146XXVF | |
| 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/game?product_id=9PK3G146XXVF" \ -H "x-api-key: $CRAWLORA_API_KEY"
{
"code": 200,
"msg": "OK",
"data": {
"product_id": "9PK3G146XXVF",
"title": "Call of Duty®: Modern Warfare® 4 - Vault Edition",
"publisher": "Activision Publishing Inc.",
"product_kind": "Game",
"categories": [
"Shooter"
],
"available_on": [
"PC"
],
"content_rating": {
"board": "ESRB",
"rating": "MATURE 17+",
"age": 17,
"descriptors": [
"Blood and Gore",
"Intense Violence"
]
},
"price": {
"list_price": 99.99,
"msrp": 99.99,
"currency": "USD",
"is_free": false
},
"is_preorder": true,
"box_art_url": "https://store-images.s-microsoft.com/image/apps.46360...",
"description": "Pre-order loyalty discount...",
"has_add_ons": true,
"included_with_subscription_ids": [],
"url": "https://www.xbox.com/en-US/games/store/game/9pk3g146xxvf"
}
}Request schema
No body schema
Response schema
#/definitions/xbox.gameResponseDoc
| Field | Type | Required | Enum | Bounds | Example | Description |
|---|---|---|---|---|---|---|
| code | integer | No | 200 | |||
| data | xbox.GameDetail | No | ||||
| data.available_on | array | No | ["XboxSeriesX|S","PC"] | |||
| data.average_rating | number | No | 4.5 | |||
| data.box_art_url | string | No | ||||
| data.categories | array | No | ["Shooter"] | |||
| data.content_rating | xbox.ContentRating | No | ||||
| data.content_rating.age | integer | No | 17 | |||
| data.content_rating.board | string | No | ESRB | |||
| data.content_rating.description | string | No | For ages 17 and up | |||
| data.content_rating.descriptors | array | No | ["Blood and Gore","Intense Violence"] | |||
| data.content_rating.image_url | string | No | ||||
| data.content_rating.rating | string | No | MATURE 17+ | |||
| data.description | string | No | ||||
| data.has_add_ons | boolean | No | ||||
| data.hero_art_url | string | No | ||||
| data.included_with_subscription_ids | array | No | ["CFQ7TTC0KHS0"] | |||
| data.is_preorder | boolean | No | ||||
| data.poster_url | string | No | ||||
| data.price | xbox.Price | No | ||||
| data.price.currency | string | No | USD | |||
| data.price.discount_percentage | number | No | 25 | |||
| data.price.is_free | boolean | No | false | |||
| data.price.list_price | number | No | 59.99 | |||
| data.price.msrp | number | No | 59.99 | |||
| data.price.sale_end_date_utc | string | No | 2026-10-23T03:59:59Z | |||
| data.product_id | string | No | 9PK3G146XXVF | |||
| data.product_kind | string | No | Game | |||
| data.publisher | string | No | 343 Industries | |||
| data.rating_count | integer | No | ||||
| data.release_date_utc | string | No | 2021-12-08T00:00:00Z | |||
| data.short_description | string | No | ||||
| data.title | string | No | Halo Infinite | |||
| data.url | string | No | https://www.xbox.com/en-US/games/store/game/9pk3g146xxvf | |||
| data.videos | array | No | ||||
| data.videos[].height | integer | No | ||||
| data.videos[].preview_image_url | string | No | ||||
| data.videos[].title | string | No | ||||
| data.videos[].url | string | No | ||||
| data.videos[].width | integer | No | ||||
| msg | string | No | OK |
| Status | Description | Schema |
|---|---|---|
| 400 | Bad Request | #/definitions/app.Response |
| 404 | Not Found | #/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/game?product_id=9PK3G146XXVF" \
-H "x-api-key: $CRAWLORA_API_KEY"