1Unauthenticated REST Interface
2==============================
3
4The REST API can be enabled with the `-rest` option.
5
6The interface runs on the same port as the JSON-RPC interface, by default port 8332 for mainnet, port 18332 for testnet,
7port 48332 for testnet4, port 38332 for signet, and port 18443 for regtest.
8
9REST Interface consistency guarantees
10-------------------------------------
11
12The [same guarantees as for the RPC Interface](/doc/JSON-RPC-interface.md#rpc-consistency-guarantees)
13apply.
14
15Default HTTP caching
16--------------------
17
18REST responses include `Cache-Control` headers by default:
19
20* `public, immutable, max-age=86400` for `/block` and `/block/notxdetails`
21  binary and hex responses, `/blockpart`, `/blockfilter` and `/spenttxouts` in
22  all formats, and `/deploymentinfo/<BLOCKHASH>.json`. The TTL is deliberately
23  short so caches do not hold older response shapes across software upgrades.
24* `no-store` for `/block` and `/block/notxdetails` JSON, `/tx`, `/headers`,
25  `/blockfilterheaders`, `/blockhashbyheight`, `/chaininfo`, `/mempool`,
26  `/getutxos`, `/deploymentinfo.json`, and all error responses. These responses
27  can change with active chain or node state and do not currently provide cache
28  validators such as `ETag` or `Last-Modified`.
29
30If you front `bitcoind` with a reverse proxy or CDN such as Caddy or nginx with
31the headers-more module, you can override these defaults there. Keep overrides
32scoped to responses you know are safe to cache more aggressively.
33
34Supported API
35-------------
36
37#### Transactions
38`GET /rest/tx/<TX-HASH>.<bin|hex|json>`
39
40Given a transaction hash: returns a transaction in binary, hex-encoded binary, or JSON formats.
41Responds with 404 if the transaction doesn't exist.
42
43By default, this endpoint will only search the mempool.
44To query for a confirmed transaction, enable the transaction index via "txindex=1" command line / configuration option.
45
46#### Blocks
47- `GET /rest/block/<BLOCK-HASH>.<bin|hex|json>`
48- `GET /rest/block/notxdetails/<BLOCK-HASH>.<bin|hex|json>`
49
50Given a block hash: returns a block, in binary, hex-encoded binary or JSON formats.
51Responds with 404 if the block doesn't exist.
52
53The HTTP request and response are both handled entirely in-memory.
54
55With the /notxdetails/ option JSON response will only contain the transaction hash instead of the complete transaction details. The option only affects the JSON response.
56
57- `GET /rest/blockpart/<BLOCK-HASH>.<bin|hex>?offset=<OFFSET>&size=<SIZE>`
58
59Given a block hash: returns a block part, in binary or hex-encoded binary formats.
60Responds with 404 if the block or the byte range doesn't exist.
61
62#### Blockheaders
63`GET /rest/headers/<BLOCK-HASH>.<bin|hex|json>?count=<COUNT=5>`
64
65Given a block hash: returns <COUNT> amount of blockheaders in upward direction.
66Returns empty if the block doesn't exist or it isn't in the active chain.
67
68*Deprecated (but not removed) since 24.0:*
69`GET /rest/headers/<COUNT>/<BLOCK-HASH>.<bin|hex|json>`
70
71#### Blockfilter Headers
72`GET /rest/blockfilterheaders/<FILTERTYPE>/<BLOCK-HASH>.<bin|hex|json>?count=<COUNT=5>`
73
74Given a block hash: returns <COUNT> amount of blockfilter headers in upward
75direction for the filter type <FILTERTYPE>.
76Returns empty if the block doesn't exist or it isn't in the active chain.
77
78*Deprecated (but not removed) since 24.0:*
79`GET /rest/blockfilterheaders/<FILTERTYPE>/<COUNT>/<BLOCK-HASH>.<bin|hex|json>`
80
81#### Blockfilters
82`GET /rest/blockfilter/<FILTERTYPE>/<BLOCK-HASH>.<bin|hex|json>`
83
84Given a block hash: returns the block filter of the given block of type
85<FILTERTYPE>.
86Responds with 404 if the block doesn't exist.
87
88#### Blockhash by height
89`GET /rest/blockhashbyheight/<HEIGHT>.<bin|hex|json>`
90
91Given a height: returns hash of block in best-block-chain at height provided.
92Responds with 404 if block not found.
93
94#### Spent transaction outputs
95`GET /rest/spenttxouts/<BLOCK-HASH>.<bin|hex|json>`
96
97Given a block hash: returns a collection of spent transaction output lists,
98one per transaction in the block.
99Responds with 404 if the block doesn't exist or its undo data is not available.
100
101#### Chaininfos
102`GET /rest/chaininfo.json`
103
104Returns various state info regarding block chain processing.
105Only supports JSON as output format.
106Refer to the `getblockchaininfo` RPC help for details.
107
108#### Deployment info
109`GET /rest/deploymentinfo.json`
110`GET /rest/deploymentinfo/<BLOCKHASH>.json`
111
112Returns an object containing various state info regarding deployments of
113consensus changes at the current chain tip, or at <BLOCKHASH> if provided.
114Only supports JSON as output format.
115Refer to the `getdeploymentinfo` RPC help for details.
116
117#### Query UTXO set
118- `GET /rest/getutxos/<TXID>-<N>/<TXID>-<N>/.../<TXID>-<N>.<bin|hex|json>`
119- `GET /rest/getutxos/checkmempool/<TXID>-<N>/<TXID>-<N>/.../<TXID>-<N>.<bin|hex|json>`
120
121The getutxos endpoint allows querying the UTXO set, given a set of outpoints.
122With the `/checkmempool/` option, the mempool is also taken into account.
123See [BIP64](https://github.com/bitcoin/bips/blob/master/bip-0064.mediawiki) for
124input and output serialization (relevant for `bin` and `hex` output formats).
125
126Example:
127```
128$ curl localhost:18332/rest/getutxos/checkmempool/b2cdfd7b89def827ff8af7cd9bff7627ff72e5e8b0f71210f92ea7a4000c5d75-0.json 2>/dev/null | json_pp
129{
130   "chainHeight" : 325347,
131   "chaintipHash" : "00000000fb01a7f3745a717f8caebee056c484e6e0bfe4a9591c235bb70506fb",
132   "bitmap": "1",
133   "utxos" : [
134      {
135         "height" : 2147483647,
136         "value" : 8.8687,
137         "scriptPubKey" : {
138            "asm" : "OP_DUP OP_HASH160 1c7cebb529b86a04c683dfa87be49de35bcf589e OP_EQUALVERIFY OP_CHECKSIG",
139            "desc" : "addr(mi7as51dvLJsizWnTMurtRmrP8hG2m1XvD)#gj9tznmy",
140            "hex" : "76a9141c7cebb529b86a04c683dfa87be49de35bcf589e88ac",
141            "type" : "pubkeyhash",
142            "address" : "mi7as51dvLJsizWnTMurtRmrP8hG2m1XvD"
143         }
144      }
145   ]
146}
147```
148
149#### Memory pool
150`GET /rest/mempool/info.json`
151
152Returns various information about the transaction mempool.
153Only supports JSON as output format.
154Refer to the `getmempoolinfo` RPC help for details.
155
156`GET /rest/mempool/contents.json?verbose=<true|false>&mempool_sequence=<false|true>`
157
158Returns the transactions in the mempool.
159Only supports JSON as output format.
160Refer to the `getrawmempool` RPC help for details. Defaults to setting
161`verbose=true` and `mempool_sequence=false`.
162
163*Query parameters for `verbose` and `mempool_sequence` available in 25.0 and up.*
164
165
166Risks
167-------------
168Running a web browser on the same node with a REST enabled bitcoind can be a risk. Accessing prepared XSS websites could read out tx/block data of your node by placing links like `<script src="http://127.0.0.1:8332/rest/tx/1234567890.json">` which might break the nodes privacy.
169