Type alias AddressAPIClient

AddressAPIClient: {
    createAddress(walletId, createAddressRequest?, options?): AxiosPromise<Address>;
    createPayloadSignature(walletId, addressId, createPayloadSignatureRequest?, options?): AxiosPromise<PayloadSignature>;
    getAddress(walletId, addressId, options?): AxiosPromise<Address>;
    getAddressBalance(walletId, addressId, assetId, options?): AxiosPromise<Balance>;
    getPayloadSignature(walletId, addressId, payloadSignatureId, options?): AxiosPromise<PayloadSignature>;
    listAddressBalances(walletId, addressId, page?, options?): AxiosPromise<AddressBalanceList>;
    listAddresses(walletId, limit?, page?, options?): AxiosPromise<AddressList>;
    listPayloadSignatures(walletId, addressId, limit?, page?, options?): AxiosPromise<PayloadSignatureList>;
}

AddressAPI client type definition.

Type declaration

  • createAddress:function
    • createAddress(walletId, createAddressRequest?, options?): AxiosPromise<Address>

    • Create a new address scoped to the wallet.

      Parameters

      • walletId: string

        The ID of the wallet to create the address in.

      • Optional createAddressRequest: CreateAddressRequest

        The address creation request.

      • Optional options: AxiosRequestConfig<any>

        Axios request options.

      Returns AxiosPromise<Address>

      Throws

      If the request fails.

  • createPayloadSignature:function
    • createPayloadSignature(walletId, addressId, createPayloadSignatureRequest?, options?): AxiosPromise<PayloadSignature>

    • Create a new payload signature with an address.

      Parameters

      • walletId: string

        The ID of the wallet the address belongs to.

      • addressId: string

        The onchain address of the address to sign the payload with.

      • Optional createPayloadSignatureRequest: CreatePayloadSignatureRequest

        The payload signature creation request.

      • Optional options: AxiosRequestConfig<any>

        Axios request options.

      Returns AxiosPromise<PayloadSignature>

      Throws

      If the request fails.

  • getAddress:function
    • getAddress(walletId, addressId, options?): AxiosPromise<Address>

    • Get address by onchain address.

      Parameters

      • walletId: string

        The ID of the wallet the address belongs to.

      • addressId: string

        The onchain address of the address that is being fetched.

      • Optional options: AxiosRequestConfig<any>

        Axios request options.

      Returns AxiosPromise<Address>

      Throws

      If the request fails.

  • getAddressBalance:function
    • getAddressBalance(walletId, addressId, assetId, options?): AxiosPromise<Balance>

    • Get address balance

      Parameters

      • walletId: string

        The ID of the wallet to fetch the balance for.

      • addressId: string

        The onchain address of the address that is being fetched.

      • assetId: string

        The symbol of the asset to fetch the balance for.

      • Optional options: AxiosRequestConfig<any>

        Axios request options.

      Returns AxiosPromise<Balance>

      Throws

  • getPayloadSignature:function
    • getPayloadSignature(walletId, addressId, payloadSignatureId, options?): AxiosPromise<PayloadSignature>

    • Get payload signature by the specified payload signature ID.

      Parameters

      • walletId: string

        The ID of the wallet the address belongs to.

      • addressId: string

        The onchain address of the address to sign the payload with.

      • payloadSignatureId: string

        The ID of the payload signature to fetch.

      • Optional options: AxiosRequestConfig<any>

        Axios request options.

      Returns AxiosPromise<PayloadSignature>

      Throws

      If the request fails.

  • listAddressBalances:function
    • listAddressBalances(walletId, addressId, page?, options?): AxiosPromise<AddressBalanceList>

    • Lists address balances

      Parameters

      • walletId: string

        The ID of the wallet to fetch the balances for.

      • addressId: string

        The onchain address of the address that is being fetched.

      • Optional page: string

        A cursor for pagination across multiple pages of results. Do not include this parameter on the first call. Use the next_page value returned in a previous response to request subsequent results.

      • Optional options: AxiosRequestConfig<any>

        Override http request option.

      Returns AxiosPromise<AddressBalanceList>

      Throws

  • listAddresses:function
    • listAddresses(walletId, limit?, page?, options?): AxiosPromise<AddressList>

    • Lists addresses.

      Parameters

      • walletId: string

        The ID of the wallet the addresses belong to.

      • Optional limit: number

        The maximum number of addresses to return.

      • Optional page: string

        A cursor for pagination across multiple pages of results. Do not include this parameter on the first call. Use the next_page value returned in a previous response to request subsequent results.

      • Optional options: AxiosRequestConfig<any>

        Override http request option.

      Returns AxiosPromise<AddressList>

      Throws

      If the request fails.

  • listPayloadSignatures:function
    • listPayloadSignatures(walletId, addressId, limit?, page?, options?): AxiosPromise<PayloadSignatureList>

    • List payload signatures for the specified address.

      Parameters

      • walletId: string

        The ID of the wallet the address belongs to.

      • addressId: string

        The onchain address of the address to sign the payload with.

      • 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't include this parameter on the first call. Use the next_page value returned in a previous response to request subsequent results.

      • Optional options: AxiosRequestConfig<any>

        Axios request options.

      Returns AxiosPromise<PayloadSignatureList>

      Throws

      If the request fails.

Settings

Member Visibility

Theme