# freetogame.game

**stable** **Standard**

Details of a free-to-play game.

`GET /v1/freetogame/game`

## What you get

One Freetogame 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 |
| --- | --- | --- | --- | --- | --- |
| `id` | string | yes | (required) | FreeToGame id | max 6 chars; must match `[0-9]{1,6}`; trimmed |

## Request

```bash
curl "https://api.onekey.dev/v1/freetogame/game?id=452" \
  -H "x-api-key: YOUR_API_KEY"
```

```python
import requests

res = requests.get(
    "https://api.onekey.dev/v1/freetogame/game",
    params={"id": "452"},
    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({ id: "452" });
const res = await fetch(`https://api.onekey.dev/v1/freetogame/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 Freetogame response, recorded and returned in Onekey's shape. Fields the platform does not provide are `null`.

```json
{
  "success": true,
  "data": {
    "entity": {
      "id": "452",
      "name": "Call of Duty: Warzone",
      "description": "A standalone free-to-play battle royale and modes accessible via Call of Duty: Modern Warfare.",
      "url": "https://www.freetogame.com/open/call-of-duty-warzone",
      "category": "Shooter",
      "status": "Live"
    },
    "ext": {
      "platform": "Windows",
      "publisher": "Activision",
      "minOs": "Windows 7 64-Bit (SP1) or Windows 10 64-Bit"
    },
    "author": {
      "username": "Infinity Ward"
    },
    "content": {
      "createdAt": "2020-03-10T00:00:00Z",
      "text": "Call of Duty: Warzone is both a standalone free-to-play battle royale and modes accessible via Call of Duty: Modern Warfare. Warzone features two modes — the general 150-player battle royle, and “Plunder”. The latter mode is described as a “race to deposit the most Cash”. In both modes players can both earn and loot cash to be used when purchasing in-match equipment, field upgrades, and more. Both cash and XP are earned in a variety of ways, including completing contracts.\r\n\r\nAn interesting feature of the game is one that allows players who have been killed in a match to rejoin it by winning a 1v1 match against other felled players in the Gulag.\r\n\r\nOf course, being a battle royale, the game does offer a battle pass. The pass offers players new weapons, playable characters, Call of Duty points, blueprints, and more. Players can also earn plenty of new items by completing objectives offered with the pass."
    },
    "media": {
      "thumbnailUrl": "https://www.freetogame.com/g/452/thumbnail.jpg",
      "url": "https://www.freetogame.com/g/452/Call-of-Duty-Warzone-1.jpg"
    }
  },
  "metadata": {
    "platform": "freetogame",
    "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 |
| --- | --- | --- |
| `id` | `entity.id` | `toString` |
| `title` | `entity.name` | - |
| `short_description` | `entity.description` | - |
| `game_url` | `entity.url` | `safeUrl` |
| `genre` | `entity.category` | - |
| `platform` | `ext.platform` | - |
| `publisher` | `ext.publisher` | - |
| `developer` | `author.username` | - |
| `release_date` | `content.createdAt` | `toIsoDate` |
| `thumbnail` | `media.thumbnailUrl` | `safeUrl` |
| `description` | `content.text` | - |
| `status` | `entity.status` | - |
| `minimum_system_requirements.os` | `ext.minOs` | - |
| `screenshots.0.image` | `media.url` | `safeUrl` |

## Caching and freshness

- Fresh for about 1 hour. Repeat calls in that window are served from cache and are free.
- Between 1 hour and 1 day 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 2 days more (marked stale).
- A "not found" is remembered for 5 minutes 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).