help.swgoh.api

Interface SwgohAPI

All Known Implementing Classes:

SwgohAPIClient

public interface SwgohAPI

Interface that exposes the public methods of SwgohAPIClient. Due to the extreme versatility of this API and the available options that are given that modify the response structures, all of the responses returned by each endpoint will be raw JSON in the form of a java.lang.String for now. The consumer of this API client is then free to parse the data into whatever form they choose.

Since:

1.0.0

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	SwgohAPI.BattleField Toggleable fields for the getBattles(Boolean, Language, BattleField...) endpoints.
static class	SwgohAPI.Collection Complete list of possible data collections that can be queried from the getSupportData(Collection, Map, Boolean, Language, String...) endpoints.
static class	SwgohAPI.EventField Toggleable fields for the getEvents(Boolean, Language, EventField...) endpoints.
static class	SwgohAPI.GuildField Toggleable fields for the getGuild(int, Boolean, Language, GuildField...) endpoints.
static class	SwgohAPI.Language All game-supported languages that can be used to get localized data from the API responses.
static class	SwgohAPI.PlayerField Toggleable fields for the getPlayers(int[], Boolean, Language, PlayerField...) endpoints.
static class	SwgohAPI.SquadRecommendationField Toggleable fields for the getSquadRecommendations(SquadRecommendationField...) endpoint.
static class	SwgohAPI.UnitsField Toggleable fields for the getUnits(int[], boolean, Boolean, Language, UnitsField...) endpoints.
static class	SwgohAPI.ZetaRecommendationField Toggleable fields for the getZetaRecommendations(ZetaRecommendationField...) endpoint.

Method Summary

