API Endpoints Reference

Get Health Status#

GET /health

Returns system health status and version information.

Response:

{
  "status": "healthy",
  "version": "5.5",
  "endpoint": "ascendara-api"
}

About Ascendara Status

This endpoint also returns the status of Ascendara's index, which can be either "OK" or "updatingIndex". When "updatingIndex", this indicates that the index of games is being updated, and the app may experience slight delays in its functionality. Things like images, game fetching, and downloads may not be available.

The game index is updated once a month and only take 5-10 minutes to update. It is rare you will experience the "updatingIndex" status but if you do you will see a message when searching for games.

Get Games List#

GET /json/games

Returns the complete list of games with metadata.

Get Game Image#

GET /v2/image/{imageid}

Returns the image for a specific game.

Get Game Image by Weight#

GET /v2/image?place={position}

Returns game image based on its weight ranking.

Note: The previous v1 image endpoint has been discontinued due to various issues in the app. The v2 endpoint includes significant improvements such as better timeout handling, enhanced request authentication to better distinguish between Ascendara app requests and external requests, and other optimizations for improved reliability.

Get Download Statistics#

GET /stats/downloads

Returns download counts for games.

Get Current App Version#

GET /

Returns the current version of Ascendara as "appVer".

API Response:

{
  "appVer":"X.X.X",
  "status":"OK"
}

Get Broken Versions#

GET /app/brokenversions

Returns a list of known broken versions.

Get Changelog#

GET /json/changelog

Returns the changelog information.