RanchiMall/flosight-api
3
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: update documentation with address endpoint query optinos

Browse Source
This commit is contained in:
Braydon Fuller 2016-05-10 15:57:38 -04:00
parent 29e96e83ae
commit 0ba78e7180
1 changed files with 8 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
README.md
View File

@ -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: 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 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 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. - `/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`. - `/block` endpoint results does not include `confirmations` and will include `poolInfo`.
@ -172,8 +177,9 @@ Example response:
### Address ### 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?noTxList=1
/insight-api/addr/mmvP3mTe53qxHdPqXEvdu8WdC7GfQ2vmx5?from=1000&to=2000
``` ```
### Address Properties ### Address Properties