# cheapshark.game

**stable** **Standard**

One game's cheapest price ever plus every current store deal (CheapShark).

`GET /v1/cheapshark/game`

## What you get

One Cheapshark record in Onekey's unified shape, in `data`. If the record does not exist you get a `404 not_found` and are not charged.

## What it costs

- **Standard · 1 credit** 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 |
| --- | --- | --- | --- | --- | --- |
| `game_id` | string | yes | (required) | CheapShark gameID (from cheapshark.search entity.id) | max 12 chars; must match `[0-9]{1,12}`; trimmed |

## Request

```bash
curl "https://api.onekey.dev/v1/cheapshark/game?game_id=612" \
  -H "x-api-key: YOUR_API_KEY"
```

```python
import requests

res = requests.get(
    "https://api.onekey.dev/v1/cheapshark/game",
    params={"game_id": "612"},
    headers={"x-api-key": "YOUR_API_KEY"},
)
body = res.json()

if body["success"]:
    print(body["data"])
else:
    print(body["error"]["code"], body["error"]["message"])
```

```javascript
const params = new URLSearchParams({ game_id: "612" });
const res = await fetch(`https://api.onekey.dev/v1/cheapshark/game?${params}`, {
  headers: { "x-api-key": "YOUR_API_KEY" },
});
const body = await res.json();

if (body.success) console.log(body.data);
else console.error(body.error.code, body.error.message);
```

## 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": {
      "name": "LEGO Batman"
    },
    "ext": {
      "steamAppId": null,
      "cheapestPriceEver": 2.28,
      "cheapestPriceEverAt": "2025-09-29T20:21:35Z",
      "deals": [
        {
          "storeID": "30",
          "dealID": "r5pU2qL0yMcQTXWlvVyaxVOuBAjgtKdD81zA65nVJak%3D",
          "price": "2.49",
          "retailPrice": "19.99",
          "savings": "87.543772"
        },
        {
          "storeID": "15",
          "dealID": "0f%2B4gT2VVUn4UcmFzPxXnuqoXKAOYoJ5mpFZRWNyohc%3D",
          "price": "15.89",
          "retailPrice": "19.99",
          "savings": "20.510255"
        },
        {
          "storeID": "23",
          "dealID": "tyTH88J0PXRvYALBjV3cNHd5Juq1qKcu4tG4lBiUCt4%3D",
          "price": "16.54",
          "retailPrice": "19.99",
          "savings": "17.258629"
        },
        {
          "storeID": "28",
          "dealID": "atibivJQyXsOousolMoHm2iwPKyZaYMxbJ0sR0030M4%3D",
          "price": "16.99",
          "retailPrice": "19.99",
          "savings": "15.007504"
        },
        {
          "storeID": "21",
          "dealID": "Dtzv5PHBf71720cIYjxx3oHvvZK3iHUbQjv6fWLVpd8%3D",
          "price": "19.99",
          "retailPrice": "19.99",
          "savings": "0.000000"
        }
      ]
    },
    "media": {
      "thumbnailUrl": "https://cdn.fanatical.com/production/product/400x225/105f34ca-7757-47ad-953e-7df7f016741e.jpeg"
    }
  },
  "metadata": {
    "platform": "cheapshark",
    "endpoint": "game",
    "cached": false,
    "stale": false,
    "age_s": 0,
    "fetched_at": "2026-01-01T12:00:00+00:00",
    "credits_charged": 1,
    "request_id": "7f3a9c2e5b1d4c8fa2e6d0b9c4f18e37"
  },
  "error": null
}
```

## Field mapping

How this endpoint's source fields become Onekey's [unified schema](https://onekey.dev/docs/schema.md). Fields the source lacks come back as `null`.

| Source path | Onekey field | Transform |
| --- | --- | --- |
| `info.title` | `entity.name` | - |
| `info.steamAppID` | `ext.steamAppId` | - |
| `info.thumb` | `media.thumbnailUrl` | `safeUrl` |
| `cheapestPriceEver.price` | `ext.cheapestPriceEver` | `toNumber` |
| `cheapestPriceEver.date` | `ext.cheapestPriceEverAt` | `toIsoDate` |
| `deals` | `ext.deals` | - |

## 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](https://onekey.dev/pricing); your balance must cover the price. |
| 404 | `not_found` | That record does not exist. Free; do not retry. |
| 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](https://onekey.dev/docs/errors.md) for the full list and retry guidance.

Status: stable (verified against the live source).
