Language

Choose a language

/build/rpc / btc

gettxout

gettxout "txid" n ( include_mempool ) Returns details about an unspent transaction output. Arguments: 1. txid (string, required) The transaction id 2. n (numeric, required) vout number 3. include_mempool (boolean, optional, default=true) Whether to include the mempool. Note that an unspent output that is spent in the mempool won't appear. Result (If the UTXO was not found): null (json null) Result (Otherwise): { (json object) "bestblock" : "hex", (string) The hash of the block at the tip of the chain "confirmations" : n, (numeric) The number of confirmations "value" : n, (numeric) The transaction value in BTC "scriptPubKey" : { (json object) "asm" : "str", (string) Disassembly of the output script "desc" : "str", (string) Inferred descriptor for the output "hex" : "hex", (string) The raw output script bytes, hex-encoded "type" : "str", (string) The type, eg pubkeyhash "address" : "str" (string, optional) The Bitcoin address (only if a well-defined address exists) }, "coinbase" : true|false, (boolean) Coinbase or not "asset_id" : "hex", (string, optional) Asset ID if this UTXO contains an asset "asset_units" : n (numeric, optional) Asset units if this UTXO contains an asset } Examples: Get unspent transactions > bitcoin-cli listunspent View the details > bitcoin-cli gettxout "txid" 1 As a JSON-RPC call > curl --user myusername --data-binary '{"jsonrpc": "2.0", "id": "curltest", "method": "gettxout", "params": ["txid", 1]}' -H 'content-type: application/json' http://127.0.0.1:8332/

Signature

gettxout(txid: string, n: number, include_mempool?: boolean) → any

Code samples

curl --user "$RPC_USER:$RPC_PASS" \
  --data-binary '{"jsonrpc":"1.0","id":"docs","method":"gettxout","params":["\"<txid>\"",0,true]}' \
  -H 'content-type: text/plain;' \
  http://127.0.0.1:8332/

Parameters

NameTypeReq.Description
txidstringyesThe transaction id
nnumberyesvout number
include_mempoolbooleanWhether to include the mempool. Note that an unspent output that is spent in the mempool won't appear.

Result

Type:  any

null (json null) { (json object) "bestblock" : "hex", (string) The hash of the block at the tip of the chain "confirmations" : n, (numeric) The number of confirmations "value" : n, (numeric) The transaction value in BTC "scriptPubKey" : { (json object) "asm" : "str", (string) Disassembly of the output script "desc" : "str", (string) Inferred descriptor for the output "hex" : "hex", (string) The raw output script bytes, hex-encoded "type" : "str", (string) The type, eg pubkeyhash "address" : "str" (string, optional) The Bitcoin address (only if a well-defined address exists) }, "coinbase" : true|false, (boolean) Coinbase or not "asset_id" : "hex", (string, optional) Asset ID if this UTXO contains an asset "asset_units" : n (numeric, optional) Asset units if this UTXO contains an asset }

Source: services/core-node/bcore/src/rpc/blockchain.cpp:1119

C++ symbol: gettxout