List Deposit Addresses

Through this endpoint customers can pull a list of Deposit/Receiving Addresses they have already generated.

Please note that listing data from the same type will apply pagination on the results.

List of Results - This endpoint returns multiple objects which means pagination is applicable. GET /wallet-as-a-service/wallets/{walletId}/{blockchain}/{network}/addresses

Path Parameters

  • Required
    blockchain string

    Represents the specific blockchain protocol name, e.g. Ethereum, Bitcoin, etc.

    Example : bitcoin
    Possible Values : bitcoin bitcoin-cash litecoin dogecoin dash ethereum ethereum-classic xrp zcash binance-smart-chain
  • Required
    network string

    Represents the name of the blockchain network used; blockchain networks are usually identical as technology and software, but they differ in data, e.g. - "mainnet" is the live network with actual data while networks like "testnet", "ropsten" are test networks.

    Example : testnet
    Possible Values : mainnet testnet ropsten mordor
  • Required
    walletId string

    Represents the unique ID of the specific Wallet.

    Example : 60c9d9921c38030006675ff6

Query parameters

  • Optional
    context string

    In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. context is specified by the user.

    Example : yourExampleString

Response schema

200 400 401 402 403 404 409 415 422 429 500
HTTP Status Code: 200
Content-Type: application/json

The request has been successful.

  • Object :

  • Required
    apiVersion string

    Specifies the version of the API that incorporates this endpoint.

    Example : 2.0.0
  • Required
    requestId string

    Defines the ID of the request. The requestId is generated by Crypto APIs and it's unique for every request.

    Example : 601c1710034ed6d407996b30
  • Optional
    context string

    In batch situations the user can use the context to correlate responses with requests. This property is present regardless of whether the response was successful or returned as an error. context is specified by the user.

    Example : yourExampleString
  • Required
    data object
    • Required
      limit integer

      Defines how many items should be returned in the response per page basis.

      Example : 50
    • Required
      offset integer

      The starting index of the response items, i.e. where the response should start listing the returned items.

      Example : 0
    • Required
      total integer

      Defines the total number of items returned in the response.

      Example : 100
    • Required
      items array
      Example : Array ( )
      • Required
        address string

        Specifies the specific address's unique string value.

        Example : 0xe2b5f5e885a268e4b6faae53f99a663f3bb3e036
      • Required
        confirmedBalance object
        • Required
          amount string

          Defines the total balance of the address that is confirmed. It doesn't include unconfirmed transactions.

          Example : 0.0101
        • Required
          unit string

          Represents the unit of the confirmed balance.

          Example : BTC
      • Required
        createdTimestamp integer

        Defines the specific UNIX time when the deposit address was created.

        Example : 346658753
      • Required
        fungibleTokens array

        Represents fungible tokens'es detailed information

        • Required
          amount string

          Defines the amount of the fungible tokens.

          Example : 0.254
        • Required
          identifier string

          Defines the specific token identifier. For Bitcoin-based transactions it should be the propertyId and for Ethereum-based transactions - the contract.

          Example : 0xdac17f958d2ee523a2206206994597c13d831ec7
        • Required
          name string

          Defines the token's name as a string.

          Example : Tether USD
        • Required
          symbol string

          Defines the symbol of the fungible tokens.

          Example : USDT
        • Required
          tokenDecimals integer

          Defines the decimals of the token, i.e. the number of digits that come after the decimal coma of the token.

          Example : 6
        • Required
          type string

          Defines the specific token type.

          Example : ERC-20
      • Required
        index string

        Represents the index of the address in the wallet.

        Example : 1
      • Required
        label string

        Represents a custom tag that customers can set up for their Wallets and addresses. E.g. custom label named "Special addresses".

        Example : yourStringHere
      • Required
        nonFungibleTokens array

        Represents non-fungible tokens'es detailed information.

        • Required
          identifier string

          Defines the specific token identifier. For Bitcoin-based transactions it should be the propertyId and for Ethereum-based transactions - the contract.

          Example : 0x90ca8a3eb2574f937f514749ce619fdcca187d45
        • Required
          name string

          Defines the token's name as a string.

          Example : Tether
        • Required
          symbol string

          Defines the symbol of the non-fungible tokens.

          Example : ENS
        • Required
          tokenId string

          Represents tokens' unique identifier.

          Example : 0x000000000000000000000000000000000000000000000000000000000000195b
        • Required
          type string

          Defines the specific token type.

          Example : ERC-721

Credits Cost : 1 Credits For 1 Result(s)

Try it out

Request Example

GET
https://rest.cryptoapis.io/v2/wallet-as-a-service/wallets/60c9d9921c38030006675ff6/bitcoin/testnet/addresses?context=yourExampleString
Headers
Host: https://rest.cryptoapis.io/v2
Content-Type: application/json
X-API-Key: my-api-key

Response Example

{
    "apiVersion": "2.0.0",
    "requestId": "601c1710034ed6d407996b30",
    "context": "yourExampleString",
    "data": {
        "limit": 50,
        "offset": 0,
        "total": 100,
        "items": [
            {
                "address": "0xe2b5f5e885a268e4b6faae53f99a663f3bb3e036",
                "confirmedBalance": {
                    "amount": "0.0101",
                    "unit": "BTC"
                },
                "createdTimestamp": 346658753,
                "fungibleTokens": [
                    {
                        "amount": "0.254",
                        "identifier": "0xdac17f958d2ee523a2206206994597c13d831ec7",
                        "name": "Tether USD",
                        "symbol": "USDT",
                        "tokenDecimals": 6,
                        "type": "ERC-20"
                    }
                ],
                "index": "1",
                "label": "yourStringHere",
                "nonFungibleTokens": [
                    {
                        "identifier": "0x90ca8a3eb2574f937f514749ce619fdcca187d45",
                        "name": "Tether",
                        "symbol": "ENS",
                        "tokenId": "0x000000000000000000000000000000000000000000000000000000000000195b",
                        "type": "ERC-721"
                    }
                ]
            }
        ]
    }
}