Skip to main content

Games API

The Games API provides endpoints for querying public game information, versions, and metadata.

Overview​

The Games API enables you to:

  • Query Games: Retrieve public game information with cursor-based pagination
  • Game Details: Get comprehensive game details including visuals and social links
  • Version Management: Access game versions organized by platform and release type
  • Platform Support: Support for web, mobile, and desktop platforms

Endpoints​

MethodEndpointDescription
GET/api/v2/public/gamesList all public games with pagination
GET/api/v2/public/games/{slug}Get detailed information about a specific game
GET/api/v2/public/games/{slug}/versionsGet all versions of a game by platform

Authentication​

All games endpoints are public and do not require authentication.

Game Information​

Public games include:

  • Basic Details: Name, slug, description, and theme color
  • Visual Assets: Images, icons, and banner images
  • Platform Support: Web, mobile (iOS/Android), and desktop platforms
  • Social Links: Twitter, Discord, and other social media links
  • Tags: Descriptive tags for categorization
  • Timestamps: Creation and update dates

Game Versions​

Game versions are organized by:

  • Platform: web, android, ios, windows, macos, linux, other
  • Release Type: production, beta, alpha, development
  • Version Details: Name, description, build numbers, download URLs

Cursor Pagination​

The list games endpoint uses cursor-based pagination:

  • Size: Number of items per page (1-30)
  • Cursor Navigation: Use key and direction for pagination
  • Sorting: Sort by name, createdAt, or updatedAt

Supported Platforms​

PlatformDescription
webWeb browser games
androidAndroid mobile apps
iosiOS mobile apps
windowsWindows desktop apps
macosmacOS desktop apps
linuxLinux desktop apps
otherOther platforms

Error Codes​

CodeDescription
400Bad Request - Invalid parameters
404Not Found - Game not found

Next Steps​