---
title: "Search the Xbox catalog, with optional sort and filters"
method: GET
path: "/xbox/search"
tags: ["Xbox"]
---

# Search the Xbox catalog, with optional sort and filters

`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`

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.

## Query parameters

- `query` string, required
- `category` 'games' | 'addons' | 'hardware'
- `cursor` string
- `sort` 'relevance' | 'release_date_desc' | 'most_popular' | 'price_asc' | 'price_desc' | 'most_wishlisted' | 'discount_desc' | 'title_asc' | 'title_desc'
- `genre` string[]
- `price` string[]
- `platform` string[]
- `subscription` string[]
- `age_rating` string[]
- `multiplayer` string[]
- `technical_features` string[]
- `handheld_compatibility` string[]
- `supported_language` string[]
- `accessibility` string[]
- `locale` string

## Headers

- `x-api-key` string, required

## Response `200`

OK

- XboxSearchResponseDoc
  - `code` integer
  - `data` XboxSearchResponse
    - `category` string
    - `has_more` boolean
    - `items` XboxGameSummary[]
      - `available_on` string[]
      - `average_rating` number
      - `box_art_url` string
      - `categories` string[]
      - `content_rating` XboxContentRating
        - `age` integer
        - `board` string
        - `description` string
        - `descriptors` string[]
        - `image_url` string
        - `rating` string
      - `hero_art_url` string
      - `is_preorder` boolean
      - `poster_url` string
      - `price` XboxPrice
        - `currency` string
        - `discount_percentage` number
        - `is_free` boolean
        - `list_price` number
        - `msrp` number
        - `sale_end_date_utc` string
      - `product_id` string
      - `product_kind` string
      - `publisher` string
      - `rating_count` integer
      - `release_date_utc` string
      - `title` string
      - `url` string
    - `next_cursor` string
    - `query` string
    - `total_items` integer
  - `msg` string

## Other responses

- `400`: Bad Request
- `503`: Service Unavailable

---

[API](https://skmtc.dev/crawlora/apis/crawlora-api.md) · [All operations](https://skmtc.dev/crawlora/apis/crawlora-api/llms.txt) · [OpenAPI document](https://skmtc.dev/crawlora/apis/crawlora-api/revisions/afac9b012a27?raw)