Interface WalletsApiInterface

WalletsApi - interface

Export

WalletsApi

interface WalletsApiInterface {
    createWallet(createWalletRequest?, options?): AxiosPromise<Wallet>;
    getWallet(walletId, options?): AxiosPromise<Wallet>;
    getWalletBalance(walletId, assetId, options?): AxiosPromise<Balance>;
    listWalletBalances(walletId, options?): AxiosPromise<AddressBalanceList>;
    listWallets(limit?, page?, options?): AxiosPromise<WalletList>;
}

Implemented by

Methods

createWallet getWallet getWalletBalance listWalletBalances listWallets

Methods

createWallet

  • createWallet(createWalletRequest?, options?): AxiosPromise<Wallet>

  • Create a new wallet scoped to the user.

    Parameters

    • Optional createWalletRequest: CreateWalletRequest
    • Optional options: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<Wallet>

    Summary

    Create a new wallet

    Throws

    Memberof

    WalletsApiInterface

getWallet

  • getWallet(walletId, options?): AxiosPromise<Wallet>

  • Get wallet

    Parameters

    • walletId: string

      The ID of the wallet to fetch

    • Optional options: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<Wallet>

    Summary

    Get wallet by ID

    Throws

    Memberof

    WalletsApiInterface

getWalletBalance

  • getWalletBalance(walletId, assetId, options?): AxiosPromise<Balance>

  • 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 AxiosPromise<Balance>

    Summary

    Get the balance of an asset in the wallet

    Throws

    Memberof

    WalletsApiInterface

listWalletBalances

  • listWalletBalances(walletId, options?): AxiosPromise<AddressBalanceList>

  • 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 AxiosPromise<AddressBalanceList>

    Summary

    List wallet balances

    Throws

    Memberof

    WalletsApiInterface

listWallets

  • listWallets(limit?, page?, options?): AxiosPromise<WalletList>

  • 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 AxiosPromise<WalletList>

    Summary

    List wallets

    Throws

    Memberof

    WalletsApiInterface

Settings

Member Visibility

Theme

On This Page

createWalletgetWalletgetWalletBalancelistWalletBalanceslistWallets