API (beta)

Overview

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

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

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

Field	Description
country	ISO 3166-1 alpha-2 code of the country
name	Subdivision name
code	ISO 3166-2 code of the subdivision

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

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.