Docs
View as Markdown

cheapshark.deals

stable Advanced

Current game deals across stores, sortable by savings or price (CheapShark).

GET /v1/cheapshark/deals

What you get#

A list of Cheapshark 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#

NameTypeRequiredDefaultWhat it isConstraints
sort_bystringnoDealRatingSort key (DealRating, Title, Savings, Price, Metacritic, Reviews, Release, Store, recent)max 20 chars; must match [A-Za-z]{3,20}; trimmed

Request#

curl "https://api.onekey.dev/v1/cheapshark/deals?sort_by=DealRating" \
  -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 Cheapshark response, recorded and returned in Onekey's shape. Fields the platform does not provide are null.

json
{
  "success": true,
  "data": [
    {
      "entity": {
        "id": "zwuIeF72lgS5EQN4ecjdR506VKx%2BdJqwcuV1inxLYIY%3D",
        "name": "ENDLESS Legend 2"
      },
      "listing": {
        "price": 24.99,
        "originalPrice": 49.99
      },
      "ext": {
        "savingsPercent": 50.010002,
        "storeId": "11",
        "gameId": "308638",
        "steamAppId": "3407390",
        "metacriticScore": 81
      },
      "media": {
        "thumbnailUrl": "https://shared.fastly.steamstatic.com/store_item_assets/steam/apps/3407390/9f2ee6ecca69fa997206c328e095d77b431b0501/capsule_231x87.jpg?t=1790510692"
      }
    },
    {
      "entity": {
        "id": "f0sK4TI6fEllMsP5%2BMcuFuA%2FdT4iQ5jw2XF1DBDsbNk%3D",
        "name": "SPRAWL zero"
      },
      "listing": {
        "price": 24.73,
        "originalPrice": 44.98
      },
      "ext": {
        "savingsPercent": 45.020009,
        "storeId": "1",
        "gameId": "330831",
        "steamAppId": "3748520",
        "metacriticScore": 76
      },
      "media": {
        "thumbnailUrl": "https://shared.fastly.steamstatic.com/store_item_assets/steam/apps/3748520/e59189f5b1c31016bfbd629ab94034cbee7f13b9/capsule_231x87.jpg?t=1790240546"
      }
    }
  ],
  "metadata": {
    "platform": "cheapshark",
    "endpoint": "deals",
    "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 pathOnekey fieldTransform
dealIDentity.id-
titleentity.name-
salePricelisting.pricetoNumber
normalPricelisting.originalPricetoNumber
savingsext.savingsPercenttoNumber
storeIDext.storeId-
gameIDext.gameId-
steamAppIDext.steamAppId-
metacriticScoreext.metacriticScoretoNumber
thumbmedia.thumbnailUrlsafeUrl

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#

StatusCodeWhat to do
401unauthorizedCheck the x-api-key header.
402insufficient_creditsAdd credits; your balance must cover the price.
404not_foundUnknown endpoint path.
422invalid_paramsFix the parameters using the table above. Free.
429rate_limitedWait Retry-After seconds, then retry.
502upstream_errorThe source failed. Refunded; retry with backoff.

See Errors for the full list and retry guidance.

Status: stable (verified against the live source).