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

Parameters

address

string

REQUIRED

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

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

This includes:

• key origin prefixes: tr([73c5da0a/86'/2'/0']xpub...)
• multipath selectors: tr(xpub.../<0;1>/*)
• explicit branch paths: tr(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 - tr(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

result

object

The result of the XPUB request

page

integer

The page number returned in this response.

totalPages

integer

The number of pages available for your original query

itemsOnPage

integer

The maximum number of transactions returned in this response

address

string

The address you provided in the original query.

balance

string

The current balance of the address using confirmed unspent transaction outputs only, denominated in satoshis (litoshis). Balance is updated after 1 confirmation.

totalReceived

string

The total value received for the address using confirmed transactions only, denominated in satoshis (litoshis).

totalSent

string

The total value sent for the address using confirmed transactions only, denominated in satoshis (litoshis).

unconfirmedBalance

string

The current balance of the address using unconfirmed unspent transaction outputs only, denominated in satoshis (litoshis).

unconfirmedTxs

integer

The current number of unconfirmed transactions for this address.

txs

integer

The total number of transactions for this address.

addrTxCount

integer

The total number of transactions across all addresses derived from this xpub.

txids

array

(only appears when details is set to txids) An array of transaction ids for the provided address.

transactions

array

(only appears when details is set to txs) An array of transactions for the provided address.

txid

string

The transaction id

version

integer

The transaction version (1 or 2)

lockTime

integer

The earliest time a transaction could have been mined into a block.

vin

array

An array of transaction objects used as inputs for the current transaction

txid

string

The transaction id

vout

integer

The output index

sequence

integer

The transaction sequence

n

integer

The input index

addresses

array

An array of addresses in this transaction

isAddress

boolean

Boolean value of whether there is an address or not

isOwn

boolean

Boolean value of whether the transaction is from the original address provided

value

string

The value of this transaction in satoshis (litoshis)

vout

array

An array of output transaction objects for the current transaction

value

string

The value of this transaction in satoshis (litoshis)

n

integer

The output index

hex

string

The raw scriptPubKey hex

spent

boolean

Boolean value of whether the transaction has been spent

addresses

array

An array of addresses in this transaction

isAddress

boolean

Boolean value of whether there is an address or not

blockHash

string

The hash of the block at which the transaction was included

height

integer

The block height at which the transaction output was created

confirmations

integer

The number of confirmations since this transaction was included in a block

blockTime

integer

The unix timestamp of when the block was confirmed

size

integer

The size of the transaction in bytes

vsize

integer

The virtual size of the transaction in bytes

value

string

The total value of the transaction in satoshis (litoshis)

valueIn

string

The value transmitted in the transaction less fees denominated in satoshis (litoshis)

fees

string

The fees for the transaction denominated in satoshis (litoshis)

hex

string

The raw hexadecimal representation of the transaction

usedTokens

integer

The number of addresses derived from this xpub that have been used.

Request

1
curl https://docs-demo.ltc-mainnet.quiknode.pro/ \
2
  -X POST \
3
  -H "Content-Type: application/json" \
4
  --data '{"method":"bb_getXPUB","params": ["zpub6rZbS9uV9Me1fVpgpipu4oTLTq4LYZ6p3giikA2eTy73JUByf4fBWuTfJ5UiAE7aWTFwBDPcRGVdyaPBqHRRQHfCSY3fFAgDbws7iArMR5p", {"page":1,"size":1000,"fromHeight":0,"details":"txids"}],"id":1,"jsonrpc":"2.0"}'

1
curl https://docs-demo.ltc-mainnet.quiknode.pro/ \
2
  -X POST \
3
  -H "Content-Type: application/json" \
4
  --data '{"method":"bb_getXPUB","params": ["zpub6rZbS9uV9Me1fVpgpipu4oTLTq4LYZ6p3giikA2eTy73JUByf4fBWuTfJ5UiAE7aWTFwBDPcRGVdyaPBqHRRQHfCSY3fFAgDbws7iArMR5p", {"page":1,"size":1000,"fromHeight":0,"details":"txids"}],"id":1,"jsonrpc":"2.0"}'

1
var myHeaders = new Headers();
2
myHeaders.append("Content-Type", "application/json");
3

4
var raw = JSON.stringify({
5
  "method": "bb_getXPUB",
6
  "params": [
7
    "zpub6rZbS9uV9Me1fVpgpipu4oTLTq4LYZ6p3giikA2eTy73JUByf4fBWuTfJ5UiAE7aWTFwBDPcRGVdyaPBqHRRQHfCSY3fFAgDbws7iArMR5p",
8
    {
9
      "page": 1,
10
      "size": 1000,
11
      "fromHeight": 0,
12
      "details": "txids"
13
    }
14
  ],
15
  "id": 1,
16
  "jsonrpc": "2.0"
17
});
18

19
var requestOptions = {
20
  method: 'POST',
21
  headers: myHeaders,
22
  body: raw,
23
  redirect: 'follow'
24
};
25

26
fetch("https://docs-demo.ltc-mainnet.quiknode.pro/", requestOptions)
27
  .then(response => response.text())
28
  .then(result => console.log(result))
29
  .catch(error => console.log('error', error));
30

1
var myHeaders = new Headers();
2
myHeaders.append("Content-Type", "application/json");
3

4
var raw = JSON.stringify({
5
  "method": "bb_getXPUB",
6
  "params": [
7
    "zpub6rZbS9uV9Me1fVpgpipu4oTLTq4LYZ6p3giikA2eTy73JUByf4fBWuTfJ5UiAE7aWTFwBDPcRGVdyaPBqHRRQHfCSY3fFAgDbws7iArMR5p",
8
    {
9
      "page": 1,
10
      "size": 1000,
11
      "fromHeight": 0,
12
      "details": "txids"
13
    }
14
  ],
15
  "id": 1,
16
  "jsonrpc": "2.0"
17
});
18

19
var requestOptions = {
20
  method: 'POST',
21
  headers: myHeaders,
22
  body: raw,
23
  redirect: 'follow'
24
};
25

26
fetch("https://docs-demo.ltc-mainnet.quiknode.pro/", requestOptions)
27
  .then(response => response.text())
28
  .then(result => console.log(result))
29
  .catch(error => console.log('error', error));
30

1
import requests
2
import json
3

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

6
payload = json.dumps({
7
  "method": "bb_getXPUB",
8
  "params": [
9
    "zpub6rZbS9uV9Me1fVpgpipu4oTLTq4LYZ6p3giikA2eTy73JUByf4fBWuTfJ5UiAE7aWTFwBDPcRGVdyaPBqHRRQHfCSY3fFAgDbws7iArMR5p",
10
    {
11
      "page": 1,
12
      "size": 1000,
13
      "fromHeight": 0,
14
      "details": "txids"
15
    }
16
  ],
17
  "id": 1,
18
  "jsonrpc": "2.0"
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)
27

1
import requests
2
import json
3

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

6
payload = json.dumps({
7
  "method": "bb_getXPUB",
8
  "params": [
9
    "zpub6rZbS9uV9Me1fVpgpipu4oTLTq4LYZ6p3giikA2eTy73JUByf4fBWuTfJ5UiAE7aWTFwBDPcRGVdyaPBqHRRQHfCSY3fFAgDbws7iArMR5p",
10
    {
11
      "page": 1,
12
      "size": 1000,
13
      "fromHeight": 0,
14
      "details": "txids"
15
    }
16
  ],
17
  "id": 1,
18
  "jsonrpc": "2.0"
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)
27

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

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

7
https = Net::HTTP.new(url.host, url.port)
8
https.use_ssl = true
9

10
request = Net::HTTP::Post.new(url)
11
request["Content-Type"] = "application/json"
12
request.body = JSON.dump({
13
  method: "bb_getXPUB",
14
  params: [
15
    "zpub6rZbS9uV9Me1fVpgpipu4oTLTq4LYZ6p3giikA2eTy73JUByf4fBWuTfJ5UiAE7aWTFwBDPcRGVdyaPBqHRRQHfCSY3fFAgDbws7iArMR5p",
16
    {
17
      page: 1,
18
      size: 1000,
19
      fromHeight: 0,
20
      details: "txids"
21
    }
22
  ],
23
  id: 1,
24
  jsonrpc: "2.0"
25
})
26

27
response = https.request(request)
28
puts response.read_body
29

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

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

7
https = Net::HTTP.new(url.host, url.port)
8
https.use_ssl = true
9

10
request = Net::HTTP::Post.new(url)
11
request["Content-Type"] = "application/json"
12
request.body = JSON.dump({
13
  method: "bb_getXPUB",
14
  params: [
15
    "zpub6rZbS9uV9Me1fVpgpipu4oTLTq4LYZ6p3giikA2eTy73JUByf4fBWuTfJ5UiAE7aWTFwBDPcRGVdyaPBqHRRQHfCSY3fFAgDbws7iArMR5p",
16
    {
17
      page: 1,
18
      size: 1000,
19
      fromHeight: 0,
20
      details: "txids"
21
    }
22
  ],
23
  id: 1,
24
  jsonrpc: "2.0"
25
})
26

27
response = https.request(request)
28
puts response.read_body
29

Don't have an account yet?

Create your Quicknode endpoint in seconds and start building

Get started for free