getdescriptoractivity

getdescriptoractivity ( ["blockhash",...] Get spend and receive activity associated This call may take several minutes. Arguments: 1. blockhashes [ "blockhash", ... ] 2. scanobjects [ "descriptor", { "desc": "str", "range": n or [n,n], }, ... ] 3. include_mempool Result: { "activity" : [ { "type" : "str", "amount" : n, "blockhash" : "hex", "height" : n, "spend_txid" : "hex", "spend_vout" : n, "prevout_txid" : "hex", "prevout_vout" : n, "prevout_spk" : { "asm" : "str", "desc" : "str", "hex" : "hex", "address" : "str", "type" : "str" } }, { "type" : "str", "amount" : n, "blockhash" : "hex", "height" : n, "txid" : "hex", "vout" : n, "output_spk" : { "asm" : "str", "desc" : "str", "hex" : "hex", "address" : "str", "type" : "str" } }, ... ] } Examples: > bitcoin-cli getdescriptoractivity [scanobjects,...] include_mempool ) with a set of descriptors for a set of blocks. This command pairs well with the `relevant_blocks` output of `scanblocks()`. If you encounter timeouts, try specifying no RPC timeout (bitcoin-cli -rpcclienttimeout=0) (json array, optional) The list of blockhashes to examine for activity. Order doesn't matter. Must be along main chain or an error is thrown. (string) A valid blockhash (json array, optional) Array of scan objects. Required for "start" action Every scan object is either a string descriptor or an object: (string) An output descriptor (json object) An object with output descriptor and metadata (string, required) An output descriptor (numeric or array, optional, default=1000) The range of HD chain indexes to explore (either end or [begin,end]) (boolean, optional, default=true) Whether to include unconfirmed activity (json object) (json array) events (json object) (string) always 'spend' (numeric) The total amount in BTC of the spent output (string, optional) The blockhash this spend appears in (omitted if unconfirmed) (numeric, optional) Height of the spend (omitted if unconfirmed) (string) The txid of the spending transaction (numeric) The vout of the spend (string) The txid of the prevout (numeric) The vout of the prevout (json object) (string) Disassembly of the output script (string) Inferred descriptor for the output (string) The raw output script bytes, hex-encoded (string, optional) The Bitcoin address (only if a well-defined address exists) (string) The type (one of: nonstandard, anchor, pubkey, pubkeyhash, scripthash, multisig, nulldata, witness_v0_scripthash, witness_v0_keyhash, witness_v1_taproot, witness_v2_taproot, witness_unknown) (json object) (string) always 'receive' (numeric) The total amount in BTC of the new output (string, optional) The block that this receive is in (omitted if unconfirmed) (numeric, optional) The height of the receive (omitted if unconfirmed) (string) The txid of the receiving transaction (numeric) The vout of the receiving output (json object) (string) Disassembly of the output script (string) Inferred descriptor for the output (string) The raw output script bytes, hex-encoded (string, optional) The Bitcoin address (only if a well-defined address exists) (string) The type (one of: nonstandard, anchor, pubkey, pubkeyhash, scripthash, multisig, nulldata, witness_v0_scripthash, witness_v0_keyhash, witness_v1_taproot, witness_v2_taproot, witness_unknown) '["000000000000000000001347062c12fded7c528943c8ce133987e2e2f5a840ee"]' '["addr(bc1qzl6nsgqzu89a66l50cvwapnkw5shh23zarqkw9)"]'

Signature

getdescriptoractivity(blockhashes?: array, scanobjects?: array, include_mempool?: boolean) → any

Code samples

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

bitcoin-cli getdescriptoractivity '["000000000000000000001347062c12fded7c528943c8ce133987e2e2f5a840ee"]' '["addr(bc1qzl6nsgqzu89a66l50cvwapnkw5shh23zarqkw9)"]'

import requests
r = requests.post(
    "http://127.0.0.1:8332/",
    auth=("$RPC_USER", "$RPC_PASS"),
    json={
        "jsonrpc": "1.0",
        "id": "docs",
        "method": "getdescriptoractivity",
        "params": [[], [], true],
    },
    timeout=30,
)
print(r.json())

