Class BalancesApi

Hierarchy

BalancesApi
- BalancesApi

Index

Constructors

Properties

basePath axios configuration

Methods

getBalance listBalances

Constructors

constructor

new BalancesApi(configuration?, basePath?, axios?): BalancesApi
Parameters
- Optionalconfiguration: Configuration
- OptionalbasePath: string
- Optionalaxios: AxiosInstance
Returns BalancesApi
Inherited from imx.BalancesApi.constructor
- Defined in packages/internal/generated-clients/dist/types/imx/base.d.ts:43

Properties

`Protected`basePath

basePath: string

`Protected`axios

axios: AxiosInstance

`Protected`configuration

configuration: undefined | Configuration

Methods

getBalance

getBalance(requestParameters, options?): Promise<AxiosResponse<Balance, any>>
Fetches the token balances of the user
Parameters
- requestParameters: BalancesApiGetBalanceRequest
  Request parameters.
- Optionaloptions: AxiosRequestConfig<any>
  Override http request option.
Returns Promise<AxiosResponse<Balance, any>>
Summary
Fetches the token balances of the user

Throws
Memberof
BalancesApi
Inherited from imx.BalancesApi.getBalance
- Defined in packages/internal/generated-clients/dist/types/imx/domain/balances-api.d.ts:169

listBalances

listBalances(requestParameters, options?): Promise<AxiosResponse<ListBalancesResponse, any>>
Get a list of balances for given user
Parameters
- requestParameters: BalancesApiListBalancesRequest
  Request parameters.
- Optionaloptions: AxiosRequestConfig<any>
  Override http request option.
Returns Promise<AxiosResponse<ListBalancesResponse, any>>
Summary
Get a list of balances for given user

Throws
Memberof
BalancesApi
Inherited from imx.BalancesApi.listBalances
- Defined in packages/internal/generated-clients/dist/types/imx/domain/balances-api.d.ts:178