Skip to main content

ltc_bb_getXPUB RPC Method

Get balances and transactions of an xpub or output descriptor.

Updated on
Apr 21, 2025

ltc_bb_getXPUB RPC Method

Please note that this RPC method requires the Litecoin Blockbook RPC add-on enabled on your QuickNode endpoint.

Parameters

address
string
REQUIRED
Provide a valid Litecoin extended public key (xpub, ypub, zpub, etc.).
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

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
Don't have an account yet?
Create your QuickNode endpoint in seconds and start building
Get started for free