diff options
| author | Wladimir J. van der Laan <laanwj@gmail.com> | 2015-04-29 15:57:35 +0200 |
|---|---|---|
| committer | Wladimir J. van der Laan <laanwj@gmail.com> | 2015-04-29 15:59:13 +0200 |
| commit | 5a91043a8c0c30069fb8d37bc8980f6ef22e5e64 (patch) | |
| tree | ec77df844367c5f6604eb54fd6cd685514c212cd | |
| parent | df1609f31483fe55ddef1e3976c91202dad826de (diff) | |
| parent | 2ccfc6360d689de8572a27b15453505726a28e0d (diff) | |
Merge pull request #6041
2ccfc63 [REST] update documentation (Jonas Schnelli)
| -rw-r--r-- | doc/REST-interface.md | 12 |
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. |