List HD Wallet (xPub, yPub, zPub) UTXOs
Through this endpoint you can list HD wallet's UTXOs (Unspent Transaction Outputs) by providing extended public key of an already synced HD wallet.
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. -
Optionalderivation string
The way how the HD walled derives, for example when the type is ACCOUNT, it derives change and receive addresses while when the type is BIP32 it derives directly.
-
Optionallimit integer
Defines how many items should be returned in the response per page basis.
-
Optionaloffset 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 : 2023-04-25 -
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
-
Requiredlimit integer
Defines how many items should be returned in the response per page basis.
Example : 50 -
Requiredoffset integer
The starting index of the response items, i.e. where the response should start listing the returned items.
Example : 0 -
Requiredtotal integer
Defines the total number of items returned in the response.
Example : 100 -
Requireditems arrayExample : Array ( )
-
Requiredaddress string
Represents the public address, which is a compressed and shortened form of a public key.
Example : muZxmnQiz8gZgpYmUoTHpD2CFTHWYEjTwB -
RequiredaddressPath string
Defines a data which tells a Hierarchical Deterministic wallet how to derive a specific key within a tree of keys.
Example : m/0/5 -
Requiredamount string
Represents the UTXO amount value.
Example : 0.0005 -
Requiredderivation string
The way how the HD walled derives, for example when the type is ACCOUNT, it derives change and receive addresses while when the type is BIP32 it derives directly.
Example : ACCOUNT -
Requiredindex integer
Represents the output index. It refers to the UTXO sequence in the transaction outputs (vout).
Example : 1 -
RequiredisAvailable boolean
Represents if the UTXO has been used from another unconfirmed transaction. If it is - the value will be "false".
Example : True -
RequiredisConfirmed boolean
Represents the state of the transaction whether it is confirmed or not confirmed.
Example : True -
RequiredreferenceId string
Represents the reference id of the record. It may be used for the startingAfter pagination attribute.
Example : 5b1ea92e584bf50020130615 -
RequiredtransactionId string
Represents the unique identifier of a transaction, i.e. it could be transactionId in UTXO-based protocols like Bitcoin, and transaction hash in Ethereum blockchain.
Example : 06af8234602b97f497496039a6eb99810db1287ce8aa3c501894dcd03bd4e544
-
-