/epicgames/games/free

POST /api/epicgames/games/free

Price: 5 credits

Get current and upcoming free game promotions on the Epic Games Store

How to use it

Get the Epic Games Store free games showcase: titles given away for free right now plus the lineup announced for the upcoming weeks. Each entry includes the title, description, seller, key images, categories, regular price, and the promotion window (start and end dates) marking when the game is or will be free for the selected country.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• country string — Store country, drives price and currency (default: "US"; one of: "US", "GB", "CA", "AU", "DE", "FR", "IT", "ES", "NL", "BR", "MX", "IN", "JP", "KR", "TR", "RU", "PL")
• locale string — Content language (default: "en-US"; one of: "en-US", "en-GB", "de-DE", "fr-FR", "it-IT", "es-ES", "nl-NL", "pt-BR", "es-MX", "ja", "ko", "tr", "ru", "pl")

Response

• @type string (default: "EpicgamesFreeGame")
• id string required
• namespace string required
• alias string nullable
• description string nullable
• offer_type string nullable
• status string nullable
• effective_date string nullable
• seller object nullable
  • @type string (default: "EpicgamesSeller")
  • id string nullable
  • name string required
• image string nullable
• images array (default: [])
  • @type string (default: "EpicgamesImage")
  • image_type string required
  • url string required
• categories array (default: [])
• price object nullable
  • @type string (default: "EpicgamesPrice")
  • original_price number nullable
  • discount_price number nullable
  • currency_code string nullable
  • discount number nullable
  • discount_percent integer nullable
  • original_price_display string nullable
  • discount_price_display string nullable
• is_currently_free boolean (default: false)
• is_upcoming_free boolean (default: false)
• current_promotions array (default: [])
  • @type string (default: "EpicgamesFreePromotion")
  • start_at string nullable
  • end_at string nullable
  • discount_percent integer nullable
  • is_free boolean (default: false)
• upcoming_promotions array (default: [])
  • @type string (default: "EpicgamesFreePromotion")
  • start_at string nullable
  • end_at string nullable
  • discount_percent integer nullable
  • is_free boolean (default: false)
• url string nullable

Errors

• 422 — The request body did not validate Check the fields against this schema. A URN with the wrong prefix is the most common cause.
• 408 — The request ran past its time limit Raise `timeout` in the request body, up to the maximum this endpoint documents. Lowering `count` or turning off the `with_*` flags also helps, because less work finishes sooner.
• 412 — The entity was not found, or a precondition failed Retrying will not help: either the entity does not exist, or the input points at a different one.
• 429 — Too many requests: a rate limit or a usage window is exhausted When the response carries an X-Retry-After header, wait that many seconds and retry: the same number is in the body as `detail.retry_after`, and the limit clears once that window passes. The message in the body names the limit that was hit.
• 500 — Something broke on our side Retrying will not help. If it keeps happening, send us the X-Request-ID from the response headers.
• 529 — Rate limit reached, or the endpoint is overloaded Wait at least 30 seconds, then retry.

Response headers

• X-Error — Error message text (present only on error)
• X-Request-ID — Unique request identifier
• X-Execution-Time — Execution time in seconds
• X-Result-Count — How many records the body carries. 0 means an empty result, which is a normal answer and not by itself an error. A non-zero count can come back together with X-Error when the failure happened partway through — read this header and X-Error independently.
• X-Total-Available-Results — How many records exist for this query, when the endpoint can say. On a `dry_run` request this is the answer and the body is empty. It saturates: the endpoint's documented maximum means 'at least that many', any smaller number is exact.
• X-Warning — Present when the request body carried keys this endpoint does not document. They were ignored, so any filter you meant to apply through them did not apply. Check the spelling against this schema and retry.
• X-Retry-After — Seconds to wait before retrying. Present only on 429.