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-02-16 14:35:13 +03:00
parent ad5dbe5a3d
commit b6704e9ef3
1 changed files with 35 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

35
README.md
View file

@ -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
```