Client libraries ​

A client library wraps the management API so your own code can read stats, list listeners, disconnect a source, ban an address or update a track title without writing HTTP calls by hand. Each library returns typed objects and raises a typed error for every API error code.

LanguagePackageStatus
PHPquikcast/quikcastCovers the whole management API, source metadata updates, health and metrics

More languages may follow. Until then, any language can call the management API directly: it is plain HTTP with a Bearer token and JSON responses.

What every client needs ​

  • The admin address. The management API listens on admin_listen, which is loopback by default. Run your code on the same host, or reach it through a private proxy, a VPN or an SSH tunnel. Allowing remote access is covered in Remote management.

  • A management token. Enable [management] and read the token from the secret file. Keep it out of source code:

    sh
    export QUIKCAST_ADMIN_URL='http://127.0.0.1:9090'
    export QUIKCAST_TOKEN="$(cat secrets/management-token)"
  • Source credentials, only for metadata updates. Changing the "now playing" title is a source operation on the streaming port. It uses the mount's encoder username and password, not the management token.

What a client covers ​

AreaOperations
ServerInfo, capabilities and limits, drain
Stats and historyCounters, per-minute listener history
Mounts and sourcesList and inspect mounts, inspect or disconnect a source
ListenersPage through a mount's listeners, disconnect one
RelaysList, inspect, restart, stop
HLSStreams, renditions, directory-stream listener sessions
Bans and revocationsBan an address or range, revoke one signed link
Source metadataUpdate artist and title
MonitoringHealth probes and Prometheus text

Versions ​

A client is released separately from the server and reads only the fields it knows, so an older client keeps working against a newer server. A new server feature may need a newer client. Each library's changelog says which server version it was checked against.