Class TradeAccountApi

TradeAccountApi - object-oriented interface

Export

TradeAccountApi

Hierarchy

BaseAPI
- TradeAccountApi

Index

Constructors

Properties

axios basePath configuration

Methods

Constructors

constructor

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

tradeAccount

tradeAccount(address, height?, options?): Promise<AxiosResponse<TradeAccountResponse, any>>
Returns the units and depth of a trade account
Parameters
- address: string
- Optional height: number
  optional block height, defaults to current tip
- Optional options: AxiosRequestConfig<any>
  Override http request option.
Returns Promise<AxiosResponse<TradeAccountResponse, any>>
Throws
Memberof
TradeAccountApi
- Defined in xchainjs-lib/packages/xchain-thornode/src/generated/thornodeApi/api.ts:8036

Generated using TypeDoc