Documentation / @blizzard-api/sc2 / ladderSummary
Function: ladderSummary()
ladderSummary(
regionId,realmId,profileId):object
Defined in: sc2/src/profile/index.ts:38
Returns the ladder summary information for the specified profile.
Parameters
regionId
The region ID for Starcraft.
realmId
1 | 2
1 or 2
profileId
number
The ID of the profile.
Returns
A resource representing the ladder summary. See LadderSummaryResponse
_responseType?
optional_responseType?:LadderSummaryResponse
Internal
The response type of the resource
namespace?
optionalnamespace?:BlizzardNamespaces
parameters?
optionalparameters?:Record<string,unknown>
path
path:
string
The request path. Dynamic path segments should be encoded with encodeURIComponent.