Skip to content

Getting Started

Base URL

https://api.radioreg.net

All endpoints are relative to this base URL. Example:

GET https://api.radioreg.net/stream

Response Format

The API always returns JSON. Errors follow this schema:

json
{
  "statusCode": 404,
  "message": "Not Found"
}

Authentication

The RadioReg API supports two types of authentication.

JWT Bearer Token

All endpoints that require a logged-in user use a JWT token. You can obtain the token via the login endpoint.

http
Authorization: Bearer <your-jwt-token>

Example:

bash
curl https://api.radioreg.net/user/streams \
  -H "Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."

Tokens are valid for 24 hours by default. Using thirtyDaysLogin: true during login extends the validity to 30 days.

Organization API Token

For webhook integrations (e.g. real-time stream updates), an organization-specific API token is used. You can find it in your organization settings.

http
Authorization: Bearer <organization-api-token>

Example:

bash
curl -X POST https://api.radioreg.net/stream/update/your-stream-uuid \
  -H "Authorization: Bearer rr_org_abc123..." \
  -H "Content-Type: application/json" \
  -d '{"title": "Song Name", "artist": "Artist Name"}'

Public Endpoints

The following endpoints are accessible without authentication:

EndpointDescription
GET /streamList all streams
GET /stream/:id/historySong history of a stream
GET /stream/:id/votesVote count for a stream
GET /organizationList all organizations
GET /organization/:idOrganization details
GET /organization/name/:nameOrganization by name
GET /organization/limit/:limitRandom organizations
GET /organization/:id/streamsStreams of an organization
POST /userCreate a new account
POST /user/loginLog in
GET /statsPlatform statistics

RadioReg API