Xbox

Search the Xbox catalog, with optional sort and filters

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.

get/xbox/search

Request

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

Query parameters

querystring required

Search keyword

category'games' | 'addons' | 'hardware'

Result category

cursorstring

Opaque pagination cursor from a previous response's next_cursor

sort'relevance' | 'release_date_desc' | 'most_popular' | 'price_asc' | 'price_desc' | 'most_wishlisted' | 'discount_desc' | 'title_asc' | 'title_desc'

Sort order

genrestring[]

Genre filter (repeatable)

pricestring[]

Price-band filter (repeatable)

platformstring[]

Platform filter (repeatable)

subscriptionstring[]

Subscription filter, by the subscription's own product id (repeatable)

age_ratingstring[]

ESRB age-rating filter (repeatable)

multiplayerstring[]

Multiplayer-mode filter (repeatable)

technical_featuresstring[]

Technical-feature filter (repeatable)

handheld_compatibilitystring[]

Handheld compatibility filter (repeatable)

supported_languagestring[]

Supported-language filter, by BCP-47 tag (repeatable)

accessibilitystring[]

Accessibility-feature filter (repeatable)

localestring

Display locale (BCP-47)

Headers

x-api-keystring required

API key required

Response

OK

codeinteger
msgstring

Example response

{
  "code": 200,
  "data": {
    "category": "games",
    "has_more": true,
    "items": [
      {
        "available_on": [
          "[\"XboxSeriesX|S\"",
          "\"PC\"]"
        ],
        "average_rating": 4.5,
        "categories": [
          "[\"Shooter\"]"
        ],
        "content_rating": {
          "age": 17,
          "board": "ESRB",
          "description": "For ages 17 and up",
          "descriptors": [
            "[\"Blood and Gore\"",
            "\"Intense Violence\"]"
          ],
          "rating": "MATURE 17+"
        },
        "price": {
          "currency": "USD",
          "discount_percentage": 25,
          "list_price": 59.99,
          "msrp": 59.99,
          "sale_end_date_utc": "2026-10-23T03:59:59Z"
        },
        "product_id": "9PK3G146XXVF",
        "product_kind": "Game",
        "publisher": "343 Industries",
        "release_date_utc": "2021-12-08T00:00:00Z",
        "title": "Halo Infinite",
        "url": "https://www.xbox.com/en-US/games/store/game/9pk3g146xxvf"
      }
    ],
    "query": "halo",
    "total_items": 41
  },
  "msg": "OK"
}

Changes

No recorded changes to this operation across all 2 revisions of this API.