RYVL API Documentation

Welcome to the RYVL API documentation. This documentation covers all available API endpoints in the Laravel application.

Overview

RYVL is a sports-focused social platform with real-time match tracking, predictions, and integrated chat functionality via Matrix Synapse.

Base URL

All API endpoints are prefixed with /api

Authentication

Most endpoints require authentication using Laravel Sanctum. See the Authentication Guide for details.

Quick Links

• API Reference - Complete list of all endpoints
• Authentication Guide - How to authenticate with the API
• Coverage Report - Documentation coverage status

Key Features

• Authentication: Phone-based login with OTP verification
• Matrix Integration: Secure chat rooms with E2EE support
• Sports Data: Teams, tournaments, events, and predictions
• Social Features: User profiles, team preferences, and coin system

Getting Started

1. First, authenticate using the phone verification flow
2. Set up your username and profile
3. Select your favorite teams
4. Start making predictions and joining chat rooms

Visit the API Reference to explore all available endpoints.