• WalletsApi - axios parameter creator

    Parameters

    Returns {
        createWallet: ((createWalletRequest?, options?) => Promise<RequestArgs>);
        getWallet: ((walletId, options?) => Promise<RequestArgs>);
        getWalletBalance: ((walletId, assetId, options?) => Promise<RequestArgs>);
        listWalletBalances: ((walletId, options?) => Promise<RequestArgs>);
        listWallets: ((limit?, page?, options?) => Promise<RequestArgs>);
    }

    • createWallet: ((createWalletRequest?, options?) => Promise<RequestArgs>)

      Create a new wallet scoped to the user.

      Summary

      Create a new wallet

      Throws

        • (createWalletRequest?, options?): Promise<RequestArgs>
        • Parameters

          • Optional createWalletRequest: CreateWalletRequest
          • Optional options: RawAxiosRequestConfig = {}

            Override http request option.

          Returns Promise<RequestArgs>

    • getWallet: ((walletId, options?) => Promise<RequestArgs>)

      Get wallet

      Summary

      Get wallet by ID

      Throws

        • (walletId, options?): Promise<RequestArgs>
        • Parameters

          • walletId: string

            The ID of the wallet to fetch

          • Optional options: RawAxiosRequestConfig = {}

            Override http request option.

          Returns Promise<RequestArgs>

    • getWalletBalance: ((walletId, assetId, options?) => Promise<RequestArgs>)

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

      Summary

      Get the balance of an asset in the wallet

      Throws

        • (walletId, assetId, options?): Promise<RequestArgs>
        • 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<RequestArgs>

    • listWalletBalances: ((walletId, options?) => Promise<RequestArgs>)

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

      Summary

      List wallet balances

      Throws

        • (walletId, options?): Promise<RequestArgs>
        • Parameters

          • walletId: string

            The ID of the wallet to fetch the balances for

          • Optional options: RawAxiosRequestConfig = {}

            Override http request option.

          Returns Promise<RequestArgs>

    • listWallets: ((limit?, page?, options?) => Promise<RequestArgs>)

      List wallets belonging to the user.

      Summary

      List wallets

      Throws

        • (limit?, page?, options?): Promise<RequestArgs>
        • 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<RequestArgs>

    Export