Olá, desenvolvedores!
Neste tópico você encontrará a documentação oficial dos endpoints públicos da API do Mush, voltada a desenvolvedores que desejam integrar bots, sites e ferramentas externas.
INFORMAÇÕES GERAIS:
Link da API: https://mush.com.br/api
• O retorno das informações é em JSON;
• Não requer autenticação;
• Campos sem valor não são retornados na resposta (não vêm como null). Trate-os como opcionais ao integrar;
• Uso indevido pode resultar em bloqueio.
ENDPOINT: PLAYER
- Retorna o perfil completo do jogador, incluindo dados da conta, clan, tags, medalhas, Discord conectado, amigos, skin, status online, datas de login, estatísticas dos modos, entre outras informações.
| Buscar perfil do jogador via Profile ID:
GET /player/profileid/{profile_id}
https://mush.com.br/api/player/profileid/{profile_id}
| Buscar perfil do jogador via Name ou UUID:
GET /player/{nameOrUuid}
https://mush.com.br/api/player/{nameOrUuid}
ENDPOINT: DADOS ESPECÍFICOS DO JOGADOR
- Retorna um dado específico do jogador, conforme o
typeinformado.
| Buscar dados específicos do jogador:
GET /player/{id_type}/{identifier}/{type}
https://mush.com.br/api/player/{id_type}/{identifier}/{type}
O identifier deve seguir o id_type informado.
Tipos de ID disponíveis (id_type):
• name;
• profileid;
• uuid;
Tipos de dados disponíveis (type):
• bedwars — Menu de compra rápida do Bed Wars;
• quickbuilders — Recordes do Quick Builders;
• missions — Missões;
• skywars — Perks selecionadas do Sky Wars;
• parkour — Recorde do Parkour nos Lobbies;
• cosmetics — Cosméticos selecionados.
ENDPOINT: GAME
- Retorna as informações da partida, incluindo modo, horários, jogadores, vencedores e dados detalhados do jogo, entre outras informações.
| Buscar informações de uma partida:
GET /game/{game_id}
https://mush.com.br/api/game/{game_id}
Você pode obter o game_id através do comando /gameid ou pela scoreboard, exibido no topo dela.
Modos suportados pela API de game:
• Hunger Games;
• Bed Wars;
• Build Battle;
• Quick Builders;
• Murder;
• Nascó Mandou;
• CTF.
ENDPOINT: LEADERBOARD
- Retorna a lista do top 100 jogadores do modo, com posição, dados da conta, avatar e algumas estatísticas relevantes daquele ranking, entre outras informações.
| Buscar o ranking (TOP 100) de um modo:
GET /leaderboard/{mode}
https://mush.com.br/api/leaderboard/{mode}
Modos disponíveis (mode):
• bedwars;
• skywars;
• bridge;
• hg;
• minimush;
• pvp;
• soup;
• gladiator;
• party;
• ctf;
• quickbuilders;
• murder.
ENDPOINT: XP TABLE
- Retorna a tabela de progressão do modo, indicando o XP total necessário para alcançar cada nível.
| Buscar tabela de progressão de XP por modo:
GET /games/{mode}/xptable
https://mush.com.br/api/games/{mode}/xptable
Modos disponíveis (mode):
• bedwars;
• skywars;
• duels.
ENDPOINT: PUNIÇÕES
- Retorna a lista de punições do período, com informações do jogador punido, motivo, tipo, status, data e total de registros, entre outras informações.
| Buscar a lista de punições ocorridas no servidor:
GET /punishments?timerange={period}&punishtype={type}&viponly={boolean}
https://mush.com.br/api/punishments?timerange={period}&punishtype={type}&viponly={boolean}
O parâmetro viponly é opcional e booleano, ou seja, aceita os valores true ou false.
Períodos disponíveis (period):
• month;
• day;
Tipos de punição disponíveis (type):
• all;
• ban;
• mute;
• other.
É importante ressaltar que o endpoint de punições não possui suporte oficial e pode ser alterado ou removido a qualquer momento sem avisos.
Olá jogador(a), agradecemos pelo seu empenho em repassar possíveis casos de jogadores quebrando nossas regras.
Olá jogador(a), agradecemos seu Bug Report.