List all current stations in the system.

GET

https://demo.azuracast.com/api/admin/stations

curl -X GET 'https://demo.azuracast.com/api/admin/stations' \
  -H 'X-API-Key: YOUR_TOKEN'

const response = await fetch('https://demo.azuracast.com/api/admin/stations', {
  method: 'GET',
  headers: {
    'X-API-Key': 'YOUR_TOKEN',
  },
});

const data = await response.text();

import requests

response = requests.get(
    'https://demo.azuracast.com/api/admin/stations',
    headers={
        'X-API-Key': 'YOUR_TOKEN',
    },
)
print(response.text)

[
  {
    "id": 0,
    "name": "AzuraTest Radio",
    "short_name": "azuratest_radio",
    "is_enabled": true,
    "frontend_type": "icecast",
    "frontend_config": {
      "custom_config": "string",
      "source_pw": "string",
      "admin_pw": "string",
      "relay_pw": "string",
      "streamer_pw": "string",
      "port": 0,
      "max_listeners": 0,
      "banned_ips": "string",
      "banned_user_agents": "string",
      "banned_countries": [
        "string"
      ],
      "allowed_ips": "string",
      "sc_license_id": "string",
      "sc_user_id": "string"
    },
    "backend_type": "liquidsoap",
    "backend_config": {
      "charset": "string",
      "dj_port": 0,
      "telnet_port": 0,
      "record_streams": true,
      "record_streams_format": "string",
      "record_streams_bitrate": 0,
      "use_manual_autodj": true,
      "reset_sequential_queues_on_restart": false,
      "autodj_queue_length": 0,
      "dj_mount_point": "string",
      "dj_buffer": 0,
      "audio_processing_method": "string",
      "post_processing_include_live": true,
      "stereo_tool_license_key": "string",
      "stereo_tool_configuration_path": "string",
      "master_me_preset": "string",
      "master_me_loudness_target": 0,
      "enable_replaygain_metadata": true,
      "crossfade_type": "string",
      "crossfade": 0,
      "crossfade_smart_high": 0,
      "crossfade_smart_medium": 0,
      "crossfade_smart_margin": 0,
      "duplicate_prevention_time_range": 120,
      "duplicate_prevention_artist_time_range": 120,
      "performance_mode": "string",
      "hls_segment_length": 0,
      "hls_segments_in_playlist": 0,
      "hls_segments_overhead": 0,
      "hls_enable_on_public_player": true,
      "hls_is_default": true,
      "live_broadcast_text": "string",
      "enable_auto_cue": true,
      "write_playlists_to_liquidsoap": true,
      "share_encoders": true,
      "custom_config_top": "string",
      "custom_config_pre_playlists": "string",
      "custom_config_pre_live": "string",
      "custom_config_pre_fade": "string",
      "custom_config": "string",
      "custom_config_bottom": "string"
    },
    "description": "A sample radio station.",
    "url": "https://demo.azuracast.com/",
    "genre": "Various",
    "radio_base_dir": "/var/azuracast/stations/azuratest_radio",
    "enable_requests": true,
    "request_delay": 5,
    "request_threshold": 15,
    "requests_only_via_playlists": false,
    "disconnect_deactivate_streamer": 0,
    "enable_streamers": false,
    "is_streamer_live": false,
    "enable_public_page": true,
    "enable_public_api": true,
    "enable_on_demand": true,
    "enable_on_demand_download": true,
    "enable_hls": true,
    "api_history_items": 5,
    "timezone": "UTC",
    "max_bitrate": 128,
    "max_mounts": 3,
    "max_hls_streams": 3,
    "branding_config": {
      "default_album_art_url": "string",
      "public_custom_css": "string",
      "public_custom_js": "string",
      "offline_text": "string"
    }
  }
]

{
  "code": 500,
  "type": "NotLoggedInException",
  "message": "Error description.",
  "formatted_message": "<b>Error description.</b><br>Detailed error text.",
  "extra_data": [],
  "success": false
}

{
  "code": 500,
  "type": "NotLoggedInException",
  "message": "Error description.",
  "formatted_message": "<b>Error description.</b><br>Detailed error text.",
  "extra_data": [],
  "success": false
}

Response

200OKArray<Station>

Success

Response fields application/json

Array<Station>

Show child attributes

idintegerrequiredread only

namestring

The full display name of the station.

Example

AzuraTest Radio

short_namestring

The URL-friendly name for the station, typically auto-generated from the full station name.

Example

azuratest_radio

is_enabledboolean

If set to ‘false’, prevents the station from broadcasting but leaves it in the database.

Example

true

frontend_typeFrontendAdaptersicecastshoutcast2rsasremote

frontend_configStationFrontendConfiguration

Show child attributes

custom_configstring | null

source_pwstring

admin_pwstring

relay_pwstring

streamer_pwstring

portinteger | null

max_listenersinteger | null

banned_ipsstring | null

banned_user_agentsstring | null

banned_countriesArray<string> | null

allowed_ipsstring | null

sc_license_idstring | null

sc_user_idstring | null

backend_typeBackendAdaptersliquidsoapnone

backend_configStationBackendConfiguration

Show child attributes

charsetstring

dj_portinteger | null

telnet_portinteger | null

record_streamsboolean

record_streams_formatstring

record_streams_bitrateinteger

use_manual_autodjboolean

