GameReqs API provides endpoints to gain informations about games' system requirements. Data is scraped from Steam store(might add other sources in the future).

Every endpoint is prefixed with http://plutone00100.pythonanywhere.com/api/v1/. The API is currently in its first iteration. Also, every request needs to contain an api key with x-api-key header. Refer to CONTRIBUTING.md for further informations.

You can find information about games' system requirements from /games. You can also create, update and delete games resources. Every resource has the following properties:

Making a request to /games with no parameters returns a list of every resource.

• name(optional): search by game's name
• page(optional): a url-encoded JSON object that allows pagination of results. Needs two properties:
  • limit(required): maximum number of returned results
  • last_id(required): indicates that the next page will yield games from last_id+1 onward
• filter(optional): a url-encoded array of JSON objects that allows filtering over RAM and storage. Every object needs 3 properties:
  • op(required): a comparison operator string (eq, neq, gt, ge, le, lt)
  • memory(required): the name of the property (storage or ram)
  • value(required): value that need to be filtered

An example with filters and pagination: /games?pagefilters=[{"memory":"ram_min","op":"lt", "value":1}]&page={"last_id":70000, "limit":10}

[
    {
        "id": 1,
        "info": {
          "description": "Legends of Persia is a highly ambitious Action RPG Adventure...",
          "developer": "Sourena Game Studio",
          "name": "Legends of Persia"
        },
        "minimum_requirements": {
          "OS_min": " Windows XP, Vista, 7 and 8",
          "cpu_min": " AMD 3500+ – Intel 2.2 Pentium 4 CPU",
          "gpu_min": " Geforce7000 series – ATI X1400 & HD series or greater",
          "ram_min": 1,
          "storage_min": 3.5
        },
        "recommended_requirements": {
          "OS_rec": null,
          "cpu_rec": null,
          "gpu_rec": null,
          "ram_rec": null,
          "storage_rec": null
        }
  }
]

This resource yields a subset of informations of the game resource. The endpoint is /games/info In particular, it returns only the info object of the games response object. As such, it accepts the same parameters as the Games resource.

This resource yields a subset of informations of the game resource. The endpoint is /games/minimum_requirements In particular, it returns only the minimum_requirements object of the games response object. As such, it accepts the same parameters as the Games resource.

This resource yields a subset of informations of the game resource. The endpoint is /games/recommended_requirements In particular, it returns only the recommended_requirements object of the games response object. As such, it accepts the same parameters as the Games resource.

It is possible to create new resources with POST /games. The body is a JSON containing all the properties described in the Games resource. The only required value here is name.

The API provides also a way to update resources with PUT /games. The object is the same as the POST request, with the only difference being the id, which is a required field.

It's possible to delete resources too, with DELETE /games/<id_game>.

Contributions are encouraged. Please refer to CONTRIBUTING.md