Skip to content

Latest commit

 

History

History
49 lines (45 loc) · 5 KB

API_ROUTES.md

File metadata and controls

49 lines (45 loc) · 5 KB

API route coverage

Source: current Yunite reference, checked 2026-10-12. All 38 HTTP operations plus the WebSocket route are covered. Optional arguments below use JavaScript defaults; from/to/round can be omitted.

Method Verb API path
getApp(withGuildNames = false, options = {}) GET /app
deauthorize(guildId, options = {}) POST /app/deauthorize
getWsToken(options = {}) GET /websocket-token
getAuditLog(guildId, query = {}, options = {}) GET /guild/{guildId}/auditlog
getUserLinks(guildId, body, options = {}) POST /guild/{guildId}/registration/links
getCrossGuildUserLinks(body, options = {}) POST /registration/links/multi-guild
getTwitchLinks(guildId, body, options = {}) POST /guild/{guildId}/registration/twitch-links
blockUser(guildId, body, options = {}) POST /guild/{guildId}/registration/blocks
getBlockStatus(guildId, body, options = {}) POST /guild/{guildId}/registration/block-status
unlinkUser(guildId, userId, options = {}) POST /guild/{guildId}/registration/unlink/{userId}
getCustomMatchLogs(guildId, query = {}, options = {}) GET /guild/{guildId}/customs/logs
getHostPresets(guildId, options = {}) GET /guild/{guildId}/customs/host/presets
openCustomSession(guildId, body, options = {}) POST /guild/{guildId}/customs/host/open
selectCustomHost(guildId, sessionId, body, options = {}) POST /guild/{guildId}/customs/host/select/{sessionId}
cancelCustomHostSelection(guildId, sessionId, options = {}) POST /guild/{guildId}/customs/host/cancel-selection/{sessionId}
dispatchCustomSession(guildId, sessionId, options = {}) POST /guild/{guildId}/customs/host/dispatch/{sessionId}
redispatchCustomSession(guildId, sessionId, body, options = {}) POST /guild/{guildId}/customs/host/redispatch/{sessionId}
toggleCustomSignup(guildId, sessionId, options = {}) POST /guild/{guildId}/customs/host/reopen/{sessionId}
resendCustomHostKey(guildId, sessionId, options = {}) POST /guild/{guildId}/customs/host/resend-key/{sessionId}
mentionCustomClientIssues(guildId, sessionId, body, options = {}) POST /guild/{guildId}/customs/host/client-check-mention/{sessionId}
cancelCustomSession(guildId, sessionId, options = {}) POST /guild/{guildId}/customs/host/cancel/{sessionId}
getTournaments(guildId, query = {}, options = {}) GET /guild/{guildId}/tournaments
getSingleTournament(guildId, tournamentId, options = {}) GET /guild/{guildId}/tournaments/{tournamentId}
createOrUpdateTournament(guildId, body, options = {}) POST /guild/{guildId}/tournaments
getLeaderboard(guildId, tournamentId, options = {}) GET /guild/{guildId}/tournaments/{tournamentId}/leaderboard
getMatches(guildId, tournamentId, query = {}, options = {}) GET /guild/{guildId}/tournaments/{tournamentId}/matches
getSingleLeaderboard(guildId, tournamentId, sessionId, query = {}, options = {}) GET /guild/{guildId}/tournaments/{tournamentId}/matches/{sessionId}[/{round}]
getMatchAnalytics(guildId, tournamentId, sessionId, round, options = {}) GET /guild/{guildId}/tournaments/{tournamentId}/matches/{sessionId}[/{round}]/analytics
getMatchTeams(guildId, tournamentId, sessionId, round, options = {}) GET /guild/{guildId}/tournaments/{tournamentId}/matches/{sessionId}[/{round}]/teams
getTeams(guildId, tournamentId, options = {}) GET /guild/{guildId}/tournaments/{tournamentId}/teams
addTeam(guildId, tournamentId, body, options = {}) POST /guild/{guildId}/tournaments/{tournamentId}/teams
addTeams(guildId, tournamentId, body, options = {}) POST /guild/{guildId}/tournaments/{tournamentId}/teams/bulk
sendTournamentEmbed(guildId, tournamentId, body, options = {}) POST /guild/{guildId}/tournaments/{tournamentId}/sendEmbed
getTicketStats(guildId, from, to, options = {}) GET /guild/{guildId}/acss/stats
getUserXp(guildId, discordId, options = {}) GET /guild/{guildId}/levelsystem/user/{discordId}
setUserXp(guildId, discordId, xp, options = {}) PUT /guild/{guildId}/levelsystem/user/{discordId}
addUserXp(guildId, discordId, xp, options = {}) POST /guild/{guildId}/levelsystem/user/{discordId}/add
getXpLeaderboard(guildId, query = {}, options = {}) GET /guild/{guildId}/levelsystem/leaderboard
connectCustomState(guildId, options = {}) WSS /guild/{guildId}/customs/stream

The getCustomStateStreamUrl helper obtains a fresh token and returns the same WSS URL for external socket clients. makeRequest remains available for undocumented API routes. Query defaults are not added except historical getApp(withGuildNames=false) and getSingleLeaderboard(includeLive=true).

The API describes optional round forms for match leaderboard/analytics/teams; both forms are supported. Open Session and the host-control endpoints return business outcomes in HTTP 200 bodies, including consent requirements; helpers do not interpret failure as success or automatically visit consent URLs.