Return upcoming and currently ongoing schedule entries.

GET

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

curl -X GET 'https://demo.azuracast.com/api/station/0/schedule'

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

const data = await response.text();

import requests

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

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

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

nowstringquery

The date/time to compare schedule items to. Defaults to the current date and time.

rowsintegerquery

The number of upcoming/ongoing schedule entries to return. Defaults to 5.

Response

200OKArray<Api_StationSchedule>

Success

Response fields application/json

Array<Api_StationSchedule>

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

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

Docs by Sourcey