BlockBook

Get BlockBook and backend status

get

Returns general information about the BlockBook instance and the connected PIVX backend node.

Authorizations
api-keystringRequired
Responses
chevron-right
200

Successful response with BlockBook and backend status

application/json
get
/api/v2
200

Successful response with BlockBook and backend status

Get block hash by block height

get

Returns the block hash corresponding to the specified block height in the PIVX blockchain.

Authorizations
api-keystringRequired
Path parameters
heightintegerRequired

Block height for which the block hash is requested

Example: 4197420
Responses
chevron-right
200

Successful response containing the block hash

application/json
blockHashstringOptional

Hash of the block at the specified height

Example: 000000000000a46e66b6ba67256ece7d162bc70cbdca0cbb8526905eea329512
get
/api/v2/block-index/{height}
200

Successful response containing the block hash

Get block details by block height

get

Returns detailed information about a block at the specified height or hash, including block metadata and a list of transactions.

Authorizations
api-keystringRequired
Path parameters
heightintegerRequired

Block height (integer) or block hash (string) to identify the block.

Example: 4197220
Responses
chevron-right
200

Successful response containing block details

application/json
pageintegerOptional

Current page number of transactions

Example: 1
totalPagesintegerOptional

Total number of pages available

Example: 1
itemsOnPageintegerOptional

Maximum number of transactions per page

Example: 1000
hashstringOptional

Hash of the current block

Example: 000000000000a46e66b6ba67256ece7d162bc70cbdca0cbb8526905eea329512
previousBlockHashstringOptional

Hash of the previous block in the blockchain

Example: 000000000000894844979ad0b8fdbd36d0eaf99a8488b01cf13bc2ab6abc3ce0
nextBlockHashstringOptional

Hash of the next block in the blockchain

Example: 00000000000077002d85c7c2a568a494c7c95c5c73d1a6a357440b5a57fabccf
heightintegerOptional

Height of the block in the blockchain

Example: 4197220
confirmationsintegerOptional

Number of confirmations for this block

Example: 201
sizeintegerOptional

Size of the block in bytes

Example: 505
timeintegerOptional

Unix timestamp when the block was mined

Example: 1768553331
versionintegerOptional

Block version number

Example: 805306368
merkleRootstringOptional

Merkle root hash of the block transactions

Example: 164cca0cd09959450fc9cc44113bb175c302326b69d9119bb394e27776151836
noncestringOptional

Nonce value used for mining the block

Example: 0
bitsstringOptional

Encoded difficulty target

Example: 1b00c624
difficultystringOptional

Mining difficulty at the time the block was mined

Example: 84671.98485923823
txCountintegerOptional

Number of transactions included in the block

Example: 2
get
/api/v2/block/{blockHeightOrHash}
200

Successful response containing block details

Get detailed transaction information

get

Returns a detailed transaction object including raw hex data, inputs, outputs, and block-related metadata.

Authorizations
api-keystringRequired
Path parameters
txidstringRequired

Transaction identifier (TXID)

Example: eddb27dea179495f955db5433a56f0e9790c8bb9ea209ab36952184789bfdea2
Responses
chevron-right
200

Successful response containing transaction details

application/json
txidstringOptional

Transaction identifier

Example: eddb27dea179495f955db5433a56f0e9790c8bb9ea209ab36952184789bfdea2
hashstringOptional

Transaction hash (internal hash representation)

Example: cafeaab897f566d7f5153b67213e8b0c53571519ef1e5a6741e9d939edf7020f
versionintegerOptional

Transaction version

Example: 1
sizeintegerOptional

Transaction size in bytes

Example: 192
vsizeintegerOptional

Virtual transaction size

Example: 165
locktimeintegerOptional

Transaction locktime

Example: 0
hexstringOptional

Raw transaction hex

Example: 010000000001010000000000000000000000000000000000000000000000000000000000000000ffffffff1803640b4040022f42696e616e63652f31207f05475a166306ffffffff021c3d32353a0000001976a914383728f848001d3faa649269a3f940890b4a0da188ac0000000000000000266a24aa21a9ed995fb49ed60c575ac789a4392155e51594c4104d4226aa26249f42cc334c1efa0120000000000000000000000000000000000000000000000000000000000000000000000000
blockhashstringOptional

Hash of the block containing the transaction

Example: 000000000000a46e66b6ba67256ece7d162bc70cbdca0cbb8526905eea329512
heightintegerOptional

Block height containing the transaction

Example: 4197220
confirmationsintegerOptional

Number of confirmations

Example: 201
timeintegerOptional

Transaction timestamp (Unix time)

Example: 1768553331
blocktimeintegerOptional

Block timestamp (Unix time)

Example: 1768553331
get
/api/v2/tx-specific/{txid}
200

Successful response containing transaction details

Get transaction details by transaction ID

get

Returns a simplified transaction representation in BlockBook v2 format. Values are represented in satoshis as strings.

Authorizations
api-keystringRequired
Path parameters
txidstringRequired

Transaction identifier (TXID)

