/gog/products/search

POST /api/gog/products/search

Price: 5 credits

Search the GOG.com catalog with keyword and filters

How to use it

Search the GOG.com store catalog by keyword and filters. Filter by product type, genres, tags, operating systems, features, available languages, release status, release year range, price range, discounted-only, and free-only, and choose the sort order. Returns matching products with title, product type, developers and publishers, genres, tags, features, supported operating systems, average user rating and review count, release dates, artwork and screenshots, and price with base and final amounts, currency, and discount for the selected country.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• query string nullable — Search keyword
• count integer required — Max number of results to return (min: 1)
• order string — Result sort order (default: "bestselling"; one of: "bestselling", "trending", "alphabetical", "price_low", "price_high", "release_new", "rating", "discount")
• product_type array — Restrict to these product types (default: []; one of: "game", "pack", "dlc", "extras")
• genres array — Restrict to these genres (default: []; one of: "action", "adventure", "racing", "rpg", "shooter", "simulation", "sports", "strategy", "arcade", "building", "card-game", "combat", "economic", "educational", "fpp", "metroidvania", "pointandclick", "puzzle", "realtime", "survival", "tpp", "teamsport", "turnbased", "visual-novel", "chess", "comedy", "detective", "espionage", "exploration", "fantasy", "fighting", "hidden-object", "historical", "horror", "jrpg", "managerial", "modern", "mystery", "narrative", "naval", "offroad", "open-world", "pinball", "platformer", "programming", "rally", "rougelike", "sandbox", "scifi", "shoot-em-up", "soccer", "stealth", "tactical", "touring", "virtuallife")
• tags array — Restrict to these catalog tag slugs, e.g. story-rich, atmospheric (default: [])
• systems array — Restrict to these operating systems (default: []; one of: "windows", "osx", "linux")
• features array — Restrict to these features (default: []; one of: "single", "multi", "coop", "achievements", "leaderboards", "controller_support", "cloud_saves", "overlay", "galaxy_multiplayer")
• languages array — Restrict to products available in these languages (default: []; one of: "ar", "br", "cn", "cz", "da", "de", "en", "es", "es_mx", "fi", "fr", "gk", "hu", "hr", "id", "it", "jp", "ko", "nl", "no", "pl", "pt", "ro", "ru", "sv", "th", "tr", "uk", "vi", "zh")
• release_statuses array — Restrict to these release statuses (default: []; one of: "new-arrival", "upcoming", "early-access")
• discounted boolean — Only products currently on discount (default: false)
• free boolean — Only free products (default: false)
• price_min number nullable — Minimum price in the selected currency (min: 0)
• price_max number nullable — Maximum price in the selected currency (min: 0)
• release_year_min integer nullable — Earliest release year (min: 1980)
• release_year_max integer nullable — Latest release year (min: 1980)
• country string — Store country, drives price and currency (default: "US"; one of: "US", "GB", "CA", "AU", "DE", "FR", "IT", "ES", "NL", "BE", "AT", "CH", "SE", "NO", "DK", "FI", "IE", "PT", "PL", "CZ", "HU", "RO", "GR", "UA", "RU", "TR", "BR", "MX", "AR", "CL", "CO", "JP", "KR", "CN", "TW", "HK", "SG", "ID", "TH", "VN", "PH", "MY", "IN", "AE", "SA", "IL", "ZA", "NZ")
• locale string — Content language (default: "en-US"; one of: "en-US", "en-GB", "de-DE", "fr-FR", "it-IT", "es-ES", "pt-BR", "pl-PL", "ru-RU", "cs-CZ", "hu-HU", "ja-JP", "ko-KR", "zh-Hans", "zh-Hant")
• currency string — Price currency (default: "USD"; one of: "USD", "EUR", "GBP", "AUD", "CAD", "CHF", "SEK", "NOK", "DKK", "PLN", "CZK", "HUF", "RUB", "BRL", "MXN", "JPY", "KRW", "CNY", "TRY", "INR", "ZAR", "NZD")

Response

• @type string (default: "GogSearchProduct")
• id integer required
• game_title string required
• slug string nullable
• product_type string nullable
• developers array (default: [])
• publishers array (default: [])
• operating_systems array (default: [])
• genres array (default: [])
  • @type string (default: "GogNamedSlug")
  • name string required
  • slug string nullable
• tags array (default: [])
  • @type string (default: "GogNamedSlug")
  • name string required
  • slug string nullable
• features array (default: [])
  • @type string (default: "GogNamedSlug")
  • name string required
  • slug string nullable
• price object nullable
  • @type string (default: "GogPrice")
  • base_price number nullable
  • final_price number nullable
  • currency string nullable
  • discount_percent integer nullable
  • bonus_wallet_funds number nullable
• rating number nullable
• review_count integer nullable
• release_date string nullable
• store_release_date string nullable
• image string nullable
• cover string nullable
• logo string nullable
• screenshots array (default: [])
• store_url string nullable

Errors

• 422 — The request body did not validate Check the fields against this schema. A URN with the wrong prefix is the most common cause.
• 408 — The request ran past its time limit Raise `timeout` in the request body, up to the maximum this endpoint documents. Lowering `count` or turning off the `with_*` flags also helps, because less work finishes sooner.
• 412 — The entity was not found, or a precondition failed Retrying will not help: either the entity does not exist, or the input points at a different one.
• 429 — Too many requests: a rate limit or a usage window is exhausted When the response carries an X-Retry-After header, wait that many seconds and retry: the same number is in the body as `detail.retry_after`, and the limit clears once that window passes. The message in the body names the limit that was hit.
• 500 — Something broke on our side Retrying will not help. If it keeps happening, send us the X-Request-ID from the response headers.
• 529 — Rate limit reached, or the endpoint is overloaded Wait at least 30 seconds, then retry.

Response headers

• X-Error — Error message text (present only on error)
• X-Request-ID — Unique request identifier
• X-Execution-Time — Execution time in seconds
• X-Result-Count — How many records the body carries. 0 means an empty result, which is a normal answer and not by itself an error. A non-zero count can come back together with X-Error when the failure happened partway through — read this header and X-Error independently.
• X-Total-Available-Results — How many records exist for this query, when the endpoint can say. On a `dry_run` request this is the answer and the body is empty. It saturates: the endpoint's documented maximum means 'at least that many', any smaller number is exact.
• X-Warning — Present when the request body carried keys this endpoint does not document. They were ignored, so any filter you meant to apply through them did not apply. Check the spelling against this schema and retry.
• X-Retry-After — Seconds to wait before retrying. Present only on 429.