Modifier and Type	Method and Description
default CompletableFuture<String>	getBattles(Boolean enums, SwgohAPI.BattleField... fields)
CompletableFuture<String>	getBattles(Boolean enums, SwgohAPI.Language language, SwgohAPI.BattleField... fields) Returns the current list of all campaigns, nodes and battle data.
default CompletableFuture<String>	getBattles(SwgohAPI.BattleField... fields)
default CompletableFuture<String>	getBattles(SwgohAPI.Language language, SwgohAPI.BattleField... fields)
default CompletableFuture<String>	getEvents(Boolean enums, SwgohAPI.EventField... fields)
CompletableFuture<String>	getEvents(Boolean enums, SwgohAPI.Language language, SwgohAPI.EventField... fields) Returns the current event schedule.
default CompletableFuture<String>	getEvents(SwgohAPI.EventField... fields)
default CompletableFuture<String>	getEvents(SwgohAPI.Language language, SwgohAPI.EventField... fields)
default CompletableFuture<String>	getGuild(int allyCode, Boolean enums, SwgohAPI.GuildField... fields)
CompletableFuture<String>	getGuild(int allyCode, Boolean enums, SwgohAPI.Language language, SwgohAPI.GuildField... fields) Returns a guild object that contains only basic information for each guild member.
default CompletableFuture<String>	getGuild(int allyCode, SwgohAPI.GuildField... fields)
default CompletableFuture<String>	getGuild(int allyCode, SwgohAPI.Language language, SwgohAPI.GuildField... fields)
default CompletableFuture<String>	getGuildUnits(int allyCode, boolean includeMods, Boolean enums, SwgohAPI.GuildField... fields)
CompletableFuture<String>	getGuildUnits(int allyCode, boolean includeMods, Boolean enums, SwgohAPI.Language language, SwgohAPI.GuildField... fields) Returns a guild object that contains a units report for each guild member.
default CompletableFuture<String>	getGuildUnits(int allyCode, boolean includeMods, SwgohAPI.GuildField... fields)
default CompletableFuture<String>	getGuildUnits(int allyCode, boolean includeMods, SwgohAPI.Language language, SwgohAPI.GuildField... fields)
default CompletableFuture<String>	getLargeGuild(int allyCode, Boolean enums, SwgohAPI.GuildField... fields)
CompletableFuture<String>	getLargeGuild(int allyCode, Boolean enums, SwgohAPI.Language language, SwgohAPI.GuildField... fields) Returns a guild object that contains a full array of player profiles for each guild member.
default CompletableFuture<String>	getLargeGuild(int allyCode, SwgohAPI.GuildField... fields)
default CompletableFuture<String>	getLargeGuild(int allyCode, SwgohAPI.Language language, SwgohAPI.GuildField... fields)
default CompletableFuture<String>	getPlayer(int allyCode, Boolean enums, SwgohAPI.Language language, SwgohAPI.PlayerField... fields)
default CompletableFuture<String>	getPlayer(int allyCode, Boolean enums, SwgohAPI.PlayerField... fields)
default CompletableFuture<String>	getPlayer(int allyCode, SwgohAPI.Language language, SwgohAPI.PlayerField... fields)
default CompletableFuture<String>	getPlayer(int allyCode, SwgohAPI.PlayerField... fields)
CompletableFuture<String>	getPlayers(int[] allyCodes, Boolean enums, SwgohAPI.Language language, SwgohAPI.PlayerField... fields) Returns a list of player objects which are identified by the given ally code(s).
default CompletableFuture<String>	getPlayers(int[] allyCodes, Boolean enums, SwgohAPI.PlayerField... fields)
default CompletableFuture<String>	getPlayers(int[] allyCodes, SwgohAPI.Language language, SwgohAPI.PlayerField... fields)
default CompletableFuture<String>	getPlayers(int[] allyCodes, SwgohAPI.PlayerField... fields)
CompletableFuture<String>	getSquadRecommendations(SwgohAPI.SquadRecommendationField... fields) Returns the current list of recommended squads, organized around their various uses throughout the game.
default CompletableFuture<String>	getSupportData(SwgohAPI.Collection collection, Boolean enums, String... fields)
default CompletableFuture<String>	getSupportData(SwgohAPI.Collection collection, Boolean enums, SwgohAPI.Language language, String... fields)
default CompletableFuture<String>	getSupportData(SwgohAPI.Collection collection, Map<String,Object> matchCriteria, Boolean enums, String... fields)
CompletableFuture<String>	getSupportData(SwgohAPI.Collection collection, Map<String,Object> matchCriteria, Boolean enums, SwgohAPI.Language language, String... fields) Returns game data listings for organizing your tools and understanding relationships between data.
default CompletableFuture<String>	getSupportData(SwgohAPI.Collection collection, Map<String,Object> matchCriteria, String... fields)
default CompletableFuture<String>	getSupportData(SwgohAPI.Collection collection, Map<String,Object> matchCriteria, SwgohAPI.Language language, String... fields)
default CompletableFuture<String>	getSupportData(SwgohAPI.Collection collection, String... fields)
default CompletableFuture<String>	getSupportData(SwgohAPI.Collection collection, SwgohAPI.Language language, String... fields)
CompletableFuture<String>	getUnits(int[] allyCodes, boolean includeMods, Boolean enums, SwgohAPI.Language language, SwgohAPI.UnitsField... fields) Returns a list of unit details organized by unit instead of by player, similar to the swgoh.gg /units API.
default CompletableFuture<String>	getUnits(int[] allyCodes, boolean includeMods, Boolean enums, SwgohAPI.UnitsField... fields)
default CompletableFuture<String>	getUnits(int[] allyCodes, boolean includeMods, SwgohAPI.Language language, SwgohAPI.UnitsField... fields)
default CompletableFuture<String>	getUnits(int[] allyCodes, boolean includeMods, SwgohAPI.UnitsField... fields)
default CompletableFuture<String>	getUnits(int allyCode, boolean includeMods, Boolean enums, SwgohAPI.Language language, SwgohAPI.UnitsField... fields)
default CompletableFuture<String>	getUnits(int allyCode, boolean includeMods, Boolean enums, SwgohAPI.UnitsField... fields)
default CompletableFuture<String>	getUnits(int allyCode, boolean includeMods, SwgohAPI.Language language, SwgohAPI.UnitsField... fields)
default CompletableFuture<String>	getUnits(int allyCode, boolean includeMods, SwgohAPI.UnitsField... fields)
CompletableFuture<String>	getZetaRecommendations(SwgohAPI.ZetaRecommendationField... fields) Returns the current zeta list, rated by their various uses throughout the game.

Method Detail

getPlayers

CompletableFuture<String> getPlayers(int[] allyCodes,
                                     Boolean enums,
                                     SwgohAPI.Language language,
                                     SwgohAPI.PlayerField... fields)

Returns a list of player objects which are identified by the given ally code(s). Cache sync: Registered user: 4 hours Verified user: 2 hours Patreon user: 1 hour https://api.swgoh.help/swgoh

