Skip to content

Documentation


Documentation / @blizzard-api/sc2 / player

Function: player() ​

player(accountId): object

Defined in: sc2/src/account/index.ts:8

Returns the player information for the specified account ID.

Parameters ​

accountId ​

string

The account ID

Returns ​

The player resource. See Resource.

_responseType? ​

optional _responseType?: unknown[]

Internal

The response type of the resource

namespace? ​

optional namespace?: BlizzardNamespaces

parameters? ​

optional parameters?: Record<string, unknown>

path ​

path: string

The request path. Dynamic path segments should be encoded with encodeURIComponent.