Get XPUB or descriptor account details.

GET

https://btgbook.nownodes.io/api/v2/xpub/{xpub}

Authorizations

ApiKeyAuthApiKeyAuth

api-key string

NOWNodes API key passed in the api-key header.

Modified between 0.5.0 and 0.6.0: page and pageSize are now validated: page is capped at 1,000,000, and when page × pageSize exceeds 100,000 the page is clamped to the last allowed one. Negative or non-numeric values fall back to the defaults. from and to are bounded to non-negative block heights. XPUB/descriptor scans are bounded: gap is capped at 10,000, a descriptor may list at most 10 change indexes, and a descriptor whose total derivation scan exceeds the server limit is rejected with an error. Documented as it exists in 0.6.0.

Returns balances and transactions of an XPUB or output descriptor for Bitcoin-type coins. Transactions are sorted by block height with newest blocks first. URL-encode descriptors before placing them after /xpub/.

Blockbook expects XPUBs at level 3 of the derivation path, for example m/purpose'/coin_type'/account'. It derives the remaining change/address_index path. The BIP scheme is inferred from the XPUB prefix; unknown prefixes default to BIP44.

Supported descriptors are pkh(xpub), sh(wpkh(xpub)), wpkh(xpub), and tr(xpub). Descriptors can include origin paths and change selectors such as <0;1> or {0,1}; when change is omitted, Blockbook defaults to <0;1>.

Note: usedTokens always reports the total number of used addresses for the XPUB, regardless of the tokens query filter.

Load estimate: High for broad accounts; grows with derived addresses, gap, used address count, pageSize, transaction history, token rows, and protocol enrichment.

Parameters

xpubstringrequiredpath

Extended public key or output descriptor to query in Blockbook.

pageinteger<int32>>= 11query

Page number of the returned transaction list. Pagination starts from 1.

pageSizeinteger<int32>[1, 1000]1000query

Maximum number of transactions returned on one page.

frominteger<int64>>= 0query

Start block height filter for transactions, inclusive.

tointeger<int64>>= 0query

End block height filter for transactions, inclusive.

detailsstringbasictokenstokenBalancestxidstxslighttxstxidsquery

Controls how much transaction or token detail is included in the response. Supported values: basic, tokens, tokenBalances, txids, txslight, txs.

tokensstringnonzerousedderivednonzeroquery

Controls which XPUB-derived address rows are included.

filterstring | integerquery

Filter by input/output side or numeric id.

contractstringquery

Contract address filter.

protocolsArray<string>query

Protocol enrichments.

secondarystringquery

Secondary currency code.

gapinteger[0, 10000]query

XPUB/address derivation gap limit.

Response

200OK

XPUB/descriptor account details.

400Bad Request

Bad Request

401Unauthorized

Unauthorized. Returned when the api-key header is missing, empty, or not accepted by the NOWNodes gateway. The body is plain text.

405Method Not Allowed

Method Not Allowed. Returned by the NOWNodes gateway for malformed or unsupported gateway-level requests.

422Unprocessable Entity

Unprocessable Entity. Returned by the NOWNodes gateway for requests it accepts but cannot process. The body is plain text.

500Internal Server Error

Internal Server Error

503Service Unavailable

Service Unavailable

default

Public API error.

Get XPUB or descriptor account details.

curl -X GET 'https://btgbook.nownodes.io/api/v2/xpub/{xpub}'

const response = await fetch('https://btgbook.nownodes.io/api/v2/xpub/{xpub}', {
  method: 'GET',
});

const data = await response.json();

require 'net/http'
require 'json'

uri = URI('https://btgbook.nownodes.io/api/v2/xpub/{xpub}')
request = Net::HTTP::Get.new(uri)

response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(request) }
data = JSON.parse(response.body)

import requests

response = requests.get('https://btgbook.nownodes.io/api/v2/xpub/{xpub}')
data = response.json()

const response = await fetch('https://btgbook.nownodes.io/api/v2/xpub/{xpub}', {
  method: 'GET',
});

const data = await response.json();

const endpoint = "https://btgbook.nownodes.io/api/v2/xpub/{xpub}";
const apiKey = "YOUR_API_KEY";

async function nownodesRequest(payload) {
  const response = await fetch(endpoint, {
    method: "GET",
    headers: {
      "Content-Type": "application/json",
      "api-key": apiKey,
    },
    body: JSON.stringify(payload),
  });

  return response.json();
}

const result = await nownodesRequest({});
console.log(result);

const response = await fetch('https://btgbook.nownodes.io/api/v2/xpub/{xpub}', {
  method: 'GET',
});

const data = await response.json();

import requests

response = requests.get('https://btgbook.nownodes.io/api/v2/xpub/{xpub}')
data = response.json()

require 'net/http'
require 'json'

uri = URI('https://btgbook.nownodes.io/api/v2/xpub/{xpub}')
request = Net::HTTP::Get.new(uri)

response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(request) }
data = JSON.parse(response.body)

{
  "page": 1,
  "totalPages": 1,
  "itemsOnPage": 1000,
  "address": "xpub661MyMwAqRbcFtXgS5sYJABqqG9YLmC4Q1Rdap9gSE8NqtwybGhePY2gZ29ESFjqJoCu1Rupje8YtGqsefD265TMg7usUDFdp6W1EGMcet8",
  "balance": "0",
  "totalReceived": "350758",
  "totalSent": "350758",
  "unconfirmedBalance": "0",
  "unconfirmedTxs": 0,
  "unconfirmedSending": "0",
  "unconfirmedReceiving": "0",
  "txs": 14,
  "addrTxCount": 14,
  "nonTokenTxs": 0,
  "internalTxs": 0,
  "transactions": [],
  "txids": [
    "75a0de262c3922bc98b93b5b942d87c7834b48e9448120998e697e111f1e7811"
  ],
  "nonce": "0",
  "usedTokens": 4,
  "tokens": [
    {
      "type": "XPUBAddress",
      "standard": "XPUBAddress",
      "path": "m/44'/0'/0'/0/0",
      "transfers": 3,
      "decimals": 8,
      "balance": "90000000",
      "totalReceived": "2903986975",
      "totalSent": "2803986975"
    }
  ],
  "secondaryValue": 21195.47633568,
  "tokensBaseValue": 0,
  "tokensSecondaryValue": 0,
  "totalBaseValue": 0,
  "totalSecondaryValue": 21195.47633568,
  "contractInfo": {
    "type": "ERC20",
    "standard": "ERC20",
    "contract": "string",
    "name": "Token",
    "symbol": "TKN",
    "decimals": 18,
    "createdInBlock": 0,
    "destructedInBlock": 0,
    "rates": {
      "baseRate": 0.000523,
      "currency": "usd",
      "secondaryRate": 1.24
    },
    "protocols": {
      "erc4626": {
        "asset": {
          "contract": "string",
          "name": "WETH",
          "symbol": "WETH",
          "decimals": 18
        },
        "share": {
          "contract": "string",
          "name": "vToken",
          "symbol": "vToken",
          "decimals": 18
        },
        "totalAssets": "123456789",
        "convertToAssets1Share": "1000000000000000000",
        "convertToShares1Asset": "1000000000000000000",
        "previewDeposit1Asset": "999999999999999999",
        "previewRedeem1Share": "1000000000000000000",
        "error": "string"
      }
    },
    "blockHeight": 12345678
  },
  "addressAliases": {},
  "stakingPools": [],
  "chainExtraData": {
    "payloadType": "tron"
  }
}

{}

Unknown API_key

Method Not Allowed

Missing API_key

{}

{}

{
  "error": "Missing xpub"
}