From b6704e9ef382ad83aa4ab0dc4a75295564d421c3 Mon Sep 17 00:00:00 2001 From: Aleksandr Statciuk Date: Wed, 16 Feb 2022 14:35:13 +0300 Subject: [PATCH] Update README.md --- README.md | 35 +++++++++++++++++++++++++++++++++++ 1 file changed, 35 insertions(+) diff --git a/README.md b/README.md index 54cc8b0..d6a35d7 100644 --- a/README.md +++ b/README.md @@ -3,6 +3,7 @@ ## Overview - [Channels](#channels) +- [Streams](#streams) - [Guides](#guides) - [Categories](#categories) - [Languages](#languages) @@ -57,6 +58,40 @@ https://iptv-org.github.io/api/channels.json | is_nsfw | Indicates whether the channel broadcasts adult content | | logo | Logo URL | +### Streams + +``` +https://iptv-org.github.io/api/streams.json +``` + +```jsonc +[ + //... + { + "channel": "BBCNews.uk", + "url": "http://1111296894.rsc.cdn77.org/LS-ATL-54548-6/index.m3u8", + "http_referrer": "http://example.com/", + "user_agent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64)", + "status": "online", + "width": 1280, + "height": 720, + "bitrate": 565040 + } + //... +] +``` + +| Field | Description | +| ------------- | -------------------------------------------------------------------------------------------------------------------- | +| channel | Channel ID | +| url | Stream URL | +| http_referrer | The [Referer](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Referer) request header for the stream | +| user_agent | The [User-Agent](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/User-Agent) request header for the stream | +| status | One of the following: `online`, `blocked`, `timeout`, `error` | +| width | The maximum width of the stream in pixels. Specified only if the status is `online` | +| height | The maximum height of the stream in pixels. Specified only if the status is `online` | +| bitrate | The bitrate of the stream in bits per second. Specified only if the status is `online` | + ### Guides ```