Actions141
- Auto DJ Actions
- Auto DJ > Events Actions
- Auto DJ > Media Actions
- Auto DJ > Playing Playlist Actions
- Auto DJ > Playlist Actions
- Encoder Events Actions
- Hls Stream Actions
- Mediapulse Actions
- Notifications Actions
- Options Actions
- Packs Actions
- Players Actions
- Radio Product Options Actions
- Radio Products Actions
- Server Events Actions
- Stations Actions
- Stats > Hls Stream Actions
- Stats > Radio Products Actions
- Stats > Stations Actions
- Get Status
- Get Instant Listeners
- Get Stats Listeners
- Get Mediastats
- Set Metadata To Station
- Get Listeners
- Get Listeners Per Minute
- Get Listeners Per Minute Per Stream
- Get Countries
- Get Countries By Continent
- Get Listeners By Stream
- Get Consumption
- Get Total Consumption
- Get Consumption By Stream
- Get Players
- Get Total Players
- Get Stats By Streams
- Export Stats
- Export Stats By Stream
- List Stats Links
- Stats > Streams Actions
- Streams Actions
- Transcodings Actions
Hls Stream → Get Hls Stream
AI-generatedSummary
Fetch an HLS stream for a specified radio product and station.
Inputs
- authentication — Authentication method – OAuth2 or API Key.
- path_radio_product_id (required) — ID of the radio product to request.
- path_station_id (required) — ID of the station to request.
- query_return — If set to 'total', returns the count of items instead of the items themselves.
- query_limit — Maximum number of items to return.
- query_skip — Index of the first item to return (zero‑based).
- query_page — Page number for pagination.
- query_per_page — Number of items per page.
- query_order_by — Field used for sorting.
- query_order — Sort order – 'asc' or 'desc'.
- query_order_for — Sorting order for a field (default uses 'order').
- returnAll — If true, returns all items without pagination limits.
- limit — Maximum number of items to return (1‑500).
- returnFullResponse — If true, returns the full response body; otherwise only a success indicator.
Output shape
a single HLS stream object containing the stream URL and metadata
Pagination parameters (limit, skip, page, etc.) can restrict the returned items; setting returnAll returns all items up to the API limit.
Examples
Example 1: Retrieve a stream for radio product 789 and station 101 using OAuth2.
authentication=oauth2, path_radio_product_id=789, path_station_id=101
Example 2: List the first 20 items of a stream with custom sorting.
path_radio_product_id=789, path_station_id=101, query_limit=20, query_order_by="name", query_order="asc"