const res = await fetch("http://127.0.0.1:8332/", {
  method: "POST",
  headers: {
    "content-type": "application/json",
    "authorization": "Basic " + btoa(`${process.env.RPC_USER}:${process.env.RPC_PASS}`),
  },
  body: JSON.stringify({
    jsonrpc: "1.0",
    id: "docs",
    method: "getdescriptoractivity",
    params: [[],[],true],
  }),
});
console.log(await res.json());

Parameters

Name	Type	Req.	Description
blockhashes	`any[]`	—	The list of blockhashes to examine for activity. Order doesn't matter. Must be along main chain or an error is thrown. [ "blockhash", (string) A valid blockhash ... ]
scanobjects	`any[]`	—	Array of scan objects. Required for "start" action Every scan object is either a string descriptor or an object: [ "descriptor", (string) An output descriptor { (json object) An object with output descriptor and metadata "desc": "str", (string, required) An output descriptor "range": n or [n,n], (numeric or array, optional, default=1000) The range of HD chain indexes to explore (either end or [begin,end]) }, ... ]
include_mempool	`boolean`	—	Whether to include unconfirmed activity

Result

Type: any

{ (json object) "activity" : [ (json array) events { (json object) "type" : "str", (string) always 'spend' "amount" : n, (numeric) The total amount in BTC of the spent output "blockhash" : "hex", (string, optional) The blockhash this spend appears in (omitted if unconfirmed) "height" : n, (numeric, optional) Height of the spend (omitted if unconfirmed) "spend_txid" : "hex", (string) The txid of the spending transaction "spend_vout" : n, (numeric) The vout of the spend "prevout_txid" : "hex", (string) The txid of the prevout "prevout_vout" : n, (numeric) The vout of the prevout "prevout_spk" : { (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 "address" : "str", (string, optional) The Bitcoin address (only if a well-defined address exists) "type" : "str" (string) The type (one of: nonstandard, anchor, pubkey, pubkeyhash, scripthash, multisig, nulldata, witness_v0_scripthash, witness_v0_keyhash, witness_v1_taproot, witness_v2_taproot, witness_unknown) } }, { (json object) "type" : "str", (string) always 'receive' "amount" : n, (numeric) The total amount in BTC of the new output "blockhash" : "hex", (string, optional) The block that this receive is in (omitted if unconfirmed) "height" : n, (numeric, optional) The height of the receive (omitted if unconfirmed) "txid" : "hex", (string) The txid of the receiving transaction "vout" : n, (numeric) The vout of the receiving output "output_spk" : { (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 "address" : "str", (string, optional) The Bitcoin address (only if a well-defined address exists) "type" : "str" (string) The type (one of: nonstandard, anchor, pubkey, pubkeyhash, scripthash, multisig, nulldata, witness_v0_scripthash, witness_v0_keyhash, witness_v1_taproot, witness_v2_taproot, witness_unknown) } }, ... ] }

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

C++ symbol: getdescriptoractivity

Code samples

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

bitcoin-cli getdescriptoractivity '["000000000000000000001347062c12fded7c528943c8ce133987e2e2f5a840ee"]' '["addr(bc1qzl6nsgqzu89a66l50cvwapnkw5shh23zarqkw9)"]'

import requests
r = requests.post(
    "http://127.0.0.1:8332/",
    auth=("$RPC_USER", "$RPC_PASS"),
    json={
        "jsonrpc": "1.0",
        "id": "docs",
        "method": "getdescriptoractivity",
        "params": [[], [], true],
    },
    timeout=30,
)
print(r.json())

const res = await fetch("http://127.0.0.1:8332/", {
  method: "POST",
  headers: {
    "content-type": "application/json",
    "authorization": "Basic " + btoa(`${process.env.RPC_USER}:${process.env.RPC_PASS}`),
  },
  body: JSON.stringify({
    jsonrpc: "1.0",
    id: "docs",
    method: "getdescriptoractivity",
    params: [[],[],true],
  }),
});
console.log(await res.json());