Api_Admin_Relay

object

idinteger

Station ID

Example

namestring | null

Station name

Example

AzuraTest Radio

shortcodestring | null

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

Example

azuratest_radio

descriptionstring | null

Station description

Example

An AzuraCast station!

urlstring | null

Station homepage URL

Example

https://www.azuracast.com/

genrestring | null

The genre of the station

Example

Variety

typestring | null

Which broadcasting software (frontend) the station uses

Example

shoutcast2

portinteger | null

The port used by this station to serve its broadcasts.

Example

relay_pwstring

The relay password for the frontend (if applicable).

Example

p4ssw0rd

admin_pwstring

The administrator password for the frontend (if applicable).

Example

p4ssw0rd

mountsArray<Api_NowPlaying_StationMount>

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

Example

{
  "id": 1,
  "name": "AzuraTest Radio",
  "shortcode": "azuratest_radio",
  "description": "An AzuraCast station!",
  "url": "https://www.azuracast.com/",
  "genre": "Variety",
  "type": "shoutcast2",
  "port": 8000,
  "relay_pw": "p4ssw0rd",
  "admin_pw": "p4ssw0rd",
  "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
    }
  ]
}

Docs by Sourcey