Return detailed information about current listeners.

GET

https://demo.azuracast.com/api/station/{station_id}/listeners

curl -X GET 'https://demo.azuracast.com/api/station/0/listeners' \
  -H 'X-API-Key: YOUR_TOKEN'

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

const data = await response.text();

import requests

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

[
  {
    "ip": "127.0.0.1",
    "user_agent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/59.0.3071.86 Safari/537.36",
    "hash": "",
    "mount_is_local": false,
    "mount_name": "/radio.mp3",
    "connected_on": 1609480800,
    "connected_until": 1609480800,
    "connected_time": 30,
    "device": {
      "client": "Firefox 121.0, Windows",
      "is_browser": true,
      "is_mobile": true,
      "is_bot": true,
      "browser_family": "Firefox",
      "os_family": "Windows"
    },
    "location": {
      "description": "Austin, Texas, US",
      "region": "Texas",
      "city": "Austin",
      "country": "United States",
      "lat": "30.000000",
      "lon": "-97.000000"
    }
  }
]

{
  "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
}

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

Parameters

station_idinteger | stringrequiredpath

Response

200OKArray<Api_Listener>

Success

Response fields application/json

Array<Api_Listener>

Show child attributes

ipstring

The listener’s IP address

Example

127.0.0.1

user_agentstring

The listener’s HTTP User-Agent

Example

Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/59.0.3071.86 Safari/537.36

hashstring

A unique identifier for this listener/user agent (used for unique calculations).

Example

mount_is_localboolean

Whether the user is connected to a local mount point or a remote one.

Example

false

mount_namestring

The display name of the mount point.

Example

/radio.mp3

connected_oninteger

UNIX timestamp that the user first connected.

Example

1609480800

connected_untilinteger

UNIX timestamp that the user disconnected (or the latest timestamp if they are still connected).

Example

1609480800

connected_timeinteger

Number of seconds that the user has been connected.

Example

deviceApi_ListenerDevice

Show child attributes

clientstring | null

Summary of the listener client.

Example

Firefox 121.0, Windows

is_browserboolean

If the listener device is likely a browser.

Example

true

is_mobileboolean

If the listener device is likely a mobile device.

Example

true

is_botboolean

If the listener device is likely a crawler.

Example

true

browser_familystring | null

Summary of the listener browser family.

Example

Firefox

os_familystring | null

Summary of the listener OS family.

Example

Windows

locationApi_ListenerLocation

Show child attributes

descriptionstring

A description of the location.

Example

Austin, Texas, US

regionstring | null

The approximate region/state of the listener.

Example

Texas

citystring | null

The approximate city of the listener.

Example

Austin

countrystring | null

The approximate country of the listener.

Example

United States

latnumber<float> | null

Latitude.

Example

30.000000

lonnumber<float> | null

Longitude.

Example

-97.000000

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

404Not FoundApi_Error

Record not found.

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