aboutsummaryrefslogtreecommitdiff
path: root/doc/REST-interface.md
diff options
context:
space:
mode:
authorJonas Schnelli <jonas.schnelli@include7.ch>2015-04-21 20:20:24 +0200
committerJonas Schnelli <jonas.schnelli@include7.ch>2015-04-23 14:49:40 +0200
commit2ccfc6360d689de8572a27b15453505726a28e0d (patch)
tree6ceb8ce7a8f8dce849021307a5f86a92fdc13923 /doc/REST-interface.md
parentb6ea3bcede1cbbf89486b9d67329e0110c4624ae (diff)
downloadbitcoin-2ccfc6360d689de8572a27b15453505726a28e0d.tar.xz
[REST] update documentation
- add documentation for /rest/headers - reformat sections
Diffstat (limited to 'doc/REST-interface.md')
-rw-r--r--doc/REST-interface.md12
1 files changed, 12 insertions, 0 deletions
diff --git a/doc/REST-interface.md b/doc/REST-interface.md
index f14aed7287..68bf7187fa 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/<COUNT>/<BLOCK-HASH>.<bin|hex>`
+
+Given a block hash,
+Returns <COUNT> amount of blockheaders in upward direction.
+
+JSON is not supported.
+
+####Chaininfos
`GET /rest/chaininfo.json`
Returns various state info regarding block chain processing.