Parameters:

allyCodes - Ally code(s) of the players to request.

enums - Optionally return enumerated items as their string equivalents.

language - Optional language to return translated names. If no language specified, no translations will be applied.

fields - Optional projection of SwgohAPI.PlayerFields you want returned. If no fields are specified, all fields will be returned.

Returns:

player data by individual or group of ally codes.

getPlayers

default CompletableFuture<String> getPlayers(int[] allyCodes,
                                             SwgohAPI.Language language,
                                             SwgohAPI.PlayerField... fields)

getPlayers

default CompletableFuture<String> getPlayers(int[] allyCodes,
                                             Boolean enums,
                                             SwgohAPI.PlayerField... fields)

getPlayers

default CompletableFuture<String> getPlayers(int[] allyCodes,
                                             SwgohAPI.PlayerField... fields)

getPlayer

default CompletableFuture<String> getPlayer(int allyCode,
                                            Boolean enums,
                                            SwgohAPI.Language language,
                                            SwgohAPI.PlayerField... fields)

getPlayer

default CompletableFuture<String> getPlayer(int allyCode,
                                            SwgohAPI.Language language,
                                            SwgohAPI.PlayerField... fields)

getPlayer

default CompletableFuture<String> getPlayer(int allyCode,
                                            Boolean enums,
                                            SwgohAPI.PlayerField... fields)

getPlayer

default CompletableFuture<String> getPlayer(int allyCode,
                                            SwgohAPI.PlayerField... fields)

getGuild

CompletableFuture<String> getGuild(int allyCode,
                                   Boolean enums,
                                   SwgohAPI.Language language,
                                   SwgohAPI.GuildField... fields)

Returns a guild object that contains only basic information for each guild member. For a full array of player profiles in the response, see getLargeGuild(int, Boolean, Language, GuildField...) For a guild-wide units report instead of an array of player profiles, see getGuildUnits(int, boolean, Boolean, Language, GuildField...) Cache sync: Registered user: 6 hours Verified user: 4 hours Patreon user: 3 hours https://api.swgoh.help/swgoh

Parameters:

allyCode - Ally code of any guild member in guild to request.

enums - Optionally return enumerated items as their string equivalents.

language - Optional language to return translated names. If no language specified, no translations will be applied.

fields - Optional projection of SwgohAPI.GuildFields you want returned. If no fields are specified, all fields will be returned.

Returns:

guild data by individual ally code of guild member.

getGuild

default CompletableFuture<String> getGuild(int allyCode,
                                           SwgohAPI.Language language,
                                           SwgohAPI.GuildField... fields)

getGuild

default CompletableFuture<String> getGuild(int allyCode,
                                           Boolean enums,
                                           SwgohAPI.GuildField... fields)

getGuild

default CompletableFuture<String> getGuild(int allyCode,
                                           SwgohAPI.GuildField... fields)

getLargeGuild

CompletableFuture<String> getLargeGuild(int allyCode,
                                        Boolean enums,
                                        SwgohAPI.Language language,
                                        SwgohAPI.GuildField... fields)

Returns a guild object that contains a full array of player profiles for each guild member. Note: Large reply object. For a basic view of the player roster, see getGuild(int, Boolean, Language, GuildField...) For a guild-wide units report instead of an array of player profiles, see getGuildUnits(int, boolean, Boolean, Language, GuildField...) Cache sync: Registered user: 6 hours Verified user: 4 hours Patreon user: 3 hours https://api.swgoh.help/swgoh

Parameters:

allyCode - Ally code of any guild member in guild to request.

enums - Optionally return enumerated items as their string equivalents.

language - Optional language to return translated names. If no language specified, no translations will be applied.

fields - Optional projection of SwgohAPI.GuildFields you want returned. If no fields are specified, all fields will be returned.

Returns:

guild data by individual ally code of guild member.

getLargeGuild

default CompletableFuture<String> getLargeGuild(int allyCode,
                                                SwgohAPI.Language language,
                                                SwgohAPI.GuildField... fields)

getLargeGuild

default CompletableFuture<String> getLargeGuild(int allyCode,
                                                Boolean enums,
                                                SwgohAPI.GuildField... fields)

getLargeGuild

default CompletableFuture<String> getLargeGuild(int allyCode,
                                                SwgohAPI.GuildField... fields)

getGuildUnits

