mirror of
https://github.com/Fijxu/BooyahDocs.git
synced 2025-04-29 14:59:52 -04:00
Added channels/stream api docs.
+ Changed json markdown format to js for avoid red comments
This commit is contained in:
parent
7d347f8b10
commit
9401e9787d
12 changed files with 75 additions and 9 deletions
|
@ -17,3 +17,7 @@ Any useful contribution to the documentation is appreciated :)
|
||||||
### This api is used for get users information
|
### This api is used for get users information
|
||||||
|
|
||||||
[Users API Docs](./docs/users.md)
|
[Users API Docs](./docs/users.md)
|
||||||
|
|
||||||
|
### Used for gather some channel information
|
||||||
|
|
||||||
|
[Channels API Docs](./docs/channels.md)
|
||||||
|
|
13
docs/channels.md
Executable file
13
docs/channels.md
Executable file
|
@ -0,0 +1,13 @@
|
||||||
|
# Channels API
|
||||||
|
|
||||||
|
Work in progress...
|
||||||
|
|
||||||
|
## Tree 🌲
|
||||||
|
|
||||||
|
```less
|
||||||
|
channels
|
||||||
|
├── streams.md
|
||||||
|
```
|
||||||
|
|
||||||
|
[Info about some stream (/streams)](./channels/streams.md)
|
||||||
|
|
49
docs/channels/streams.md
Executable file
49
docs/channels/streams.md
Executable file
|
@ -0,0 +1,49 @@
|
||||||
|
# Streams
|
||||||
|
|
||||||
|
* */api/v3/channels/`userID`/streams* = Get info about some stream, varies depending on whether streamer is offline or online. This can be used to detect if the streamer is live and send a notification.
|
||||||
|
* Response Example if streamer is live:
|
||||||
|
|
||||||
|
```js
|
||||||
|
{
|
||||||
|
"game_build_id": 0, // Game/category number
|
||||||
|
"snapshot": "https://resmambet-a.akamaihd.net/mambet-storage/Stream/Snapshot/12345678/12345678.jpg",
|
||||||
|
"snapshot_webp": "https://resmambet-a.akamaihd.net/mambet-storage/Stream/Snapshot/12345678/12345678.webp",
|
||||||
|
"stream_addr_list": [{
|
||||||
|
"resolution": "1080p",
|
||||||
|
"url_path": "/hls/1000051/12345678.m3u8" // The m3u8 list
|
||||||
|
}],
|
||||||
|
"mirror_list": [{ // Mirror list
|
||||||
|
"name": "centurylink.br.cdn.booyah.live",
|
||||||
|
"url_domain": "https://centurylink.br.cdn.booyah.live"
|
||||||
|
}, {
|
||||||
|
"name": "aws-br.cdn.booyah.live",
|
||||||
|
"url_domain": "https://aws-br.cdn.booyah.live"
|
||||||
|
}, {
|
||||||
|
"name": "akamai2-br.cdn.booyah.live",
|
||||||
|
"url_domain": "https://akamai2-br.cdn.booyah.live"
|
||||||
|
}, {
|
||||||
|
"name": "google-br.cdn.booyah.live",
|
||||||
|
"url_domain": "https://google-br.cdn.booyah.live"
|
||||||
|
}],
|
||||||
|
"default_mirror": "akamai2-br.cdn.booyah.live",
|
||||||
|
"viewer_count": 2, // Spectators
|
||||||
|
"viewer_count_info": [{
|
||||||
|
"platform": "mambettv", // Mambettv = Booyah
|
||||||
|
"live_views": 2
|
||||||
|
}],
|
||||||
|
"encoder": "Lavf58.76.100", // This can be used
|
||||||
|
"tag_uniq": "",
|
||||||
|
"create_time": 1629322384, // Unix time // Time at which the stremearing started
|
||||||
|
"update_time": 1629323357, // Unix time //The time at which the data in this request is updated.
|
||||||
|
"source_stream_url_path": "/hls/1000051/12345678.m3u8" // The m3u8 list
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
* Response Example if streamer is offline:
|
||||||
|
|
||||||
|
```js
|
||||||
|
{
|
||||||
|
"code": 404,
|
||||||
|
"message": "Stream is not online"
|
||||||
|
}
|
||||||
|
```
|
|
@ -3,7 +3,7 @@
|
||||||
* */api/v3/users/`userID`/blocks* = Get accounts accounts you have blocked
|
* */api/v3/users/`userID`/blocks* = Get accounts accounts you have blocked
|
||||||
* Response Example:
|
* Response Example:
|
||||||
|
|
||||||
```json
|
```js
|
||||||
{
|
{
|
||||||
"block_list": [{
|
"block_list": [{
|
||||||
"blocked_uid": "12345678", //userID of the blocked user
|
"blocked_uid": "12345678", //userID of the blocked user
|
||||||
|
|
|
@ -3,7 +3,7 @@
|
||||||
* */api/v3/users/`userID`/bug-report-claims* = Some report shit
|
* */api/v3/users/`userID`/bug-report-claims* = Some report shit
|
||||||
* Response Example:
|
* Response Example:
|
||||||
|
|
||||||
```json
|
```js
|
||||||
{ // I don't know nothing about this
|
{ // I don't know nothing about this
|
||||||
"claim": false,
|
"claim": false,
|
||||||
"claim_id": 0,
|
"claim_id": 0,
|
||||||
|
|
|
@ -3,7 +3,7 @@
|
||||||
* */api/v3/users/`userID`/cash-coins* = Some thing about cashout and money in the account
|
* */api/v3/users/`userID`/cash-coins* = Some thing about cashout and money in the account
|
||||||
* Response Example:
|
* Response Example:
|
||||||
|
|
||||||
```json
|
```js
|
||||||
{
|
{
|
||||||
"cash_coin": "0.00",
|
"cash_coin": "0.00",
|
||||||
"currency": "USD",
|
"currency": "USD",
|
||||||
|
|
|
@ -3,7 +3,7 @@
|
||||||
* */api/v3/users/`userID`/coins* = Get info about your account coins and tickets count
|
* */api/v3/users/`userID`/coins* = Get info about your account coins and tickets count
|
||||||
* Response Example:
|
* Response Example:
|
||||||
|
|
||||||
```json
|
```js
|
||||||
{
|
{
|
||||||
"coin": 0, // Your coins
|
"coin": 0, // Your coins
|
||||||
"ticket_info": {
|
"ticket_info": {
|
||||||
|
|
|
@ -3,7 +3,7 @@
|
||||||
* */api/v3/users/`userID`/followers/daily-logins* = Some info about the daily login of YOUR user, you can't view other users daily-login info and streaks
|
* */api/v3/users/`userID`/followers/daily-logins* = Some info about the daily login of YOUR user, you can't view other users daily-login info and streaks
|
||||||
* Response Example:
|
* Response Example:
|
||||||
|
|
||||||
```json
|
```js
|
||||||
{
|
{
|
||||||
"daily_login_list": [{
|
"daily_login_list": [{
|
||||||
"day": 1,
|
"day": 1,
|
||||||
|
|
|
@ -3,7 +3,7 @@
|
||||||
* */api/v3/users/`userID`/followers/count* = Get the follower count of channelID
|
* */api/v3/users/`userID`/followers/count* = Get the follower count of channelID
|
||||||
* Response Example:
|
* Response Example:
|
||||||
|
|
||||||
```json
|
```js
|
||||||
{"count":1337} // Follower Count
|
{"count":1337} // Follower Count
|
||||||
```
|
```
|
||||||
|
|
|
@ -3,7 +3,7 @@
|
||||||
* */api/v3/users/`userID`/free-gifts* = Some thing about free gifts and tokens
|
* */api/v3/users/`userID`/free-gifts* = Some thing about free gifts and tokens
|
||||||
* Response Example:
|
* Response Example:
|
||||||
|
|
||||||
```json
|
```js
|
||||||
{
|
{
|
||||||
"free_gift_list": [{
|
"free_gift_list": [{
|
||||||
"name": "5 Tickets",
|
"name": "5 Tickets",
|
||||||
|
|
|
@ -3,7 +3,7 @@
|
||||||
* */api/v3/users/`userID`/push-message-sessions* = Get some things about the notificactions
|
* */api/v3/users/`userID`/push-message-sessions* = Get some things about the notificactions
|
||||||
* Response Example:
|
* Response Example:
|
||||||
|
|
||||||
```json
|
```js
|
||||||
{
|
{
|
||||||
"read_msg_id": "20randomnumbersherex", // Some random numbers with id
|
"read_msg_id": "20randomnumbersherex", // Some random numbers with id
|
||||||
"unread_msg_count": 0, // Unreaded notifications
|
"unread_msg_count": 0, // Unreaded notifications
|
||||||
|
|
|
@ -3,7 +3,7 @@
|
||||||
* */api/v3/users/`userID`* = Get info about the userID account
|
* */api/v3/users/`userID`* = Get info about the userID account
|
||||||
* Response Example:
|
* Response Example:
|
||||||
|
|
||||||
```json
|
```js
|
||||||
{
|
{
|
||||||
"user": {
|
"user": {
|
||||||
"uid": 12345678, // userID
|
"uid": 12345678, // userID
|
||||||
|
|
Loading…
Add table
Reference in a new issue