Update README.md

This commit is contained in:
Aleksandr Statciuk 2022-02-16 14:49:02 +03:00
parent d23516810c
commit 84fb5ea3eb

View file

@ -37,19 +37,19 @@ https://iptv-org.github.io/api/channels.json
] ]
``` ```
| Field | Description | | Field | Type | Description |
| -------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | | -------------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- |
| id | Unique channel ID | | id | string | Unique channel ID |
| name | Full name of the channel | | name | string | Full name of the channel |
| network | Name of the network operating the channel | | network | string | Name of the network operating the channel |
| country | Country code from which the broadcast is transmitted ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)) | | country | string | Country code from which the broadcast is transmitted ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)) |
| subdivision | Code of the subdivision (e.g., provinces or states) from which the broadcast is transmitted ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)) | | subdivision | string | Code of the subdivision (e.g., provinces or states) from which the broadcast is transmitted ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)) |
| city | Name of the city from which the broadcast is transmitted | | city | string | 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>`) | | broadcast_area | array | List of codes describing the broadcasting area (`r/<region_code>`, `c/<country_code>`, `s/<subdivision_code>`) |
| languages | List of languages broadcast | | languages | array | List of languages broadcast |
| categories | List of categories to which this channel belongs | | categories | array | List of categories to which this channel belongs |
| is_nsfw | Indicates whether the channel broadcasts adult content | | is_nsfw | boolean | Indicates whether the channel broadcasts adult content |
| logo | Logo URL | | logo | string | Logo URL |
### Guides ### Guides
@ -70,12 +70,12 @@ https://iptv-org.github.io/api/guides.json
] ]
``` ```
| Field | Description | | Field | Type | Description |
| ------- | --------------------------------------------------------------------------------- | | ------- | ------ | --------------------------------------------------------------------------------- |
| channel | Channel ID | | channel | string | Channel ID |
| site | Program source domain name | | site | string | Program source domain name |
| lang | Language of the guide ([ISO_639-1](https://en.wikipedia.org/wiki/ISO_639-1) code) | | lang | string | Language of the guide ([ISO_639-1](https://en.wikipedia.org/wiki/ISO_639-1) code) |
| url | Link to the guide | | url | string | Link to the guide |
### Categories ### Categories
@ -94,10 +94,10 @@ https://iptv-org.github.io/api/categories.json
] ]
``` ```
| Field | Description | | Field | Type | Description |
| ----- | -------------------- | | ----- | ------ | -------------------- |
| id | Category ID | | id | string | Category ID |
| name | Name of the category | | name | string | Name of the category |
### Languages ### Languages
@ -116,10 +116,10 @@ https://iptv-org.github.io/api/languages.json
] ]
``` ```
| Field | Description | | Field | Type | Description |
| ----- | ------------------------------------------------------------------------- | | ----- | ------ | ------------------------------------------------------------------------- |
| name | Language name | | name | string | Language name |
| code | [ISO 639-3](https://en.wikipedia.org/wiki/ISO_639-3) code of the language | | code | string | [ISO 639-3](https://en.wikipedia.org/wiki/ISO_639-3) code of the language |
### Countries ### Countries
@ -140,12 +140,12 @@ https://iptv-org.github.io/api/countries.json
] ]
``` ```
| Field | Description | | Field | Type | Description |
| ----- | ------------------------------------------------------------------------------------------ | | ----- | ------ | ------------------------------------------------------------------------------------------ |
| name | Name of the country | | name | string | Name of the country |
| code | [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) code of the country | | code | string | [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) | | lang | string | Official language ([ISO 639-3](https://en.wikipedia.org/wiki/ISO_639-3) code) |
| flag | Country flag emoji | | flag | string | Country flag emoji |
### Subdivisions ### Subdivisions
@ -165,11 +165,11 @@ https://iptv-org.github.io/api/subdivisions.json
] ]
``` ```
| Field | Description | | Field | Type | Description |
| ------- | ------------------------------------------------------------------------------------------ | | ------- | ------ | ------------------------------------------------------------------------------------------ |
| country | [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) code of the country | | country | string | [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) code of the country |
| name | Subdivision name | | name | string | Subdivision name |
| code | [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) code of the subdivision | | code | string | [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) code of the subdivision |
### Regions ### Regions
@ -189,11 +189,11 @@ https://iptv-org.github.io/api/regions.json
] ]
``` ```
| Field | Description | | Field | Type | Description |
| --------- | ------------------------------- | | --------- | ------ | ------------------------------- |
| name | Region name | | name | string | Region name |
| code | Code of the region | | code | string | Code of the region |
| countries | List of countries in the region | | countries | array | List of countries in the region |
### Blocklist ### Blocklist
@ -212,10 +212,10 @@ https://iptv-org.github.io/api/blocklist.json
] ]
``` ```
| Field | Description | | Field | Type | Description |
| ------- | ----------------------------------------------- | | ------- | ------ | ----------------------------------------------- |
| channel | Channel ID | | channel | string | Channel ID |
| ref | Link to removal request or DMCA takedown notice | | ref | string | Link to removal request or DMCA takedown notice |
## Contribution ## Contribution