Class BorrowersApi

BorrowersApi - object-oriented interface

Export

BorrowersApi

Hierarchy

BaseAPI
- BorrowersApi

Index

Constructors

Properties

axios basePath configuration

Methods

borrower borrowers

Constructors

constructor

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

Properties

`Protected` axios

axios: AxiosInstance = globalAxios

`Protected` basePath

basePath: string = BASE_PATH

`Protected` configuration

configuration: undefined | Configuration

Methods

borrower

borrower(asset, address, height?, options?): Promise<AxiosResponse<Borrower, any>>
Returns the borrower position given the pool and address.
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<Borrower, any>>
Throws
Memberof
BorrowersApi
- Defined in xchainjs-lib/packages/xchain-thornode/src/generated/thornodeApi/api.ts:4062

borrowers

borrowers(asset, height?, options?): Promise<AxiosResponse<BorrowersResponse, any>>
Returns all borrowers for the given pool.
Parameters
- asset: string
- Optional height: number
  optional block height, defaults to current tip
- Optional options: AxiosRequestConfig<any>
  Override http request option.
Returns Promise<AxiosResponse<BorrowersResponse, any>>
Throws
Memberof
BorrowersApi
- Defined in xchainjs-lib/packages/xchain-thornode/src/generated/thornodeApi/api.ts:4074

Generated using TypeDoc