aboutsummaryrefslogtreecommitdiff
path: root/doc/REST-interface.md
diff options
context:
space:
mode:
authorPavel Janík <Pavel@Janik.cz>2015-08-06 19:38:19 +0200
committerPavel Janík <Pavel@Janik.cz>2015-08-14 07:01:03 +0200
commit70180b2e576ebcb675c905ef4bd9d5b4fd378b6c (patch)
treed4c055ad001d5d127f7b7bd6b19a5c920682e5c8 /doc/REST-interface.md
parenta4fe57da6207c1e5691a1e843d22db571f3f0186 (diff)
downloadbitcoin-70180b2e576ebcb675c905ef4bd9d5b4fd378b6c.tar.xz
Implement REST mempool API, add test and documentation.
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 ac7cd45f70..bf669235e3 100644
--- a/doc/REST-interface.md
+++ b/doc/REST-interface.md
@@ -77,6 +77,20 @@ $ curl localhost:18332/rest/getutxos/checkmempool/b2cdfd7b89def827ff8af7cd9bff76
}
```
+####Memory pool
+`GET /rest/mempool/info.json`
+
+Returns various information about the TX mempool.
+Only supports JSON as output format.
+* size : (numeric) the number of transactions in the TX mempool
+* bytes : (numeric) size of the TX mempool in bytes
+* usage : (numeric) total TX mempool memory usage
+
+`GET /rest/mempool/contents.json`
+
+Returns transactions in the TX mempool.
+Only supports JSON as output format.
+
Risks
-------------
Running a web browser on the same node with a REST enabled bitcoind can be a risk. Accessing prepared XSS websites could read out tx/block data of your node by placing links like `<script src="http://127.0.0.1:8332/rest/tx/1234567890.json">` which might break the nodes privacy.