List HD Wallet (xPub, yPub, zPub) Transactions

This endpoint will list HD Wallet transactions.

List of Results - This endpoint returns multiple objects which means pagination is applicable. GET /blockchain-data/{blockchain}/{network}/hd/{extendedPublicKey}/transactions

Path Parameters

Required
blockchain string

Represents the specific blockchain.

Example : bitcoin

Possible Values : bitcoin bitcoin-cash litecoin dogecoin dash ethereum zcash ethereum-classic binance-smart-chain xrp tron
Required
extendedPublicKey string

Defines the master public key (xPub) of the account.

Example : tpubD9GMECjiZHCaF9NHSMAeMbQMXnM7CviEJZsYBuztVwsUjPHWjxewWAUXWV2UExaAtoEvQGXDBmVWo6ZHGtj6TsH6Pop7D9DskQwGHA1gu1w
Required
network 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.

Example : testnet

Possible Values : mainnet testnet mordor nile goerli

Query parameters

Optional
context 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
Optional
derivation 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.

Possible Values : account bip32
Optional
limit integer

Defines how many items should be returned in the response per page basis.

Default : 50

Example : 50
Optional
offset integer

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

Default : 0

Example : 0

Response schema

200 400 401 402 403 409 415 422 429 500

HTTP Status Code: 200
Content-Type: application/json

The request has been successful.

Object :
Required
apiVersion string

Specifies the version of the API that incorporates this endpoint.

Example : 2021-03-20
Required
requestId string

Defines the ID of the request. The requestId is generated by Crypto APIs and it's unique for every request.

Example : 601c1710034ed6d407996b30
Optional
context 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
Required
data
object
- Required
  limit integer
  
  Defines how many items should be returned in the response per page basis.
  
  Example : 50
- Required
  offset integer
  
  The starting index of the response items, i.e. where the response should start listing the returned items.
  
  Example : 0
- Required
  total integer
  
  Defines the total number of items returned in the response.
  
  Example : 100
- Required
  items array
  Example : Array ( )
  
  Required
  index integer
  
  Represents the index position of the transaction in the block.
  
  Example : 1
  
  Required
  minedInBlockHash string
  
  Represents the hash of the block where this transaction was mined/confirmed for first time. The hash is defined as a cryptographic digital fingerprint made by hashing the block header twice through the SHA256 algorithm.
  
  Example : 00000000407f119ecb74b44229228910400aaeb9f4e3b9869955b85a53e9b7db
  
  Required
  minedInBlockHeight integer
  
  Represents the hight of the block where this transaction was mined/confirmed for first time. The height is defined as the number of blocks in the blockchain preceding this specific block.
  
  Example : 1903849
  
  Required
  recipients array
  
  Represents a list of recipient addresses with the respective amounts. In account-based protocols like Ethereum there is only one address in this list.
  
  Required
  address string
  
  The address which receives this transaction. In UTXO-based protocols like Bitcoin there could be several senders while in account-based protocols like Ethereum there is always only one recipient.
  
  Example : 2MzakdGTEp8SMWEHKwKM4HYv6uNCBXtHpkV
  
  Required
  amount string
  
  Represents the amount received to this address.
  
  Example : 0.000144
  
  Required
  isMember boolean
  
  Defines whether an address is a child address derived from the HD wallet (xPub, yPub, zPub) as boolean.
  
  Example : False
  
  Required
  senders array
  
  Represents a list of sender addresses with the respective amounts. In account-based protocols like Ethereum there is only one address in this list.
  
  Required
  address string
  
  Represents the address which sends this transaction. In UTXO-based protocols like Bitcoin there could be several senders while in account-based protocols like Ethereum there is always only one sender.
  
  Example : 2N5PcdirZUzKF9bWuGdugNuzcQrCbBudxv1
  
  Required
  amount string
  
  Represents the amount sent by this address.
  
  Example : 0.00873472
  
  Required
  isMember boolean
  
  Defines whether an address is a child address derived from the HD wallet (xPub, yPub, zPub) as boolean.
  
  Example : True
  
  Required
  timestamp integer
  
  Defines the exact date/time in Unix Timestamp when this transaction was mined, confirmed or first seen in Mempool, if it is unconfirmed.
  
  Example : 1582202940
  
  Required
  transactionHash string
  
  Represents the same as transactionId for account-based protocols like Ethereum, while it could be different in UTXO-based protocols like Bitcoin. E.g., in UTXO-based protocols hash is different from transactionId for SegWit transactions.
  
  Example : 1ec73b0f61359927d02376b35993b756b1097cb9a857bec23da4c98c4977d2b2
  
  Required
  transactionId 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 : 4b66461bf88b61e1e4326356534c135129defb504c7acb2fd6c92697d79eb250
  
  Required
  fee object
  
  Required
  amount string
  
  Defines the amount of the transaction fee.
  
  Example : 0.00016932

