Address

The address endpoints allow you to create addresses and retrieve address information from your wallets.

Create Address

POST https://api.walletcloud.app/wallet/:walletId/address

Create an address for a wallet

Path Parameters

Name	Type	Description
walletId*	string	ID of the wallet to create an address for.

Headers

Name	Type	Description
x-api-key*	string	Api key of the wallet to create an address for.

Request Body

Name	Type	Description
addressLabel	string	This is the label of the address you want create. It could be a description of what the address purpose or a userId.

200 Address created successfully

{
    "status": true,
    "message": "Address created successfully!",
    "data": {
        "addressId": "b8642455-0c47-4cfd-8efb-950fa1bad3db",
        "address": "0x5b29a678e41b72b2e74e1ff9553e6b3fd03c7984",
        "walletId": "7c1a6e27-854e-4587-9dd6-df6b6846fc88",
        "coin": "eth",
        "blockchain": "Ethereum",
        "network": "testnet",
        "label": "some label"
    }
}

400 Sample error response for a non-existent wallet

{
    "status": false,
    "message": "Your wallet does not exist!",
    "data": {}
}

Get Address

GET https://api.walletcloud.app/wallet/:walletId/:addressOrId

Get the details of an address with the address or the addressId

Path Parameters

Name	Type	Description
walletId*	string	ID of the wallet to fetch details from.
addressOrId*	string	Address or ID of the address to be fetched..

Headers

Name	Type	Description
x-api-key*	string	Api key of the wallet you want to retrieve an address from.

200 Address successfully retrieved

{
    "status": true,
    "message": "Address successfully retrieved!",
    "data": {
        "addressId": "132e3308-062b-46e6-8539-3f2eeda462a4",
        "address": "0xb9f4774d07b34baf0b2edeecf38156607e348ef0",
        "walletId": "14b7efd3-fae6-4cef-ae21-589d9d19d784",
        "coin": "eth",
        "blockchain": "Ethereum",
        "network": "testnet",
        "label": "some label"
    }
}

List Addresses

GET https://api.walletcloud.app/wallet/:walletId/addresses

List all the addresses in a wallet

Path Parameters

Name	Type	Description
walletId*	string	ID of the wallet to fetch details from.

Query Parameters

Name	Type	Description
nextItemKey	string	The start key of the next batch of addresses to fetch.
limit	integer	Maximum number of results to return per request. If the result set is truncated, use nextItemKey to get the next batch. Default: 25

Headers

Name	Type	Description
x-api-key*	string	Api key of the wallet you want to retrieve addresses from.

200 Addresses successfully retrieved

{
    "status": true,
    "message": "Addresses successfully retrieved!",
    "data": {
        "addresses": [
            {
                "addressId": "4d88b357-58d4-409f-908c-2d19add962bf",
                "address": "0xa2a80ae416705d26c053d2a184697af4d8efcaaf",
                "walletId": "14b7efd3-fae6-4cef-ae21-589d9d19d784",
                "coin": "eth",
                "blockchain": "Ethereum",
                "network": "testnet",
                "label": "some label"
            },
            {
                "addressId": "d13ffd3d-b977-4cf2-9936-a11a3581e2ff",
                "address": "0x2f2a0a52d04e55f873d84099eea6dcbcc1fea6f0",
                "walletId": "14b7efd3-fae6-4cef-ae21-589d9d19d784",
                "coin": "eth",
                "blockchain": "Ethereum",
                "network": "testnet",
                "label": "some label"
            }
        ],
        "nextItemKey": "eyJ3YWxsZXRJZCI6IjE0YjdlZmQzLWZhZTYtNGNlZi1hZTIxLTU4OWQ5ZDE5ZDc4NCIsImNvaW4iOiJldGgiLCJhZGRyZXNzSWQiOiJkMTNmZmQzZC1iOTc3LTRjZjItOTkzNi1hMTFhMzU4MWUyZmYifQ=="
    }
}