Documentation Powered by Redocly

swgoh-comlink (0.34.0)

Download OpenAPI specification:Download

An API for sending requests to Star Wars Galaxy of Heroes' game services

game data

Get an object containing all of the game data enums

Responses

Response samples

Content type
application/json
{ }

Get the game data

Request Body schema: application/json
required
object
enums
boolean
Default: false

Responses

Request samples

Content type
application/json
{
  • "payload": {
    },
  • "enums": false
}

Response samples

Content type
application/json
{
  • "units": [
    ],
  • "battleEnvironments": [
    ],
  • "xpTable": [
    ],
  • "material": [
    ],
  • "recipe": [
    ],
  • "statProgression": [
    ],
  • "category": [
    ],
  • "helpEntry": [
    ],
  • "challenge": [
    ],
  • "skill": [
    ],
  • "eventSampling": [
    ],
  • "equipment": [
    ],
  • "warDefinition": [
    ],
  • "targetingSet": [
    ],
  • "ability": [
    ],
  • "effect": [
    ],
  • "requirement": [
    ],
  • "powerUpBundle": [
    ],
  • "guildBanner": {
    },
  • "raidConfig": [
    ],
  • "guildRaid": [
    ],
  • "statModSet": [
    ],
  • "statMod": [
    ],
  • "guildExchangeItem": [
    ],
  • "table": [
    ],
  • "unlockAnnouncementDefinition": [
    ],
  • "battleTargetingRule": [
    ],
  • "territoryBattleDefinition": [
    ],
  • "territoryWarDefinition": [
    ],
  • "environmentCollection": [
    ],
  • "challengeStyle": [
    ],
  • "socialStatus": {
    },
  • "starterGuild": [
    ],
  • "playerTitle": [
    ],
  • "modRecommendation": [
    ],
  • "persistentVfx": [
    ],
  • "territoryTournamentDefinition": [
    ],
  • "eventBonus": [
    ],
  • "seasonDefinition": [
    ],
  • "playerPortrait": [
    ],
  • "timeZoneChangeConfig": {
    },
  • "effectIconPriority": [
    ],
  • "mysteryBox": [
    ],
  • "mysteryStatMod": [
    ],
  • "cooldown": [
    ],
  • "dailyActionCap": [
    ],
  • "energyReward": [
    ],
  • "territoryTournamentMatchmakingDescKey": "string",
  • "seasonLeagueDefinition": [
    ],
  • "seasonDivisionDefinition": [
    ],
  • "seasonRewardTable": [
    ],
  • "relicTierDefinition": [
    ],
  • "scavengerConversionSet": [
    ],
  • "unitGuideDefinition": [
    ],
  • "galacticBundle": [
    ],
  • "linkedStoreItem": [
    ],
  • "territoryTournamentLeagueDefinition": [
    ],
  • "territoryTournamentDivisionDefinition": [
    ],
  • "savedSquadConfig": [
    ],
  • "guildRaidGlobalConfig": {
    },
  • "campaign": [
    ],
  • "conquestDefinition": [
    ],
  • "conquestMission": [
    ],
  • "artifactDefinition": [
    ],
  • "abilityDecisionTree": [
    ],
  • "consumableDefinition": [
    ],
  • "consumableType": [
    ],
  • "artifactTierDefinition": [
    ],
  • "consumableTierDefinition": [
    ],
  • "recommendedSquad": [
    ],
  • "unitGuideLayout": [
    ],
  • "dailyLoginRewardDefinition": [
    ],
  • "calendarCategoryDefinition": [
    ],
  • "territoryTournamentDailyRewardTable": {
    },
  • "datacronSet": [
    ],
  • "datacronTemplate": [
    ],
  • "datacronAffixTemplateSet": [
    ],
  • "datacronHelpEntry": [
    ],
  • "displayableEnemy": [
    ]
}

Get the localization bundle

Request Body schema: application/json
unzip
boolean
required
object
enums
boolean
Default: false

Responses

Request samples

Content type
application/json
{
  • "unzip": true,
  • "payload": {
    },
  • "enums": false
}

Response samples

Content type
application/json
{ }

Get the game metadata

Request Body schema: application/json
object
enums
boolean
Default: false

Responses

Request samples

Content type
application/json
{
  • "payload": {
    },
  • "enums": false
}

Response samples

