docs: add notes about block order sorting

This commit is contained in:
Braydon Fuller 2016-05-11 13:36:27 -04:00
parent 285e3550f5
commit 9eacb3dedc

View File

@ -63,10 +63,12 @@ Response format:
There are a few changes to the `GET` endpoint for `/addr/[:address]`: 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 in an address summary does not include orphaned transactions
- The txids will be sorted in block order
- The list of txids will be limited at 1000 txids - 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`) - 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 transaction history for an address will be sorted in block order
- 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.
- `/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.