From 199627c94c2a9f4feaecfda0fe4d8350cf654525 Mon Sep 17 00:00:00 2001 From: Jonas Schnelli <jonas.schnelli@include7.ch> Date: Thu, 20 Nov 2014 16:39:09 +0100 Subject: [PATCH] [REST] adding basic documentation --- doc/REST-interface.md | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+) create mode 100644 doc/REST-interface.md diff --git a/doc/REST-interface.md b/doc/REST-interface.md new file mode 100644 index 000000000..05c532be5 --- /dev/null +++ b/doc/REST-interface.md @@ -0,0 +1,24 @@ +Unauthenticated REST Interface +============================== + +The REST API can be enabled with the `-rest` option. + +Supported API +------------- +`GET /rest/tx/TX-HASH.{bin|hex|json}` + +Given a transaction hash, +Returns a transaction, in binary, hex-encoded binary or JSON formats. + +`GET /rest/block/BLOCK-HASH.{bin|hex|json}` + +Given a block hash, +Returns a block, in binary, hex-encoded binary or JSON formats. + +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. + +For full TX query capability, one must enable the transaction index via "txindex=1" command line / configuration option. + +Risks +------------- +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:1234/tx/json/1234567890">` which might break the nodes privacy. \ No newline at end of file