CompletableFuture<String> getGuildUnits(int allyCode,
                                        boolean includeMods,
                                        Boolean enums,
                                        SwgohAPI.Language language,
                                        SwgohAPI.GuildField... fields)

Returns a guild object that contains a units report for each guild member. Note: Large reply object. For a basic view of the player roster, see getGuild(int, Boolean, Language, GuildField...) For a full array of player profiles in the response, see getLargeGuild(int, Boolean, Language, GuildField...) Cache sync: Registered user: 6 hours Verified user: 4 hours Patreon user: 3 hours https://api.swgoh.help/swgoh

Parameters:

allyCode - Ally code of any guild member in guild to request.

includeMods - Optionally include unit mods in units report. Note: Large reply object

enums - Optionally return enumerated items as their string equivalents.

language - Optional language to return translated names. If no language specified, no translations will be applied.

fields - Optional projection of SwgohAPI.GuildFields you want returned. If no fields are specified, all fields will be returned.

Returns:

guild data by individual ally code of guild member.

getGuildUnits

default CompletableFuture<String> getGuildUnits(int allyCode,
                                                boolean includeMods,
                                                SwgohAPI.Language language,
                                                SwgohAPI.GuildField... fields)

getGuildUnits

default CompletableFuture<String> getGuildUnits(int allyCode,
                                                boolean includeMods,
                                                Boolean enums,
                                                SwgohAPI.GuildField... fields)

getGuildUnits

default CompletableFuture<String> getGuildUnits(int allyCode,
                                                boolean includeMods,
                                                SwgohAPI.GuildField... fields)

getUnits

CompletableFuture<String> getUnits(int[] allyCodes,
                                   boolean includeMods,
                                   Boolean enums,
                                   SwgohAPI.Language language,
                                   SwgohAPI.UnitsField... fields)

Returns a list of unit details organized by unit instead of by player, similar to the swgoh.gg /units API. Cache sync: Registered user: 4 hours Verified user: 2 hours Patreon user: 1 hour https://api.swgoh.help/swgoh

Parameters:

allyCodes - Ally code(s) of the players to request.

includeMods - Optionally include unit-mods in report. Note: Large reply object

enums - Optionally return enumerated items as their string equivalents.

language - (in conjunction with mods) Optionally converts mod stat values to text.

fields - Optional projection of SwgohAPI.UnitsFields you want returned. If no fields are specified, all fields will be returned.

Returns:

player profiles organized by units for individual or group of ally codes.

getUnits

default CompletableFuture<String> getUnits(int[] allyCodes,
                                           boolean includeMods,
                                           SwgohAPI.Language language,
                                           SwgohAPI.UnitsField... fields)

getUnits

default CompletableFuture<String> getUnits(int[] allyCodes,
                                           boolean includeMods,
                                           Boolean enums,
                                           SwgohAPI.UnitsField... fields)

getUnits

default CompletableFuture<String> getUnits(int[] allyCodes,
                                           boolean includeMods,
                                           SwgohAPI.UnitsField... fields)

getUnits

default CompletableFuture<String> getUnits(int allyCode,
                                           boolean includeMods,
                                           Boolean enums,
                                           SwgohAPI.Language language,
                                           SwgohAPI.UnitsField... fields)

getUnits

default CompletableFuture<String> getUnits(int allyCode,
                                           boolean includeMods,
                                           SwgohAPI.Language language,
                                           SwgohAPI.UnitsField... fields)

getUnits

default CompletableFuture<String> getUnits(int allyCode,
                                           boolean includeMods,
                                           Boolean enums,
                                           SwgohAPI.UnitsField... fields)

getUnits

default CompletableFuture<String> getUnits(int allyCode,
                                           boolean includeMods,
                                           SwgohAPI.UnitsField... fields)

getZetaRecommendations

CompletableFuture<String> getZetaRecommendations(SwgohAPI.ZetaRecommendationField... fields)

Returns the 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 in the care of a third party and does not have available translations. Cache sync: 7 days https://api.swgoh.help/swgoh

Parameters:

fields - Optional projection of SwgohAPI.ZetaRecommendationFields you want returned. If no fields are specified, all fields will be returned.

Returns:

current zeta list, rated by their various uses throughout the game.

getSquadRecommendations

CompletableFuture<String> getSquadRecommendations(SwgohAPI.SquadRecommendationField... fields)

