Please note that this RPC method requires the Blockbook RPC enabled on your Quicknode endpoint.

Parameters

address

string

REQUIRED

An extended public key, or an output descriptor wrapping one. Supported descriptor form: pkh(...). Must be an account-level key, not a master key. Example: pkh(xpub...).

Descriptors containing a / are not supported and return an error.

This includes:

• key origin prefixes: pkh([73c5da0a/44'/133'/0']xpub...)
• multipath selectors: pkh(xpub.../<0;1>/*)
• explicit branch paths: pkh(xpub.../0/*)

Percent-encoding the slash does not help. Note the origin prefix cannot be shortened either, since it contains slashes of its own.

Use the bare form instead - pkh(xpub...) - which is fully supported. The branch selector is unnecessary: Blockbook automatically scans both the receive (0) and change (1) branches for the account.

object

object

The options object with the following fields:

page

integer

The page you would like to retrieve.

size

integer

The number of transactions you would like on each page

fromHeight

integer

Filter of the returned transactions from block height

toHeight

integer

Filter of the returned transactions to block height

details

string

Must be one of: basic|txids|txs

secondary

string

The secondary (fiat) currency in which the token and total balances are returned in addition to crypto values. Must be one of: usd|eur

filter

string

Filter transactions by token. Provide a token's contract address, or 0 to return only transactions with no token transfers.

contract

string

Limit returned token balances and transactions to the specified token contract address.

protocols

string

Comma-separated list of token protocols to include (for example erc20).

gap

integer

The gap limit used when deriving addresses from an extended public key (xpub). Defaults to 20.

Returns

page

integer

Current page number

totalPages

integer

Total number of pages

itemsOnPage

integer

Number of items on each page

address

string

The queried xpub key

balance

string

Current confirmed balance in satoshis

totalReceived

string

Total amount received in satoshis

totalSent

string

Total amount sent in satoshis

unconfirmedBalance

string

Unconfirmed balance in satoshis

unconfirmedTxs

integer

Number of unconfirmed transactions

txs

integer

Total number of transactions

txids

array

List of transaction IDs

tokens

array

Derived addresses from the xpub

type

string

Token type (e.g., XPUBAddress)

name

string

Derived address

path

string

BIP32 derivation path

transfers

integer

Number of transfers for this address

decimals

integer

Decimal places

balance

string

Balance of this derived address

totalReceived

string

Total received by this derived address

totalSent

string

Total sent from this derived address

Request

1
curl -X POST "https://docs-demo.zec-mainnet.quiknode.pro/" \
2
  -H "Content-Type: application/json" \
3
  -d '{
4
  "jsonrpc": "2.0",
5
  "method": "bb_getXPUB",
6
  "params": [
7
    "xpub661MyMwAqRbcGrx39FhTVkPJSd1oMiD8P8Vu4EP8SHyuvhqnaqu9VeK4m43WPPXouHpuUakK77Y6GzqCCKYYiCTsxhPBjmqhrfHqosmEFjL",
8
    {
9
      "page": 1,
10
      "size": 1000,
11
      "fromHeight": 0,
12
      "details": "txids"
13
    }
14
  ],
15
  "id": 1
16
}'

1
curl -X POST "https://docs-demo.zec-mainnet.quiknode.pro/" \
2
  -H "Content-Type: application/json" \
3
  -d '{
4
  "jsonrpc": "2.0",
5
  "method": "bb_getXPUB",
6
  "params": [
7
    "xpub661MyMwAqRbcGrx39FhTVkPJSd1oMiD8P8Vu4EP8SHyuvhqnaqu9VeK4m43WPPXouHpuUakK77Y6GzqCCKYYiCTsxhPBjmqhrfHqosmEFjL",
8
    {
9
      "page": 1,
10
      "size": 1000,
11
      "fromHeight": 0,
12
      "details": "txids"
13
    }
14
  ],
15
  "id": 1
16
}'

1
const body = {
2
    jsonrpc: '2.0',
3
    method: 'bb_getXPUB',
4
    params: ["xpub661MyMwAqRbcGrx39FhTVkPJSd1oMiD8P8Vu4EP8SHyuvhqnaqu9VeK4m43WPPXouHpuUakK77Y6GzqCCKYYiCTsxhPBjmqhrfHqosmEFjL",{"page":1,"size":1000,"fromHeight":0,"details":"txids"}],
5
    id: 1
6
}
7

8
async function main() {
9
    const response = await fetch('https://docs-demo.zec-mainnet.quiknode.pro/', {
10
        method: 'POST',
11
        headers: {'Content-Type': 'application/json'},
12
        body: JSON.stringify(body)
13
    })
14
    const data = await response.json()
15
    console.log(data)
16
}
17

18
main()

1
const body = {
2
    jsonrpc: '2.0',
3
    method: 'bb_getXPUB',
4
    params: ["xpub661MyMwAqRbcGrx39FhTVkPJSd1oMiD8P8Vu4EP8SHyuvhqnaqu9VeK4m43WPPXouHpuUakK77Y6GzqCCKYYiCTsxhPBjmqhrfHqosmEFjL",{"page":1,"size":1000,"fromHeight":0,"details":"txids"}],
5
    id: 1
6
}
7

8
async function main() {
9
    const response = await fetch('https://docs-demo.zec-mainnet.quiknode.pro/', {
10
        method: 'POST',
11
        headers: {'Content-Type': 'application/json'},
12
        body: JSON.stringify(body)
13
    })
14
    const data = await response.json()
15
    console.log(data)
16
}
17

18
main()

1
import requests
2
import json
3

4
url = "https://docs-demo.zec-mainnet.quiknode.pro/"
5

6
payload = json.dumps({
7
  "jsonrpc": "2.0",
8
  "method": "bb_getXPUB",
9
  "params": [
10
    "xpub661MyMwAqRbcGrx39FhTVkPJSd1oMiD8P8Vu4EP8SHyuvhqnaqu9VeK4m43WPPXouHpuUakK77Y6GzqCCKYYiCTsxhPBjmqhrfHqosmEFjL",
11
    {
12
      "page": 1,
13
      "size": 1000,
14
      "fromHeight": 0,
15
      "details": "txids"
16
    }
17
  ],
18
  "id": 1
19
})
20
headers = {
21
  'Content-Type': 'application/json'
22
}
23

24
response = requests.request("POST", url, headers=headers, data=payload)
25

26
print(response.text)

1
import requests
2
import json
3

4
url = "https://docs-demo.zec-mainnet.quiknode.pro/"
5

6
payload = json.dumps({
7
  "jsonrpc": "2.0",
8
  "method": "bb_getXPUB",
9
  "params": [
10
    "xpub661MyMwAqRbcGrx39FhTVkPJSd1oMiD8P8Vu4EP8SHyuvhqnaqu9VeK4m43WPPXouHpuUakK77Y6GzqCCKYYiCTsxhPBjmqhrfHqosmEFjL",
11
    {
12
      "page": 1,
13
      "size": 1000,
14
      "fromHeight": 0,
15
      "details": "txids"
16
    }
17
  ],
18
  "id": 1
19
})
20
headers = {
21
  'Content-Type': 'application/json'
22
}
23

24
response = requests.request("POST", url, headers=headers, data=payload)
25

26
print(response.text)

1
require "uri"
2
require "json"
3
require "net/http"
4

5
uri = URI("https://docs-demo.zec-mainnet.quiknode.pro/")
6

7
payload = {
8
  jsonrpc: "2.0",
9
  id: 1,
10
  method: "bb_getXPUB",
11
  params: ["xpub661MyMwAqRbcGrx39FhTVkPJSd1oMiD8P8Vu4EP8SHyuvhqnaqu9VeK4m43WPPXouHpuUakK77Y6GzqCCKYYiCTsxhPBjmqhrfHqosmEFjL",{"page":1,"size":1000,"fromHeight":0,"details":"txids"}]
12
}
13

14
request = Net::HTTP::Post.new(uri)
15
request["Content-Type"] = "application/json"
16
request.body = JSON.generate(payload)
17

18
response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) do |http|
19
  http.request(request)
20
end
21

22
puts response.body

1
require "uri"
2
require "json"
3
require "net/http"
4

5
uri = URI("https://docs-demo.zec-mainnet.quiknode.pro/")
6

7
payload = {
8
  jsonrpc: "2.0",
9
  id: 1,
10
  method: "bb_getXPUB",
11
  params: ["xpub661MyMwAqRbcGrx39FhTVkPJSd1oMiD8P8Vu4EP8SHyuvhqnaqu9VeK4m43WPPXouHpuUakK77Y6GzqCCKYYiCTsxhPBjmqhrfHqosmEFjL",{"page":1,"size":1000,"fromHeight":0,"details":"txids"}]
12
}
13

14
request = Net::HTTP::Post.new(uri)
15
request["Content-Type"] = "application/json"
16
request.body = JSON.generate(payload)
17

18
response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) do |http|
19
  http.request(request)
20
end
21

22
puts response.body

Response

1
{
2
  "id": 1,
3
  "result": {
4
    "page": 1,
5
    "totalPages": 1,
6
    "itemsOnPage": 1000,
7
    "address": "xpub...",
8
    "balance": "0",
9
    "totalReceived": "0",
10
    "totalSent": "0",
11
    "unconfirmedBalance": "0",
12
    "unconfirmedTxs": 0,
13
    "txs": 0,
14
    "tokens": []
15
  },
16
  "jsonrpc": "2.0"
17
}

1
{
2
  "id": 1,
3
  "result": {
4
    "page": 1,
5
    "totalPages": 1,
6
    "itemsOnPage": 1000,
7
    "address": "xpub...",
8
    "balance": "0",
9
    "totalReceived": "0",
10
    "totalSent": "0",
11
    "unconfirmedBalance": "0",
12
    "unconfirmedTxs": 0,
13
    "txs": 0,
14
    "tokens": []
15
  },
16
  "jsonrpc": "2.0"
17
}

Don't have an account yet?

Create your Quicknode endpoint in seconds and start building

Get started for free