From 2ccfc6360d689de8572a27b15453505726a28e0d Mon Sep 17 00:00:00 2001 From: Jonas Schnelli Date: Tue, 21 Apr 2015 20:20:24 +0200 Subject: [PATCH] [REST] update documentation - add documentation for /rest/headers - reformat sections --- doc/REST-interface.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/doc/REST-interface.md b/doc/REST-interface.md index f14aed728..68bf7187f 100644 --- a/doc/REST-interface.md +++ b/doc/REST-interface.md @@ -5,6 +5,8 @@ The REST API can be enabled with the `-rest` option. Supported API ------------- + +####Transactions `GET /rest/tx/TX-HASH.{bin|hex|json}` Given a transaction hash, @@ -12,6 +14,7 @@ Returns a transaction, in binary, hex-encoded binary or JSON formats. For full TX query capability, one must enable the transaction index via "txindex=1" command line / configuration option. +####Blocks `GET /rest/block/BLOCK-HASH.{bin|hex|json}` `GET /rest/block/notxdetails/BLOCK-HASH.{bin|hex|json}` @@ -22,6 +25,15 @@ The HTTP request and response are both handled entirely in-memory, thus making m 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. +####Blockheaders +`GET /rest/headers//.` + +Given a block hash, +Returns amount of blockheaders in upward direction. + +JSON is not supported. + +####Chaininfos `GET /rest/chaininfo.json` Returns various state info regarding block chain processing.