Parameters
- addressstringREQUIRED
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'/145'/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.
- objectobject
The options object with the following fields:
- pageinteger
The page you would like to retrieve.
- sizeinteger
The number of transactions you would like on each page
- fromHeightinteger
Filter of the returned transactions from block height
- toHeightinteger
Filter of the returned transactions to block height
- detailsstring
Must be one of: basic|txids|txs
- secondarystring
The secondary (fiat) currency in which the token and total balances are returned in addition to crypto values. Must be one of: usd|eur
- filterstring
Filter transactions by token. Provide a token's contract address, or
0to return only transactions with no token transfers.
- contractstring
Limit returned token balances and transactions to the specified token contract address.
- protocolsstring
Comma-separated list of token protocols to include (for example
erc20).
- gapinteger
The gap limit used when deriving addresses from an extended public key (xpub). Defaults to 20.
Returns
- pageinteger
The page number returned in this response.
- totalPagesinteger
The number of pages available for your original query
- itemsOnPageinteger
The maximum number of transactions returned in this response
- addressstring
The address you provided in the original query.
- balancestring
The current balance of the address using confirmed unspent transaction outputs only, denominated in satoshis. Balance is updated after 1 confirmation.
- totalReceivedstring
The total value received for the address using confirmed transactions only, denominated in satoshis.
- totalSentstring
The total value sent for the address using confirmed transactions only, denominated in satoshis.
- unconfirmedBalancestring
The current balance of the address using unconfirmed unspent transaction outputs only, denominated in satoshis.
- unconfirmedTxsinteger
The current number of unconfirmed transactions for this address.
- txsinteger
The total number of transactions for this address.
- txidsarray
(only appears when details is set to txids) An array of transaction ids for the provided address.
- txidstring
The transaction id
- transactionsarray
(only appears when details is set to txs) An array of transactions for the provided address.
- txidstring
The transaction id
- versioninteger
The transaction version (1 or 2)
- lockTimeinteger
The earliest time a transaction could have been mined into a block.
- vinarray
An array of transaction objects used as inputs for the current transaction
- txidstring
The transaction id
- voutinteger
The output index
- sequenceinteger
The transaction sequence
- ninteger
The nonce of this transaction
- addressesarray
An array of addresses in this transaction
- isAddressboolean
Boolean value of whether there is an address or not
- isOwnboolean
Boolean value of whether the transaction is from the original address provided
- valuestring
The value of this transaction in satoshis
- voutarray
An array of output transaction objects for the current transaction
- valuestring
The value of this transaction in satoshis
- ninteger
The nonce of this transaction
- hexstring
The raw hexadecimal representation of the transaction
- spentboolean
Boolean value of whether the transaction has been spent
- addressesarray
An array of addresses in this transaction
- isAddressboolean
Boolean value of whether there is an address or not
- blockHashstring
The hash of the block at which the transaction was included
- heightinteger
The block height at which the transaction output was created
- confirmationsinteger
The number of confirmations since this transaction was included in a block
- blockTimeinteger
The unix timestamp of when the block was confirmed
- sizeinteger
The size of the transaction in bytes
- vsizeinteger
The virtual size of the transaction in bytes (read more)
- valuestring
The total value of the transaction in satoshis
- valueInstring
The value transmitted in the transaction less fees denominated in satoshis
- feesstring
The fees for the transaction denominated in satoshis
- hexstring
The raw hexadecimal representation of the transaction
1{2"id": 1,3"result": {4"page": 1,5"totalPages": 1,6"itemsOnPage": 1000,7"address": "xpub661MyMwAqRbcGrx39FhTVkPJSd1oMiD8P8Vu4EP8SHyuvhqnaqu9VeK4m43WPPXouHpuUakK77Y6GzqCCKYYiCTsxhPBjmqhrfHqosmEFjL",8"balance": "0",9"totalReceived": "0",10"totalSent": "0",11"unconfirmedBalance": "0",12"unconfirmedTxs": 0,13"txs": 014},15"jsonrpc": "2.0"16}
1{2"id": 1,3"result": {4"page": 1,5"totalPages": 1,6"itemsOnPage": 1000,7"address": "xpub661MyMwAqRbcGrx39FhTVkPJSd1oMiD8P8Vu4EP8SHyuvhqnaqu9VeK4m43WPPXouHpuUakK77Y6GzqCCKYYiCTsxhPBjmqhrfHqosmEFjL",8"balance": "0",9"totalReceived": "0",10"totalSent": "0",11"unconfirmedBalance": "0",12"unconfirmedTxs": 0,13"txs": 014},15"jsonrpc": "2.0"16}