API Docs

Welcome to the Gameboxd API documentation. Here you will find details about how to use the API endpoints, including examples of requests and responses.

Base URL

All endpoints are relative to the base URL:

https://api.gameboxd.me/api/

Endpoints

Get All Games

Retrieves all games from the database with optional pagination.

/api/games

Query Parameters

page (optional): Page number (default: 1)
limit (optional): Number of games per page (default: 20, max: 100)
sort (optional): Sort field (e.g., 'releaseDate', 'name')
order (optional): Sort order ('asc' or 'desc', default: 'desc')

Response

{
  "games": [
    {
      "id": 780,
      "created_at": "2024-09-20T21:23:52.816637+00:00",
      "name": "Game Name",
      "slug": "game-name",
      "coverImageUrl": "https://example.com/image.jpg",
      "addedBy": "USER_ID",
      "description": "Game description.",
      "releaseDate": "2025-02-14",
      "platforms": ["Platform1", "Platform2"],
      "genres": ["Genre1", "Genre2"],
      "developer": "Developer Name",
      "publisher": "Publisher Name",
      "isNSFW": false,
      "averageRating": null,
      "storeLinks": {
        "gog": "",
        "xbox": "",
        "steam": "",
        "epicGames": "",
        "playStation": "",
        "nintendoSwitch": ""
      },
      "franchises": ["Franchise1"],
      "aliases": ["Alias1"],
      "isTBA": false,
      "hashtags": ["hashtag1", "hashtag2"],
      "images": [
        {
          "url": "https://example.com/image1.jpg",
          "description": "Image description"
        }
      ],
      "videos": [
        {
          "url": "https://youtube.com/watch?v=video_id",
          "description": "Video description"
        }
      ]
    },
    // ... more games ...
  ],
  "pagination": {
    "currentPage": 1,
    "totalPages": 10,
    "totalGames": 198,
    "gamesPerPage": 20
  }
}

Error Responses

400: Invalid query parameters