/nowplaying

GET

https://demo.azuracast.com/api/nowplaying

Returns a full summary of all stations’ current state.

GET /nowplaying

curl -X GET 'https://demo.azuracast.com/api/nowplaying'

const response = await fetch('https://demo.azuracast.com/api/nowplaying', {
  method: 'GET',
});

const data = await response.text();

import requests

response = requests.get('https://demo.azuracast.com/api/nowplaying')
print(response.text)

200

[
  {
    "station": {
      "id": 1,
      "name": "AzuraTest Radio",
      "shortcode": "azuratest_radio",
      "description": "An AzuraCast station!",
      "frontend": "shoutcast2",
      "backend": "liquidsoap",
      "timezone": "America/Chicago",
      "listen_url": "http://localhost:8000/radio.mp3",
      "url": "https://example.com/",
      "public_player_url": "https://example.com/public/example_station",
      "playlist_pls_url": "https://example.com/public/example_station/playlist.pls",
      "playlist_m3u_url": "https://example.com/public/example_station/playlist.m3u",
      "is_public": true,
      "requests_enabled": true,
      "mounts": [
        {
          "id": 1,
          "name": "/radio.mp3",
          "url": "http://localhost:8000/radio.mp3",
          "bitrate": 128,
          "format": "mp3",
          "listeners": {
            "total": 20,
            "unique": 15,
            "current": 20
          },
          "path": "/radio.mp3",
          "is_default": true
        }
      ],
      "remotes": [
        {
          "id": 1,
          "name": "/radio.mp3",
          "url": "http://localhost:8000/radio.mp3",
          "bitrate": 128,
          "format": "mp3",
          "listeners": {
            "total": 20,
            "unique": 15,
            "current": 20
          }
        }
      ],
      "hls_enabled": true,
      "hls_is_default": true,
      "hls_url": "https://example.com/hls/azuratest_radio/live.m3u8",
      "hls_listeners": 1
    },
    "listeners": {
      "total": 20,
      "unique": 15,
      "current": 20
    },
    "live": {
      "is_live": false,
      "streamer_name": "DJ Jazzy Jeff",
      "broadcast_start": "1591548318",
      "art": "https://picsum.photos/1200/1200"
    },
    "now_playing": {
      "sh_id": 0,
      "played_at": 1609480800,
      "duration": 180,
      "playlist": "Top 100",
      "playlist_chain": [
        "Main Rotation",
        "Rock",
        "Rock Hits"
      ],
      "playlist_source": "songs",
      "streamer": "Test DJ",
      "is_request": true,
      "song": {
        "text": "Chet Porter - Aluko River",
        "artist": "Chet Porter",
        "title": "Aluko River",
        "album": "Moving Castle",
        "genre": "Rock",
        "isrc": "US28E1600021",
        "lyrics": "",
        "id": "9f33bbc912c19603e51be8e0987d076b",
        "art": "https://picsum.photos/1200/1200",
        "custom_fields": [
          "custom_field_value"
        ]
      },
      "elapsed": 25,
      "remaining": 155
    },
    "playing_next": {
      "cued_at": 1609480800,
      "played_at": 1609480800,
      "duration": 180,
      "playlist": "Top 100",
      "playlist_chain": [
        "Main Rotation",
        "Rock",
        "Rock Hits"
      ],
      "playlist_source": "songs",
      "is_request": true,
      "song": {
        "text": "Chet Porter - Aluko River",
        "artist": "Chet Porter",
        "title": "Aluko River",
        "album": "Moving Castle",
        "genre": "Rock",
        "isrc": "US28E1600021",
        "lyrics": "",
        "id": "9f33bbc912c19603e51be8e0987d076b",
        "art": "https://picsum.photos/1200/1200",
        "custom_fields": [
          "custom_field_value"
        ]
      }
    },
    "song_history": [
      {
        "sh_id": 0,
        "played_at": 1609480800,
        "duration": 180,
        "playlist": "Top 100",
        "playlist_chain": [
          "Main Rotation",
          "Rock",
          "Rock Hits"
        ],
        "playlist_source": "songs",
        "streamer": "Test DJ",
        "is_request": true,
        "song": {
          "text": "Chet Porter - Aluko River",
          "artist": "Chet Porter",
          "title": "Aluko River",
          "album": "Moving Castle",
          "genre": "Rock",
          "isrc": "US28E1600021",
          "lyrics": "",
          "id": "9f33bbc912c19603e51be8e0987d076b",
          "art": "https://picsum.photos/1200/1200",
          "custom_fields": [
            "custom_field_value"
          ]
        }
      }
    ],
    "is_online": true,
    "cache": "hit"
  }
]

Response

200OKArray<Api_NowPlaying>

Success

Response fields application/json

Array<Api_NowPlaying>

Show child attributes

