Class WalletsApi

WalletsApi - object-oriented interface

Export

WalletsApi

Hierarchy (view full)

Implements

Constructors

constructor

Properties

axios basePath configuration

Methods

createWallet getWallet getWalletBalance listWalletBalances listWallets

Constructors

constructor

Properties

Protected axios

axios: AxiosInstance = globalAxios

Protected basePath

basePath: string = BASE_PATH

Protected configuration

configuration: undefined | Configuration

Methods

createWallet

  • createWallet(createWalletRequest?, options?): Promise<AxiosResponse<Wallet, any>>

  • Create a new wallet scoped to the user.

    Parameters

    • Optional createWalletRequest: CreateWalletRequest
    • Optional options: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<AxiosResponse<Wallet, any>>

    Summary

    Create a new wallet

    Throws

    Memberof

    WalletsApi

getWallet

  • getWallet(walletId, options?): Promise<AxiosResponse<Wallet, any>>

  • Get wallet

    Parameters

    • walletId: string

      The ID of the wallet to fetch

    • Optional options: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<AxiosResponse<Wallet, any>>

    Summary

    Get wallet by ID

    Throws

    Memberof

    WalletsApi

getWalletBalance

  • getWalletBalance(walletId, assetId, options?): Promise<AxiosResponse<Balance, any>>

  • Get the aggregated balance of an asset across all of the addresses in the wallet.

    Parameters

    • walletId: string

      The ID of the wallet to fetch the balance for

    • assetId: string

      The symbol of the asset to fetch the balance for

    • Optional options: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<AxiosResponse<Balance, any>>

    Summary

    Get the balance of an asset in the wallet

    Throws

    Memberof

    WalletsApi

listWalletBalances

  • listWalletBalances(walletId, options?): Promise<AxiosResponse<AddressBalanceList, any>>

  • List the balances of all of the addresses in the wallet aggregated by asset.

    Parameters

    • walletId: string

      The ID of the wallet to fetch the balances for

    • Optional options: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<AxiosResponse<AddressBalanceList, any>>

    Summary

    List wallet balances

    Throws

    Memberof

    WalletsApi

listWallets

  • listWallets(limit?, page?, options?): Promise<AxiosResponse<WalletList, any>>

  • List wallets belonging to the user.

    Parameters

    • Optional limit: number

      A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.

    • Optional page: string

      A cursor for pagination across multiple pages of results. Don&#39;t include this parameter on the first call. Use the next_page value returned in a previous response to request subsequent results.

    • Optional options: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<AxiosResponse<WalletList, any>>

    Summary

    List wallets

    Throws

    Memberof

    WalletsApi

Settings

Member Visibility

Theme

On This Page

constructoraxiosbasePathconfigurationcreateWalletgetWalletgetWalletBalancelistWalletBalanceslistWallets