gog.search

stable Advanced

Search the GOG store catalog.

GET /v1/gog/search

What you get#

A list of Gog results in Onekey's unified shape, in data (an array). An empty array is a normal, successful answer and is charged like any other; a source that reports "nothing found" as an error returns a free 404 not_found instead.

What it costs#

Advanced · 5 credits for a fresh fetch, charged only when it succeeds.
Free when served from cache (0.2 credit for a cached response over 100 KB).
Free if the request is invalid (never charged) or the source fails or reports not found (refunded).

Parameters#

Name	Type	Required	Default	What it is	Constraints
`q`	string	yes	(required)	Search query	max 200 chars; trimmed, repeated spaces collapsed

Request#

curl "https://api.onekey.dev/v1/gog/search?q=witcher" \
  -H "x-api-key: YOUR_API_KEY"

Try it

Add your key to run this call right here. No key? Get one free. The key stays in this tab.

Recorded response#

A real Gog response, recorded and returned in Onekey's shape. Fields the platform does not provide are null.

json

{
  "success": true,
  "data": [
    {
      "entity": {
        "id": "1640424747",
        "name": "The Witcher 3: Wild Hunt - Complete Edition",
        "slug": "the_witcher_3_wild_hunt_game_of_the_year_edition",
        "url": "https://www.gog.com/en/game/the_witcher_3_wild_hunt_game_of_the_year_edition",
        "stats": {
          "rating": 48
        },
        "type": "pack"
      },
      "ext": {
        "priceText": "$24.99",
        "normalPriceText": "$49.99",
        "discount": "-50%",
        "developers": [
          "CD PROJEKT RED"
        ],
        "reviews": 14209
      },
      "content": {
        "createdAt": "2016-08-30T00:00:00Z"
      },
      "media": {
        "thumbnailUrl": "https://images.gog-statics.com/71d71c40052877a42c096b8230c71856a560d42132208cfa8e719243b5c6626b.png"
      }
    },
    {
      "entity": {
        "id": "1207658930",
        "name": "The Witcher 2: Assassins of Kings Enhanced Edition",
        "slug": "the_witcher_2",
        "url": "https://www.gog.com/en/game/the_witcher_2",
        "stats": {
          "rating": 47
        },
        "type": "game"
      },
      "ext": {
        "priceText": "$2.99",
        "normalPriceText": "$19.99",
        "discount": "-85%",
        "developers": [
          "CD PROJEKT RED"
        ],
        "reviews": 14510
      },
      "content": {
        "createdAt": "2012-04-17T00:00:00Z"
      },
      "media": {
        "thumbnailUrl": "https://images.gog-statics.com/8355e657a19311b158a3553a154e109199d6991c7791a20c3305af1f84d15ed7.png"
      }
    }
  ],
  "metadata": {
    "platform": "gog",
    "endpoint": "search",
    "cached": false,
    "stale": false,
    "age_s": 0,
    "fetched_at": "2026-01-01T12:00:00+00:00",
    "credits_charged": 5,
    "request_id": "7f3a9c2e5b1d4c8fa2e6d0b9c4f18e37"
  },
  "error": null
}

Field mapping#

How this endpoint's source fields become Onekey's unified schema. Fields the source lacks come back as null.

Source path	Onekey field	Transform
`id`	`entity.id`	-
`title`	`entity.name`	-
`slug`	`entity.slug`	-
`storeLink`	`entity.url`	`safeUrl`
`price.final`	`ext.priceText`	-
`price.base`	`ext.normalPriceText`	-
`price.discount`	`ext.discount`	-
`developers`	`ext.developers`	-
`releaseDate`	`content.createdAt`	`toIsoDate`
`reviewsRating`	`entity.stats.rating`	`toNumber`
`reviewsCount`	`ext.reviews`	`toNumber`
`productType`	`entity.type`	-
`coverHorizontal`	`media.thumbnailUrl`	`safeUrl`

Caching and freshness#

Fresh for about 2 minutes. Repeat calls in that window are served from cache and are free.
Between 2 minutes and 15 minutes the cached copy is still served instantly and marked stale: true while Onekey refreshes it in the background.
If the source is down when a refresh is needed, the last copy can be served for up to 1 hour more (marked stale).
A "not found" is remembered for 1 minute and is free.
The cache is shared across all customers, which is what keeps repeat calls cheap.

What can go wrong#

Status	Code	What to do
401	`unauthorized`	Check the `x-api-key` header.
402	`insufficient_credits`	Add credits; your balance must cover the price.
404	`not_found`	Unknown endpoint path.
422	`invalid_params`	Fix the parameters using the table above. Free.
429	`rate_limited`	Wait `Retry-After` seconds, then retry.
502	`upstream_error`	The source failed. Refunded; retry with backoff.

See Errors for the full list and retry guidance.

Status: stable (verified against the live source).