Infomaniak Streaming Radio icon

Infomaniak Streaming Radio

Interact with Infomaniak Streaming Radio API

Actions141

Players → List Station Players

AI-generated

Summary

List the players associated with a specific radio product and station.

Inputs

  • authentication — Authentication method (OAuth2 or API Key) for the Infomaniak API.
  • path_radio_product_id (required) — Identifier of the radio product whose players are requested.
  • path_station_id (required) — Identifier of the station whose players are requested.
  • query_return — If set to 'total', the response returns the total count of items instead of the items themselves.
  • query_limit — Maximum number of items to return per request (1‑500).
  • query_skip — Number of items to skip before returning results, used for pagination.
  • query_page — Page number to return (1‑based) for paginated results.
  • query_per_page — Number of items per page when paginating.
  • query_order_by — Field name used for sorting the results.
  • query_order — Sort direction, either 'asc' or 'desc'.
  • query_order_for — JSON object defining secondary sorting order; defaults to using 'order'.
  • limit — Numeric limit applied to the request; must be between 1 and 500.
  • returnAll — When true, attempts to retrieve all matching items regardless of pagination limits.
  • returnFullResponse — If true, returns the full API response; otherwise only the relevant subset.

Output shape

Array of station player objects representing each player associated with the specified station.

Pagination parameters (limit, skip/page/per_page) control the subset returned; query_return can replace items with a total count; returnAll may fetch all items; default behavior returns the first page up to the limit.

Examples

Example 1: Basic list of players for a given product and station using default pagination.

authentication: oauth2, path_radio_product_id: 123, path_station_id: 456

Example 2: Return only the total number of players instead of the list.

authentication: apiKey, path_radio_product_id: 123, path_station_id: 456, query_return: total

Example 3: Paginated retrieval of the second page with 10 items per page, sorted descending.

authentication: oauth2, path_radio_product_id: 123, path_station_id: 456, query_page: 2, query_per_page: 10, query_order: desc

Links

Discussion