Class Rates

Rates - object-oriented interface

export

Hierarchy

BaseAPI
- Rates

Index

Constructors

constructor

Methods

Constructors

constructor

new Rates(configuration?: Configuration, basePath?: string, axios?: AxiosInstance): Rates

Inherited from BaseAPI.constructor
- Defined in src/openapi/base.ts:52
Parameters
- Optional configuration: Configuration
- basePath: string = BASE_PATH
- axios: AxiosInstance = globalAxios
Returns Rates

Methods

all

all(options?: any): Promise<AxiosResponse<RatesResult>>

- Defined in src/openapi/api.ts:5128
This endpoint allows you to retrieve all public rates.

summary
Retrieve all rates

throws
{RequiredError}

memberof
Rates

Parameters
- Optional options: any
Returns Promise<AxiosResponse<RatesResult>>

retrieve

retrieve(baseCurrency: string, quoteCurrency: string, options?: any): Promise<AxiosResponse<RateResult>>

- Defined in src/openapi/api.ts:5141
This endpoint allows you to retrieve a public rate by currency pair.

summary
Retrieve a pair rate

throws
{RequiredError}

memberof
Rates

Parameters
- baseCurrency: string
  
  Base currency of pair
- quoteCurrency: string
  
  Quote currency of pair
- Optional options: any
Returns Promise<AxiosResponse<RateResult>>

Generated using TypeDoc