Skip to content

Commit 5a91043

Browse files
committed
Merge pull request #6041
2ccfc63 [REST] update documentation (Jonas Schnelli)
2 parents df1609f + 2ccfc63 commit 5a91043

File tree

1 file changed

+12
-0
lines changed

1 file changed

+12
-0
lines changed

doc/REST-interface.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,13 +5,16 @@ The REST API can be enabled with the `-rest` option.
55

66
Supported API
77
-------------
8+
9+
####Transactions
810
`GET /rest/tx/TX-HASH.{bin|hex|json}`
911

1012
Given a transaction hash,
1113
Returns a transaction, in binary, hex-encoded binary or JSON formats.
1214

1315
For full TX query capability, one must enable the transaction index via "txindex=1" command line / configuration option.
1416

17+
####Blocks
1518
`GET /rest/block/BLOCK-HASH.{bin|hex|json}`
1619
`GET /rest/block/notxdetails/BLOCK-HASH.{bin|hex|json}`
1720

@@ -22,6 +25,15 @@ The HTTP request and response are both handled entirely in-memory, thus making m
2225

2326
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.
2427

28+
####Blockheaders
29+
`GET /rest/headers/<COUNT>/<BLOCK-HASH>.<bin|hex>`
30+
31+
Given a block hash,
32+
Returns <COUNT> amount of blockheaders in upward direction.
33+
34+
JSON is not supported.
35+
36+
####Chaininfos
2537
`GET /rest/chaininfo.json`
2638

2739
Returns various state info regarding block chain processing.

0 commit comments

Comments
 (0)