API ReferenceSearch
Search offers with OpenSearch-backed filters and aggregations
Query Parameters
country?string
ISO country code used to resolve an Epic Games Store pricing region. Defaults to the EGDATA_COUNTRY cookie, then US.
Length
2 <= length <= 2Request 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
Value in
"releaseDate" | "lastModifiedDate" | "effectiveDate" | "creationDate" | "viewableDate" | "pcReleaseDate" | "upcoming" | "priceAsc" | "priceDesc" | "price" | "discount" | "discountPercent" | "giveawayDate"sortDir?string
Value in
"asc" | "desc"limit?integer
Range
1 <= value <= 100page?integer
Range
1 <= valuerefundType?string
isCodeRedemptionOnly?boolean
price?
onSale?boolean
developerDisplayName?string
publisherDisplayName?string
spt?boolean
excludeBlockchain?boolean
pastGiveaways?boolean
isLowestPrice?boolean
isLowestPriceEver?boolean
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", "offerType": "string", "seller": { "id": "string", "name": "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" } ], "page": 0, "limit": 0, "aggregations": {}, "meta": { "ms": 0, "timed_out": true, "cached": true }}{ "message": "string", "error": "string"}{ "message": "string", "error": "string"}{ "message": "string", "error": "string"}