Class PoolsApi

PoolsApi - object-oriented interface

Export

PoolsApi

Hierarchy

BaseAPI
- PoolsApi

Index

Constructors

Properties

axios basePath configuration

Methods

Constructors

constructor

new PoolsApi(configuration?, basePath?, axios?): PoolsApi
Parameters
- Optional configuration: Configuration
- basePath: string = BASE_PATH
- axios: AxiosInstance = globalAxios
Returns PoolsApi
Inherited from BaseAPI.constructor
- Defined in xchainjs-lib/packages/xchain-mayanode/src/generated/mayanodeApi/base.ts:52

Properties

`Protected` axios

axios: AxiosInstance = globalAxios

`Protected` basePath

basePath: string = BASE_PATH

`Protected` configuration

configuration: undefined | Configuration

Methods

pool

pool(asset, height?, options?): Promise<AxiosResponse<Pool, any>>
Returns the pool information for the provided asset.
Parameters
- asset: string
- Optional height: number
  optional block height, defaults to current tip
- Optional options: AxiosRequestConfig<any>
  Override http request option.
Returns Promise<AxiosResponse<Pool, any>>
Throws
Memberof
PoolsApi
- Defined in xchainjs-lib/packages/xchain-mayanode/src/generated/mayanodeApi/api.ts:3805

pools

pools(height?, options?): Promise<AxiosResponse<PoolsResponse, any>>
Returns the pool information for all assets.
Parameters
- Optional height: number
  optional block height, defaults to current tip
- Optional options: AxiosRequestConfig<any>
  Override http request option.
Returns Promise<AxiosResponse<PoolsResponse, any>>
Throws
Memberof
PoolsApi
- Defined in xchainjs-lib/packages/xchain-mayanode/src/generated/mayanodeApi/api.ts:3816

Generated using TypeDoc