diff --git a/README.md b/README.md index d6a35d7..8a24503 100644 --- a/README.md +++ b/README.md @@ -18,9 +18,9 @@ https://iptv-org.github.io/api/channels.json ``` -``` +```jsonc [ - ... + //... { "id": "KSTSDT3.us", "name": "KSTS-DT3", @@ -28,35 +28,29 @@ https://iptv-org.github.io/api/channels.json "country": "US", "subdivision": "US-CA", "city": "San Francisco", - "broadcast_area": [ - "s/US-CA" - ], - "languages": [ - "eng" - ], - "categories": [ - "general" - ], + "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](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)) | -| city | Name of the city from which the broadcast is transmitted | -| broadcast_area | List of codes describing the broadcasting area (`r/`, `c/`, `s/`) | -| 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 | +| Field | Type | Description | +| -------------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | +| id | string | Unique channel ID | +| name | string | Full name of the channel | +| network | string | Name of the network operating the channel | +| 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 | 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 | string | Name of the city from which the broadcast is transmitted | +| broadcast_area | array | List of codes describing the broadcasting area (`r/`, `c/`, `s/`) | +| languages | array | List of languages broadcast | +| categories | array | List of categories to which this channel belongs | +| is_nsfw | boolean | Indicates whether the channel broadcasts adult content | +| logo | string | Logo URL | ### Streams @@ -98,25 +92,25 @@ https://iptv-org.github.io/api/streams.json https://iptv-org.github.io/api/guides.json ``` -``` +```jsonc [ - ... + //... { "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](https://en.wikipedia.org/wiki/ISO_639-1) code) | -| url | Link to the guide | +| Field | Type | Description | +| ------- | ------ | --------------------------------------------------------------------------------- | +| channel | string | Channel ID | +| site | string | Program source domain name | +| lang | string | Language of the guide ([ISO_639-1](https://en.wikipedia.org/wiki/ISO_639-1) code) | +| url | string | Link to the guide | ### Categories @@ -124,21 +118,21 @@ https://iptv-org.github.io/api/guides.json https://iptv-org.github.io/api/categories.json ``` -``` +```jsonc [ - ... + //... { "id": "documentary", "name": "Documentary" - }, - ... + } + //... ] ``` -| Field | Description | -| ----- | -------------------- | -| id | Category ID | -| name | Name of the category | +| Field | Type | Description | +| ----- | ------ | -------------------- | +| id | string | Category ID | +| name | string | Name of the category | ### Languages @@ -146,21 +140,21 @@ https://iptv-org.github.io/api/categories.json https://iptv-org.github.io/api/languages.json ``` -``` +```jsonc [ - ... + //... { "name": "French", "code": "fra" - }, - ... + } + //... ] ``` -| Field | Description | -| ----- | ------------------------------------------------------------------------- | -| name | Language name | -| code | [ISO 639-3](https://en.wikipedia.org/wiki/ISO_639-3) code of the language | +| Field | Type | Description | +| ----- | ------ | ------------------------------------------------------------------------- | +| name | string | Language name | +| code | string | [ISO 639-3](https://en.wikipedia.org/wiki/ISO_639-3) code of the language | ### Countries @@ -168,25 +162,25 @@ https://iptv-org.github.io/api/languages.json https://iptv-org.github.io/api/countries.json ``` -``` +```jsonc [ - ... + //... { "name": "United Kingdom", "code": "UK", "lang": "eng", "flag": "🇬🇧" - }, - ... + } + //... ] ``` -| Field | Description | -| ----- | ------------------------------------------------------------------------------------------ | -| name | Name of the country | -| 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 | +| Field | Type | Description | +| ----- | ------ | ------------------------------------------------------------------------------------------ | +| name | string | Name 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 | string | Official language ([ISO 639-3](https://en.wikipedia.org/wiki/ISO_639-3) code) | +| flag | string | Country flag emoji | ### Subdivisions @@ -194,23 +188,23 @@ https://iptv-org.github.io/api/countries.json https://iptv-org.github.io/api/subdivisions.json ``` -``` +```jsonc [ - ... + //... { "country": "CA", "name": "Ontario", "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-2) code of the subdivision | +| Field | Type | Description | +| ------- | ------ | ------------------------------------------------------------------------------------------ | +| country | string | [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) code of the country | +| name | string | Subdivision name | +| code | string | [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) code of the subdivision | ### Regions @@ -218,29 +212,23 @@ https://iptv-org.github.io/api/subdivisions.json https://iptv-org.github.io/api/regions.json ``` -``` +```jsonc [ - ... + //... { "name": "Maghreb", "code": "MAGHREB", - "countries": [ - "DZ", - "LY", - "MA", - "MR", - "TN" - ] - }, - ... + "countries": ["DZ", "LY", "MA", "MR", "TN"] + } + //... ] ``` -| Field | Description | -| --------- | ------------------------------- | -| name | Region name | -| code | Code of the region | -| countries | List of countries in the region | +| Field | Type | Description | +| --------- | ------ | ------------------------------- | +| name | string | Region name | +| code | string | Code of the region | +| countries | array | List of countries in the region | ### Blocklist @@ -248,21 +236,21 @@ https://iptv-org.github.io/api/regions.json https://iptv-org.github.io/api/blocklist.json ``` -``` +```jsonc [ - ... + //... { "channel": "AnimalPlanetEast.us", - "ref": "https://github.com/iptv-org/iptv/issues/1831", - }, - ... + "ref": "https://github.com/iptv-org/iptv/issues/1831" + } + //... ] ``` -| Field | Description | -| ------- | ----------------------------------------------- | -| channel | Channel ID | -| ref | Link to removal request or DMCA takedown notice | +| Field | Type | Description | +| ------- | ------ | ----------------------------------------------- | +| channel | string | Channel ID | +| ref | string | Link to removal request or DMCA takedown notice | ## Contribution