Xbox API endpoint
Returns one page of Xbox search results for a keyword, scoped to a category (games, add-ons, or hardware) and optionally sorted/filtered with the same parameters as /xbox/browse. Cursor-paginated.
/xbox/searchQuery parameters:
query (required) — search keyword.category (optional, default games) — one of games, addons, hardware. (subscriptions is not supported.)cursor (optional) — opaque pagination cursor from a previous response's next_cursor. Omit for the first page.sort (optional, default relevance) — one of relevance, release_date_desc, most_popular, price_asc, price_desc, most_wishlisted, discount_desc, title_asc, title_desc.genre (optional, repeatable) — matches ANY given genre. One of Action & adventure, Card & board, Casino, Classics, Companion, Educational, Family & kids, Fighting, Multi-Player Online Battle Arena, Music, Other, Platformer, Puzzle & trivia, Racing & flying, Role playing, Shooter, Simulation, Sports, Strategy, Tools, Word.price (optional, repeatable) — one of OnSale, 0 (Free), 0.01To5, 5To10, 10To20, 20To40, 40To60, 60To.platform (optional, repeatable) — one of XboxSeriesX|S, XboxOne, PC, Handheld, CloudGaming, XboxPlayAnywhere.subscription (optional, repeatable) — one of CFQ7TTC0KHS0 (Game Pass Ultimate), CFQ7TTC0P85B (Game Pass Premium), CFQ7TTC0K5DJ (Game Pass Essential), CFQ7TTC0K6L8 (Game Pass for Console), CFQ7TTC0KGQ8 (Game Pass for PC), CFQ7TTC0K5DH (EA Play), CFQ7TTC0QH5H (Ubisoft+).age_rating (optional, repeatable) — one of ESRB:EC, ESRB:E, ESRB:E10, ESRB:T, ESRB:M, ESRB:AO, ESRB:RPEveryone, ESRB:RPMature, ESRB:RPTeen, ESRB:UR.multiplayer (optional, repeatable) — one of CrossPlatformMultiplayer, CrossPlatformCoop, SinglePlayer, OnlineMultiplayerWithGold, CoopSupportOnline, CoopSupportLocal, LocalMultiplayer.technical_features (optional, repeatable) — one of CapabilityXboxEnhanced, ConsoleGen9Optimized, ConsoleCrossGen, Capability4k, CapabilityHDR, 60fps, 120fps, RayTracing.handheld_compatibility (optional, repeatable) — one of VERIFIED, PLAYABLE, UNSUPPORTED, UNKNOWN.supported_language (optional, repeatable) — one of ar-SA, zh-CN, zh-TW, cs-CZ, da-DK, nl-NL, en-GB, en-US, fi-FI, fr-FR, de-DE, el-GR, he-IL, hu-HU, it-IT, ja-JP, ko-KR, nb-NO, pl-PL, pt-BR, pt-PT, ru-RU, sk-SK, es-MX, es-ES, sv-SE, tr-TR.accessibility (optional, repeatable) — one of AccessibilityOnLaunch, AdjustableDifficulty, OnDemandTutorials, Pausable, ProgressSavingOptions, MonoSound, CustomVolumeControls, NarratedGameMenus, StereoSound, SpatialAudio, SteadyCamera, ContrastOptions, ColorOptions, SubtitleOptions, AdjustableTextSize, AdjustableInputSensitivity, BasicInputRemapping, TtsSttCommunications, InputRemapping, PlayableWithButtonsOnly, FullKeyboardSupport, PlayableWithMouseOnly, PlayableWithTouchOnly, NoButtonHolds, PlayableWithoutMotionControls, NoQuickTimeEvents, PlayableWithoutTouchControls, SingleStickGameplay, StickInversion.locale (optional, default en-US) — display locale (BCP-47).These sort/filter values are identical to /xbox/browse's.
Returns query, category, total_items, has_more, next_cursor, and items[] (the same game-summary shape as /xbox/browse).
Example response (truncated):
{"code":200,"msg":"OK","data":{"query":"halo","category":"games","total_items":41,"has_more":true,"items":[{"product_id":"9NP1P1WFS0LB","title":"Halo Infinite","product_kind":"Game","url":"https://www.xbox.com/en-US/games/store/game/9np1p1wfs0lb"}]}}
| Field | Filled in, of 25 checked | Values in the sample |
|---|---|---|
| product_id | 25 | |
| title | 25 | “Halo Infinite” and 21 other values |
| publisher | 25 | Microsoft Studios (12), Xbox Game Studios (9), Microsoft (2) and 2 more |
| product_kind | 25 | Game in all 25 |
| categories | 25 | median 1 entry |
| available_on | 25 | median 3 entries |
| average_rating | 25 | 3.1 to 4.9, median 3.7 |
| rating_count | 25 | 45 to 44,671, median 3,998 |
| release_date_utc | 15 | 2013-12-23 to 2026-07-28 |
| content_rating | 25 | |
| price | 15 | |
| box_art_url | 25 | store-images.s-microsoft.com |
| poster_url | 25 | store-images.s-microsoft.com |
| hero_art_url | 25 | store-images.s-microsoft.com |
| url | 25 | xbox.com |
| Parameter | Type | Required | Default | Description | Example |
|---|---|---|---|---|---|
| query | string | Yes | Search keyword | halo | |
| category | string | No | Result category Allowed values: games, addons, hardware. | ||
| cursor | string | No | Opaque pagination cursor from a previous response's next_cursor | ||
| sort | string | No | Sort order Allowed values: relevance, release_date_desc, most_popular, price_asc, price_desc, most_wishlisted, discount_desc, title_asc, title_desc. | ||
| genre | array<string> | No | Genre filter (repeatable) Allowed values: Action & adventure, Card & board, Casino, Classics, Companion, Educational, Family & kids, Fighting, Multi-Player Online Battle Arena, Music, Other, Platformer, Puzzle & trivia, Racing & flying, Role playing, Shooter, Simulation, Sports, Strategy, Tools, Word. Repeat this query parameter for multiple values. | ||
| price | array<string> | No | Price-band filter (repeatable) Allowed values: OnSale, 0, 0.01To5, 5To10, 10To20, 20To40, 40To60, 60To. Repeat this query parameter for multiple values. | ||
| platform | array<string> | No | Platform filter (repeatable) Allowed values: XboxSeriesX|S, XboxOne, PC, Handheld, CloudGaming, XboxPlayAnywhere. Repeat this query parameter for multiple values. | ||
| subscription | array<string> | No | Subscription filter, by the subscription's own product id (repeatable) Allowed values: CFQ7TTC0KHS0, CFQ7TTC0P85B, CFQ7TTC0K5DJ, CFQ7TTC0K6L8, CFQ7TTC0KGQ8, CFQ7TTC0K5DH, CFQ7TTC0QH5H. Repeat this query parameter for multiple values. | ||
| age_rating | array<string> | No | ESRB age-rating filter (repeatable) Allowed values: ESRB:EC, ESRB:E, ESRB:E10, ESRB:T, ESRB:M, ESRB:AO, ESRB:RPEveryone, ESRB:RPMature, ESRB:RPTeen, ESRB:UR. Repeat this query parameter for multiple values. | ||
| multiplayer | array<string> | No | Multiplayer-mode filter (repeatable) Allowed values: CrossPlatformMultiplayer, CrossPlatformCoop, SinglePlayer, OnlineMultiplayerWithGold, CoopSupportOnline, CoopSupportLocal, LocalMultiplayer. Repeat this query parameter for multiple values. | ||
| technical_features | array<string> | No | Technical-feature filter (repeatable) Allowed values: CapabilityXboxEnhanced, ConsoleGen9Optimized, ConsoleCrossGen, Capability4k, CapabilityHDR, 60fps, 120fps, RayTracing. Repeat this query parameter for multiple values. | ||
| handheld_compatibility | array<string> | No | Handheld compatibility filter (repeatable) Allowed values: VERIFIED, PLAYABLE, UNSUPPORTED, UNKNOWN. Repeat this query parameter for multiple values. | ||
| supported_language | array<string> | No | Supported-language filter, by BCP-47 tag (repeatable) Allowed values: ar-SA, zh-CN, zh-TW, cs-CZ, da-DK, nl-NL, en-GB, en-US, fi-FI, fr-FR, de-DE, el-GR, he-IL, hu-HU, it-IT, ja-JP, ko-KR, nb-NO, pl-PL, pt-BR, pt-PT, ru-RU, sk-SK, es-MX, es-ES, sv-SE, tr-TR. Repeat this query parameter for multiple values. | ||
| accessibility | array<string> | No | Accessibility-feature filter (repeatable) Allowed values: AccessibilityOnLaunch, AdjustableDifficulty, OnDemandTutorials, Pausable, ProgressSavingOptions, MonoSound, CustomVolumeControls, NarratedGameMenus, StereoSound, SpatialAudio, SteadyCamera, ContrastOptions, ColorOptions, SubtitleOptions, AdjustableTextSize, AdjustableInputSensitivity, BasicInputRemapping, TtsSttCommunications, InputRemapping, PlayableWithButtonsOnly, FullKeyboardSupport, PlayableWithMouseOnly, PlayableWithTouchOnly, NoButtonHolds, PlayableWithoutMotionControls, NoQuickTimeEvents, PlayableWithoutTouchControls, SingleStickGameplay, StickInversion. Repeat this query parameter for multiple values. | ||
| 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/search?query=halo&category=games&sort=relevance&genre=Action+%26+adventure&price=OnSale&platform=XboxSeriesX%7CS&subscription=CFQ7TTC0KHS0&age_rating=ESRB%3AEC&multiplayer=CrossPlatformMultiplayer&technical_features=CapabilityXboxEnhanced&handheld_compatibility=VERIFIED&supported_language=ar-SA&accessibility=AccessibilityOnLaunch" \ -H "x-api-key: $CRAWLORA_API_KEY"
{
"code": 200,
"msg": "OK",
"data": {
"query": "halo",
"category": "games",
"total_items": 41,
"has_more": true,
"items": [
{
"product_id": "9NP1P1WFS0LB",
"title": "Halo Infinite",
"product_kind": "Game",
"url": "https://www.xbox.com/en-US/games/store/game/9np1p1wfs0lb"
}
]
}
}Request schema
No body schema
Response schema
#/definitions/xbox.searchResponseDoc
| Field | Type | Required | Enum | Bounds | Example | Description |
|---|---|---|---|---|---|---|
| code | integer | No | 200 | |||
| data | xbox.SearchResponse | No | ||||
| data.category | string | No | games | |||
| data.has_more | boolean | No | true | |||
| data.items | array | No | GameSummary record, 28 fields: available_on, average_rating, box_art_url, categories, content_rating, hero_art_url, is_preorder, poster_url, price, product_id, product_kind, publisher and 4 more. Described under Xbox Catalog Browse API. | |||
| data.next_cursor | string | No | ||||
| data.query | string | No | halo | |||
| data.total_items | integer | No | 41 | |||
| 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/search?query=halo&category=games&sort=relevance&genre=Action+%26+adventure&price=OnSale&platform=XboxSeriesX%7CS&subscription=CFQ7TTC0KHS0&age_rating=ESRB%3AEC&multiplayer=CrossPlatformMultiplayer&technical_features=CapabilityXboxEnhanced&handheld_compatibility=VERIFIED&supported_language=ar-SA&accessibility=AccessibilityOnLaunch" \
-H "x-api-key: $CRAWLORA_API_KEY"