Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/nestrilabs/nestri/llms.txt

Use this file to discover all available pages before exploring further.

The games endpoints expose the Nestri game catalogue. Use GET /games to retrieve every title in the authenticated user’s library, or use GET /games/:id to look up any game in the Nestri catalogue by its ID — even titles not yet in the user’s library. Each game record includes base metadata, categorisation, and all available image assets.

GET /games

List all games in the authenticated user’s library.
GET https://api.nestri.io/games

Request headers

Authorization
string
required
Bearer token in the format Bearer <your-jwt-token>.

Response

Returns a data array of Game objects.
data
Game[]
required

Example

curl https://api.nestri.io/games \
  --header "Authorization: Bearer <your-jwt-token>"

GET /games/:id

Get a single game by its ID. The game does not need to be in the user’s library — this endpoint covers the full Nestri catalogue.
GET https://api.nestri.io/games/:id
Use this endpoint to display game details without requiring the user to own the title, for example on a storefront or discovery page.

Path parameters

id
string
required
The Steam App ID of the game to retrieve. Example: "1809540".

Request headers

Authorization
string
required
Bearer token in the format Bearer <your-jwt-token>.

Response

Returns a data object with the same Game field structure as the list endpoint above.

Example

curl https://api.nestri.io/games/1809540 \
  --header "Authorization: Bearer <your-jwt-token>"

Example response

{
  "data": {
    "id": "1809540",
    "slug": "nine-sols",
    "name": "Nine Sols",
    "description": "Nine Sols is a lore rich, hand-drawn 2D action-platformer...",
    "score": 4.7,
    "releaseDate": "2024-05-29T06:53:24.000Z",
    "primaryGenre": "Action",
    "controllerSupport": "full",
    "compatibility": "high",
    "links": ["https://example.com"],
    "size": {
      "downloadSize": 7907568608,
      "sizeOnDisk": 13176088178
    },
    "genres": [
      { "slug": "action", "name": "Action" },
      { "slug": "adventure", "name": "Adventure" }
    ],
    "tags": [
      { "slug": "metroidvania", "name": "Metroidvania" }
    ],
    "developers": [
      { "slug": "redcandlegames", "name": "RedCandleGames" }
    ],
    "publishers": [
      { "slug": "redcandlegames", "name": "RedCandleGames" }
    ],
    "categories": [
      { "slug": "partial-controller", "name": "Partial Controller" }
    ],
    "franchises": [],
    "screenshots": [ ... ],
    "boxArts": [ ... ],
    "posters": [ ... ],
    "banners": [ ... ],
    "heroArts": [ ... ],
    "backdrops": [ ... ],
    "logos": [ ... ],
    "icons": [ ... ]
  }
}

Error responses

StatusCodeDescription
400INVALID_PARAMETERRequest validation failed (e.g. missing id)
404RESOURCE_NOT_FOUNDNo game found with the given ID
429Rate limit exceeded

Build docs developers (and LLMs) love