aboutsummaryrefslogtreecommitdiff
path: root/doc/REST-interface.md
diff options
context:
space:
mode:
authorMatt Corallo <git@bluematt.me>2021-10-12 02:56:48 +0000
committerMatt Corallo <git@bluematt.me>2021-10-17 02:56:56 +0000
commit2b64fa3251ac5ff4b4d174f1f0be7226490dce87 (patch)
treedafff8913879a886fd938b9cf41e81339c37f69f /doc/REST-interface.md
parentef7c8228fd5cf45526518ae2bd5ebdd483e65525 (diff)
Update REST docs with new accessors
Diffstat (limited to 'doc/REST-interface.md')
-rw-r--r--doc/REST-interface.md14
1 files changed, 14 insertions, 0 deletions
diff --git a/doc/REST-interface.md b/doc/REST-interface.md
index 8b281acca7..51a73b89fc 100644
--- a/doc/REST-interface.md
+++ b/doc/REST-interface.md
@@ -52,6 +52,20 @@ With the /notxdetails/ option JSON response will only contain the transaction ha
Given a block hash: returns <COUNT> amount of blockheaders in upward direction.
Returns empty if the block doesn't exist or it isn't in the active chain.
+#### Blockfilter Headers
+`GET /rest/blockfilterheaders/<FILTERTYPE>/<COUNT>/<BLOCK-HASH>.<bin|hex|json>`
+
+Given a block hash: returns <COUNT> amount of blockfilter headers in upward
+direction for the filter type <FILTERTYPE>.
+Returns empty if the block doesn't exist or it isn't in the active chain.
+
+#### Blockfilters
+`GET /rest/blockfilter/<FILTERTYPE>/<BLOCK-HASH>.<bin|hex|json>`
+
+Given a block hash: returns the block filter of the given block of type
+<FILTERTYPE>.
+Responds with 404 if the block doesn't exist.
+
#### Blockhash by height
`GET /rest/blockhashbyheight/<HEIGHT>.<bin|hex|json>`