Modify README.md, upload some users api docs

README.md

@@ -1,2 +1,19 @@
-# BooyahApiListing
-Listing of Booyah api, their use and example response
+![apiv3](https://user-images.githubusercontent.com/61166695/129963654-8abb0486-2a0d-42a3-828b-8d604e6ace3b.png)
+
+# Booyah.live Docs
+
+Unofficial usermade documentation of the v3 API of the streaming platform called booyah
+
+Since booyah does not provide documentation to its API, I am doing the documentation to make the development of bots (or something else) easier for everyone.
+
+I am not a booyah employee and I am not affiliated with them either (in fact, I hate booyah). I am just a normal user
+
+This work is in progress, I will update it when I have time available. The booyah api is too extensive to finish it in a few days.
+
+Any useful contribution to the documentation is appreciated :)
+
+## ↓ Docs ↓
+
+### This api is used for get users information
+
+[Users API Docs](./docs/users.md)

docs/users.md

@@ -0,0 +1,40 @@
+# Users API
+
+Work in progress...
+
+## Tree 🌲
+
+```less
+users
+├── blocks.md
+├── bug-report-claims.md
+├── cash-coins.md
+├── coins.md
+├── daily-logins.md
+├── followers.md
+├── free-gifts.md
+├── push-message-sessions.md
+└── userID.md
+```
+
+### For all users
+
+[Info about some account](./users/userID.md)
+
+[Info about the follower count of some user](./users/followers.md)
+
+### Only for your account
+
+[Get a list of users blocked](./users/blocks.md)
+
+[Info about daily login](./users/daily-logins.md)
+
+[Info about coins](./users/coins.md)
+
+[Info about real money in your account](./users/cash-coins.md)
+
+[Info about your account notifications/alerts](./users/push-message-sessions.md)
+
+[Info about some Free gifts/tickets](./users/free-gifts.md)
+
+[Info about some bug report or something else](./users/bug-report-claims.md)

docs/users/blocks.md

@@ -0,0 +1,15 @@
+# Blocks
+
+* */api/v3/users/`userID`/blocks* = Get accounts accounts you have blocked
+  * Response Example:
+
+    ```json
+    {
+        "block_list": [{
+            "blocked_uid": "12345678", //userID of the blocked user
+            "nickname": "Thisismynickname", // Nickanem of the blocked user
+            "source": 0 // From booyah files -> // 0: MAMBETTV, 1: YOUTUBE, 3:FACEBOOK
+            // MAMBETTV is the old name of booyah
+        }]
+    }
+    ```

docs/users/bug-report-claims.md

@@ -0,0 +1,13 @@
+# Bug Report Claims
+
+* */api/v3/users/`userID`/bug-report-claims* = Some report shit
+  * Response Example:
+
+    ```json
+    { // I don't know nothing about this
+    "claim": false,
+    "claim_id": 0,
+    "start_time": 0,
+    "end_time": 0
+    }
+    ```

docs/users/cash-coins.md

@@ -0,0 +1,18 @@
+# Cash Coins
+
+* */api/v3/users/`userID`/cash-coins* = Some thing about cashout and money in the account
+  * Response Example:
+  
+    ```json
+    {
+        "cash_coin": "0.00",
+        "currency": "USD",
+        "currency_amount": "0",
+        "currency_exchange_rate": "0.0035",
+        "min_currency_amount": "40.00",
+        "max_currency_amount": "5000.00",
+        "withdraw_sub_code": 400005,
+        "withdraw_sub_msg": "You need to apply for a minimum amount of 40.00USD to cashout",
+        "withdraw_sub_title": "Lower than minimum amount"
+    }
+    ```

docs/users/coins.md

@@ -0,0 +1,15 @@
+# Coins
+
+* */api/v3/users/`userID`/coins* = Get info about your account coins and tickets count
+  * Response Example:
+
+    ```json
+    {
+        "coin": 0, // Your coins
+        "ticket_info": {
+            "balance": 1065, // Your tokens
+            "sent": 200, // Total tokens spended in streamers or something else
+            "received": 0 // Recived tokens 
+        }
+    }
+    ```

docs/users/daily-logins.md

