Jump to
Ctrl
+
/

List Deposit Addresses

GET
/wallet-as-a-service/wallets/{walletId}/{blockchain}/{network}/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.

Path Parameters

blockchain string Required

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

network string Required

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", "sepolia" are test networks.

walletId string Required

Represents the unique ID of the specific Wallet.

Query Parameters

context string Optional

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.

limit integer Optional

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

Default : 50
offset integer Optional

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

Default : 0

Response Schema

apiVersion string Required

Specifies the version of the API that incorporates this endpoint.

2021-03-20
requestId string Required

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

601c1710034ed6d407996b30
context string Optional

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.

yourExampleString
data object Required
limit integer Required

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

50
offset integer Required

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

0
total integer Required

Defines the total number of items returned in the response.

100
items array Items (object) Required
address string Required

Specifies the specific address's unique string value.

0xe2b5f5e885a268e4b6faae53f99a663f3bb3e036
confirmedBalance object Required
amount string Required

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

0.0101
unit string Required

Represents the unit of the confirmed balance.

BTC
createdTimestamp integer Required

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

346658753
fungibleTokens array Items (object) Required

Represents fungible tokens'es detailed information

amount string Required

Defines the amount of the fungible tokens.

0.254
identifier string Required

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

0xdac17f958d2ee523a2206206994597c13d831ec7
name string Required

Defines the token's name as a string.

Tether USD
symbol string Required

Defines the symbol of the fungible tokens.

USDT
tokenDecimals integer Required

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

6
type string Required

Defines the specific token type.

ERC-20
index string Required

Represents the index of the address in the wallet.

1
label string Required

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

yourStringHere
nonFungibleTokens array Items (object) Required

Represents non-fungible tokens'es detailed information.

identifier string Required

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

0x90ca8a3eb2574f937f514749ce619fdcca187d45
name string Required

Defines the token's name as a string.

Tether
symbol string Required

Defines the symbol of the non-fungible tokens.

ENS
tokenId string Required

Represents tokens' unique identifier.

0x000000000000000000000000000000000000000000000000000000000000195b
type string Required

Defines the specific token type.

ERC-721

Credits Cost : 100 Credits for 1 Results

Was this page helpful?
Yes
No
Language
URL

{
    "apiVersion": "2021-03-20",
    "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"
                    }
                ]
            }
        ]
    }
}