Skip to main content

Usage

Ping​

You can check the status of the service by sending a GET request to the /ping endpoint. The service should respond with a 200 OK status code.

For example, you can use curl to do that:

curl --request GET http://localhost:10000/ping

Mounting sources​

To mount a source you need to use a client that can communicate with Icecast.

For example, you can use Liquidsoap for that:

liquidsoap \
    'output.icecast(
        host="localhost",
        port=10000,
        user="source",
        password="password",
        mount="radio.mp3",
        %mp3,
        sine()
    )'

Now you should hear a sine wave at http://localhost:10000/radio.mp3.

Listening​

You can listen to any active mount point. If a mount point is called radio.mp3 then you can reach the stream at http://localhost:10000/radio.mp3.

Icecast is responsible for handling as many listeners as possible and making sure all of them get the live audio.

Administration​

There are various endpoints with internal insights and statistics:

  • /admin/listclients.json?mount=/radio.mp3 - list clients listening to /radio.mp3
  • /admin/listmounts.json - list all active mount points
  • /admin/stats.json - various statistics
  • /admin/streamlist.json - list all active streams
  • /admin/publicstats.json - subset of statistics that are safe to expose to the public

All of them return data in JSON format. You need to authenticate with basic auth to access them.