From 0ba78e7180b3c1a459065d76f54c7a2ed0a28c38 Mon Sep 17 00:00:00 2001 From: Braydon Fuller Date: Tue, 10 May 2016 15:57:38 -0400 Subject: [PATCH] docs: update documentation with address endpoint query optinos --- README.md | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 1335aaa..d1526cf 100644 --- a/README.md +++ b/README.md @@ -60,10 +60,15 @@ Response format: } ``` +There are a few changes to the `GET` endpoint for `/addr/[:address]`: + +- The list of txids in an address summary does not include orphaned transactions +- The list of txids will be limited at 1000 txids +- There are two new query options "from" and "to" for pagination of the txids (e.g. `/addr/[:address]?from=1000&to=2000`) + Some additional general notes: - The response for the `/sync` endpoint does not include `startTs` and `endTs` as the sync is no longer relevant as indexes are built in bitcoind. - The endpoint for `/peer` is no longer relevant connection to bitcoind is via ZMQ. -- The list of txids in an address summary does not include orphaned transactions. - `/tx` endpoint results will now include block height, and spentTx related fields will be set to `null` if unspent. - `/block` endpoint results does not include `confirmations` and will include `poolInfo`. @@ -172,8 +177,9 @@ Example response: ### Address ``` - /insight-api/addr/[:addr][?noTxList=1] + /insight-api/addr/[:addr][?noTxList=1][&from=&to=] /insight-api/addr/mmvP3mTe53qxHdPqXEvdu8WdC7GfQ2vmx5?noTxList=1 + /insight-api/addr/mmvP3mTe53qxHdPqXEvdu8WdC7GfQ2vmx5?from=1000&to=2000 ``` ### Address Properties