Jump to
Ctrl
+
/

List HD Wallet (xPub, yPub, zPub) UTXOs

GET
/blockchain-data/{blockchain}/{network}/hd/{extendedPublicKey}/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

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 network like "testnet" is a test network.

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.

derivation string Optional

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.

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

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

muZxmnQiz8gZgpYmUoTHpD2CFTHWYEjTwB
addressPath string Required

Defines a data which tells a Hierarchical Deterministic wallet how to derive a specific key within a tree of keys.

m/0/5
amount string Required

Represents the UTXO amount value.

0.0005
derivation string Required

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.

ACCOUNT
index integer Required

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

1
isAvailable boolean Required

Represents if the UTXO has been used from another unconfirmed transaction. If it is - the value will be "false".

true
isConfirmed boolean Required

Represents the state of the transaction whether it is confirmed or not confirmed.

true
referenceId string Required

Represents the reference id of the record. It may be used for the startingAfter pagination attribute.

5b1ea92e584bf50020130615
transactionId string Required

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.

06af8234602b97f497496039a6eb99810db1287ce8aa3c501894dcd03bd4e544

Credits Cost : 500 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": "muZxmnQiz8gZgpYmUoTHpD2CFTHWYEjTwB",
                "addressPath": "m/0/5",
                "amount": "0.0005",
                "derivation": "ACCOUNT",
                "index": 1,
                "isAvailable": true,
                "isConfirmed": true,
                "referenceId": "5b1ea92e584bf50020130615",
                "transactionId": "06af8234602b97f497496039a6eb99810db1287ce8aa3c501894dcd03bd4e544"
            }
        ]
    }
}