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

Merge branch 'master' into add-doc-for-streams

Browse source
This commit is contained in:
Aleksandr Statciuk 2022-02-16 14:49:11 +03:00
commit 516c768401
1 changed files with 84 additions and 96 deletions
Download patch file Download diff file Expand all files Collapse all files

180
README.md
View file

@ -18,9 +18,9 @@
https://iptv-org.github.io/api/channels.json https://iptv-org.github.io/api/channels.json
``` ```
``` ```jsonc
[ [
... //...
{ {
"id": "KSTSDT3.us", "id": "KSTSDT3.us",
"name": "KSTS-DT3", "name": "KSTS-DT3",
@ -28,35 +28,29 @@ https://iptv-org.github.io/api/channels.json
"country": "US", "country": "US",
"subdivision": "US-CA", "subdivision": "US-CA",
"city": "San Francisco", "city": "San Francisco",
"broadcast_area": [ "broadcast_area": ["s/US-CA"],
"s/US-CA" "languages": ["eng"],
], "categories": ["general"],
"languages": [
"eng"
],
"categories": [
"general"
],
"is_nsfw": false, "is_nsfw": false,
"logo": "https://cdn.tvpassport.com/image/station/100x100/nbc.png" "logo": "https://cdn.tvpassport.com/image/station/100x100/nbc.png"
}, }
... //...
] ]
``` ```
| 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 |
### Streams ### Streams
@ -98,25 +92,25 @@ https://iptv-org.github.io/api/streams.json
https://iptv-org.github.io/api/guides.json https://iptv-org.github.io/api/guides.json
``` ```
``` ```jsonc
[ [
... //...
{ {
"channel": "KSTSDT3.us", "channel": "KSTSDT3.us",
"site": "tvtv.us", "site": "tvtv.us",
"lang": "en", "lang": "en",
"url": "https://iptv-org.github.io/epg/guides/us/tvtv.us.epg.xml" "url": "https://iptv-org.github.io/epg/guides/us/tvtv.us.epg.xml"
}, }
... //...
] ]
``` ```
| 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
@ -124,21 +118,21 @@ https://iptv-org.github.io/api/guides.json
https://iptv-org.github.io/api/categories.json https://iptv-org.github.io/api/categories.json
``` ```
``` ```jsonc
[ [
... //...
{ {
"id": "documentary", "id": "documentary",
"name": "Documentary" "name": "Documentary"
}, }
... //...
] ]
``` ```
| 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
@ -146,21 +140,21 @@ https://iptv-org.github.io/api/categories.json
https://iptv-org.github.io/api/languages.json https://iptv-org.github.io/api/languages.json
``` ```
``` ```jsonc
[ [
... //...
{ {
"name": "French", "name": "French",
"code": "fra" "code": "fra"
}, }
... //...
] ]
``` ```
| 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
@ -168,25 +162,25 @@ https://iptv-org.github.io/api/languages.json
https://iptv-org.github.io/api/countries.json https://iptv-org.github.io/api/countries.json
``` ```
``` ```jsonc
[ [
... //...
{ {
"name": "United Kingdom", "name": "United Kingdom",
"code": "UK", "code": "UK",
"lang": "eng", "lang": "eng",
"flag": "🇬🇧" "flag": "🇬🇧"
}, }
... //...
] ]
``` ```
| 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
@ -194,23 +188,23 @@ https://iptv-org.github.io/api/countries.json
https://iptv-org.github.io/api/subdivisions.json https://iptv-org.github.io/api/subdivisions.json
``` ```
``` ```jsonc
[ [
... //...
{ {
"country": "CA", "country": "CA",
"name": "Ontario", "name": "Ontario",
"code": "CA-ON" "code": "CA-ON"
}, }
... //...
] ]
``` ```
| 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
@ -218,29 +212,23 @@ https://iptv-org.github.io/api/subdivisions.json
https://iptv-org.github.io/api/regions.json https://iptv-org.github.io/api/regions.json
``` ```
``` ```jsonc
[ [
... //...
{ {
"name": "Maghreb", "name": "Maghreb",
"code": "MAGHREB", "code": "MAGHREB",
"countries": [ "countries": ["DZ", "LY", "MA", "MR", "TN"]
"DZ", }
"LY", //...
"MA",
"MR",
"TN"
]
},
...
] ]
``` ```
| 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
@ -248,21 +236,21 @@ https://iptv-org.github.io/api/regions.json
https://iptv-org.github.io/api/blocklist.json https://iptv-org.github.io/api/blocklist.json
``` ```
``` ```jsonc
[ [
... //...
{ {
"channel": "AnimalPlanetEast.us", "channel": "AnimalPlanetEast.us",
"ref": "https://github.com/iptv-org/iptv/issues/1831", "ref": "https://github.com/iptv-org/iptv/issues/1831"
}, }
... //...
] ]
``` ```
| 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