aboutsummaryrefslogtreecommitdiff
path: root/doc/REST-interface.md
diff options
context:
space:
mode:
authorMarcoFalke <falke.marco@gmail.com>2017-08-16 00:45:58 +0200
committerMarcoFalke <falke.marco@gmail.com>2017-08-16 00:46:40 +0200
commit6366941275344dac7e2130b0c972e90117d37ed0 (patch)
tree7d3d4fbc86ae8497dcac02f530d872f704f9f4fb /doc/REST-interface.md
parent4fb2586661471a1572c2df2a5a091011d45eb7c4 (diff)
parent1d8df01412db0d94ac0030bd2225683891748aff (diff)
Merge #10680: Fix inconsistencies and grammar in various files
1d8df0141 Fix MD formatting in REST-interface.md and spelling mistake in test_runner.py (MeshCollider) 41f3e84aa Fix inconsistencies and grammar in various files (MeshCollider) Pull request description: Just a simple fix of some inconsistent capitalization, formatting and grammar in a few files (no code changes) Tree-SHA512: 60b12a5a5c69a1af4a25b7db0b32ed806ed62ad2966cee08b3792a7cfa7f51848fd485349b4c09e60a7eedfdf55ee730c51daa066d6e226ae404c93342bf3e13
Diffstat (limited to 'doc/REST-interface.md')
-rw-r--r--doc/REST-interface.md12
1 files changed, 6 insertions, 6 deletions
diff --git a/doc/REST-interface.md b/doc/REST-interface.md
index caf6782886..7a17c175bd 100644
--- a/doc/REST-interface.md
+++ b/doc/REST-interface.md
@@ -8,14 +8,14 @@ The interface runs on the same port as the JSON-RPC interface, by default port 8
Supported API
-------------
-####Transactions
+#### Transactions
`GET /rest/tx/<TX-HASH>.<bin|hex|json>`
Given a transaction hash: 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
+#### Blocks
`GET /rest/block/<BLOCK-HASH>.<bin|hex|json>`
`GET /rest/block/notxdetails/<BLOCK-HASH>.<bin|hex|json>`
@@ -25,12 +25,12 @@ 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
+#### Blockheaders
`GET /rest/headers/<COUNT>/<BLOCK-HASH>.<bin|hex|json>`
Given a block hash: returns <COUNT> amount of blockheaders in upward direction.
-####Chaininfos
+#### Chaininfos
`GET /rest/chaininfo.json`
Returns various state info regarding block chain processing.
@@ -48,7 +48,7 @@ Only supports JSON as output format.
* softforks : (array) status of softforks in progress
* bip9_softforks : (object) status of BIP9 softforks in progress
-####Query UTXO set
+#### Query UTXO set
`GET /rest/getutxos/<checkmempool>/<txid>-<n>/<txid>-<n>/.../<txid>-<n>.<bin|hex|json>`
The getutxo command allows querying of the UTXO set given a set of outpoints.
@@ -81,7 +81,7 @@ $ curl localhost:18332/rest/getutxos/checkmempool/b2cdfd7b89def827ff8af7cd9bff76
}
```
-####Memory pool
+#### Memory pool
`GET /rest/mempool/info.json`
Returns various information about the TX mempool.