Class LiquidityProvidersApi

LiquidityProvidersApi - object-oriented interface

Export

LiquidityProvidersApi

Hierarchy

BaseAPI
- LiquidityProvidersApi

Index

Constructors

Properties

axios basePath configuration

Methods

liquidityProvider liquidityProviders

Constructors

constructor

new LiquidityProvidersApi(configuration?, basePath?, axios?): LiquidityProvidersApi
Parameters
- Optional configuration: Configuration
- basePath: string = BASE_PATH
- axios: AxiosInstance = globalAxios
Returns LiquidityProvidersApi
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

liquidityProvider

liquidityProvider(asset, address, height?, options?): Promise<AxiosResponse<LiquidityProvidersResponse, any>>
Returns the liquidity provider information for an address and asset.
Parameters
- asset: string
- address: string
- Optional height: number
  optional block height, defaults to current tip
- Optional options: AxiosRequestConfig<any>
  Override http request option.
Returns Promise<AxiosResponse<LiquidityProvidersResponse, any>>
Throws
Memberof
LiquidityProvidersApi
- Defined in xchainjs-lib/packages/xchain-mayanode/src/generated/mayanodeApi/api.ts:2311

liquidityProviders

liquidityProviders(asset, height?, options?): Promise<AxiosResponse<LiquidityProvider, any>>
Returns all liquidity provider information for an 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<LiquidityProvider, any>>
Throws
Memberof
LiquidityProvidersApi
- Defined in xchainjs-lib/packages/xchain-mayanode/src/generated/mayanodeApi/api.ts:2323

Generated using TypeDoc