egdata API
API ReferenceSearch

Search offers with OpenSearch-backed filters and aggregations

POST
/search/v2/search

Query Parameters

country?string

ISO country code used to resolve an Epic Games Store pricing region. Defaults to the EGDATA_COUNTRY cookie, then US.

Length2 <= length <= 2
locale?string

Exact BCP-47-style locale used to overlay localized public offer text fields. Defaults to en-US.

Request Body

application/json

Search filters and sort options.

TypeScript Definitions

Use the request body type in TypeScript.

title?string
offerType?string
tags?array<string>
customAttributes?array<string>
categories?array<string>
seller?string
sortBy?string

Field used to order results. priceUpdatedAt sorts by prices.<selected region>.updatedAt.

Value in"releaseDate" | "lastModifiedDate" | "effectiveDate" | "creationDate" | "viewableDate" | "pcReleaseDate" | "upcoming" | "priceAsc" | "priceDesc" | "price" | "discount" | "discountPercent" | "priceUpdatedAt" | "giveawayDate"
sortDir?string
Value in"asc" | "desc"
limit?integer
Range1 <= value <= 100
page?integer
Range1 <= value
refundType?string
isCodeRedemptionOnly?boolean
price?
onSale?boolean
developerDisplayName?string
publisherDisplayName?string
spt?boolean
excludeBlockchain?boolean
pastGiveaways?boolean
isLowestPrice?boolean
isLowestPriceEver?boolean
technologies?array<>

Detected build technologies that every matching offer must contain. Values are trimmed and duplicates are ignored. Available values and matching offer counts are returned in aggregations.technologies.buckets.

Response Body

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/search/v2/search" \  -H "Content-Type: application/json" \  -d '{}'
{  "total": 0,  "offers": [    {      "id": "string",      "namespace": "string",      "title": "string",      "description": "string",      "longDescription": "string",      "offerType": "string",      "developerDisplayName": "string",      "publisherDisplayName": "string",      "seller": {        "id": "string",        "name": "string"      },      "tags": [        {}      ],      "offerMappings": [        {}      ],      "productSlug": "string",      "urlSlug": "string",      "url": "string",      "keyImages": [        {          "type": "string",          "url": "http://example.com",          "width": 0,          "height": 0        }      ],      "price": {        "offerId": "string",        "region": "string",        "price": {          "currencyCode": "string",          "originalPrice": 0,          "discountPrice": 0,          "discount": 0        },        "updatedAt": "2019-08-24T14:15:22Z"      },      "releaseDate": "2019-08-24T14:15:22Z",      "lastModifiedDate": "2019-08-24T14:15:22Z",      "locale": "es-ES",      "localeStatus": "canonical",      "canonicalLocale": "en-US",      "localization": {        "source": "string",        "fetchedAt": "2019-08-24T14:15:22Z",        "sourceUpdatedAt": "2019-08-24T14:15:22Z"      }    }  ],  "page": 0,  "limit": 0,  "aggregations": {    "technologies": {      "buckets": [        {          "key": "string",          "doc_count": 0        }      ]    }  },  "meta": {    "ms": 0,    "timed_out": true,    "cached": true  }}
{  "message": "string",  "error": "string"}
{  "message": "string",  "error": "string"}
{  "message": "string",  "error": "string"}

List sellers represented in free game history GET

Previous Page

Search offers with natural language POST

Embeds the query with Cloudflare Workers AI, ranks offer vectors in Cloudflare Vectorize, and hydrates each match from canonical Mongo offer documents using its indexed offer ID. Stale vectors that no longer resolve to an offer are omitted.