Skip to content

gettxout JSON-RPC command

gettxout "txid" n ( include_mempool patterns )

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.
4. patterns           (boolean, optional, default=false) If true then the byteCodePattern object will be added

Result

{
  "bestblock" : "hash",       (string) the block hash
  "confirmations" : n,        (numeric) The number of confirmations
  "value" : x.xxx,            (numeric) The transaction value in BCH
  "scriptPubKey" : {          (json object)
     "asm" : "code",          (string)
     "hex" : "hex",           (string)
     "reqSigs" : n,           (numeric) Number of required signatures
     "type" : "pubkeyhash",   (string) The type, eg pubkeyhash
     "addresses" : [          (array of string) array of Bitcoin Cash addresses
        "address"             (string) Bitcoin Cash address
        ,...
     ],
     "byteCodePattern" : {    (json object, optional) Only for patterns == true
       "fingerprint" : "str", (string) Single SHA-256 hash of script pattern
       "pattern" : "str",     (string) Hex-encoded script pattern
       "patternAsm" : "str",  (string) Script pattern asm
       "data" : [             (json array) Script data pushes
         "hex", ...           (string) Hex-encoded data push
       ],
       "error": true          (boolean, optional) Only if there was an error parsing the script (e.g. ending with an incomplete push)
     }
  },
  "tokenData" : {             (json object optional)
    "category" : "hex",       (string) token id
    "amount" : "xxx",         (string) fungible amount (is a string to support >53-bit amounts)
    "nft" : {                 (json object optional)
      "capability" : "xxx",   (string) one of "none", "mutable", "minting"
      "commitment" : "hex"    (string) NFT commitment
    }
  },
  "coinbase" : true|false     (boolean) Coinbase or not
}

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": "1.0", "id":"curltest", "method": "gettxout", "params": ["txid", 1] }' -H 'content-type: text/plain;' http://127.0.0.1:8332/

Bitcoin Cash Node Daemon version v29.0.1-6b3dec3

Documentation on docs.bitcoincashnode.org reflects the current master branch in Git, and may include API changes that are not yet present in the latest release.