API (beta)
Overview
Channels
https://iptv-org.github.io/api/channels.json
[
...
{
"id": "KSTSDT3.us",
"name": "KSTS-DT3",
"network": "NBC",
"country": "US",
"subdivision": "US-CA",
"city": "San Francisco",
"broadcast_area": [
"s/US-CA"
],
"languages": [
"eng"
],
"categories": [
"general"
],
"is_nsfw": false,
"logo": "https://cdn.tvpassport.com/image/station/100x100/nbc.png"
},
...
]
| Field |
Description |
| id |
Unique channel ID |
| name |
Full name of the channel |
| network |
Name of the network operating the channel |
| country |
Country code from which the broadcast is transmitted (ISO 3166-1 alpha-2) |
| subdivision |
Code of the subdivision (e.g., provinces or states) from which the broadcast is transmitted (ISO 3166-2) |
| city |
Name of the city from which the broadcast is transmitted |
| broadcast_area |
List of codes describing the broadcasting area (r/<region_code>, c/<country_code>, s/<subdivision_code>) |
| languages |
List of languages broadcast |
| categories |
List of categories to which this channel belongs |
| is_nsfw |
Indicates whether the channel broadcasts adult content |
| logo |
Logo URL |
Streams
https://iptv-org.github.io/api/streams.json
[
//...
{
"channel": "BBCNews.uk",
"url": "http://1111296894.rsc.cdn77.org/LS-ATL-54548-6/index.m3u8",
"http_referrer": "http://example.com/",
"user_agent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64)",
"status": "online",
"width": 1280,
"height": 720,
"bitrate": 565040
}
//...
]
| Field |
Description |
| channel |
Channel ID |
| url |
Stream URL |
| http_referrer |
The Referer request header for the stream |
| user_agent |
The User-Agent request header for the stream |
| status |
One of the following: online, blocked, timeout, error |
| width |
The maximum width of the stream in pixels. Specified only if the status is online |
| height |
The maximum height of the stream in pixels. Specified only if the status is online |
| bitrate |
The bitrate of the stream in bits per second. Specified only if the status is online |
Guides
https://iptv-org.github.io/api/guides.json
[
...
{
"channel": "KSTSDT3.us",
"site": "tvtv.us",
"lang": "en",
"url": "https://iptv-org.github.io/epg/guides/us/tvtv.us.epg.xml"
},
...
]
| Field |
Description |
| channel |
Channel ID |
| site |
Program source domain name |
| lang |
Language of the guide (ISO_639-1 code) |
| url |
Link to the guide |
Categories
https://iptv-org.github.io/api/categories.json
[
...
{
"id": "documentary",
"name": "Documentary"
},
...
]
| Field |
Description |
| id |
Category ID |
| name |
Name of the category |
Languages
https://iptv-org.github.io/api/languages.json
[
...
{
"name": "French",
"code": "fra"
},
...
]
| Field |
Description |
| name |
Language name |
| code |
ISO 639-3 code of the language |
Countries
https://iptv-org.github.io/api/countries.json
[
...
{
"name": "United Kingdom",
"code": "UK",
"lang": "eng",
"flag": "🇬🇧"
},
...
]
| Field |
Description |
| name |
Name of the country |
| code |
ISO 3166-1 alpha-2 code of the country |
| lang |
Official language (ISO 639-3 code) |
| flag |
Country flag emoji |
Subdivisions
https://iptv-org.github.io/api/subdivisions.json
[
...
{
"country": "CA",
"name": "Ontario",
"code": "CA-ON"
},
...
]
Regions
https://iptv-org.github.io/api/regions.json
[
...
{
"name": "Maghreb",
"code": "MAGHREB",
"countries": [
"DZ",
"LY",
"MA",
"MR",
"TN"
]
},
...
]
| Field |
Description |
| name |
Region name |
| code |
Code of the region |
| countries |
List of countries in the region |
Blocklist
https://iptv-org.github.io/api/blocklist.json
[
...
{
"channel": "AnimalPlanetEast.us",
"ref": "https://github.com/iptv-org/iptv/issues/1831",
},
...
]
| Field |
Description |
| channel |
Channel ID |
| ref |
Link to removal request or DMCA takedown notice |
Contribution
If you find a bug or want to contribute to the code or documentation, you can help by submitting an issue or a pull request.
