Class TradeUnitApi

TradeUnitApi - object-oriented interface

Export

TradeUnitApi

Hierarchy

BaseAPI
- TradeUnitApi

Index

Constructors

Properties

axios basePath configuration

Methods

Constructors

constructor

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

tradeUnit

tradeUnit(asset, height?, options?): Promise<AxiosResponse<TradeUnitResponse, any>>
Returns the total units and depth of a trade 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<TradeUnitResponse, any>>
Throws
Memberof
TradeUnitApi
- Defined in xchainjs-lib/packages/xchain-thornode/src/generated/thornodeApi/api.ts:8254

Generated using TypeDoc