{"api_name":"Bot-Ranker API","version":"1.0.0","status":"online","description":"A RESTful API to programmatically manage your Roblox group members and retrieve information.","documentation":"https://www.botranker.uk/docs","support":{"website":"https://www.botranker.uk","discord":"https://discord.gg/F3z99npsyF"},"authentication":{"type":"api_key","param_name":"apiKey","location":"Can be included in the JSON body for POST requests or as a query parameter for GET requests.","description":"Generate API keys from your user profile on the portal. Each key is tied to your account."},"endpoints":{"Ranking Actions":{"promote":{"method":"POST","path":"https://www.botranker.uk/api/v1/promote","description":"Promotes a user by one rank. Fails if they are at the highest rank.","bodyParams":["apiKey","robloxGroupId","username","triggeredBy"]},"demote":{"method":"POST","path":"https://www.botranker.uk/api/v1/demote","description":"Demotes a user by one rank. Fails if they are at the lowest rank.","bodyParams":["apiKey","robloxGroupId","username","triggeredBy"]},"setrank":{"method":"POST","path":"https://www.botranker.uk/api/v1/setrank","description":"Sets a user's rank to a specific Rank ID. Can be used to add users to the group.","bodyParams":["apiKey","robloxGroupId","username","rankId","triggeredBy"]}},"Information Retrieval":{"userRank":{"method":"GET","path":"https://www.botranker.uk/api/v1/user/rank","description":"Get a specific user's rank and role name in a group.","queryParams":["apiKey","robloxGroupId","username"]},"groupRoles":{"method":"GET","path":"https://www.botranker.uk/api/v1/group/roles","description":"Get a list of all roles/ranks in a specified group.","queryParams":["apiKey","robloxGroupId"]},"getFirstPlayerWithRank":{"method":"GET","path":"https://www.botranker.uk/api/v1/getFirstPlayerWithRank","description":"Get the first player found with a specific rank in a group.","queryParams":["apiKey","robloxGroupId","rankId"]}}}}