FAQ - swgoh-utils/swgoh-comlink GitHub Wiki

Table of Contents

Questions

Q: Can Comlink get unequipped gear and mods?

A: No. This api can only access publicly displayed information within the game so any information that is behind a login can not be obtained using it. Information that requires a login includes:

  • unequipped gear
  • unequipped mods
  • resource inventory such as relic materials, ability materials, feature store tokens
  • All running Territory Battle information including member leaderboards, combat logs, progress
  • All running Territory War information including member leaderboards, combat logs, participation
  • active raids

Q: Can Comlink do things for me in the game such as opening bronzium packs or leveling up mods?

A: No. This api only accesses information provided publicly by Capital Games. It will not connect you to any player accounts within the game.

Q: Are there or will there be premium features?

A: No. There may be a way to donate in the future, but there are no plans to monetize the service.

Q: What are the rate limits?

A: This is controlled entirely by CG's policies. From observation, CG limits the total request/responses per public IP per second to ~20, but your mileage may vary. You are responsible for the consequences of abuse, and if you're running this from the same network that you play the game, your traffic from your actual game client will also factor in to the total throughput you consume.

Q: Can I get access to the source?

A: No

Q: Will this ever support things that require logging in as a specific user?

A: No

Q: What if I need to run multiple copies of comlink on a cloud host provider that has the same IP?

A: The guild and guild search APIs currently use your app name that you specify, public IP, and the port that you're running the service on in order to generate a stable set of identities to use for logging in/authenticating as an anonymous guest player. The goal is to re-use these identities across restarts, so as long as your app name, IP, and port are not changing, you'll be reusing those accounts. However if you have multiple copies of comlink running with the same values, you'll get collisions with the accounts logging each other out. There's no advantage to running multiple comlinks on a personal server/host, but there may be unavoidable scenarios where cloud hosts have the same apparent public IP. In this case you may need to vary your PORT or app name to avoid the comlink instances interfering with each other.

Q: Why does it force me to upgrade my client?

A: The client contains a failsafe to force you to update in case 2 major game releases have happened since the version of the client that you're using was published based off of. This is to help ensure that if there are any necessary updates, you will pick them up at least every few months. There's also the possibility that CG will ask for changes to the behavior of the client, which wouldn't be possible if they continued to function indefinitely.

Q: Why does my roster not include GP or stats for each unit?

A: Stats and Galactic Power for units is calculated on the server side for the game and not stored in the game data or player data. These values must be calculated using the same or similar formulas the game servers use which looks at several different things within the game data. The best way to get stats and GP is to use SWGOH Stats, alternatively you could also just adapt Crinolo's Stat Calculator and Crinolo's Data Builder to your own projects.

Q: Why is the guild data only showing player ids?

A: You must set the property "includeRecentGuildActivityInfo" to true in the request body. See Guild Data for more details.

Q: Can the guild endpoint show me all guild event results or details?

A: No. The guild endpoint currently only shows you every detail about a guild that you can see in-game when doing a Guild Search. All event information shown is for the most recent successfully completed event within the last 60 days that had an exact or higher outcome. This means that each raid shown will be the previously completed one and will include damage down by each member. For Territory Wars this will only show the last 8 that were participated in that fall within the 60 day limit and will not include any breakdown of member performance. For Territory Battles it will only show the stars achieved. All other guild information about events is locked behind user authorization to an account that is within the guild which Comlink does not do.

Q: Can Comlink give me best mod recommendations?

A: There is no endpoint that can give you best mod recommendations, but you can build it yourself with data collected from Comlink.

You would start by grabbing the top 100 guild ids using /getGuildLeaderboard for whatever leaderboard you want to use for it. Ideas for leaderboards to use includes top guilds by Galactic Power which are typically used for general best mods, with Territory Wars being used for PVP. Alternatively GAC data can also be used for PVP, but requires storing a lot more data to analyze rather than calling a single endpoint. Once you have all the guild ids you would just follow the process of getting each player id in each guild and then running them all in /player endpoint. You can then store whatever information you would like about the mods so you can access it with your applications.