# epic.free_games

**stable** **Advanced**

Epic Games Store current and upcoming free games.

`GET /v1/epic/free_games`

## What you get

A list of Epic 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

This endpoint takes no parameters.

## Request

```bash
curl "https://api.onekey.dev/v1/epic/free_games" \
  -H "x-api-key: YOUR_API_KEY"
```

```python
import requests

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

```json
{
  "success": true,
  "data": [
    {
      "content": {
        "id": "1f723b00df58467998c4984ca39915ad",
        "text": "Them's Fightin' Herds",
        "createdAt": "2022-12-19T16:00:00Z"
      },
      "entity": {
        "name": "Them's Fightin' Herds",
        "slug": "thems-fightin-herds"
      },
      "ext": {
        "developer": "Gameplay Group International Inc.",
        "normalPriceText": "$19.99",
        "priceText": "$19.99"
      },
      "media": {
        "thumbnailUrl": "https://cdn1.epicgames.com/offer/a567c32599bf4d4fb609e424f3691b39/EGS_ThemsFightinHerds_Mane6Inc_S1_2560x1440-da3a940faafe30c602d3966d2c295825"
      }
    },
    {
      "content": {
        "id": "d3e5b556640144bfa5de2d5d3b283d68",
        "text": "Join the latest trend in simulation games, bring out your creativity and make awesome-looking models with the base game and all available DLCs. Assemble, customize and display your creations, whether you’re a veteran or a novice. Get building, and get creative!",
        "createdAt": "2023-01-16T17:00:00Z"
      },
      "entity": {
        "name": "Model Builder: Complete Edition",
        "slug": "3f18c54a6e00424ba6e8f4422167cac7"
      },
      "ext": {
        "developer": "Green Man Gaming Publishing",
        "normalPriceText": "$19.99",
        "priceText": "$19.99"
      },
      "media": {
        "thumbnailUrl": "https://cdn1.epicgames.com/spt-assets/7472ec268e344e77a85e95976c0ffc6d/model-builder-1vfgr.png"
      }
    }
  ],
  "metadata": {
    "platform": "epic",
    "endpoint": "free_games",
    "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](https://onekey.dev/docs/schema.md). Fields the source lacks come back as `null`.

| Source path | Onekey field | Transform |
| --- | --- | --- |
| `id` | `content.id` | - |
| `title` | `entity.name` | - |
| `description` | `content.text` | - |
| `effectiveDate` | `content.createdAt` | `toIsoDate` |
| `seller.name` | `ext.developer` | - |
| `urlSlug` | `entity.slug` | - |
| `price.totalPrice.fmtPrice.originalPrice` | `ext.normalPriceText` | - |
| `price.totalPrice.fmtPrice.discountPrice` | `ext.priceText` | - |
| `keyImages.0.url` | `media.thumbnailUrl` | `safeUrl` |

## Caching and freshness

- Fresh for about 30 seconds. Repeat calls in that window are served from cache and are free.
- Between 30 seconds and 5 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` | 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](https://onekey.dev/docs/errors.md) for the full list and retry guidance.

Status: stable (verified against the live source).
