api/README.md

API (beta)

Overview

• Channels
• Streams
• Guides
• Categories
• Languages
• Countries
• Subdivisions
• Regions
• Blocklist

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,
    "website": "http://nbc.com/",
    "logo": "https://cdn.tvpassport.com/image/station/100x100/nbc.png"
  }
  //...
]

Field	Type	Description
id	string	Unique channel ID
name	string	Full name of the channel
network	string or null	Name of the network operating the channel
country	string	Country code from which the broadcast is transmitted (ISO 3166-1 alpha-2)
subdivision	string or null	Code of the subdivision (e.g., provinces or states) from which the broadcast is transmitted (ISO 3166-2)
city	string or null	Name of the city from which the broadcast is transmitted
broadcast_area	array	List of codes describing the broadcasting area (r/<region_code>, c/<country_code>, s/<subdivision_code>)
languages	array	List of languages broadcast
categories	array	List of categories to which this channel belongs
is_nsfw	boolean	Indicates whether the channel broadcasts adult content
website	string or null	Official website URL
logo	string or null	Logo URL

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

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	Type	Description
channel	string	Channel ID
url	string	Stream URL
http_referrer	string or null	The Referer request header for the stream
user_agent	string or null	The User-Agent request header for the stream
status	string	One of the following: online, blocked, timeout, error
width	integer	The maximum width of the stream in pixels. Specified only if the status is online
height	integer	The maximum height of the stream in pixels. Specified only if the status is online
bitrate	integer	The bitrate of the stream in bits per second. Specified only if the status is online

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

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	Type	Description
channel	string	Channel ID
site	string	Program source domain name
lang	string	Language of the guide (ISO_639-1 code)
url	string	Link to the guide

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

Categories

https://iptv-org.github.io/api/categories.json

[
  //...
  {
    "id": "documentary",
    "name": "Documentary"
  }
  //...
]

Field	Type	Description
id	string	Category ID
name	string	Name 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": "United Kingdom",
    "code": "UK",
    "lang": "eng",
    "flag": "🇬🇧"
  }
  //...
]

Field	Type	Description
name	string	Name of the country
code	string	ISO 3166-1 alpha-2 code of the country
lang	string	Official language (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": "CA",
    "name": "Ontario",
    "code": "CA-ON"
  }
  //...
]

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

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

Regions

https://iptv-org.github.io/api/regions.json

[
  //...
  {
    "name": "Maghreb",
    "code": "MAGHREB",
    "countries": ["DZ", "LY", "MA", "MR", "TN"]
  }
  //...
]

Field	Type	Description
name	string	Region name
code	string	Code of the region
countries	array	List of countries in the region

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

Blocklist

https://iptv-org.github.io/api/blocklist.json

[
  //...
  {
    "channel": "AnimalPlanetEast.us",
    "ref": "https://github.com/iptv-org/iptv/issues/1831"
  }
  //...
]

Field	Type	Description
channel	string	Channel ID
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.