Skip to content

Endpoints

Jump to bottom
Tyler Hancock edited this page Nov 16, 2020 · 1 revision

Endpoints

Games

Get All Games - v1/games

The base endpoint for games will provide you with the data for every single game in our database.

Property Type Description
games Game[] An array of all games in our database.
sort SlugName[] An array of all supported sorting options for sorting game data.
gameCount Long The total number of games.

Get Specific Game - v1/games/{gameSlug}

When a specific game is specified the API will return the data for just that game. The return data is Specifying a specific game will provide you with the data for that game. The data returned uses our Game data structure.

Get Project Type - v1/games/{gameSlug}/{projectTypeSlug}

When specifying the game and a specific project type you will get the data for that project type. The data returned by our API uses the ProjectType data structure.

Get All Projects - v1/games/{gameSlug}/{projectTypeSlug}/projects

When specifying the game and a specific project type you can get all of the projects of that type. The data returned by our API uses the Project data structure.

//TODO This currently returns a Project[] which is not JSON compliant. This may be wrapped in an object in a future update.

Get Specific Project - v1/games/{gameSlug}/{projectTypeSlug}/{projectSlug}

When specifying the game, type, and project slug the API will return the data of a specific project. The data returned uses the Project data structure.

Get Project Files - v1/games//{gameSlug}/{projectTypeSlug}/{projectSlug}/files

When specifying the game, type, and project slug the API can return the files for a given project.

Patch Project - v1/games/{gameSlug}/{projectTypeSlug}/{projectSlug}

//TODO

Get Project Feed - v1/games/{gameSlug}/{projectTypeSlug}/feed.atom

When specifying the game and a specific project type you can get an Atom feed of the released projects. This feed will contain the 25 most recent projects to be published to the platform.

Feed items include the following information.

  • title - The name of the project.
  • updated - The creation date of the project.
  • id - The URL of the project's page.
  • author - A collection of author names.
  • content - The summary description of the project.

Get Project File Feed - v1/games/{gameSlug}/{projectTypeSlug}/{projectSlug}/feed.atom

When specifying the game, project type, and project slug you can get an Atom feed of the released files for the project. This will return all files for the project with newer files showing up first.

Feed items include the following information.

  • title - The name of the file.
  • updated - The creation date of the file.
  • id - A URL to a page with more information about the file.
  • author - A collection of author names.
  • content - The changelog for the file.

Clone this wiki locally