Jump to
Ctrl
+
/

Derive HD Wallet (xPub, yPub, zPub) Change Or Receiving Addresses

GET
/blockchain-tools/{blockchain}/{network}/hd/{extendedPublicKey}/addresses/derive-address

Through this endpoint, customers can derive up to 10 addresses - both change and receive, from a certain HD Wallet (xPub, yPub, zPub), by providing an extended public key. By default the system creates a receiving/deposit address, unless the isChange attribute is set to 'true'. In that case the system derives a 'change' address. The change address can be derived only for UTXO based blockchains, for all the rest, this endpoint always creates a deposit/receiving address.

Path Parameters

blockchain string Required

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

extendedPublicKey string Required

Defines the account extended publicly known key which is used to derive all child public keys.

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.

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.

addressFormat string Optional

Represents the format of the address.

addressesCount integer Optional

Represents the addresses count.

isChange boolean Optional

Defines if the specific address is a change or deposit address. If the value is True - it is a change address, if it is False - it is a Deposit address.

startIndex integer Optional

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

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
item object Required
addresses array Items (object) Required

Represents the address details.

address string Required

Represents the public address, which is a compressed and shortened form of a public key.

muZxmnQiz8gZgpYmUoTHpD2CFTHWYEjTwB
index integer Required

Represents the output index. It refers to the UTXO sequence in the transaction outputs (vout).

1

Credits Cost : 100 Credits for 1 Results

Was this page helpful?
Yes
No
Language
URL

{
    "apiVersion": "2021-03-20",
    "requestId": "601c1710034ed6d407996b30",
    "context": "yourExampleString",
    "data": {
        "item": {
            "addresses": [
                {
                    "address": "muZxmnQiz8gZgpYmUoTHpD2CFTHWYEjTwB",
                    "index": 1
                }
            ]
        }
    }
}