Credits Cost : 100 Credits For 1 Result(s)

Try it out

Request Example

Http Java C# PHP Python Ruby Node.js Go

GET

https://rest.cryptoapis.io/blockchain-data/bitcoin/testnet/hd/tpubD9GMECjiZHCaF9NHSMAeMbQMXnM7CviEJZsYBuztVwsUjPHWjxewWAUXWV2UExaAtoEvQGXDBmVWo6ZHGtj6TsH6Pop7D9DskQwGHA1gu1w/transactions?context=yourExampleString&limit=50&offset=0

Headers

Content-Type: application/json

X-API-Key: my-api-key

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://rest.cryptoapis.io/blockchain-data/bitcoin/testnet/hd/tpubD9GMECjiZHCaF9NHSMAeMbQMXnM7CviEJZsYBuztVwsUjPHWjxewWAUXWV2UExaAtoEvQGXDBmVWo6ZHGtj6TsH6Pop7D9DskQwGHA1gu1w/transactions?context=yourExampleString&limit=50&offset=0")
  .get()
  .addHeader("Content-Type", "application/json")
  .addHeader("X-API-Key", "my-api-key")
  .build();

Response response = client.newCall(request).execute();

var client = new RestClient("https://rest.cryptoapis.io/blockchain-data/bitcoin/testnet/hd/tpubD9GMECjiZHCaF9NHSMAeMbQMXnM7CviEJZsYBuztVwsUjPHWjxewWAUXWV2UExaAtoEvQGXDBmVWo6ZHGtj6TsH6Pop7D9DskQwGHA1gu1w/transactions?context=yourExampleString&limit=50&offset=0");
var request = new RestRequest(Method.GET);
request.AddHeader("X-API-Key", "my-api-key");
IRestResponse response = client.Execute(request);

$request = new HttpRequest();
$request->setUrl('https://rest.cryptoapis.io/blockchain-data/bitcoin/testnet/hd/tpubD9GMECjiZHCaF9NHSMAeMbQMXnM7CviEJZsYBuztVwsUjPHWjxewWAUXWV2UExaAtoEvQGXDBmVWo6ZHGtj6TsH6Pop7D9DskQwGHA1gu1w/transactions?context=yourExampleString&limit=50&offset=0');
$request->setMethod(HTTP_METH_GET);

$request->setHeaders(array(
    'Content-Type' => 'application/json',
    'X-API-Key' => 'my-api-key'
));

try {
    $response = $request->send();

    echo $response->getBody();
} catch (HttpException $ex) {
    echo $ex;
}

import http.client

conn = http.client.HTTPConnection("https://rest.cryptoapis.io")
querystring = {"context":"yourExampleString","limit":50,"offset":0}
headers = {
  'Content-Type': "application/json",
  'X-API-Key': "my-api-key"
}

conn.request("GET", "blockchain-data,bitcoin,testnet,hd,tpubD9GMECjiZHCaF9NHSMAeMbQMXnM7CviEJZsYBuztVwsUjPHWjxewWAUXWV2UExaAtoEvQGXDBmVWo6ZHGtj6TsH6Pop7D9DskQwGHA1gu1w,transactions", headers=headers  , params=querystring )

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))
}

require 'uri'
require 'net/http'

