Derive HD Wallet (xPub, yPub, zPub) Change Or Receiving Addresses
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
-
Requiredblockchain string
Represents the specific blockchain protocol name, e.g. Ethereum, Bitcoin, etc.
-
RequiredextendedPublicKey string
Defines the account extended publicly known key which is used to derive all child public keys.
-
Requirednetwork 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.
Query parameters
-
Optionalcontext 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. -
OptionaladdressFormat string
Represents the format of the address.
-
OptionaladdressesCount integer
Represents the addresses count.
-
OptionalisChange boolean
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.
-
OptionalstartIndex integer
The starting index of the response items, i.e. where the response should start listing the returned items.
Response schema
Content-Type: application/json
The request has been successful.
Object :
-
RequiredapiVersion string
Specifies the version of the API that incorporates this endpoint.
Example : 2021-03-20 -
RequiredrequestId string
Defines the ID of the request. The
requestId
is generated by Crypto APIs and it's unique for every request.Example : 601c1710034ed6d407996b30 -
Optionalcontext 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 -
Requireddata object
-
Requireditem object
-
Requiredaddresses array
Represents the address details.
-
Requiredaddress string
Represents the public address, which is a compressed and shortened form of a public key.
Example : muZxmnQiz8gZgpYmUoTHpD2CFTHWYEjTwB -
Requiredindex integer
Represents the output index. It refers to the UTXO sequence in the transaction outputs (vout).
Example : 1
-
-
-