About this endpoint
What it does
Searches for games using the provided query, paging, sorting, and filter parameters, then returns a JSON object containing the matching results plus pagination and option metadata.
Query Parameter(s)
| Attribute | Type | Mandatory | Description |
|---|---|---|---|
| sort | String | Yes | Sort key. String up to 300 characters. |
| limit | Integer | Yes | Page size. Integer (int32). Default: 10. |
| query | String | Yes | Search text. String up to 300 characters. |
| offset | Integer | Yes | Result offset for paging. Integer (int32). Default: 0. |
| filters | String | Yes | Filter payload encoded as a string. String up to 3000 characters. Default: []. |
| sort-order | ENUM | Yes | Sort direction. Allowed values: asc, desc. Default: asc. |
| generate-filter-options | Boolean | Yes | Whether to include generated filter options. Default: true. |
Response
Returns a JSON object with pagination fields, search results, sorting metadata, and filter metadata. Top-level fields include limit and offset integers, query as a string, results as an array of game objects, sorting as an object, total_results as an integer, filter_options as an array, sorting_options as an array, and active_filter_options as an array.
| Parameter | Type | Mandatory | Description |
|---|---|---|---|
| limit | Integer | No | Page size used in the response. |
| query | String | No | Search text used in the response. |
| offset | Integer | No | Result offset used in the response. |
| results | Object Array | No | Matching games. Each item includes id, link, name, year, genre, image, rating.mean, rating.count, gameplay, adult_only, screenshots, micro_trailer, and short_description. screenshots is an array of URI strings with up to 100 items. |
| sorting | Object | No | Sorting metadata. Includes key and direction, both nullable strings. |
| total_results | Integer | No | Total number of matching results. |
| filter_options | Object Array | No | Available filter options. Each item includes key, name, and values; each value item includes key, name, and count. Both arrays are limited to 100 items. |
| sorting_options | Object Array | No | Available sorting options. Each item includes key, name, and sort. Limited to 100 items. |
| active_filter_options | Object Array | No | Active filter options. Each item includes key, values, and connection; each value item includes match and value. Both arrays are limited to 100 items. |



