Skip to Content
🚧 Documentation is currently under construction. Check back for updates! 🚧
APIEndpoints

API Endpoints

This document outlines the available API endpoints for managing window controls, team actions, and application settings. All endpoints are prefixed with http://localhost:8080/api.

The API is divided into three main categories:


Window Actions

The api/window/ endpoints manage the application’s window states and utilities.

EndpointMethodDescription
/api/window/toggleWindowGETToggles the main window between open and closed states.
/api/window/minimizeWindowGETMinimizes the main window to the taskbar.
/api/window/closeWindowGETHides the main window without exiting the app.
/api/window/openWindowGETOpens the main window if it’s hidden or closed.
/api/window/toggleOrientationGETSwitches the main window’s orientation (e.g., horizontal/vertical).
/api/window/hotkeyManagerGETOpens the hotkey manager window.
/api/window/checkForUpdatesGETChecks for available application updates.
/api/window/getAppVersionGETReturns the current application version

Example

To toggle the window:

GET http://localhost:8080/api/window/toggleWindow

Response: 200 OK on success.


Team Actions

The api/team/ endpoints manage team-related data, such as scores, names, and appearances.

EndpointMethodQuery ParametersDescription
/api/team/swapTeamsGETNoneSwaps the positions of the two teams.
/api/team/resetTeamsGETNoneResets all team data to default values.
/api/team/incrementGETteam (required)Increments the score of the specified team by 1.
/api/team/decrementGETteam (required)Decrements the score of the specified team by 1.
/api/team/setScoreGETteam (required), score (required)Sets the score for the specified team.
/api/team/setTeamNameGETteam (required), name (required)Updates the name of the specified team.
/api/team/setTeamInfoGETteam (required), info (required)Sets additional info (e.g., description) for the team.
/api/team/setTeamColorGETteam (required), color (required)Sets the team’s color using a hex code (e.g., FF5733).
/api/team/setTeamLogoGETteam (required), logo (required)Sets the team’s logo (local path or URL).
/api/team/updateMatchDataGETNoneSaves the current match data.

Parameters

  • team: Must be 1 or 2 to specify the target team.
  • score: An integer value (e.g., 10).
  • color: A hex color code without # (e.g., FF5733 for orange).
  • logo: A file path (e.g., C:/logos/team1.png) or URL (e.g., https://example.com/logo.png).

Example

To set Team 1’s score to 5:

GET http://localhost:8080/api/team/setScore?team=1&score=5

Response: 200 OK on success, 400 Bad Request if parameters are missing.


App Actions

The api/app/ endpoints handle application-level configurations.

EndpointMethodQuery ParametersDescription
/api/app/selectgameconfigGETgame (required), version (required)Selects a game configuration by its ID.
/api/app/getgameconfigsGETNoneReturns the current game configurations available (if no id is provided).

Parameters

  • game: A unique identifier for the game config (e.g., Overwatch).
  • version: The version of the game config (e.g., 1.0).

Example

To select a game config:

GET http://localhost:8080/api/app/selectgameconfig?game=Overwatch&version=1.0

Response: 200 OK on success.


Live Data

The api/ endpoints provide access to live data for the dashboard overlay.

EndpointMethodQuery ParametersDescription
/api/getfulljsonGETNoneReturns a JSON object containing all data needed to run the overlay.
/api/getValueGETvalue (required)Retrieves a specific value from the dashboard data using dot notation.
/api/bracketGETNoneReturns the current bracket data in JSON format.
/api/tournament-teamsGETNoneReturns the list of teams in the current tournament.

Parameters

  • value: A string in dot notation to specify the data to fetch (e.g., teams.team1.players.0).

Examples

To fetch the full JSON data for the overlay: GET http://localhost:8080/api/getfulljson 

Response: 200 OK with a JSON object containing all data.

{11 items
"configVersion":"1.0"
"configAuthor":"EsportsDash"
"configID":"esportsdash.valorant"
"currentGame":"Valorant"
"totalPlayers":3
"teams":{2 items
"team1":{...}9 items
"team2":{...}8 items
}
"matchFormat":""
"maps":{3 items
"totalMaps":"3"
"selectedMap":{...}6 items
"mapData":[...]7 items
}
"totalMaps":"3"
"general":{4 items
"color":{...}6 items
"file":{...}2 items
"text":{...}12 items
"list":{...}6 items
}
"appVersion":"0.7.10"
}

To get a specific value, such as the name of Team 1:

GET http://localhost:8080/api/getValue?value=teams.team1.teamName **Response**: `200 OK` with the value `"Ninjacats"`.

General Notes

  • Base URL: Most all endpoints are accessed via http://localhost:8080/api unless otherwise mentioned.
  • Success Response: Returns 200 OK unless otherwise specified.
  • Error Handling: Missing or invalid query parameters result in a 400 Bad Request.
  • Hotkeys: Retrieved via /api/window/getHotkeys as a JSON object.
  • Team Values: The team parameter must be 1 or 2.
Last updated on