API Reference Overview

This section contains detailed documentation for all API endpoints available in the RYVL application.

Endpoint Categories

Public Endpoints (No Authentication Required)

• Login & Verification - Phone-based authentication
• Room Invites - Public room invitation handling

Protected Endpoints (Authentication Required)

All other endpoints require authentication via bearer token.

Authentication Endpoints

• User Management - User profile and session management
• Phone Verification - Phone number verification flows
• Matrix Integration - Matrix chat system integration
• E2EE Keys - End-to-end encryption key management

Resource Endpoints

• Teams - Sports team management
• Tournaments - Tournament data and listings
• Events - Match events and schedules
• Predictions - User predictions system
• Chat Rooms - Chat room management
• Coins - Virtual currency system

Development Endpoints

• Logs - Development environment logging (local/staging only)

Response Format

All API responses follow a consistent JSON structure:

Success Response

{
  "data": { ... },
  "message": "Success message (optional)"
}

Error Response

{
  "message": "Error description",
  "errors": {
    "field": ["validation error"]
  }
}

HTTP Status Codes

• 200 - Success
• 201 - Created
• 400 - Bad Request
• 401 - Unauthorized
• 403 - Forbidden
• 404 - Not Found
• 422 - Validation Error
• 500 - Server Error