stationApi_NowPlaying_Stationrequired

Show child attributes

idintegerrequired

Station ID

Example

namestringrequired

Station name

Example

AzuraTest Radio

shortcodestringrequired

Station “short code”, used for URL and folder paths

Example

azuratest_radio

descriptionstringrequired

Station description

Example

An AzuraCast station!

frontendstringrequired

Which broadcasting software (frontend) the station uses

Example

shoutcast2

backendstringrequired

Which AutoDJ software (backend) the station uses

Example

liquidsoap

timezonestringrequired

The station’s IANA time zone

Example

America/Chicago

listen_urlstringrequired

The full URL to listen to the default mount of the station

Example

http://localhost:8000/radio.mp3

urlstring | nullrequired

The public URL of the station.

Example

https://example.com/

public_player_urlstringrequired

The public player URL for the station.

Example

https://example.com/public/example_station

playlist_pls_urlstringrequired

The playlist download URL in PLS format.

Example

https://example.com/public/example_station/playlist.pls

playlist_m3u_urlstringrequired

The playlist download URL in M3U format.

Example

https://example.com/public/example_station/playlist.m3u

is_publicbooleanrequired

If the station is public (i.e. should be shown in listings of all stations)

Example

true

requests_enabledbooleanrequired

If the station has song requests enabled.

Example

true

mountsArray<Api_NowPlaying_StationMount>required

Show child attributes

idintegerrequired

Mount/Remote ID number.

Example

namestringrequired

Mount point name/URL

Example

/radio.mp3

urlstringrequired

Full listening URL specific to this mount

Example

http://localhost:8000/radio.mp3

bitrateinteger | nullrequired

Bitrate (kbps) of the broadcasted audio (if known)

Example

formatstring | nullrequired

Audio encoding format of broadcasted audio (if known)

Example

mp3

listenersApi_NowPlaying_Listenersrequired

Show child attributes

totalintegerrequired

Total non-unique current listeners

Example

uniqueintegerrequired

Total unique current listeners

Example

currentintegerrequired

Total non-unique current listeners (Legacy field, may be retired in the future.)

Example

pathstringrequired

The relative path that corresponds to this mount point

Example

/radio.mp3

is_defaultbooleanrequired

If the mount is the default mount for the parent station

Example

true

remotesArray<Api_NowPlaying_StationRemote>required

Show child attributes

idintegerrequired

Mount/Remote ID number.

Example

namestringrequired

Mount point name/URL

Example

/radio.mp3

urlstringrequired

Full listening URL specific to this mount

Example

http://localhost:8000/radio.mp3

bitrateinteger | nullrequired

Bitrate (kbps) of the broadcasted audio (if known)

Example

formatstring | nullrequired

Audio encoding format of broadcasted audio (if known)

Example

mp3

listenersApi_NowPlaying_Listenersrequired

Show child attributes

totalintegerrequired

Total non-unique current listeners

Example

uniqueintegerrequired

Total unique current listeners

Example

currentintegerrequired

Total non-unique current listeners (Legacy field, may be retired in the future.)

Example

hls_enabledbooleanrequired

If the station has HLS streaming enabled.

Example

true

hls_is_defaultbooleanrequired

If the HLS stream should be the default one for the station.

Example

true

hls_urlstring | nullrequired

The full URL to listen to the HLS stream for the station.

Example

https://example.com/hls/azuratest_radio/live.m3u8

hls_listenersintegerrequired

HLS Listeners

Example

listenersApi_NowPlaying_Listenersrequired

Show child attributes

totalintegerrequired

Total non-unique current listeners

Example

uniqueintegerrequired

Total unique current listeners

Example

currentintegerrequired

Total non-unique current listeners (Legacy field, may be retired in the future.)

Example

liveApi_NowPlaying_Liverequired

Show child attributes

is_livebooleanrequired

Whether the stream is known to currently have a live DJ.

Example

false

streamer_namestringrequired

The current active streamer/DJ, if one is available.

Example

DJ Jazzy Jeff

broadcast_startinteger | nullrequired

The start timestamp of the current broadcast, if one is available.

Example

1591548318

artstring | nullrequired

URL to the streamer artwork (if available).

Example

https://picsum.photos/1200/1200

now_playingApi_NowPlaying_SongHistory & object | nullrequired

Show child attributes

One of

sh_idintegerrequired

Song history unique identifier

played_atintegerrequired

UNIX timestamp when playback started.

Example

1609480800

durationintegerrequired

Duration of the song in seconds

Example

playliststring | nullrequired

Indicates the playlist that the song was played from, if available, or empty string if not.

Example

Top 100

playlist_chainArray<string> | nullrequired

Names of the playlist group chain the song was picked through if played from a group

Example

[
  "Main Rotation",
  "Rock",
  "Rock Hits"
]

