sikkienl/dash
1
0
Fork 0
mirror of https://github.com/dashpay/dash.git synced 2024-12-26 04:22:55 +01:00
Code Issues Actions Packages Projects Releases Wiki Activity

Merge pull request #6041

Browse Source 
2ccfc63 [REST] update documentation (Jonas Schnelli)
This commit is contained in:
Wladimir J. van der Laan 2015-04-29 15:57:35 +02:00
commit 5a91043a8c
No known key found for this signature in database
GPG Key ID: 74810B012346C9A6
1 changed files with 12 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
doc/REST-interface.md
View File

@ -5,6 +5,8 @@ The REST API can be enabled with the `-rest` option.
Supported API Supported API
------------- -------------
####Transactions
`GET /rest/tx/TX-HASH.{bin|hex|json}` `GET /rest/tx/TX-HASH.{bin|hex|json}`
Given a transaction hash, 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. 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/BLOCK-HASH.{bin|hex|json}`
`GET /rest/block/notxdetails/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. 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` `GET /rest/chaininfo.json`
Returns various state info regarding block chain processing. Returns various state info regarding block chain processing.