Skip to content

Documentation


Documentation / @blizzard-api/hs / fetchOneCard

Function: fetchOneCard() ​

fetchOneCard(id, options?): object

Defined in: hs/src/cards/index.ts:81

Returns a single card based on the ID provided.

Parameters ​

id ​

string

The card ID

options? ​

The options for fetching a card.

gameMode? ​

GameMode

The game mode to use for fetching the card (optional).

locale? ​

Locales

The locale to use for fetching the card (optional).

Returns ​

The card resource. See FetchOneCardResponse.

_responseType? ​

optional _responseType?: FetchOneCardResponse

Internal

The response type of the resource

namespace? ​

optional namespace?: BlizzardNamespaces

parameters? ​

optional parameters?: object

parameters.gameMode? ​

optional gameMode?: GameMode

parameters.locale? ​

optional locale?: Locales

path ​

path: string

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