diff --git a/README.md b/README.md index 8e78a8e..e558cc4 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,127 @@ -# API +# API (beta) -_WIP_ +_Work in Progress_ + +### Channels + +``` +https://iptv-org.github.io/api/channels.json +``` + +``` +[ + ... + { + "name": "CNN", + "id": "CNN.us", + "country": "US", + "languages": [ + "eng" + ], + "broadcast_area": [ + "c/US" + ], + "categories": [ + "news" + ], + "logo": "https://myhealthhub.frontline.ca/myhealthhubtv/channellogos/cnn.png" + }, + ... +] +``` + +### Categories + +``` +https://iptv-org.github.io/api/categories.json +``` + +``` +[ + ... + { + "name": "Documentary", + "slug": "documentary", + "is_nsfw": false + }, + ... +] +``` + +### Countries + +``` +https://iptv-org.github.io/api/countries.json +``` + +``` +[ + ... + { + "name": "United Kingdom", + "code": "UK", + "lang": "eng", + "flag": "🇬🇧" + }, + ... +] +``` + +### Divisions + +``` +https://iptv-org.github.io/api/divisions.json +``` + +``` +[ + ... + { + "name": "Ontario", + "code": "CA-ON", + "country": "CA" + }, + ... +] +``` + +### Languages + +``` +https://iptv-org.github.io/api/languages.json +``` + +``` +[ + ... + { + "name": "French", + "code": "fra" + }, + ... +] +``` + +### Regions + +``` +https://iptv-org.github.io/api/regions.json +``` + +``` +[ + ... + { + "name": "Maghreb", + "code": "MAGHREB", + "countries": [ + "DZ", + "LY", + "MA", + "MR", + "TN" + ] + }, + ... +] +```