playlist_sourcePlaylistSources | nullrequired

The source of the playlist that the song was played from, if available.

Show child attributes

One of

PlaylistSourcessongsplaylistsremote_urlrequests

streamerstring | nullrequired

Indicates the current streamer that was connected, if available, or empty string if not.

Example

Test DJ

is_requestbooleanrequired

Indicates whether the song is a listener request.

songApi_HasSongFields & objectrequired

Show child attributes

textstring

The song title, usually “Artist - Title”

Example

Chet Porter - Aluko River

artiststring | null

The song artist.

Example

Chet Porter

titlestring | null

The song title.

Example

Aluko River

albumstring | null

The song album.

Example

Moving Castle

genrestring | null

The song genre.

Example

Rock

isrcstring | null

The International Standard Recording Code (ISRC) of the file.

Example

US28E1600021

lyricsstring | null

Lyrics to the song.

Example

idstring

The song’s 32-character unique identifier hash

Example

9f33bbc912c19603e51be8e0987d076b

artstring

URL to the album artwork (if available).

Example

https://picsum.photos/1200/1200

custom_fieldsArray<string>

elapsedintegerrequired

Elapsed time of the song’s playback since it started.

Example

remainingintegerrequired

Remaining time in the song, in seconds.

Example

playing_nextApi_NowPlaying_StationQueue | nullrequired

Show child attributes

One of

cued_atintegerrequired

UNIX timestamp when the AutoDJ is expected to queue the song for playback.

Example

1609480800

played_atinteger | nullrequired

UNIX timestamp when playback is expected to start.

Example

1609480800

durationnumber<float>required

Duration of the song in seconds

Example

playliststring | nullrequired

Indicates the playlist that the song was played from, if available, or empty string if not.

Example

Top 100

playlist_chainArray<string> | nullrequired

Names of the playlist group chain the song was picked through if played from a group

Example

[
  "Main Rotation",
  "Rock",
  "Rock Hits"
]

playlist_sourcePlaylistSources | nullrequired

The source of the playlist that the song was played from, if available.

Show child attributes

One of

PlaylistSourcessongsplaylistsremote_urlrequests

is_requestbooleanrequired

Indicates whether the song is a listener request.

songApi_HasSongFields & objectrequired

Show child attributes

textstring

The song title, usually “Artist - Title”

Example

Chet Porter - Aluko River

artiststring | null

The song artist.

Example

Chet Porter

titlestring | null

The song title.

Example

Aluko River

albumstring | null

The song album.

Example

Moving Castle

genrestring | null

The song genre.

Example

Rock

isrcstring | null

The International Standard Recording Code (ISRC) of the file.

Example

US28E1600021

lyricsstring | null

Lyrics to the song.

Example

idstring

The song’s 32-character unique identifier hash

Example

9f33bbc912c19603e51be8e0987d076b

artstring

URL to the album artwork (if available).

Example

https://picsum.photos/1200/1200

custom_fieldsArray<string>

song_historyArray<Api_NowPlaying_SongHistory>required

Show child attributes

sh_idintegerrequired

Song history unique identifier

played_atintegerrequired

UNIX timestamp when playback started.

Example

1609480800

durationintegerrequired

Duration of the song in seconds

Example

playliststring | nullrequired

Indicates the playlist that the song was played from, if available, or empty string if not.

Example

Top 100

playlist_chainArray<string> | nullrequired

Names of the playlist group chain the song was picked through if played from a group

Example

[
  "Main Rotation",
  "Rock",
  "Rock Hits"
]

playlist_sourcePlaylistSources | nullrequired

The source of the playlist that the song was played from, if available.

Show child attributes

One of

PlaylistSourcessongsplaylistsremote_urlrequests

streamerstring | nullrequired

Indicates the current streamer that was connected, if available, or empty string if not.

Example

Test DJ

is_requestbooleanrequired

Indicates whether the song is a listener request.

songApi_HasSongFields & objectrequired

Show child attributes

textstring

The song title, usually “Artist - Title”

Example

Chet Porter - Aluko River

artiststring | null

The song artist.

Example

Chet Porter

titlestring | null

The song title.

Example

Aluko River

albumstring | null

The song album.

Example

Moving Castle

genrestring | null

The song genre.

Example

Rock

isrcstring | null

The International Standard Recording Code (ISRC) of the file.

Example

US28E1600021

lyricsstring | null

Lyrics to the song.

Example

idstring

The song’s 32-character unique identifier hash

Example

9f33bbc912c19603e51be8e0987d076b

artstring

URL to the album artwork (if available).

Example

https://picsum.photos/1200/1200

custom_fieldsArray<string>

is_onlinebooleanrequired

Whether the stream is currently online.

Example

true

cachestring | nullhitdatabasestationrequired

Debugging information about where the now playing data comes from.

Docs by Sourcey