Docs


Login

Auth /auth/signin

Request Header

{
  "method": "post",
  "content-type": "application/x-www-form-urlencoded"
}

Response

{
  "token_type": "bearer",
  "access_token": "ad6e16c9698802859ec3b5296504e553e36ad728",
  "expires_in": 3600
}

Save token for further data requests
YOUR_ACCESS_TOKEN = response.access_token

Token

Your access token should be retained and passed in your request headers for each api call.

Request Headers

{
  "method": "post",
  "content-type": "application/json",
  "authorization": "\"Bearer\" + YOUR_ACCESS_TOKEN"
}

Routes

Players /swgoh/players

Return array of player profiles.

Parameters

Guilds /swgoh/guilds

Return array of guild profiles, including member details for futher lookups.

Parameters

Rosters /swgoh/roster

Array of player roster's organized by unit defId
Note: This dataset does not return any localizations.

Parameters

Units /swgoh/units

Player roster's report with player-array reduced into a single object
Note: This dataset does not return any localizations.

Parameters

Zeta recommendations /swgoh/zetas

Return current zeta list, rated by their various uses throughout the game.
This dataset is an aggregated summary of rankings collected through a grouping of krakens, whales, dolphins and free-to-players.
Note: This dataset is care of a third party and does not have available translation.

Parameters

Squad recommendations /swgoh/squads

Return current list of recommended squads, organized around their various uses throughout the game.
Note: This dataset is care of a third party and does not have available translation.

Parameters

Event schedule /swgoh/events

Return the current in-game event schedule.

Parameters

Campaign battles /swgoh/battles

Return current list of all campaigns, nodes and battle data.

Parameters

Supporting game data /swgoh/data

Return game data listings for organizing your tools, building translation mappings, and understanding relationships between data.

Parameters

Params

allycodes

  • Optional: false
  • Default: Required field

For best results, ensure your allycodes param is an array of integers


language

Responses available in 14 language options. If no language specified, no localization will be applied.
Note: Language parameter is not case sensitive


enums

  • Optional: true
  • Default: false

Convert any available enum integers into their string equivalents.
Note: String equivalent is not an localization string


structure

  • Optional: true
  • Default: false

Return the structure of your query after other parameters are applied.
Note: Enum fields change data types depending on specified enum param.


project

  • Optional: true
  • Default: Entire field list

Specify specific fields that you want returned in results. If no project is specified, all fields will be returned.
Note: The project field is directly piped to the aggregation's $project parameter. For more information on projection, see
https://docs.mongodb.com/manual/reference/operator/aggregation/project/


collection

  • Optional: false
  • Default: Required field

Data collection to search.
Note: Collection names are case sensitive


match

  • Optional: false
  • Default: Required field

Specify match criteria to filter results.
Note: The match field is directly piped to the aggregation's $match parameter. For more information on matching, see
https://docs.mongodb.com/manual/reference/operator/aggregation/project/


Collections

v5.0.15