Added more api docs, changed few things 🖤

+ Added Curl request examples (chatrooms api)
+ Updated tree in the files of ./docs
This commit is contained in:
Fijxu 2021-08-20 06:50:42 -04:00
parent 4750a4523d
commit f715c168a7
6 changed files with 69 additions and 9 deletions

View file

@ -14,10 +14,18 @@ Any useful contribution to the documentation is appreciated :)
## ↓ Docs ↓
### Used for get users information
### Get users information
[Users API Docs](./docs/users.md)
[Users API](./docs/users.md) (Incomplete)
### Used for get channels information
### Get channels information
[Channels API Docs](./docs/channels.md)
[Channels API](./docs/channels.md) (Incomplete)
### Get chatrooms information
[Chatrooms API](./docs/chatrooms.md) (Incomplete)
### Get games information
[Chatrooms API](./docs/games.md) (Incomplete)

View file

@ -6,7 +6,12 @@ Work in progress...
```less
channels
├── alert-configs.md
├── stats.md
├── stream-keys.md
├── stream-settings.md
├── streams.md
└── videos.md
```
### Public access

17
docs/chatrooms.md Normal file
View file

@ -0,0 +1,17 @@
# Chatrooms API
Work in progress...
## Tree 🌲
```less
chatrooms
├── audiences-count.md
└── chatrooms.md
```
### Public access
[Info about channel chatroom, settings and moderators of the channel (/chatrooms/userID)](./chatrooms/chatrooms.md)
[Get current viewers of a channel (only works if the streamer is live) (/chatrooms/userID/audiences/count)](./chatrooms/chatrooms.md)

View file

@ -0,0 +1,21 @@
# Audience Count (Spectators)
Request Method: GET
* */chatrooms/`userID`/audiences/count* = Get info about the channel chatroom, contains the list of moderators of the channel
* Response Example:
```js
{
"ccu": 0,
"logged_in_ccu": 0,
"viewer_count": 0
}
```
## Curl Request
```bash
curl 'https://booyah.live/api/v3/chatrooms/12345678/audiences/count' \
-H 'booyah-session-key: yourbooyahsessionkey'
```

View file

@ -1,6 +1,13 @@
# Chatroom
# Chatrooms
Request Method: GET
* */chatroom/`userID`* = Get info about the channel chatroom, contains the list of moderators of the channel
* */chatrooms/`userID`* = Get info about the channel chatroom, contains the list of moderators of the channel
* Response Example: The response is too long to put here and contains to much sensitive information.
## Curl Request
```bash
curl 'https://booyah.live/api/v3/chatrooms/12345678' \
-H 'booyah-session-key: yourbooyahsessionkey'
```

View file

@ -5,12 +5,14 @@ Work in progress...
## Tree 🌲
```less
channels
├── streams.md
games
├── games-1-rewards.json
├── games-1-rewards.md
└── games.md
```
### Public access
[Get list of games, sorted by popularity (/games)](./games/games.md)
[Get rewards (/games-1-rewards)](./games/games-1-rewards.md)
[Get rewards of game ID 1 (Free Fire) (/games-1-rewards)](./games/games-1-rewards.md)