iptv-org/api Documentation

Retrieve a list of all available TV channels. Each channel object contains metadata such as its unique ID, name, network, country (ISO 3166-1 alpha-2), and categories.

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

Retrieve the actual streaming URLs for channels and feeds. This data includes the stream URL, required HTTP headers (referrer and user_agent), and quality information.

Endpoint: 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",
    "label": "Geo-blocked"
  }
]

Retrieve a list of specific broadcast feeds. A feed is associated with a channel and provides details about the broadcast area, timezones, languages, and video format.

Endpoint: 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"
  }
]

Retrieve Electronic Program Guide (EPG) information. This provides links to XML sources and site-specific identifiers for channel programming guides.

Endpoint: 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",
    "sources": [
      {
        "host": "example.com",
        "url": "https://example.com/guide.xml",
        "format": "XML"
      }
    ]
  }
]

Retrieve channel and feed logos. Each entry includes the URL, dimensions, format, and whether the broadcaster is currently using the logo.

Endpoint: https://iptv-org.github.io/api/logos.json

[
  {
    "channel": "France3.fr",
    "feed": "ParisIledeFrance",
    "in_use": true,
    "tags": ["horizontal", "white"],
    "width": 1000,
    "height": 468,
    "format": "SVG",
    "url": "https://example.com/logo.svg"
  }
]

A list of geographical regions and the countries they encompass.

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

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

A list of channels that have been blocked, including the reason (dmca or nsfw) and a reference link.

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

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

A list of timezones from the tz database, including UTC offsets and associated countries.

Endpoint: https://iptv-org.github.io/api/timezones.json

[
  {
    "id": "Europe/London",
    "utc_offset": "+00:00",
    "countries": ["UK", "GG", "IM", "JE"]
  }
]

A list of administrative subdivisions using ISO 3166-2 codes.

Endpoint: https://iptv-org.github.io/api/subdivisions.json

[
  {
    "country": "BD",
    "name": "Bandarban",
    "code": "BD-01",
    "parent": "BD-B"
  }
]

A list of programming categories available for channels.

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

[
  {
    "id": "documentary",
    "name": "Documentary",
    "description": "Programming that depicts a person or real-world event"
  }
]

A list of countries with their ISO 3166-1 alpha-2 codes, official languages (ISO 639-3), and flag emojis.

Endpoint: https://iptv-org.github.io/api/countries.json

[
  {
    "name": "Canada",
    "code": "CA",
    "languages": ["eng", "fra"],
    "flag": "🇨🇦"
  }
]

A list of supported languages using ISO 639-3 codes.

Endpoint: https://iptv-org.github.io/api/languages.json

[
  {
    "name": "French",
    "code": "fra"
  }
]