logo
0
0
Login
freearhey<7253922+freearhey@users.noreply.github.com>
Update README.md

API

Overview

Channels

https://iptv-org.github.io/api/channels.json
[ //... { "id": "AnhuiTV.cn", "name": "Anhui TV", "alt_names": ["安徽卫视"], "network": "Anhui", "owners": ["China Central Television"], "country": "CN", "categories": ["general"], "is_nsfw": false, "launched": "2016-07-28", "closed": "2020-05-31", "replaced_by": "CCTV1.cn", "website": "http://www.ahtv.cn/" } //... ]
FieldTypeDescription
idstringUnique channel ID
namestringFull name of the channel
alt_namesarrayList of alternative channel names
networkstring or nullName of the network operating the channel
ownersarrayList of channel owners
countrystringCountry code from which the broadcast is transmitted (ISO 3166-1 alpha-2)
categoriesarrayList of categories to which this channel belongs
is_nsfwbooleanIndicates whether the channel broadcasts adult content
launchedstring or nullLaunch date of the channel (YYYY-MM-DD)
closedstring or nullDate on which the channel closed (YYYY-MM-DD)
replaced_bystring or nullThe ID of the channel that this channel was replaced by
websitestring or nullOfficial website URL

Source of data: https://github.com/iptv-org/database

Feeds

https://iptv-org.github.io/api/feeds.json
[ //... { "channel": "France3.fr", "id": "ParisIledeFrance", "name": "Paris Ile-de-France", "alt_names": ["Paris Île-de-France"], "is_main": false, "broadcast_area": ["c/FR"], "timezones": ["Europe/Paris"], "languages": ["fra"], "format": "576i" } //... ]
FieldTypeDescription
channelstringChannel ID
idstringUnique feed ID
namestringName of the feed
alt_namesarrayList of alternative feed names
is_mainbooleanIndicates if this feed is the main for the channel
broadcast_areaarrayList of codes describing the broadcasting area (r/<region_code>, c/<country_code>, s/<subdivision_code>, ct/<city_code>)
timezonesarrayList of timezones in which the feed is broadcast
languagesarrayList of broadcast languages
formatstringVideo format of the feed

Source of data: https://github.com/iptv-org/database

Logos

https://iptv-org.github.io/api/logos.json
[ //... { "channel": "France3.fr", "feed": "ParisIledeFrance", "tags": ["horizontal", "white"], "width": 1000, "height": 468, "format": "SVG", "url": "https://example.com/logo.svg" } //... ]
FieldTypeDescription
channelstringChannel ID
feedstring or nullFeed ID
tagsarrayList of keywords describing this version of the logo
widthnumberThe width of the image in pixels
heightnumberThe height of the image in pixels
formatstring or nullImage format (one of: PNG, JPEG, SVG, GIF, WebP, AVIF, APNG)
urlstringLogo URL

Source of data: https://github.com/iptv-org/database

Streams

https://iptv-org.github.io/api/streams.json
[ //... { "channel": "France3.fr", "feed": "NordPasdeCalaisHD", "title": "France 3 Nord Pas-de-Calais HD", "url": "http://1111296894.rsc.cdn77.org/LS-ATL-54548-6/index.m3u8", "referrer": "http://example.com/", "user_agent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64)", "quality": "720p" } //... ]
FieldTypeDescription
channelstring or nullChannel ID
feedstring or nullFeed ID
titlestringStream title
urlstringStream URL
referrerstring or nullThe Referer request header for the stream
user_agentstring or nullThe User-Agent request header for the stream
qualitystring or nullMaximum stream quality

Source of data: https://github.com/iptv-org/iptv

Guides

https://iptv-org.github.io/api/guides.json
[ //... { "channel": "BBCOne.uk", "feed": "EastMidlandsHD", "site": "sky.co.uk", "site_id": "bbcone", "site_name": "BBC One", "lang": "en" } //... ]
FieldTypeDescription
channelstring or nullChannel ID
feedstring or nullFeed ID
sitestringSite domain name
site_idstringUnique channel ID used on the site
site_namestringChannel name used on the site
langstringLanguage of the guide (ISO 639-1 code)

Source of data: https://github.com/iptv-org/epg

Categories

https://iptv-org.github.io/api/categories.json
[ //... { "id": "documentary", "name": "Documentary", "description": "Programming that depicts a person or real-world event" } //... ]
FieldTypeDescription
idstringCategory ID
namestringName of the category
descriptionstringShort description of the category

Source of data: https://github.com/iptv-org/database

Languages

https://iptv-org.github.io/api/languages.json
[ //... { "name": "French", "code": "fra" } //... ]
FieldTypeDescription
namestringLanguage name
codestringISO 639-3 code of the language

Source of data: https://github.com/iptv-org/database

Countries

https://iptv-org.github.io/api/countries.json
[ //... { "name": "Canada", "code": "CA", "languages": ["eng", "fra"], "flag": "🇨🇦" } //... ]
FieldTypeDescription
namestringName of the country
codestringISO 3166-1 alpha-2 code of the country
languagesarrayList of official languages of the country (ISO 639-3 code)
flagstringCountry flag emoji

Source of data: https://github.com/iptv-org/database

Subdivisions

https://iptv-org.github.io/api/subdivisions.json
[ //... { "country": "BD", "name": "Bandarban", "code": "BD-01", "parent": "BD-B" } //... ]
FieldTypeDescription
countrystringISO 3166-1 alpha-2 code of the country
namestringSubdivision name
codestringISO 3166-2 code of the subdivision
parentstring or nullISO 3166-2 code of the parent subdivision

Source of data: https://github.com/iptv-org/database

Cities

https://iptv-org.github.io/api/cities.json
[ //... { "country": "CN", "subdivision": "CN-SD", "name": "Yantai", "code": "CNYAT", "wikidata_id": "Q210493" } //... ]
FieldTypeDescription
countrystringISO 3166-1 alpha-2 code of the country where the city is located
subdivisionstring or nullISO 3166-2 code of the subdivision where the city is located
namestringCity name
codestringUN/LOCODE of the city
wikidata_idstringID of this city in Wikidata

Source of data: https://github.com/iptv-org/database

Regions

https://iptv-org.github.io/api/regions.json
[ //... { "code": "MAGHREB", "name": "Maghreb", "countries": ["DZ", "LY", "MA", "MR", "TN"] } //... ]
FieldTypeDescription
codestringCode of the region
namestringFull name of the region
countriesarrayList of countries in the region

Source of data: https://github.com/iptv-org/database

Timezones

https://iptv-org.github.io/api/timezones.json
[ //... { "id": "Europe/London", "utc_offset": "+00:00", "countries": ["UK", "GG", "IM", "JE"] } //... ]
FieldTypeDescription
idstringTimezone ID from tz database
utc_offsetstringUTC offset for this time zone
countriesarrayList of countries included in this time zone

Source of data: https://github.com/iptv-org/database

Blocklist

https://iptv-org.github.io/api/blocklist.json
[ //... { "channel": "AnimalPlanetEast.us", "reason": "dmca", "ref": "https://github.com/iptv-org/iptv/issues/1831" } //... ]
FieldTypeDescription
channelstringChannel ID
reasonstringReason for blocking (dmca or nsfw)
refstringLink to removal request or DMCA takedown notice

Source of data: https://github.com/iptv-org/database

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.