Developers

Streamitter API

Versioned JSON over HTTPS for station metadata, listings, and integrations. Issue tokens in Admin, then Settings, then HTTP API and API access tokens.

Base URL

All machine endpoints are under a version prefix. Paths from the docs are appended to this root (example):

https://radio.streamitter.com/api/v1

What you can build

  • Read station and directory data in JSON (aligned with the live site)
  • Automate internal tools or partner dashboards with stable routes
  • Separate public integrations from admin capabilities using access policies on each route

Authentication

Send a secret as Authorization: Bearer <secret> or X-Api-Key: <secret>. Long-lived tokens are stored hashed; only a short prefix is shown after creation. Legacy keys from settings may still exist during migration.

If the API master switch is off in site settings, every JSON call returns 503 until it is enabled again.

Health endpoint

Example JSON route (requires an ApiBearer credential such as a configured public key or access token):

https://radio.streamitter.com/api/v1/health

Use curl or your HTTP client with the headers described above. Without a valid key you will see an auth error JSON response, which still confirms the API gateway is reachable.

Documentation

In this repository, read docs/API_FOR_AGENTS.md for the route map, access policies, and how App\Api\Dispatcher wires requests. For waitlists, early access, or partnerships, use the contact form.