RanchiMall/blockbook
3
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

fiatRates, balanceHistory: update docs

Browse Source
This commit is contained in:
Vladyslav Burzakovskyy 2020-01-21 19:23:47 +01:00 committed by Martin
parent 8ea853c388
commit 5b41a37da6
1 changed files with 29 additions and 23 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

52
docs/api.md
View File

@ -580,14 +580,14 @@ or in case of error
#### Tickers list #### Tickers list
Returns a list of available currency rate tickers for the specified timestamp. Returns a list of available currency rate tickers for the specified date, along with an actual data timestamp.
``` ```
GET /api/v2/tickers-list/?timestamp=<timestamp> GET /api/v2/tickers-list/?timestamp=<timestamp>
``` ```
The query parameters: The query parameters:
- *timestamp*: specifies a UNIX timestamp to return available tickers for. - *timestamp*: specifies a Unix timestamp to return available tickers for.
Example response: Example response:
@ -603,7 +603,7 @@ Example response:
#### Tickers #### Tickers
Returns currency rate for the specified currency and date. If the currency is not available for that specific timestamp, the closest rate will be returned. Returns currency rate for the specified currency and date. If the currency is not available for that specific timestamp, the next closest rate will be returned.
All responses contain an actual rate timestamp. All responses contain an actual rate timestamp.
``` ```
@ -612,7 +612,7 @@ GET /api/v2/tickers/[?currency=<currency>&timestamp=<timestamp>]
The optional query parameters: The optional query parameters:
- *currency*: specifies a currency of returned rate ("usd", "eur", "eth"...). If not specified, all available currencies will be returned. - *currency*: specifies a currency of returned rate ("usd", "eur", "eth"...). If not specified, all available currencies will be returned.
- *timestamp*: a UNIX timestamp that specifies a date to return currency rates for. If not specified, the last available rate will be returned. - *timestamp*: a Unix timestamp that specifies a date to return currency rates for. If not specified, the last available rate will be returned.
Example response (no parameters): Example response (no parameters):
@ -652,11 +652,11 @@ GET /api/v2/balancehistory/<XPUB | address>?from=<dateFrom>&to=<dateTo>[&fiatcur
``` ```
Query parameters: Query parameters:
- *from*: specifies a start date, format is YYYY-MM-DD. - *from*: specifies a start date as a Unix timestamp
- *to*: specifies an end date, same format. - *to*: specifies an end date as a Unix timestamp
The optional query parameters: The optional query parameters:
- *fiatcurrency*: if specified, the response will contain calculated fiat amounts at the time of transaction. - *fiatcurrency*: if specified, the response will contain fiat rate at the time of transaction.
- *groupBy*: an interval in seconds, to group results by. Default is 3600 seconds. - *groupBy*: an interval in seconds, to group results by. Default is 3600 seconds.
Example response (fiatcurrency=usd): Example response (fiatcurrency=usd):
@ -664,32 +664,38 @@ Example response (fiatcurrency=usd):
```javascript ```javascript
[ [
{ {
"time":1397768400, "time": 1578391200,
"txs":1, "txs": 5,
"received":"6169114", "received": "5000000",
"sent":"0", "sent": "0",
"fiatRate":478.2312 "rates": {
"usd": 7855.9
}
}, },
{ {
"time":1397772000, "time": 1578488400,
"txs":1, "txs": 1,
"received":"0", "received": "0",
"sent":"6169114", "sent": "5000000",
"fiatRate":479.1233 "rates": {
"usd": 8283.11
}
} }
] ]
``` ```
Example response (fiatcurrency=usd&groupBy=86400): Example response (fiatcurrency=usd&groupBy=172800):
```javascript ```javascript
[ [
{ {
"time":1397700000, "time": 1578355200,
"txs":2, "txs": 6,
"received":"6169114", "received": "5000000",
"sent":"6169114", "sent": "5000000",
"fiatRate":478.2312 "rates": {
"usd": 7734.45
}
} }
] ]
``` ```