diff --git a/README.md b/README.md index 7cb43a0..85f76b2 100644 --- a/README.md +++ b/README.md @@ -17,3 +17,7 @@ Any useful contribution to the documentation is appreciated :) ### This api is used for get users information [Users API Docs](./docs/users.md) + +### Used for gather some channel information + +[Channels API Docs](./docs/channels.md) diff --git a/docs/channels.md b/docs/channels.md new file mode 100755 index 0000000..1d9ab57 --- /dev/null +++ b/docs/channels.md @@ -0,0 +1,13 @@ +# Channels API + +Work in progress... + +## Tree 🌲 + +```less +channels +├── streams.md +``` + +[Info about some stream (/streams)](./channels/streams.md) + diff --git a/docs/channels/streams.md b/docs/channels/streams.md new file mode 100755 index 0000000..8398d85 --- /dev/null +++ b/docs/channels/streams.md @@ -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" + } + ``` diff --git a/docs/users/blocks.md b/docs/users/blocks.md index bb3130a..eac011a 100755 --- a/docs/users/blocks.md +++ b/docs/users/blocks.md @@ -3,7 +3,7 @@ * */api/v3/users/`userID`/blocks* = Get accounts accounts you have blocked * Response Example: - ```json + ```js { "block_list": [{ "blocked_uid": "12345678", //userID of the blocked user diff --git a/docs/users/bug-report-claims.md b/docs/users/bug-report-claims.md index 9c94859..92d3a49 100755 --- a/docs/users/bug-report-claims.md +++ b/docs/users/bug-report-claims.md @@ -3,7 +3,7 @@ * */api/v3/users/`userID`/bug-report-claims* = Some report shit * Response Example: - ```json + ```js { // I don't know nothing about this "claim": false, "claim_id": 0, diff --git a/docs/users/cash-coins.md b/docs/users/cash-coins.md index 84a4502..82c9703 100755 --- a/docs/users/cash-coins.md +++ b/docs/users/cash-coins.md @@ -3,7 +3,7 @@ * */api/v3/users/`userID`/cash-coins* = Some thing about cashout and money in the account * Response Example: - ```json + ```js { "cash_coin": "0.00", "currency": "USD", diff --git a/docs/users/coins.md b/docs/users/coins.md index e0aa970..30551f1 100755 --- a/docs/users/coins.md +++ b/docs/users/coins.md @@ -3,7 +3,7 @@ * */api/v3/users/`userID`/coins* = Get info about your account coins and tickets count * Response Example: - ```json + ```js { "coin": 0, // Your coins "ticket_info": { diff --git a/docs/users/daily-logins.md b/docs/users/daily-logins.md index 1d594d5..de81f1a 100755 --- a/docs/users/daily-logins.md +++ b/docs/users/daily-logins.md @@ -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 * Response Example: - ```json + ```js { "daily_login_list": [{ "day": 1, diff --git a/docs/users/followers.md b/docs/users/followers.md index 385ecad..3e1ea49 100755 --- a/docs/users/followers.md +++ b/docs/users/followers.md @@ -3,7 +3,7 @@ * */api/v3/users/`userID`/followers/count* = Get the follower count of channelID * Response Example: - ```json + ```js {"count":1337} // Follower Count ``` \ No newline at end of file diff --git a/docs/users/free-gifts.md b/docs/users/free-gifts.md index 59dd8f5..53b61e1 100755 --- a/docs/users/free-gifts.md +++ b/docs/users/free-gifts.md @@ -3,7 +3,7 @@ * */api/v3/users/`userID`/free-gifts* = Some thing about free gifts and tokens * Response Example: - ```json + ```js { "free_gift_list": [{ "name": "5 Tickets", diff --git a/docs/users/push-message-sessions.md b/docs/users/push-message-sessions.md index 15154a5..13197b0 100755 --- a/docs/users/push-message-sessions.md +++ b/docs/users/push-message-sessions.md @@ -3,7 +3,7 @@ * */api/v3/users/`userID`/push-message-sessions* = Get some things about the notificactions * Response Example: - ```json + ```js { "read_msg_id": "20randomnumbersherex", // Some random numbers with id "unread_msg_count": 0, // Unreaded notifications diff --git a/docs/users/userID.md b/docs/users/userID.md index 27b30fb..3811625 100755 --- a/docs/users/userID.md +++ b/docs/users/userID.md @@ -3,7 +3,7 @@ * */api/v3/users/`userID`* = Get info about the userID account * Response Example: - ```json + ```js { "user": { "uid": 12345678, // userID