Returns the current list of recommended squads, organized around their various uses throughout the game. This dataset is provided by swgoh.help home-site and additions or changes can be requested in their Discord server. https://discord.gg/kau4XTB Note: This dataset is in the care of a third party and does not have available translations. Cache sync: 7 days https://api.swgoh.help/swgoh

Parameters:

fields - Optional projection of SwgohAPI.SquadRecommendationFields you want returned. If no fields are specified, all fields will be returned.

Returns:

current list of recommended squads, organized around their various uses throughout the game.

getEvents

CompletableFuture<String> getEvents(Boolean enums,
                                    SwgohAPI.Language language,
                                    SwgohAPI.EventField... fields)

Returns the current event schedule. Cache sync: 4 hours https://api.swgoh.help/swgoh

Parameters:

enums - Optionally return enumerated items as their string equivalents.

language - Optional language to return translated names. If no language specified, no translations will be applied.

fields - Optional projection of SwgohAPI.EventFields you want returned. If no fields are specified, all fields will be returned.

Returns:

current event schedule.

getEvents

default CompletableFuture<String> getEvents(SwgohAPI.Language language,
                                            SwgohAPI.EventField... fields)

getEvents

default CompletableFuture<String> getEvents(Boolean enums,
                                            SwgohAPI.EventField... fields)

getEvents

default CompletableFuture<String> getEvents(SwgohAPI.EventField... fields)

getBattles

CompletableFuture<String> getBattles(Boolean enums,
                                     SwgohAPI.Language language,
                                     SwgohAPI.BattleField... fields)

Returns the current list of all campaigns, nodes and battle data. Cache sync: 4 hours https://api.swgoh.help/swgoh

Parameters:

enums - Optionally return enumerated items as their string equivalents.

language - Optional language to return translated names. If no language specified, no translations will be applied.

fields - Optional projection of SwgohAPI.BattleFields you want returned. If no fields are specified, all fields will be returned.

Returns:

current list of all campaigns, nodes and battle data.

getBattles

default CompletableFuture<String> getBattles(SwgohAPI.Language language,
                                             SwgohAPI.BattleField... fields)

getBattles

default CompletableFuture<String> getBattles(Boolean enums,
                                             SwgohAPI.BattleField... fields)

getBattles

default CompletableFuture<String> getBattles(SwgohAPI.BattleField... fields)

getSupportData

CompletableFuture<String> getSupportData(SwgohAPI.Collection collection,
                                         Map<String,Object> matchCriteria,
                                         Boolean enums,
                                         SwgohAPI.Language language,
                                         String... fields)

Returns game data listings for organizing your tools and understanding relationships between data. The match criteria should be the $match's body, according to mongodb specifications. https://docs.mongodb.com/manual/reference/operator/aggregation/match/ Cache sync: on game updates https://api.swgoh.help/swgoh

Parameters:

collection - Name of the collection to access.

matchCriteria - Optionally include match criteria to filter down response.

enums - Optionally return enumerated items as their string equivalents.

language - Optional language to return translated names. If no language specified, no translations will be applied.

fields - Optional projection of fields you want returned. If no fields are specified, all fields will be returned.

Returns:

game data listings for organizing your tools and understanding relationships between data.

getSupportData

default CompletableFuture<String> getSupportData(SwgohAPI.Collection collection,
                                                 Boolean enums,
                                                 SwgohAPI.Language language,
                                                 String... fields)

getSupportData

default CompletableFuture<String> getSupportData(SwgohAPI.Collection collection,
                                                 Map<String,Object> matchCriteria,
                                                 SwgohAPI.Language language,
                                                 String... fields)

getSupportData

default CompletableFuture<String> getSupportData(SwgohAPI.Collection collection,
                                                 Map<String,Object> matchCriteria,
                                                 Boolean enums,
                                                 String... fields)

getSupportData

default CompletableFuture<String> getSupportData(SwgohAPI.Collection collection,
                                                 SwgohAPI.Language language,
                                                 String... fields)

getSupportData

default CompletableFuture<String> getSupportData(SwgohAPI.Collection collection,
                                                 Boolean enums,
                                                 String... fields)

getSupportData

default CompletableFuture<String> getSupportData(SwgohAPI.Collection collection,
                                                 Map<String,Object> matchCriteria,
                                                 String... fields)

getSupportData

default CompletableFuture<String> getSupportData(SwgohAPI.Collection collection,
                                                 String... fields)