Search across all entity types (games, profiles, platforms, collections, engines).

GET

/xrpc/games.gamesgamesgamesgames.search

Parameters

Query Parameters

q

required

string

>= 1 characters <= 200 characters

sort

string

limit

integer

default: 20 >= 1 <= 100

modes

Array<string>

types

Array<string>

cursor

string

genres

Array<string>

themes

Array<string>

ageRatings

Filter game results by age rating in ‘organization:rating’ format (e.g. esrb:M, pegi:Eighteen).

Array<string>

Filter game results by age rating in ‘organization:rating’ format (e.g. esrb:M, pegi:Eighteen).

includeUnrated

When age rating filters are active, also include games with no age ratings.

boolean

When age rating filters are active, also include games with no age ratings.

applicationTypes

Filter game results by application type (e.g. game, dlc, bundle). Only applies when types includes game.

Array<string>

Filter game results by application type (e.g. game, dlc, bundle). Only applies when types includes game.

includeCancelled

boolean

playerPerspectives

Array<string>

Responses

200

Success

object

cursor

string

results

required

Array

One of:

object

object

uri

required

string format: uri

name

required

string

slug

string

media

Array<object>

object

blob

string format: binary

title

string

width

integer

height

integer

locale

string

mediaType

string

Allowed values: accoladesTrailer announcementTrailer artwork cinematicTrailer conceptArt cover coverAlt coverHistorical coverSquare cutscene devDiary gameplayImage gameplayTrailer icon infographic intro keyArt keyArtLogo launchTrailer logoBlack logoColor logoWhite releaseDateTrailer screenshot teaser trailer

description

string

summary

string

applicationType

string

Allowed values: addon bundle dlc episode expandedGame expansion fork game mod port remake remaster season standaloneExpansion update

firstReleaseDate

Earliest release date as YYYYMMDD integer.

integer

object

object

did

required

string format: did

uri

required

string format: uri

avatar

string format: binary

displayName

string

<= 640 characters

profileType

required

string

object

object

uri

required

string format: uri

name

required

string

slug

string

category

string

abbreviation

string

object

object

uri

required

string format: uri

name

required

string

slug

string

type

string

object

object

uri

required

string format: uri

name

required

string

slug

string

totalResults

Total number of results matching the query above the relevance threshold.

integer