📚 API Documentation

Base URL

https://your-platform.com/api/v1

Authentication

All API requests require authentication using Bearer token:

Authorization: Bearer YOUR_API_TOKEN

Endpoints

POST /auth/login

Authenticate user and receive access token

Request Body:

{
  "email": "user@example.com",
  "password": "password123"
}

Response:

{
  "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
  "user": {
    "id": 1,
    "username": "john_doe",
    "email": "user@example.com"
  }
}
GET /videos

Get list of videos

Query Parameters:

Response:

{
  "videos": [...],
  "pagination": {
    "current_page": 1,
    "total_pages": 10,
    "total_items": 200
  }
}
POST /videos/upload

Upload new video

Request Body (multipart/form-data):

GET /live-streams/active

Get list of active live streams

POST /contests/{id}/enter

Enter a contest

GET /analytics/dashboard

Get creator analytics dashboard data

Error Responses

{
  "error": "Error message",
  "code": "ERROR_CODE",
  "details": {}
}

Rate Limiting

API requests are limited to 1000 requests per hour per user.

Webhooks

Configure webhooks to receive real-time notifications for events.