Example: eddb27dea179495f955db5433a56f0e9790c8bb9ea209ab36952184789bfdea2
Responses
chevron-right
200

Successful response containing transaction data

application/json
txidstringOptional

Transaction identifier

Example: eddb27dea179495f955db5433a56f0e9790c8bb9ea209ab36952184789bfdea2
versionintegerOptional

Transaction version

Example: 1
blockHashstringOptional

Hash of the block containing the transaction

Example: 000000000000a46e66b6ba67256ece7d162bc70cbdca0cbb8526905eea329512
blockHeightintegerOptional

Block height containing the transaction

Example: 4197220
confirmationsintegerOptional

Number of confirmations

Example: 201
blockTimeintegerOptional

Block timestamp (Unix time)

Example: 1768553331
sizeintegerOptional

Transaction size in bytes

Example: 192
vsizeintegerOptional

Virtual transaction size

Example: 165
valuestringOptional

Total output value in satoshis

Example: 250000588060
valueInstringOptional

Total input value in satoshis

Example: 0
feesstringOptional

Transaction fee in satoshis

Example: 0
hexstringOptional

Raw transaction hex

Example: 010000000001010000000000000000000000000000000000000000000000000000000000000000ffffffff1803640b4040022f42696e616e63652f31207f05475a166306ffffffff021c3d32353a0000001976a914383728f848001d3faa649269a3f940890b4a0da188ac0000000000000000266a24aa21a9ed995fb49ed60c575ac789a4392155e51594c4104d4226aa26249f42cc334c1efa0120000000000000000000000000000000000000000000000000000000000000000000000000
get
/api/v2/tx/{txid}
200

Successful response containing transaction data

Get address details

get

Returns information about a specific address, including balances, transaction count, and transaction IDs.

Authorizations
api-keystringRequired
Path parameters
addressstringRequired

The blockchain address to query

Example: REQRzqybtFvVGDGKpmGb8MaEGwuDczC1K7
Responses
chevron-right
200

Successful response with address information

application/json
pageintegerOptional

Current page number

Example: 1
totalPagesintegerOptional

Total number of pages for transaction history

Example: 24
itemsOnPageintegerOptional

Number of items on the current page

Example: 1000
addressstringOptional

The queried address

Example: REQRzqybtFvVGDGKpmGb8MaEGwuDczC1K7
balancestringOptional

Confirmed balance in satoshis

Example: 1250036366481
totalReceivedstringOptional

Total received by the address in satoshis

Example: 4176764294689021
totalSentstringOptional

Total sent by the address in satoshis

Example: 4175514258322540
unconfirmedBalancestringOptional

Unconfirmed balance in satoshis

Example: 0
unconfirmedTxsintegerOptional

Number of unconfirmed transactions

Example: 0
txsintegerOptional

Total number of transactions for this address

Example: 23170
txidsstring[]Optional

List of transaction IDs involving this address

Example: ["9f19baca7d15e7d2152830e802d67d384303b08adeab1838edebbd815ddf9f88","646935fb916b3298797db127a6019a440c3395054b910e227fc18e24941cd0de","b3a3a0029be86e20115767db4b431a80b3f24636bba48d742c62c57472af2cd7"]
get
/api/v2/address/{address}
200

Successful response with address information

Get UTXOs for an address

get

Returns a list of unspent transaction outputs (UTXOs) for the given address, XPUB, or descriptor.

Authorizations
api-keystringRequired
Path parameters
addressstringRequired

Address, XPUB or descriptor to query UTXOs for.

Example: REQRzqybtFvVGDGKpmGb8MaEGwuDczC1K7
Query parameters
confirmedbooleanOptional

If true, only return confirmed UTXOs. Defaults to false (returns both confirmed and unconfirmed).

Default: false
Responses
chevron-right
200

Successful response with UTXOs

application/json

List of UTXOs for the given address

txidstringOptional

Transaction ID of the UTXO

Example: 646935fb916b3298797db127a6019a440c3395054b910e227fc18e24941cd0de
voutintegerOptional

Index of the output in the transaction

Example: 0
valuestringOptional

Value of the UTXO in satoshis

Example: 250012506692
heightintegerOptional

Block height where the transaction was included

Example: 4197402
confirmationsintegerOptional

Number of confirmations for this UTXO

Example: 19
coinbasebooleanOptional

Whether this UTXO comes from a coinbase transaction

Example: true
get
/api/v2/utxo/{addressOrXpubOrDescriptor}
200

Successful response with UTXOs

Estimate transaction fee per kilobyte

get

Estimates the fee (in coins) per kilobyte needed for a transaction to be confirmed within a certain number of blocks.

Authorizations
api-keystringRequired
Path parameters
blocksintegerRequired

Number of blocks within which the transaction should be confirmed

Example: 10
Responses
chevron-right
200

Successful fee estimation

application/json
resultstringOptional

Estimated fee per kilobyte in coins

Example: 0.01013364
get
/api/v2/estimatefee/{blocks}
200

Successful fee estimation

Get balance history for an address

get

Returns the balance history of a given address, including amounts received, sent, and sent to self, grouped by time intervals.

