iptv-org-mirror/api
1
0
Fork 0
mirror of https://github.com/iptv-org/api.git synced 2025-05-12 01:50:06 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions

Update README.md

Browse source
This commit is contained in:
Aleksandr Statciuk 2022-01-24 21:02:25 +03:00
parent 9e7f39758f
commit 944bfaf959
1 changed files with 52 additions and 8 deletions
Download patch file Download diff file Expand all files Collapse all files

60
README.md
View file

@ -1,6 +1,6 @@
# API (beta)
_Work in Progress_
## Overview
### Channels
@ -15,21 +15,33 @@ https://iptv-org.github.io/api/channels.json
"name": "CNN",
"id": "CNN.us",
"country": "US",
"languages": [
"eng"
],
"broadcast_area": [
"c/US"
],
"languages": [
"eng"
],
"categories": [
"news"
],
"is_nsfw": false,
"logo": "https://myhealthhub.frontline.ca/myhealthhubtv/channellogos/cnn.png"
},
...
]
```
| Field | Description |
| -------------- | ------------------------------------------------------------------------------------------------------ |
| name | Full name of the channel |
| id | Unique channel ID |
| country | Broadcast source country ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) code) |
| broadcast_area | Any combination of: `r/<region_code>`, `c/<country_code>`, `s/<subdivision_code>` |
| languages | List of [languages](#languages) broadcast |
| categories | List of [categories](#categories) to which this channel belongs |
| is_nsfw | Indicates whether the channel broadcasts adult content |
| logo | Logo URL |
### Categories
```
@ -41,13 +53,17 @@ https://iptv-org.github.io/api/categories.json
...
{
"name": "Documentary",
"slug": "documentary",
"is_nsfw": false
"id": "documentary"
},
...
]
```
| Field | Description |
| ----- | -------------------- |
| name | Name of the category |
| id | Category ID |
### Countries
```
@ -67,6 +83,13 @@ https://iptv-org.github.io/api/countries.json
]
```
| Field | Description |
| ----- | ------------------------------------------------------------------------------------------ |
| name | Name of the category |
| code | [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) code of the country |
| lang | Official language ([ISO 639-3](https://en.wikipedia.org/wiki/ISO_639-3) code) |
| flag | Country flag emoji |
### Subdivisions
```
@ -77,14 +100,20 @@ https://iptv-org.github.io/api/subdivisions.json
[
...
{
"country": "CA",
"name": "Ontario",
"code": "CA-ON",
"country": "CA"
"code": "CA-ON"
},
...
]
```
| Field | Description |
| ------- | ------------------------------------------------------------------------------------------ |
| country | [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) code of the country |
| name | Subdivision name |
| code | [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) code of the subdivision |
### Languages
```
@ -102,6 +131,11 @@ https://iptv-org.github.io/api/languages.json
]
```
| Field | Description |
| ----- | ------------------------------------------------------------------------- |
| name | Language name |
| code | [ISO 639-3](https://en.wikipedia.org/wiki/ISO_639-3) code of the language |
### Regions
```
@ -125,3 +159,13 @@ https://iptv-org.github.io/api/regions.json
...
]
```
| Field | Description |
| --------- | --------------------------------------------- |
| name | Region name |
| code | Code of the region |
| countries | List of [countries](#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](https://github.com/iptv-org/api/issues) or a [pull request](https://github.com/iptv-org/api/pulls).