url = URI("https://rest.cryptoapis.io/blockchain-data/bitcoin/testnet/hd/tpubD9GMECjiZHCaF9NHSMAeMbQMXnM7CviEJZsYBuztVwsUjPHWjxewWAUXWV2UExaAtoEvQGXDBmVWo6ZHGtj6TsH6Pop7D9DskQwGHA1gu1w/transactions?context=yourExampleString&limit=50&offset=0")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Get.new(url)
request["Content-Type"] = 'application/json'
request["X-API-Key"] = 'my-api-key'

response = http.request(request)
puts response.read_body

var https = require("https");

var options = {
  "method": "GET",
  "hostname": "rest.cryptoapis.io",
  "path": "/v2/blockchain-data/bitcoin/testnet/hd/tpubD9GMECjiZHCaF9NHSMAeMbQMXnM7CviEJZsYBuztVwsUjPHWjxewWAUXWV2UExaAtoEvQGXDBmVWo6ZHGtj6TsH6Pop7D9DskQwGHA1gu1w/transactions",
  "qs": {"context":"yourExampleString","limit":50,"offset":0},
  "headers": {
    "Content-Type": "application/json",
    "X-API-Key": "my-api-key"
  }
};

var req = https.request(options, function (res) {
  var chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    var body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.end();

package main

import (
  "fmt"
  "net/http"
  "io/ioutil"
)

func main() {

  url := "https://rest.cryptoapis.io/blockchain-data/bitcoin/testnet/hd/tpubD9GMECjiZHCaF9NHSMAeMbQMXnM7CviEJZsYBuztVwsUjPHWjxewWAUXWV2UExaAtoEvQGXDBmVWo6ZHGtj6TsH6Pop7D9DskQwGHA1gu1w/transactions?context=yourExampleString&limit=50&offset=0"

  req, _ := http.NewRequest("GET", url, nil)

  req.Header.Add("Content-Type", "application/json")
  req.Header.Add("X-API-Key", "my-api-key")

  res, _ := http.DefaultClient.Do(req)

  defer res.Body.Close()
  body, _ := ioutil.ReadAll(res.Body)

  fmt.Println(res)
  fmt.Println(string(body))

}

200 400 401 402 403 409 415 422 429 500

Response Example

{
    "apiVersion": "2021-03-20",
    "requestId": "601c1710034ed6d407996b30",
    "context": "yourExampleString",
    "data": {
        "limit": 50,
        "offset": 0,
        "total": 100,
        "items": [
            {
                "index": 1,
                "minedInBlockHash": "00000000407f119ecb74b44229228910400aaeb9f4e3b9869955b85a53e9b7db",
                "minedInBlockHeight": 1903849,
                "recipients": [
                    {
                        "address": "2MzakdGTEp8SMWEHKwKM4HYv6uNCBXtHpkV",
                        "amount": "0.000144",
                        "isMember": false
                    }
                ],
                "senders": [
                    {
                        "address": "2N5PcdirZUzKF9bWuGdugNuzcQrCbBudxv1",
                        "amount": "0.00873472",
                        "isMember": true
                    }
                ],
                "timestamp": 1582202940,
                "transactionHash": "1ec73b0f61359927d02376b35993b756b1097cb9a857bec23da4c98c4977d2b2",
                "transactionId": "4b66461bf88b61e1e4326356534c135129defb504c7acb2fd6c92697d79eb250",
                "fee": {
                    "amount": "0.00016932"
                }
            }
        ]
    }
}

{
    "apiVersion": "2021-03-20",
    "requestId": "601c1710034ed6d407996b30",
    "context": "yourExampleString",
    "error": {
        "code": "uri_not_found",
        "message": "The specified URI has not been found. Check the URI and try again.",
        "details": [
            {
                "attribute": "attribute which content caused the error",
                "message": "message describing the error"
            }
        ]
    }
}

{
    "apiVersion": "2021-03-20",
    "requestId": "601c1710034ed6d407996b30",
    "context": "yourExampleString",
    "error": {
        "code": "limit_greater_than_allowed",
        "message": "You have reached the allowed limit. The maximum number of items for this endpoint is {limit}, please use the specific pagination attributes to get the items in portions.",
        "details": [
            {
                "attribute": "attribute which content caused the error",
                "message": "message describing the error"
            }
        ]
    }
}

{
    "apiVersion": "2021-03-20",
    "requestId": "601c1710034ed6d407996b30",
    "context": "yourExampleString",
    "error": {
        "code": "invalid_pagination",
        "message": "The pagination attributes that have been used are invalid. Please check the Documentation to see details on pagination.",
        "details": [
            {
                "attribute": "attribute which content caused the error",
                "message": "message describing the error"
            }
        ]
    }
}

{
    "apiVersion": "2021-03-20",
    "requestId": "601c1710034ed6d407996b30",
    "context": "yourExampleString",
    "error": {
        "code": "invalid_xpub",
        "message": "The provided Xpub is invalid.",
        "details": [
            {
                "attribute": "attribute which content caused the error",
                "message": "message describing the error"
            }
        ]
    }
}

{
    "apiVersion": "2021-03-20",
    "requestId": "601c1710034ed6d407996b30",
    "context": "yourExampleString",
    "error": {
        "code": "invalid_blockchain",
        "message": "Invalid blockchain! Blockchain MUST be one of: {validBlockchains}",
        "details": [
            {
                "attribute": "attribute which content caused the error",
                "message": "message describing the error"
            }
        ]
    }
}

{
    "apiVersion": "2021-03-20",
    "requestId": "601c1710034ed6d407996b30",
    "context": "yourExampleString",
    "error": {
        "code": "invalid_network",
        "message": "The provided network is invalid. The network **must** be a supported one. For the full list of supported networks please see our Documentation.",
        "details": [
            {
                "attribute": "attribute which content caused the error",
                "message": "message describing the error"
            }
        ]
    }
}

{
    "apiVersion": "2021-03-20",
    "requestId": "601c1710034ed6d407996b30",
    "context": "yourExampleString",
    "error": {
        "code": "xpub_not_synced",
        "message": "This xPub is not yet synced, please first use endpoint \u201cSync HD (xPub, yPub, zPub) wallet\u201d to synchronize it.",
        "details": [
            {
                "attribute": "attribute which content caused the error",
                "message": "message describing the error"
            }
        ]
    }
}

{
    "apiVersion": "2021-03-20",
    "requestId": "601c1710034ed6d407996b30",
    "context": "yourExampleString",
    "error": {
        "code": "missing_api_key",
        "message": "The specific authorization header (API Key) is missing, please check our Authorization section in our Documentation.",
        "details": [
            {
                "attribute": "attribute which content caused the error",
                "message": "message describing the error"
            }
        ]
    }
}

{
    "apiVersion": "2021-03-20",
    "requestId": "601c1710034ed6d407996b30",
    "context": "yourExampleString",
    "error": {
        "code": "invalid_api_key",
        "message": "The provided API key is invalid. Please, generate a new one from your Dashboard.",
        "details": [
            {
                "attribute": "attribute which content caused the error",
                "message": "message describing the error"
            }
        ]
    }
}

{
    "apiVersion": "2021-03-20",
    "requestId": "601c1710034ed6d407996b30",
    "context": "yourExampleString",
    "error": {
        "code": "insufficient_credits",
        "message": "You have insufficient credits. Please upgrade your plan from your Dashboard or contact our team via email.",
        "details": [
            {
                "attribute": "attribute which content caused the error",
                "message": "message describing the error"
            }
        ]
    }
}

{
    "apiVersion": "2021-03-20",
    "requestId": "601c1710034ed6d407996b30",
    "context": "yourExampleString",
    "error": {
        "code": "banned_ip_address",
        "message": "This IP address has been banned. To check the reason for that, please contact our team via email.",
        "details": [
            {
                "attribute": "attribute which content caused the error",
                "message": "message describing the error"
            }
        ]
    }
}

{
    "apiVersion": "2021-03-20",
    "requestId": "601c1710034ed6d407996b30",
    "context": "yourExampleString",
    "error": {
        "code": "endpoint_not_allowed_for_plan",
        "message": "This endpoint is not available for your current subscription plan, please upgrade your plan to be able to use it.",
        "details": [
            {
                "attribute": "attribute which content caused the error",
                "message": "message describing the error"
            }
        ]
    }
}

{
    "apiVersion": "2021-03-20",
    "requestId": "601c1710034ed6d407996b30",
    "context": "yourExampleString",
    "error": {
        "code": "endpoint_not_allowed_for_api_key",
        "message": "This endpoint is not available for your API key.",
        "details": [
            {
                "attribute": "attribute which content caused the error",
                "message": "message describing the error"
            }
        ]
    }
}

{
    "apiVersion": "2021-03-20",
    "requestId": "601c1710034ed6d407996b30",
    "context": "yourExampleString",
    "error": {
        "code": "feature_mainnets_not_allowed_for_plan",
        "message": "Mainnets access is not available for your current subscription plan, please upgrade your plan to be able to use it.",
        "details": [
            {
                "attribute": "attribute which content caused the error",
                "message": "message describing the error"
            }
        ]
    }
}

{
    "apiVersion": "2021-03-20",
    "requestId": "601c1710034ed6d407996b30",
    "context": "yourExampleString",
    "error": {
        "code": "invalid_data",
        "message": "The data provided seems to be invalid.",
        "details": [
            {
                "attribute": "attribute which content caused the error",
                "message": "message describing the error"
            }
        ]
    }
}

{
    "apiVersion": "2021-03-20",
    "requestId": "601c1710034ed6d407996b30",
    "context": "yourExampleString",
    "error": {
        "code": "unsupported_media_type",
        "message": "The selected Media Type is unavailable. The Content-Type header should be 'application/json'.",
        "details": [
            {
                "attribute": "attribute which content caused the error",
                "message": "message describing the error"
            }
        ]
    }
}

{
    "apiVersion": "2021-03-20",
    "requestId": "601c1710034ed6d407996b30",
    "context": "yourExampleString",
    "error": {
        "code": "invalid_request_body_structure",
        "message": "Your request body for POST requests must have a structure of { data: { item: [...properties] } }",
        "details": [
            {
                "attribute": "attribute which content caused the error",
                "message": "message describing the error"
            }
        ]
    }
}

{
    "apiVersion": "2021-03-20",
    "requestId": "601c1710034ed6d407996b30",
    "context": "yourExampleString",
    "error": {
        "code": "xpub_sync_in_progress",
        "message": "Your wallet (xPub, yPub, zPub) is still syncing, it should take few seconds depending on how many transactions it has.",
        "details": [
            {
                "attribute": "attribute which content caused the error",
                "message": "message describing the error"
            }
        ]
    }
}

{
    "apiVersion": "2021-03-20",
    "requestId": "601c1710034ed6d407996b30",
    "context": "yourExampleString",
    "error": {
        "code": "request_limit_reached",
        "message": "The request limit has been reached. There can be maximum {requests} requests per {seconds} second(s) made. Please contact our team via email if you need more or upgrade your plan.",
        "details": [
            {
                "attribute": "attribute which content caused the error",
                "message": "message describing the error"
            }
        ]
    }
}

{
    "apiVersion": "2021-03-20",
    "requestId": "601c1710034ed6d407996b30",
    "context": "yourExampleString",
    "error": {
        "code": "unexpected_server_error",
        "message": "An unexpected server error has occurred, we are working to fix this. Please try again later and in case it occurs again please report it to our team via email.",
        "details": [
            {
                "attribute": "attribute which content caused the error",
                "message": "message describing the error"
            }
        ]
    }
}

Key	Value

Key	Value

List HD Wallet (xPub, yPub, zPub) Transactions

Path Parameters

Query parameters

Response schema

Object :

Object :

Object :

Object :

Object :

Object :

Object :

Object :

Object :

Object :

Credits Cost : 100 Credits For 1 Result(s)

Request Example

Response Example

Try It Out API Endpoint