Authorizations
api-keystringRequired
Path parameters
addressstringRequired

The PIVX address to retrieve balance history for

Example: REQRzqybtFvVGDGKpmGb8MaEGwuDczC1K7
Responses
chevron-right
200

Balance history data

application/json
timeintegerOptional

Unix timestamp representing the time of the interval

Example: 1717480800
txsintegerOptional

Number of transactions in this interval

Example: 1
receivedstringOptional

Total amount received in satoshis during this interval

Example: 250000000000
sentstringOptional

Total amount sent in satoshis during this interval

Example: 0
sentToSelfstringOptional

Total amount sent to self in satoshis during this interval

Example: 0
get
/api/v2/balancehistory/{address}
200

Balance history data

Get list of tickers at a specific timestamp

get

Returns a list of cryptocurrency tickers and their rates at the specified timestamp.

Authorizations
api-keystringRequired
Query parameters
timestampintegerRequired

Unix timestamp to retrieve ticker data for

Example: 1768553331
Responses
chevron-right
200

List of tickers

application/json
symbolstringOptional

Ticker symbol

Example: PIVX
pricestringOptional

Price of the ticker in USD at the given timestamp

Example: 0.03456
marketCapstringOptional

Market capitalization in USD

Example: 452345678
volume24hstringOptional

24-hour trading volume in USD

Example: 2345678
change24hstringOptional

24-hour price change in percentage

Example: 2.34
get
/api/v2/tickers-list
200

List of tickers

Get XPUB/Descriptor Details

get

Returns balances and transaction history for the given extended public key (XPUB) or output descriptor.

Authorizations
api-keystringRequired
Path parameters
xpubOrDescriptorstringRequired

Extended public key (XPUB) or output descriptor.

Example: xpub6CUGRUonZSQ4TWtTMmzXdrXDtypWKiKrhko4egpiMZbpiaQ
Query parameters
pageintegerOptional

Page number of returned transactions (pagination)

Default: 1Example: 1
pageSizeintegerOptional

Number of transactions returned per page

Default: 1000Example: 500
fromintegerOptional

Start block height filter (inclusive)

Example: 3000000
tointegerOptional

End block height filter (inclusive)

Example: 4000000
detailsstringOptional

Level of transaction detail. Supported: basic, tokens, tokenBalances, txids, txs

Example: txids
Responses
chevron-right
200

Successful XPUB/Descriptor details response

application/json
pageintegerOptional

Current page of results

Example: 1
totalPagesintegerOptional

Total number of pages available

Example: 1
itemsOnPageintegerOptional

Number of items on this page

Example: 22
addressstringOptional

Provided XPUB or descriptor string

Example: xpub6CUGRUonZSQ4TWtTMmzXdrXDtypWKiKrhko4egpiMZbpiaQL2j
balancestringOptional

Confirmed balance in smallest unit (sats)

Example: 12706308
totalReceivedstringOptional

Total received amount

Example: 12926308
totalSentstringOptional

Total sent amount

Example: 220000
unconfirmedBalancestringOptional

Unconfirmed balance

Example: 0
unconfirmedTxsintegerOptional

Count of unconfirmed transactions

Example: 0
txsintegerOptional

Total number of transactions

Example: 22
addrTxCountintegerOptional

Count of address transactions

Example: 22
txidsstring[]Optional

List of transaction IDs

Example: 4a556c81e88d30f99f56a0df1d28de0f22d3d6a1342bc0bbe882a5201fe2b9ff
usedTokensintegerOptional

Number of token entries used

Example: 19
get
/api/v2/xpub/{xpubOrDescriptor}
200

Successful XPUB/Descriptor details response

Broadcast raw transaction

get

Broadcasts a raw transaction in hexadecimal format to the network. Returns the transaction ID if successfully broadcast. Kindly note that if sendtx is too long, the hexadecimal transaction may be cut off. In this case, it is preferable to use the POST version of the sendtx method.

Authorizations
api-keystringRequired
Path parameters
hexTxDatastringRequired

Raw transaction data in hexadecimal string format.

Example: 0200000001abcdef...00000000
Responses
chevron-right
200

Transaction broadcast successfully

application/json
resultstringOptional

Transaction ID of the broadcast transaction

Example: 4a556c81e88d30f99f56a0df1d28de0f22d3d6a1342bc0bbe882a5201fe2b9ff
get
/api/v2/sendtx/{hexTxData}
200

Transaction broadcast successfully

Broadcast raw transaction via POST body

post

Broadcasts a raw transaction provided in hexadecimal format via the request body. Returns the transaction ID if successfully broadcast.

Authorizations
api-keystringRequired
Body
hexstringOptional

Raw transaction in hexadecimal format

Example: 0200000001abcdef...00000000
Responses
chevron-right
200

Transaction broadcast successfully

application/json
resultstringOptional

Transaction ID of the broadcast transaction

Example: 4a556c81e88d30f99f56a0df1d28de0f22d3d6a1342bc0bbe882a5201fe2b9ff
post
/api/v2/sendtx/
200

Transaction broadcast successfully

Last updated