Skip to content

Latest commit

 

History

History
37 lines (26 loc) · 2.44 KB

README.md

File metadata and controls

37 lines (26 loc) · 2.44 KB
description cover coverY
This is unofficial documentation of TuneIn's Streaming API, used by them to provide web radio streams and podcasts/shows to its users. You are always welcome to contribute.
.gitbook/assets/tunein-api-img-test.png
0

👋 Introduction

{% hint style="info" %} This documentation is still in its early stages. You are welcome to contribute, point out unclarity, or add new endpoints/documentation via GitHub. {% endhint %}

Before You Begin

The base URI for all requests is https://opml.radiotime.com you will use this to get the data necessary to stream/play music or podcasts.

API Organization

The API is organized into three parts.

1. The API basics, like this introduction and information on how to get started.

2. The endpoints, additional information on their response fields/data and how to stream music from the API.

3. Credits, helpful resources & basis for the documentation.

Meaning of different colors within the API Documentation.

Color Description
Yellow Simplified explanation/TL:DR or used as a "warning" due to the elements or parameters etc. not being fully understood or unknown meaning of the said element.
Blue Usually representing a link or information.
Green Representing something safe.
Red Representing something unsafe.