Skip to content

Latest commit

 

History

History
85 lines (83 loc) · 10.4 KB

response-fields-and-meaning.md

File metadata and controls

85 lines (83 loc) · 10.4 KB
description
Response fields and their meaning for the describe endpoint.

📃 Response Fields & Meaning

Field Name Description
element Indicates that the object represents a station.
guide_id The unique ID of the station used by Radiotime.
preset_id The unique ID of the station used by TuneIn.
name The name of the station.
call_sign The call sign of the station.
slogan The slogan or tagline of the station.
frequency The frequency of the station's broadcast.
band The band (e.g. FM, AM) on which the station broadcasts.
url The website URL of the station.
report_url The URL of the TuneIn contact form for reporting issues with the station.
detail_url The URL of the TuneIn station detail page.
is_preset Indicates whether the station is a TuneIn preset station.
is_available Indicates whether the station is currently available.
is_music Indicates whether the station plays music.
has_song Indicates whether the station is currently playing a song.
has_schedule Indicates whether the station has a schedule of programming.
has_topics Indicates whether the station has topic-based programming.
twitter_id The Twitter handle of the station.
logo The URL of the station's logo.
location The location of the station.
current_song The currently playing song on the station, if available.
current_artist The artist of the currently playing song on the station, if available.
current_artist_id The unique ID of the artist of the currently playing song on the station, if available.
current_album The album of the currently playing song on the station, if available.
current_artist_art The URL of the artist image for the currently playing song on the station, if available.
current_album_art The URL of the album cover image for the currently playing song on the station, if available.
description A description of the station.
email The email address of the station.
phone The phone number of the station.
mailing_address The mailing address of the station.
language The language(s) spoken on the station.
genre_id The unique ID of the station's genre.
genre_name The name of the station's genre.
region_id The unique ID of the station's region.
country_region_id The unique ID of the station's country region.
latlon The latitude and longitude of the station
region_id The unique ID of the region.
country_region_id The ID of the country/region.
latlon The latitude and longitude of the station.
tz The time zone of the station.
tz_offset The time zone offset in minutes.
publish_song Whether the station is currently publishing a song.
publish_song_url The URL of the currently published song.
publish_song_rejection_reason The reason why the song publishing was rejected.
now_playing_url The URL of the now playing data.
external_key The external key of the station.
ad_eligible Whether the station is eligible for ads.
preroll_ad_eligible Whether the station is eligible for preroll ads.
companion_ad_eligible Whether the station is eligible for companion ads.
video_preroll_ad_eligible Whether the station is eligible for video preroll ads.
fb_share Whether the station can be shared on Facebook.
twitter_share Whether the station can be shared on Twitter.
song_share Whether the currently playing song can be shared.
donation_eligible Whether the station is eligible for donations.
donation_url The URL to donate to the station.
donation_text The text displayed to ask for donations.
donation_icon The URL of the donation icon.
song_buy_eligible Whether the currently playing song is eligible for purchase.
tunein_url The URL of the station on TuneIn.
is_family_content Whether the station's content is family-friendly.
is_mature_content Whether the station's content is mature.
is_event Whether the station is an event.
content_classification The classification of the station's content.
echoed_count The number of echoes the station has received.
favorited_count The number of times the station has been favorited.
is_favorited Whether the station is favorited.
is_favoritable Whether the station is favoritable.
has_profile Whether the station has a profile.
can_cast Whether the station can be casted.
nielsen_eligible Whether the station is eligible for Nielsen ratings.
nielsen_provider The provider of Nielsen ratings for the station.
nielsen_asset_id The ID of the Nielsen asset for the station.
nowplaying_channel The channel of the now playing data.
why_ads_text The text explaining why ads are played on the station.
use_native_player Whether the station uses a native player.
live_seek_stream Whether the station supports live seeking.
seek_disabled Whether seeking is disabled for the station.