# CheapShark on Onekey

> 4 endpoints for CheapShark (4 stable, 0 beta), 1 to 5 credits each. Category: Gaming. One key, one JSON shape.

Base URL: https://api.onekey.dev
Auth: header `x-api-key: <key>`. Call shape: `GET /v1/{platform}/{endpoint}?{params}`.
Every response is `{success, data, metadata, error}`; check `success` first. Cost is in `metadata.credits_charged`. Free when served from cache (0.2 credit for a cached response over 100 KB). Failed and not-found calls are refunded.
Status: stable = verified against the live source; beta = not yet verified, fields may be missing.

Page: https://onekey.dev/platforms/cheapshark
Reference (Markdown): https://onekey.dev/docs/api/cheapshark.md
All docs: https://onekey.dev/llms.txt

## Canonical fields returned

Unified-schema fields (same names on every platform), with how many of the 4 mapped CheapShark endpoints return each:

- `entity.name` (string): 4
- `entity.id` (string): 3
- `media.thumbnailUrl` (URL): 3
- `listing.price` (number): 2
- `listing.originalPrice` (number): 1
- plus 10 platform-specific fields under `ext.`

## Endpoints

### cheapshark.deals

Current game deals across stores, sortable by savings or price (CheapShark).
- Price: 5 credits per fresh call. Status: stable. Returns: a list.
- Request: `GET https://api.onekey.dev/v1/cheapshark/deals?sort_by=DealRating` with header `x-api-key: YOUR_API_KEY`
- Parameters:
  - `sort_by` (string, optional, default DealRating): Sort key (DealRating, Title, Savings, Price, Metacritic, Reviews, Release, Store, recent)
- Fields returned: `entity.id`, `entity.name`, `listing.price`, `listing.originalPrice`, `media.thumbnailUrl`, `ext.savingsPercent`, `ext.storeId`, `ext.gameId`, `ext.steamAppId`, `ext.metacriticScore`
- Reference: https://onekey.dev/docs/api/cheapshark/deals.md

### cheapshark.game

One game's cheapest price ever plus every current store deal (CheapShark).
- Price: 1 credit per fresh call. Status: stable. Returns: one record.
- Request: `GET https://api.onekey.dev/v1/cheapshark/game?game_id=612` with header `x-api-key: YOUR_API_KEY`
- Parameters:
  - `game_id` (string, required): CheapShark gameID (from cheapshark.search entity.id)
- Fields returned: `entity.name`, `media.thumbnailUrl`, `ext.steamAppId`, `ext.cheapestPriceEver`, `ext.cheapestPriceEverAt`, `ext.deals`
- Reference: https://onekey.dev/docs/api/cheapshark/game.md

### cheapshark.search

Search games and their cheapest current price (CheapShark).
- Price: 5 credits per fresh call. Status: stable. Returns: a list.
- Request: `GET https://api.onekey.dev/v1/cheapshark/search?q=batman` with header `x-api-key: YOUR_API_KEY`
- Parameters:
  - `q` (string, required): Search query
- Fields returned: `entity.id`, `entity.name`, `listing.price`, `media.thumbnailUrl`, `ext.dealId`, `ext.steamAppId`
- Reference: https://onekey.dev/docs/api/cheapshark/search.md

### cheapshark.stores

The stores CheapShark tracks (id, name, active flag).
- Price: 5 credits per fresh call. Status: stable. Returns: a list.
- Request: `GET https://api.onekey.dev/v1/cheapshark/stores` with header `x-api-key: YOUR_API_KEY`
- Parameters: none
- Fields returned: `entity.id`, `entity.name`, `ext.active`
- Reference: https://onekey.dev/docs/api/cheapshark/stores.md

## Sample request

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