Api_StationProfile

object

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

servicesApi_StationServiceStatusrequired

Show child attributes

backendRunningbooleanrequired

Example

true

frontendRunningbooleanrequired

Example

true

scheduleArray<Api_StationSchedule>required

Show child attributes

idinteger

Unique identifier for this schedule entry.

Example

typestringplayliststreamer

The type of this schedule entry.

Example

playlist

namestring

Either the playlist or streamer’s display name.

Example

Example Schedule Entry

titlestring

The name of the event.

Example

Example Schedule Entry

descriptionstring

The full name of the type and name combined.

Example

Playlist: Example Schedule Entry

start_timestampinteger

The start time of the schedule entry, in UNIX format.

Example

1609480800

startstring

The start time of the schedule entry, in ISO 8601 format.

Example

020-02-19T03:00:00-06:00

end_timestampinteger

The end time of the schedule entry, in UNIX format.

Example

1609480800

endstring

The start time of the schedule entry, in ISO 8601 format.

Example

020-02-19T05:00:00-06:00

is_nowboolean

Whether the event is currently ongoing.

Example

true

Example

{
  "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
  },
  "services": {
    "backendRunning": true,
    "frontendRunning": true
  },
  "schedule": [
    {
      "id": 1,
      "type": "playlist",
      "name": "Example Schedule Entry",
      "title": "Example Schedule Entry",
      "description": "Playlist: Example Schedule Entry",
      "start_timestamp": 1609480800,
      "start": "020-02-19T03:00:00-06:00",
      "end_timestamp": 1609480800,
      "end": "020-02-19T05:00:00-06:00",
      "is_now": true
    }
  ]
}

Docs by Sourcey