Returns data about one or more specified stations
/stations/{rpuids}
Returns information about one or more specific stations objects, identified by their rpuid parameters.
The information returned in the results can be specified by the include parameter.
Endpoint
Base URL: https://api.radioplayer.org/v2/stations/{rpuids}
Request Parameters
Header Fields
To find out how to correctly construct authentication headers for the Radioplayer Partner API (WRAPI) please see the Authentication guide
Path Parameters
| PATH PARAMETER | VALUE |
|---|---|
{rpuids} |
Returns one or more station objects identified by their rpuid, or unique identifier. |
Query Parameters
Look up stations by rpuid
/v2/stations/3722,372101
Lookup station with include parameters
/v2/stations/372101?include=social,images
| QUERY PARAMETER | VALUE |
|---|---|
{rpuids} |
Compulsory. Specifies one or more station objects by their rpuid, which can be requested using a comma separated list. |
include |
Optional. Specifies which fields are returned by the request for a station object, defined by a comma separated list. Available values are:
include is not applied, all fields will be returned for the station object. |
Response
When successful, the HTTP status code in the response header is 200 OK. One or more station objects are returned in JSON format (or on special request, XML supported by the RadioDNS schema).
content-type: application/json; charset=utf-8
x-ratelimit-limit: 300000
x-ratelimit-remaining: 285030
x-ratelimit-reset: 1585699200
If there is an error, the header returns an error status code.
The WRAPI also includes information about your monthly request quota in the returned header:
This includes information on:
- Your total monthly quota
- How many requests you have remaining for the month
- When the quota will be reset, given as a UNIX timestamp.
The returned response body consists of a meta and data object.
Example Response Body
{
"data": [
{
"name": "RTÉ 2fm",
"description": "The home of Irish talent, great festivals and live music.",
"liveStreams": [
{
"streamSource": {
"url": "https://www.rte.ie/manifests/2fm.m3u8",
"mimeValue": "audio/x-mpegurl"
},
"bitRate": {
"target": 48000
}
},
{
"streamSource": {
"url": "https://av.rasset.ie/av/live/radio/playlist/2fm.m3u",
"mimeValue": "audio/mpeg"
},
"bitRate": {
"target": 96000
}
}
],
"socialIds": [
{
"type": "twitter",
"uid": "rte2fm"
},
{
"type": "facebook",
"uid": "2fmofficial"
}
],
"alphanumericKey": "r",
"multimedia": [
{
"url": "http://ierpimagecache.s3.amazonaws.com/image/2_600x600_2018-11-22-16-45-26-675.png",
"mimeValue": "image/png",
"language": "en",
"width": 600,
"height": 600
},
{
"url": "http://ierpimagecache.s3.amazonaws.com/image/2_86x48_2016-01-11-09-45-02-437.png",
"mimeValue": "image/png",
"language": "en",
"width": 86,
"height": 48
},
{
"url": "http://ierpimagecache.s3.amazonaws.com/image/2_288x162_2016-01-11-09-45-02-35.png",
"mimeValue": "image/png",
"language": "en",
"width": 288,
"height": 162
},
{
"url": "http://ierpimagecache.s3.amazonaws.com/image/2_128x128_2018-11-30-10-15-26-615.png",
"mimeValue": "image/png",
"language": "en",
"width": 128,
"height": 128
},
{
"url": "http://ierpimagecache.s3.amazonaws.com/image/2_1920x1080_2018-11-22-16-45-26-813.png",
"mimeValue": "image/png",
"language": "en",
"width": 1920,
"height": 1080
},
{
"url": "http://ierpimagecache.s3.amazonaws.com/image/2_74x41_2016-01-11-09-45-02-472.png",
"mimeValue": "image/png",
"language": "en",
"width": 74,
"height": 41
},
{
"url": "http://ierpimagecache.s3.amazonaws.com/image/2_160x90_2016-01-11-09-45-02-529.png",
"mimeValue": "image/png",
"language": "en",
"width": 160,
"height": 90
},
{
"url": "http://ierpimagecache.s3.amazonaws.com/image/2_320x240_2018-11-30-10-15-27-51.png",
"mimeValue": "image/png",
"language": "en",
"width": 320,
"height": 240
},
{
"url": "http://ierpimagecache.s3.amazonaws.com/image/2_112x32_2018-11-30-10-15-27-90.png",
"mimeValue": "image/png",
"language": "en",
"width": 112,
"height": 32
},
{
"url": "http://ierpimagecache.s3.amazonaws.com/image/2_32x32_2018-11-30-10-15-27-114.png",
"mimeValue": "image/png",
"language": "en",
"width": 32,
"height": 32
}
],
"country": "372",
"rpuid": "3722",
"bearers": [
{
"id": "fm:2e3.2202.09050",
"cost": 0
},
{
"id": "fm:2e3.2202.09140",
"cost": 0
},
{
"id": "fm:2e3.2202.09200",
"cost": 0
},
{
"id": "fm:2e3.2202.09040",
"cost": 0
},
{
"id": "fm:2e3.2202.09130",
"cost": 0
},
{
"id": "fm:2e3.2202.09060",
"cost": 0
},
{
"id": "fm:2e3.2202.09220",
"cost": 0
},
{
"id": "fm:2e3.2202.09210",
"cost": 0
},
{
"id": "fm:2e3.2202.09160",
"cost": 0
},
{
"id": "fm:2e3.2202.09170",
"cost": 0
},
{
"id": "fm:2e3.2202.09150",
"cost": 0
},
{
"id": "fm:2e3.2202.09100",
"cost": 0
},
{
"id": "fm:2e3.2202.09070",
"cost": 0
},
{
"id": "fm:2e3.2202.09700",
"cost": 0
},
{
"id": "fm:2e3.2202.09180",
"cost": 0
},
{
"id": "fm:2e3.2202.09110",
"cost": 0
},
{
"id": "dab:2e3.2e01.2242.0",
"cost": 0,
"mimeValue": "audio/mpeg"
},
{
"id": "fm:2e3.2202.09190",
"cost": 0
},
{
"id": "fm:2e3.2202.09120",
"cost": 0
},
{
"id": "dab:2e3.2e01.2262.0",
"cost": 0,
"mimeValue": "audio/mpeg"
},
{
"id": "fm:2e3.2202.09090",
"cost": 0
},
{
"id": "fm:2e3.2202.09080",
"cost": 0
},
{
"id": "fm:2e3.2202.09240",
"cost": 0
},
{
"id": "dab:2e3.2e04.2811.0",
"cost": 0,
"mimeValue": "audio/mpeg"
},
{
"id": "dab:2e3.2e01.2202.0",
"cost": 0,
"mimeValue": "audio/mpeg"
}
],
"phoneticInputs": [
{
"id": "1513074452060_3722_i",
"type": "pidgin",
"value": "RTE 2FM",
"exclude": []
},
{
"id": "1513074491976_3722_i",
"type": "pidgin",
"value": "RTE radio 2",
"exclude": []
},
{
"id": "1511533989509_272_i",
"type": "pidgin",
"value": "radio 2",
"exclude": []
},
{
"id": "1513074937830_3722_i",
"type": "pidgin",
"value": "or TE radio 2FM",
"exclude": []
},
{
"id": "1513074402269_3722_i",
"type": "pidgin",
"value": "RTE 2",
"exclude": []
},
{
"id": "1513074832108_3722_i",
"type": "pidgin",
"value": "RTE radio 2FM",
"exclude": []
},
{
"id": "1511533989508_66_i",
"type": "pidgin",
"value": "2",
"exclude": []
},
{
"id": "1513074825866_3722_i",
"type": "pidgin",
"value": "RTE radio 2 FM",
"exclude": []
},
{
"id": "1511533989508_162_i",
"type": "pidgin",
"value": "2 FM",
"exclude": []
},
{
"id": "1513074898338_3722_i",
"type": "pidgin",
"value": "or TE 2FM",
"exclude": []
},
{
"id": "1511533989509_302_i",
"type": "pidgin",
"value": "2FM",
"exclude": []
},
{
"id": "1513074891476_3722_i",
"type": "pidgin",
"value": "or TE 2 FM",
"exclude": []
},
{
"id": "1513074908246_3722_i",
"type": "pidgin",
"value": "or TE radio 2",
"exclude": []
},
{
"id": "1513074884115_3722_i",
"type": "pidgin",
"value": "or TE 2",
"exclude": []
},
{
"id": "1511533989508_76_i",
"type": "pidgin",
"value": "radio 2 FM",
"exclude": []
},
{
"id": "1513074926853_3722_i",
"type": "pidgin",
"value": "or TE radio 2 FM",
"exclude": []
},
{
"id": "1513074427063_3722_i",
"type": "pidgin",
"value": "RTE 2 FM",
"exclude": []
}
],
"phoneticOutputs": [
{
"id": "1524094865388_3722_o",
"type": "pidgin",
"value": "R. T. E. 2 F. M.",
"exclude": []
}
]
}
],
"meta": {
"nesting": false,
"paginated": false,
"dataType": "stations",
"count": 1,
"fromCache": true,
"cacheExpiresAt": 1585306833078
}
}
The possible meta field values for this endpoint are:
| FIELD | VALUE |
|---|---|
paginated |
Optional, Boolean. Sets how or if results are grouped into pages. For more information on pagination, see the API Documentation index. |
nesting |
Optional, Boolean. Indicates whether full data objects are nested within other objects. For this endpoint this value is always set to false.For more information on nesting, see the API Documentation index. |
dataType |
Object type returned by the request. In this case it is stations. |
count |
Optional, string. A number describing how many items are in the data set. |
fromCache |
Optional, Boolean. Indicates whether this data came from cached data. For more information on caching, please see the API Documentation index. |
cacheExpiresAt |
Optional. UNIX Epoch timestamp indicating when the cache will expire. For more information on caching, please see the API Documentation index. |
Multiple data objects are to be expected - one per station. The possible data field values for this endpoint are:
| FIELD | VALUE |
|---|---|
name |
String. The full name of the radio station |
description |
String. A description relating to the station. Typically a slogan or strapline under 128 characters. |
livestream |
Array. An array containing one or many live streaming assets. |
streamSource |
Array. An array describing a single audio stream. |
↳ url |
URL. The URL of the live stream resource. |
mimeValue |
String. The MIME type of the stream which indicates the stream codec and format. |
bitrate↳ target |
Integer. A number, in bits per second, indicating the bitrate of the stream. |
socialIds |
Array, optional. An array of one or more social media identifiers |
↳ type |
Constant. Can be ‘twitter’ or ‘facebook’ |
↳ uid |
String. The corresponding social media ID. |
alphanumericKey |
String. Where a station is listed in an alphabetical list, this key indicates the letter of the alphabet under which the content should appear. |
multimedia |
Array. An array of one of one or many visual assets (typically station logos) |
↳ url |
String. URL of the image asset |
↳ language |
String. Language of the image asset. Useful for image that may display lines of text |
↳ type |
String, constant. This is always logo_unrestricted as per the DAB-EPG spec |
↳ width |
Integer. The number of pixels representing the width of the image |
↳ height |
Integer. The number of pixels representing the height of the image. |
rpuid |
Integer. A unique identifier relating to the radio station that published the OD content |
country |
Integer. ISO numeric country code of the station that published the OD content. |
bearers |
Array, Optional. An array of broadcast transmission parameters. See Section 5 of ETSI TS102818 for details |
↳ id |
String, URI. An individual broadcast bearer. |
↳ cost |
Integer. The ‘cost’ of the bearer (see ETSI TS102818) |
phoneticInputs |
Array, optional. An array of synonyms - typically alternative names for a station, or spellings to assist recognition by voice systems. |
↳ id |
String. A unique identifier for the entry. |
↳ type |
Constant. The type of phonetic schema used. Usually ‘pidgin’; ‘ssml’ also supported |
↳ value |
String. The phonetic entry itself. |
↳ exclude |
Array. An array of platforms which should disregard this entry. If empty, assume use by all voice platforms is allowed. |
phoneticOutput |
Array, optional. An array of phonetics to assist voice systems with the correct pronunciation of a station name. |
↳ id |
String. A unique identifier for the entry. |
↳ type |
Constant. The type of phonetic schema in use. Either ‘pidgin’ or ‘ssml’ |
↳ value |
String. The value of the phonetic entry itself. |
↳ exclude |
Array, optional. An array of platforms which should disregard this entry. If empty, assume use by all voice platforms is allowed. |