@@ -0,0 +1,55 @@
+# Daily Logins
+
+* */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
+    {
+    "daily_login_list": [{
+        "day": 1,
+        "reward_type": 0,
+        "reward_amount": 25,
+        "status": 1,
+        "review_time": 1629154508 // Unix time
+    }, {
+        "day": 2,
+        "reward_type": 0,
+        "reward_amount": 25,
+        "status": 1,
+        "review_time": 1629176468 // Unix time
+    }, {
+        "day": 3,
+        "reward_type": 0,
+        "reward_amount": 25,
+        "status": 1,
+        "review_time": 1629259336 // Unix time
+    }, {
+        "day": 4,
+        "reward_type": 0,
+        "reward_amount": 50,
+        "status": 0
+    }, {
+        "day": 5,
+        "reward_type": 0,
+        "reward_amount": 50,
+        "status": 0
+    }, {
+        "day": 6,
+        "reward_type": 0,
+        "reward_amount": 50,
+        "status": 0
+    }, {
+        "day": 7,
+        "reward_type": 2,
+        "reward_amount": 1,
+        "ff_item_name": "BOOYAH Weapon Loot Crate",
+        "ff_item_icon_url": "https://totallyrealurl/booyah/ops_resource/loot_item_pic/loot_crate_booyah_weapon.notapng", 
+        // Scuffed url to avoid scrapping
+        "status": 0
+    }],
+    "current_day": 3, // Current day of the daily login streak 
+    "current_time": 1629309773, // Unix time
+    "next_day_time": 1629331200, // Unix time
+    "next_cycle_time": 1629676800 // Unix time
+    } 
+    ```

docs/users/followers.md

@@ -0,0 +1,9 @@
+# Followers Count
+
+* */api/v3/users/`userID`/followers/count* = Get the follower count of channelID
+  * Response Example:
+
+     ```json
+     {"count":1337} // Follower Count
+     ```
+  

docs/users/free-gifts.md

@@ -0,0 +1,70 @@
+# Free Gifts
+
+* */api/v3/users/`userID`/free-gifts* = Some thing about free gifts and tokens
+  * Response Example:
+  
+    ```json
+    {
+        "free_gift_list": [{
+            "name": "5 Tickets",
+            "picture_url": "https://totalyrealurl:)/mambet-storage/Server/Admin/FreeGift/298d72d8-b86e-4551-996d-431bdc7b7ce8.png",
+            "level": 1,
+            "wait_duration": 300,
+            "ticket_amount": 5,
+            "is_block": false,
+            "claimed": false,
+            "can_claim": true,
+            "count_down": 0
+        }, {
+            "name": "10 Tickets",
+            "picture_url": "https://totalyrealurl:)/mambet-storage/Server/Admin/FreeGift/5b665b76-caed-47ec-a80f-6c0b152c4eb5.png",
+            "level": 2,
+            "wait_duration": 300,
+            "ticket_amount": 10,
+            "is_block": false,
+            "claimed": false,
+            "can_claim": true,
+            "count_down": 0
+        }, {
+            "name": "15 Tickets",
+            "picture_url": "https://totalyrealurl:)/mambet-storage/Server/Admin/FreeGift/3c01c650-e4e7-4467-b119-9de02b52f73f.png",
+            "level": 3,
+            "wait_duration": 300,
+            "ticket_amount": 15,
+            "is_block": true,
+            "claimed": false,
+            "can_claim": true,
+            "count_down": 0
+        }, {
+            "name": "20 Tickets",
+            "picture_url": "https://totalyrealurl:)/mambet-storage/Server/Admin/FreeGift/a81f5673-3afc-4f55-841c-6e86d177d00f.png",
+            "level": 4,
+            "wait_duration": 300,
+            "ticket_amount": 20,
+            "is_block": false,
+            "claimed": false,
+            "can_claim": false,
+            "count_down": 300
+        }, {
+            "name": "20 Tickets",
+            "picture_url": "https://totalyrealurl:)/mambet-storage/Server/Admin/FreeGift/d6f18b04-13a3-44a7-800a-74689bf8b138.png",
+            "level": 5,
+            "wait_duration": 600,
+            "ticket_amount": 20,
+            "is_block": false,
+            "claimed": false,
+            "can_claim": false,
+            "count_down": 600
+        }, {
+            "name": "30 Tickets",
+            "picture_url": "https://totalyrealurl:)/mambet-storage/Server/Admin/FreeGift/7b22eac3-0e7d-4f9b-83a3-9a3e5a152e70.png",
+            "level": 6,
+            "wait_duration": 900,
+            "ticket_amount": 30,
+            "is_block": true,
+            "claimed": false,
+            "can_claim": false,
+            "count_down": 900
+        }]
+    }
+    ```

docs/users/push-message-sessions.md

@@ -0,0 +1,12 @@
+# Push Message Sessions
+
+* */api/v3/users/`userID`/push-message-sessions* = Get some things about the notificactions
+  * Response Example:
+
+    ```json
+    {
+    "read_msg_id": "20randomnumbersherex", // Some random numbers with id
+    "unread_msg_count": 0, // Unreaded notifications
+    "latest_msg_id": "20randomnumbersherex" // Latest id of msg
+    }
+    ```

docs/users/userID.md

@@ -0,0 +1,62 @@
+# userID
+
+* */api/v3/users/`userID`* = Get info about the userID account
+  * Response Example:
+
+    ```json
+    {
+        "user": {
+            "uid": 12345678, // userID
+            "nickname": "Fijxu", // Nickname
+            "nickname_next_update_time": 1627966320, 
+            // The date and time in which the user is available to change their nickname. This can be converted to human time with this Unix command: 
+            //"date --date='@1627966320'" Output = Tue Aug  3 12:52:00 AM -04 2021
+            "thumbnail": "https://totalyrealurl:)/mambet-storage/Web/Avatar/74290923/image-1625374334547.jpeg", //Profile Picture
+            "gender": 0, // Gender of the user, 0 = No gender, 1 = Male, 2 = Female, 3 = Other, 4 = Keep Secret
+            //I do not guarantee that these will be the values of the genres, it is only a prediction.
+            "gender_next_update_time": 0, // The date and time in which the user is available to change their gender.
+            // This can be converted to human time with the same Unix command mentioned before
+            "age": 51, // Age of the user (Is 0 if the user has not entered his or her date of birth)
+            "birthday": -4406400, // The birthday birth of the user, why this is public?
+            "birthday_next_update_time": 1628822959, // The date and time in which the user is available to change their birthday.
+            // This can be converted to human time with the same Unix command mentioned before
+            "platform": 8, // The login method used by the user
+            // none = 0,
+            // facebook = 3,
+            // vk = 5,
+            // line = 6,
+            // google = 8,
+            // apple = 10,
+            // twitter = 11
+            "following_count": 5, // Channels this user follows
+            "follower_count": 16 // Users who follow this user
+        },
+        "channel": {
+            "channel_id": 12345678, // channelID, is the same as userID
+            "chatroom_id": 12345678, // The id of chatroom of this user
+            "name": "ffmpeg and shit!", // Title of the stream
+            "streaming_lang": "en", // Language of this user
+            "description": "", // Description of this channel
+            "flag": 16, // wtf is this????????? 
+            // From internal files: enableUploadVod = !!(flag & 512); enableHosting = !!(flag & 1024);
+            // I think it means that if the user has the flag 512, he is allowed to upload vods, if he has the flag 1024, he can host other streamers.
+            // There is also a hidden flag in some streamers which is 5813, 5300, 1716, and other mores, i think a higher flag means higher priority or higher permissions.
+            "offline_pic": "", // Ofline picture, like twitch when a streamer is offline
+            "thumbnail": "", // Customized thumbnail for the main page
+            "create_time": 1625374300, // The date when the account was created
+            // This can be converted to human time with the same Unix command mentioned before
+            "share_url": "https://booyah.live/channels/12345678", // The share url when a user press the share button 
+            "alias": "SomeAlias", // Alias of the user
+            // Obvious strings
+            "is_streaming": false, 
+            "is_verified_streamer": false,
+            "is_content_creator": false,
+            "is_enable_vod": false,
+            "is_enable_download_vod": false,
+            "is_enable_long_clip": false,
+            // Obvious strings
+            "is_enable_lucky_draw": false, // wtf is lucky draw
+            "social_links": [] // Social links that the user has posted on his channel
+        }
+    }
+    ```