Skip to main content

API Reference

Welcome to the Intraverse Backend API reference. This documentation provides comprehensive information about all available endpoints, request/response formats, and authentication methods.

Base URL​

All API requests should be made to:

https://api.intraverse.io/

Authentication​

The Intraverse API uses different authentication methods depending on the endpoint:

Public APIs (No Authentication)​

  • Tournament APIs (/api/v2/tournament/...)
  • Drop APIs (/api/v2/drop/...)
  • Games APIs (/api/v2/public/games/...)
  • Guild discovery (/api/v2/guilds/public, /api/v2/guilds/public/:id, /api/v2/guilds/slug/:slug)

Game Key Authentication​

For game-specific operations:

x-game-key: your-game-key-here

Game Server Key Authentication​

For server-side game operations:

 x-game-server-key: your-game-key-here

JWT Token Authentication​

For user-specific operations:

Authorization: Bearer user-jwt-token-here

API Versioning​

The API uses versioning in the URL path:

  • v2: only available version

Response Format​

API responses vary by endpoint but follow consistent patterns:

Success Response (varies by endpoint)​

// Simple data response
{
  "data": [...]
}

// Simple message response
{
  "message": "Done"
}

// Simple value response
{
  "score": 1500
}

// Pagination response
{
  "current": {...},
  "previous": {...},
  "next": {...},
  "data": [...]
}

Error Response (consistent across all endpoints)​

{
  "message": "Error description",
  "status": 400
}

API Categories​

Authentication API​

Authentication guide for the Intraverse platform:

Drop API (Public)​

Query NFT ownership and calculate multipliers:

Games API (Public)​

Retrieve public game information and versions:

Guilds API​

Manage guilds (communities), members, and guild tournaments:

User API​

Retrieve player information from external games:

Game Point API​

Set and retrieve player game scores:

Tournament API (Public)​

Query tournaments and calculate NFT-based scores:

API Schemas​

Reference schemas for request/response objects:

Security​

For comprehensive security information, see our Security Guide.

Quick Security Notes:

  • Many APIs are public and require no authentication
  • Game keys should be kept secure for game-related operations
  • JWT tokens are required for user-specific data
  • All communications must use HTTPS
  • Input validation is performed on all requests

HTTP Status Codes​

CodeDescription
200Success
201Created
400Bad Request
401Unauthorized
403Forbidden
404Not Found
409Conflict
422Unprocessable Entity
429Too Many Requests
500Internal Server Error

Pagination​

List endpoints use cursor-based pagination:

Parameters​

  • size: Number of items per page (1-30, required)
  • key: Cursor key for pagination (optional)
  • direction: forward or backward (optional)
  • order: asc or desc (optional)
  • orderBy: Field to sort by (varies by endpoint)

Response Format​

{
  "current": {
    "size": 10,
    "key": null,
    "direction": null,
    "order": "asc",
    "orderBy": "name"
  },
  "previous": null,
  "next": {
    "size": 10,
    "key": "item-123",
    "direction": "forward"
  },
  "data": [...]
}

Key Features​

NFT Integration​

  • Query NFT ownership and calculate multipliers
  • Tournament scoring based on NFT holdings
  • Support for multiple blockchain platforms

Tournament System​

  • Public tournament listings with game-based filtering
  • NFT-based score calculation system
  • Tournament projects and airdrops integration

Game Management​

  • Public game catalog with detailed information
  • Multi-platform version management
  • Social media and visual asset integration

Guilds & Communities​

  • Guild creation and management with role-based permissions
  • Public guild discovery by slug or ID
  • Member management (join, list, count)
  • Integration with guild tournaments

Support​

For API support and questions: