Bitcoin commands

Call a command as POST /v1/bitcoin/{command}. Coverage: every transaction from the genesis block to max_block, with wallet clusters.

Node forms: an address (1..., 3..., or bc1... all lowercase or all uppercase) or a numeric id from resolve. Non-standard scripts appear as s-... names and are passed by id.

Cluster forms: cluster:<address> (any member address names its cluster) or cluster:#<id>. cluster, neighbors and topk with node=cluster, and the counterparty option, take a cluster. trace with node=cluster takes any member address. A bare number after cluster: is refused.

Commands

Command	Input	targets	Weight
info	none	–	light
resolve	1–1,000 nodes	–	light
addr	1 node	up to 200	light
utxo	1 node	–	light
tx	<block> <tx_index>	up to 200	light
cluster	1 node or cluster	–	light
neighbors	1 node	up to 200	heavy
topk	1 node	up to 200	heavy
trace	1 node	–	heavy

Options

Command	Option	Range	When omitted
addr	list	0 – 1,000	0
utxo	limit	1 – 1,000	50
cluster	members	0 – 1,000	10
addr, tx, neighbors, topk	no-labels	switch	labels on
neighbors, topk	dir	in / out	out
	node	addr / cluster	addr
	max-fanout	1 – 10,000	10,000
	from-block, to-block	0 – 4294967295	whole history
	min-sat	0 – 2,100,000,000,000,000	0
	max-scan	1 – 2,000,000	2,000,000
neighbors	offset	0 – 18446744073709551615	0
	limit	1 – 1,000	100
	order	time / amount	time
	counterparty	one node or cluster	–
	max-legs	1 – 2,000,000	2,000,000
topk	k	1 – 2,000	20
trace	rule	haircut / poison / fifo / lifo	haircut
	hops	1 – 6	3
	min-taint-sat	1 – 2,100,000,000,000,000	traced amount ÷ 1e6, at least 1
	max-fanout	1 – 10,000	10,000
	stop-labels	1–20 names	cex,exchange,mixer,privacy
	top	1 – 200	30
	node	addr / cluster	addr
	pin-addr	1–20 addresses (cluster mode)	–
	no-pin-deposits	switch	pinning on
	min-purity	0 – 1 (0 = off)	0

Bitcoin has no server-filled defaults.

Notes

• neighbors rows are net flows per transaction and counterparty, with block and tx_index. There is no last option.
• topk reports groups_total, and partial when it is larger than the rows returned.
• No command lists every spend of an address. The closest are neighbors with {"dir": "out"} (one row per spending transaction and counterparty) and trace with {"min-purity": 0.99}.
• The neighbors and topk scan cap counts the node’s whole history, so a block window does not help on a busy cluster. Use {"node": "addr"} or a member address.
• Clusters change as new transactions arrive. Compare _meta.dataset.generation before comparing cluster sizes across days.