API

Overview

• Channels
• Feeds
• Logos
• Streams
• Guides
• Categories
• Languages
• Countries
• Subdivisions
• Cities
• Regions
• Timezones
• Blocklist

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/"
  }
  //...
]

Field	Type	Description
id	string	Unique channel ID
name	string	Full name of the channel
alt_names	array	List of alternative channel names
network	string or null	Name of the network operating the channel
owners	array	List of channel owners
country	string	Country code from which the broadcast is transmitted (ISO 3166-1 alpha-2)
categories	array	List of categories to which this channel belongs
is_nsfw	boolean	Indicates whether the channel broadcasts adult content
launched	string or null	Launch date of the channel (YYYY-MM-DD)
closed	string or null	Date on which the channel closed (YYYY-MM-DD)
replaced_by	string or null	The ID of the channel that this channel was replaced by
website	string or null	Official 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"
  }
  //...
]

Field	Type	Description
channel	string	Channel ID
id	string	Unique feed ID
name	string	Name of the feed
alt_names	array	List of alternative feed names
is_main	boolean	Indicates if this feed is the main for the channel
broadcast_area	array	List of codes describing the broadcasting area (r/<region_code>, c/<country_code>, s/<subdivision_code>, ct/<city_code>)
timezones	array	List of timezones in which the feed is broadcast
languages	array	List of broadcast languages
format	string	Video 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"
  }
  //...
]

Field	Type	Description
channel	string	Channel ID
feed	string or null	Feed ID
tags	array	List of keywords describing this version of the logo
width	number	The width of the image in pixels
height	number	The height of the image in pixels
format	string or null	Image format (one of: PNG, JPEG, SVG, GIF, WebP, AVIF, APNG)
url	string	Logo 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"
  }
  //...
]

Field	Type	Description
channel	string or null	Channel ID
feed	string or null	Feed ID
title	string	Stream title
url	string	Stream URL
referrer	string or null	The Referer request header for the stream
user_agent	string or null	The User-Agent request header for the stream
quality	string or null	Maximum 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"
  }
  //...
]

Field	Type	Description
channel	string or null	Channel ID
feed	string or null	Feed ID
site	string	Site domain name
site_id	string	Unique channel ID used on the site
site_name	string	Channel name used on the site
lang	string	Language 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"
  }
  //...
]

Field	Type	Description
id	string	Category ID
name	string	Name of the category
description	string	Short 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"
  }
  //...
]

Field	Type	Description
name	string	Language name
code	string	ISO 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": "🇨🇦"
  }
  //...
]

Field	Type	Description
name	string	Name of the country
code	string	ISO 3166-1 alpha-2 code of the country
languages	array	List of official languages of the country (ISO 639-3 code)
flag	string	Country 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"
  }
  //...
]

Field	Type	Description
country	string	ISO 3166-1 alpha-2 code of the country
name	string	Subdivision name
code	string	ISO 3166-2 code of the subdivision
parent	string or null	ISO 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"
  }
  //...
]

Field	Type	Description
country	string	ISO 3166-1 alpha-2 code of the country where the city is located
subdivision	string or null	ISO 3166-2 code of the subdivision where the city is located
name	string	City name
code	string	UN/LOCODE of the city
wikidata_id	string	ID 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"]
  }
  //...
]

Field	Type	Description
code	string	Code of the region
name	string	Full name of the region
countries	array	List 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"]
  }
  //...
]

Field	Type	Description
id	string	Timezone ID from tz database
utc_offset	string	UTC offset for this time zone
countries	array	List 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"
  }
  //...
]

Field	Type	Description
channel	string	Channel ID
reason	string	Reason for blocking (dmca or nsfw)
ref	string	Link 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.