Class CoinGeckoRecipe

Recipe providing configuration and query mapping for the CoinGecko REST API.

Implements

RestApiRecipe

Index

Constructors

Properties

defaultBaseUrl name querySerializer

Methods

Constructors

constructor

new CoinGeckoRecipe(): CoinGeckoRecipe
Returns CoinGeckoRecipe

Properties

defaultBaseUrl

defaultBaseUrl: string = 'https://api.coingecko.com/api/v3'

The default endpoint URL.

name

name: string = 'CoinGecko'

The human-readable name of the recipe.

querySerializer

querySerializer: QuerySerializer = ...

Custom query serializer transforming Quatrain filters and pagination into CoinGecko parameters.

Param: filters

Active filters.

Param: pagination

Pagination details.

Returns

The parameter record.

Methods

getOptions

getOptions(
apiKey?: string,
overrides?: Partial<RestAdapterOptions>,
): RestAdapterOptions
Returns the composed REST adapter options.
Parameters
- OptionalapiKey: string
  Optional API key.
- Optionaloverrides: Partial<RestAdapterOptions>
  Additional adapter options.
Returns RestAdapterOptions
The generated adapter options.
Implementation of RestApiRecipe.getOptions
- Defined in CoinGeckoRecipe.ts:53