Content type
application/json
{
  • "config": [
    ],
  • "assetVersion": 0,
  • "assetSubpath": "string",
  • "texFormat": "string",
  • "serverTimestamp": 0,
  • "debugMode": true,
  • "latestLocalizationBundleVersion": "string",
  • "latestGamedataVersion": "string",
  • "resourceCacheMemoryLimit": 0,
  • "gamedataRevision": "string",
  • "monoExtraMemoryAllocationDivisor": 0,
  • "qualityData": {
    },
  • "latestLocalizationRevision": "string",
  • "serverVersion": "string",
  • "clientCache": [
    ],
  • "eadpParameters": {
    }
}

events

Get the game events

Request Body schema: application/json
payload
object
enums
boolean
Default: false

Responses

Request samples

Content type
application/json
{
  • "payload": { },
  • "enums": false
}

Response samples

Content type
application/json
{
  • "gameEvent": [
    ]
}

guild

Get information about a guild

Request Body schema: application/json
required
object
enums
boolean
Default: false

Responses

Request samples

Content type
application/json
{
  • "payload": {
    },
  • "enums": false
}

Response samples

Content type
application/json
{
  • "guild": {
    }
}

Get the guild leaderboards

Request Body schema: application/json
required
object
enums
boolean
Default: false

Responses

Request samples

Content type
application/json
{
  • "payload": {
    },
  • "enums": false
}

Response samples

Content type
application/json
{
  • "leaderboard": [
    ]
}

Search guilds

Request Body schema: application/json
required
object
enums
boolean
Default: false

Responses

Request samples

Content type
application/json
{
  • "payload": {
    },
  • "enums": false
}

Response samples

Content type
application/json
{
  • "guild": [
    ],
  • "totalRecords": 0,
  • "includeStarterGuild": true
}

gac

View GAC leaderboards. Supports both the global leaderboards, as well as the leaderboards for the GAC groupings of 8.

Request Body schema: application/json
required
object
enums
boolean
Default: false

Responses

Request samples

Content type
application/json
{
  • "payload": {
    },
  • "enums": false
}

Response samples

Content type
application/json
{
  • "player": [
    ],
  • "playerStatus": {
    }
}

player

Get a player profile

Request Body schema: application/json
required
object or object
enums
boolean
Default: false

Responses

Request samples

Content type
application/json
{
  • "payload": {
    },
  • "enums": false
}

Response samples

Content type
application/json
{
  • "name": "string",
  • "level": 0,
  • "allyCode": 0,
  • "playerId": "string",
  • "rosterUnit": [
    ],
  • "profileStat": [
    ],
  • "guildId": "string",
  • "guildName": "string",
  • "guildLogoBackground": "string",
  • "guildBannerColor": "string",
  • "guildBannerLogo": "string",
  • "pvpProfile": [
    ],
  • "selectedPlayerTitle": {
    },
  • "unlockedPlayerTitle": [
    ],
  • "guildTypeId": "string",
  • "localTimeZoneOffsetMinutes": 0,
  • "lastActivityTime": 0,
  • "selectedPlayerPortrait": {
    },
  • "unlockedPlayerPortrait": [
    ],
  • "seasonStatus": [
    ],
  • "lifetimeSeasonScore": 0,
  • "playerRating": {
    },
  • "datacron": [
    ],
  • "nucleusId": "string"
}

Get a player's arena profile

Request Body schema: application/json
required
object or object
enums
boolean
Default: false

Responses

Request samples

Content type
application/json
{
  • "payload": {
    },
  • "enums": false
}

Response samples

Content type
application/json
{
  • "name": "string",
  • "level": 0,
  • "allyCode": 0,
  • "playerId": "string",
  • "pvpProfile": [
    ],
  • "localTimeZoneOffsetMinutes": 0,
  • "lifetimeSeasonScore": 0,
  • "playerRating": {
    },
  • "nucleusId": "string"
}

arena

Get a player's arena profile

Request Body schema: application/json
required
object or object
enums
boolean
Default: false

Responses

Request samples

Content type
application/json
{
  • "payload": {
    },
  • "enums": false
}

Response samples

Content type
application/json
{
  • "name": "string",
  • "level": 0,
  • "allyCode": 0,
  • "playerId": "string",
  • "pvpProfile": [
    ],
  • "localTimeZoneOffsetMinutes": 0,
  • "lifetimeSeasonScore": 0,
  • "playerRating": {
    },
  • "nucleusId": "string"
}