diff --git a/docs/api.md b/docs/api.md index 55d01729..b698b8a8 100644 --- a/docs/api.md +++ b/docs/api.md @@ -648,7 +648,7 @@ Example error response (e.g. rate unavailable, incorrect currency...): Returns a balance history for the specified XPUB or address. ``` -GET /api/v2/balancehistory/?from=&to=[&fiatcurrency=&gap=&groupBy=] +GET /api/v2/balancehistory/?from=&to=[&fiatcurrency=&groupBy=] ``` Query parameters: @@ -657,7 +657,6 @@ Query parameters: The optional query parameters: - *fiatcurrency*: if specified, the response will contain calculated fiat amounts at the time of transaction. -- *gap*: TODO - *groupBy*: an interval in seconds, to group results by. Default is 3600 seconds. Example response (fiatcurrency=usd): @@ -681,6 +680,20 @@ Example response (fiatcurrency=usd): ] ``` +Example response (fiatcurrency=usd&groupBy=100000): + +```javascript +[ + { + "time":1397700000, + "txs":2, + "received":"6169114", + "sent":"6169114", + "fiatRate":478.2312 + } +] +``` + ### Websocket API Websocket interface is provided at `/websocket/`. The interface can be explored using Blockbook Websocket Test Page found at `/test-websocket.html`.