doc/REST-interface.md

   1 Unauthenticated REST Interface
   2 ==============================
   3
   4 The REST API can be enabled with the `-rest` option.
   5
   6 Supported API
   7 -------------
   8 `GET /rest/tx/TX-HASH.{bin|hex|json}`
   9
  10 Given a transaction hash,
  11 Returns a transaction, in binary, hex-encoded binary or JSON formats.
  12
  13 For full TX query capability, one must enable the transaction index via "txindex=1" command line / configuration option.
  14
  15 `GET /rest/block/BLOCK-HASH.{bin|hex|json}`
  16 `GET /rest/block/notxdetails/BLOCK-HASH.{bin|hex|json}`
  17
  18 Given a block hash,
  19 Returns a block, in binary, hex-encoded binary or JSON formats.
  20
  21 The HTTP request and response are both handled entirely in-memory, thus making maximum memory usage at least 2.66MB (1 MB max block, plus hex encoding) per request.
  22
  23 With the /notxdetails/ option JSON response will only contain the transaction hash instead of the complete transaction details. The option only affects the JSON response.
  24
  25 `GET /rest/chaininfo.json`
  26
  27 Returns various state info regarding block chain processing.
  28 Only supports JSON as output format.
  29 * chain : (string) current network name as defined in BIP70 (main, test, regtest)
  30 * blocks : (numeric) the current number of blocks processed in the server
  31 * headers : (numeric) the current number of headers we have validated
  32 * bestblockhash : (string) the hash of the currently best block
  33 * difficulty : (numeric) the current difficulty
  34 * verificationprogress : (numeric) estimate of verification progress [0..1]
  35 * chainwork : (string) total amount of work in active chain, in hexadecimal
  36
  37 Risks
  38 -------------
  39 Running a webbrowser 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.