Skip to content

Documentation


Documentation / @blizzard-api/hs / cardSearch

Function: cardSearch() ​

cardSearch(options): object

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

Returns a list of cards based on the search parameters provided.

Parameters ​

options ​

CardSearchParameters

The options for fetching cards. See CardSearchParameters.

Returns ​

The card search resource. See CardSearchResponse.

_responseType? ​

optional _responseType?: CardSearchResponse

Internal

The response type of the resource

namespace? ​

optional namespace?: BlizzardNamespaces

parameters? ​

optional parameters?: BlizzardCardSearchParameters

path ​

path: string

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