Documentation

Endpoints

Core API endpoints by resource

Endpoints

Core API endpoints organized by resource type.

API v1 - Demo Endpoints

GET /api/v1/demo/year

Get the current year with timestamp

Public
GET /api/v1/status

Check API operational status

Public

API v1 - Protected Endpoints

GET /api/v1/protected/test

Test API key authentication

API Key
GET /api/v1/user/me

Get user info for API key owner

API Key
GET /api/v1/usage/stats

Get API usage statistics

API Key

WebSocket Endpoints - Live Demo

WS /api/v1/ws/echo

Echo server - sends back your messages with timestamp

Public
WS /api/v1/ws/time?api_key=YOUR_KEY

Time broadcast - streams server time every second (protected)

API Key