reset_sequential_queues_on_restartboolean

Reset the internal queue of sequential playlists when the station is restarted or its configuration is rewritten.

Example

false

autodj_queue_lengthinteger

dj_mount_pointstring

dj_bufferinteger

audio_processing_methodstring

post_processing_include_liveboolean

stereo_tool_license_keystring | null

stereo_tool_configuration_pathstring | null

master_me_presetstring | null

master_me_loudness_targetinteger

enable_replaygain_metadataboolean

crossfade_typestring

crossfadenumber<float>

crossfade_smart_highnumber<float>

The dB level above which a track is considered ‘loud’ (‘high’ parameter in ‘cross.smart’).

crossfade_smart_mediumnumber<float>

The dB level below which a track is considered ‘quiet’ (‘medium’ parameter in ‘cross.smart’).

crossfade_smart_marginnumber<float>

The dB difference above which two tracks are considered too different to overlap (‘margin’ parameter in ‘cross.smart’).

duplicate_prevention_time_rangeinteger

The time range (in minutes) of the song history that duplicate prevention checks tracks and titles against, also applies to artists when duplicate_prevention_artist_time_range is not set.

Example

duplicate_prevention_artist_time_rangeinteger | null

The time range (in minutes) of the song history that duplicate prevention checks artists against, uses duplicate_prevention_time_range if set to null.

Example

performance_modestring

hls_segment_lengthinteger

hls_segments_in_playlistinteger

hls_segments_overheadinteger

hls_enable_on_public_playerboolean

hls_is_defaultboolean

live_broadcast_textstring

enable_auto_cueboolean

write_playlists_to_liquidsoapboolean

share_encodersboolean

custom_config_topstring | null

Custom Liquidsoap Configuration: Top Section

custom_config_pre_playlistsstring | null

Custom Liquidsoap Configuration: Pre-Playlists Section

custom_config_pre_livestring | null

Custom Liquidsoap Configuration: Pre-Live Section

custom_config_pre_fadestring | null

Custom Liquidsoap Configuration: Pre-Fade Section

custom_configstring | null

Custom Liquidsoap Configuration: Pre-Broadcast Section

custom_config_bottomstring | null

Custom Liquidsoap Configuration: Post-Broadcast Section

descriptionstring | null

Example

A sample radio station.

urlstring | null

Example

https://demo.azuracast.com/

genrestring | null

Example

Various

radio_base_dirstring

Example

/var/azuracast/stations/azuratest_radio

enable_requestsboolean

Whether listeners can request songs to play on this station.

Example

true

request_delayinteger | null

Example

request_thresholdinteger | null

Example

requests_only_via_playlistsboolean

Example

false

disconnect_deactivate_streamerinteger | null

Example

enable_streamersboolean

Whether streamers are allowed to broadcast to this station at all.

Example

false

is_streamer_liveboolean

Whether a streamer is currently active on the station.

Example

false

enable_public_pageboolean

Whether this station’s public pages (player, on-demand streaming, etc.) are visible to non-authenticated users.

Example

true

enable_public_apiboolean

Whether the public-facing API endpoints (now playing, art, etc.) are visible to non-authenticated users. Automatically enabled if ‘enable_public_page’ is true.

Example

true

enable_on_demandboolean

Whether this station has a public ‘on-demand’ streaming and download page.

Example

true

enable_on_demand_downloadboolean

Whether the ‘on-demand’ page offers download capability.

Example

true

enable_hlsboolean

Whether HLS streaming is enabled.

Example

true

api_history_itemsinteger

The number of ‘last played’ history items to show for a station in API responses.

Example

timezonestring

The time zone that station operations should take place in.

Example

UTC

max_bitrateinteger

The maximum bitrate at which a station may broadcast, in Kbps. 0 for unlimited

Example

max_mountsinteger

The maximum number of mount points the station can have, 0 for unlimited

Example

max_hls_streamsinteger

The maximum number of HLS streams the station can have, 0 for unlimited

Example

branding_configStationBrandingConfiguration

Show child attributes

default_album_art_urlstring | null

public_custom_cssstring | null

public_custom_jsstring | null

offline_textstring | null

403ForbiddenApi_Error

Access denied.

Response fields application/json

codeintegerrequired

The numeric code of the error.

Example

typestringrequired

The programmatic class of error.

Example

NotLoggedInException

messagestringrequired

The text description of the error.

Example

Error description.

formatted_messagestring | nullrequired

The HTML-formatted text description of the error.

Example

<b>Error description.</b><br>Detailed error text.

extra_dataArray<any>required

Stack traces and other supplemental data.

successbooleanrequired

Used for API calls that expect an \Entity\Api\Status type response.

Example

false

500Internal Server ErrorApi_Error

A generic exception has occurred.

Response fields application/json

codeintegerrequired

The numeric code of the error.

Example

typestringrequired

The programmatic class of error.

Example

NotLoggedInException

messagestringrequired

The text description of the error.

Example

Error description.

formatted_messagestring | nullrequired

The HTML-formatted text description of the error.

Example

<b>Error description.</b><br>Detailed error text.

extra_dataArray<any>required

Stack traces and other supplemental data.

successbooleanrequired

Used for API calls that expect an \Entity\Api\Status type response.

Example

false

Authorization

ApiKeyapiKey in header

Docs by Sourcey