Back to top

API Keys

API keys have not been implemented yet but will be when in a production like state.

Standard Response Body

All endpoints will respond with this structure unless noted otherwise.

[{  
    "title": "string",
    "platform": "string",
    "list_price": number,
    "msrp": number,
    "mem_price": number,
    "url": "string",
    "thumbnail": "string",
    "source": "string",
    "date": number
]}

Retreive All

Retrieve All JSON

GET /v1/all

To get all deals in a single API call use GET /v1/all. The response is an array of all results in the standard body format.

Retrieve All CSV

GET /v1/all/csv

Using GET /v1/all/csv will return a file in CSV format that can be shared with anyone who wants a more human eye friendly format such as social media personel. The file will contain the same data you get from /v1/all.

Retrieve All Counts

GET /v1/all/count

To get all the statistics of all the game deals by platform call GET /v1/all/count. The response body is a list of objects with keys platform and count showing the number of deals available for each platform.

Deals

Query Deals

GET /v1/deals

Retrieve deals based on query parameters.

Query params:

  • platforms: string- Comma separated values for platforms. Possible keys available from GET /v1/all/count response in platfrom values.
  • limit: int - Number of items you want per page.
  • index: int - Page of items you want returned.
  • order: string - Sorts response. Possible values: Ascending ASC and Descending DSND.