SWGoH Comlink is a service provided as a binary executable that makes calls to read-only, (mostly) unauthenticated game APIs for the mobile game Star Wars: Galaxy of Heroes. APIs that cannot be called without authentication, such as the guild and guild search APIs, use a combination of the app name you select, the public IP of where comlink is running, and the port it's running on in order to generate anonymous guest accounts to use with the game that can be re-used across service restarts. When the service is run, a web server is exposed on the port specified by the user. Users are responsible for hosting their own copy of the comlink service to provide for the game data needs of the tools/services they develop and/or provide.
Capital Games ultimately controls what data is accessible in the APIs Comlink connects to. Those APIs currently only include the following information:
The list of endpoints provided by the service, their parameters, and the response formats are bundled directly with the service in an OpenAPI specification that can be viewed and downloaded with the included Redoc UI interface on the web server. The github wiki has additional details about the entity relationships of the response data for the game data, player data, and guild data.
Vist the Getting Started page for additional information and instructions on setup.
Comlink is only able to return the data accessible from the game APIs. It has no way to log into an account to perform actions or retrieve information about a player's account beyond what can be seen in the game when clicking on other players. This means unequipped mods, mats, and gear will not be accessible.
The data returned from the APIs is provided as-is and unmodified, with the exception of the localization bundle, which is provided either in base64 encoded string format, or unzipped into a json object based on your request parameters. Users will need to do their own formatting and modifications to the data, some examples can be found in the github wiki. This includes calculating Galactic Power and stats for units as it is not included in the raw data. SWGoH Stats can be used to help assist in all GP and stat calculations. Updates to the game that bring access to new data within the game APIs will be provided on a best effort basis, but aren't guaranteed.
Rate limits are controlled entirely by Capital Games' policies. From observation, CG limits the total request/responses per public IP per second to ~20. The /player and /playerArena endpoints may have a more generous limit of 100 /second. These limits can change at any time at Captial Games' discretion and the users of Comlink are responsible for the consequences of abuse that may be brought on by their tools/services.
SWGoH Comlink Discord ↗\ API Client Libraries\ FAQ\ Troubleshooting\ Game Data\ Player Data
SWGoH Comlink is provided as-is and a person's use of it shall not create any expressed or implied warranty or guarantee of any kind. Furthermore, the developers and contributors for SWGoH Comlink are not liable for any damages and/or actions brought upon a user by their use of this tool. It is the user's responsibility to ensure that their usage of SWGoH Comlink complies with the terms of service for the game ↗.