diff --git a/README.md b/README.md index 8fd7901..f512ec5 100644 --- a/README.md +++ b/README.md @@ -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) diff --git a/docs/channels.md b/docs/channels.md index 983994b..7ece271 100755 --- a/docs/channels.md +++ b/docs/channels.md @@ -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 diff --git a/docs/chatrooms.md b/docs/chatrooms.md new file mode 100644 index 0000000..6dd93e2 --- /dev/null +++ b/docs/chatrooms.md @@ -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) diff --git a/docs/chatrooms/audiences-count.md b/docs/chatrooms/audiences-count.md new file mode 100644 index 0000000..bace384 --- /dev/null +++ b/docs/chatrooms/audiences-count.md @@ -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' +``` diff --git a/docs/chatrooms/chatrooms.md b/docs/chatrooms/chatrooms.md index 61b9ab3..9b87d41 100755 --- a/docs/chatrooms/chatrooms.md +++ b/docs/chatrooms/chatrooms.md @@ -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' +``` diff --git a/docs/games.md b/docs/games.md index f1842cc..450d33e 100755 --- a/docs/games.md +++ b/docs/games.md @@ -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)