Skip to content

Commit 195573b

Browse files
shekenahgloryshekenahglory
committed
document new endpoints
1 parent b4dc363 commit 195573b

File tree

3 files changed

+267
-11
lines changed

3 files changed

+267
-11
lines changed

‎README.md‎

Lines changed: 238 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -26,9 +26,17 @@ V2 Methods:
2626
* [Get Ledger - `GET /v2/ledgers/{:ledger_identifier}`](#get-ledger-v2)
2727
* [Get Transaction - `GET /v2/transactions/{:hash}`](#get-transaction-v2)
2828
* [Get Transactions - `GET /v2/transactions/`](#get-transactions)
29+
* [Get Payments - `GET /v2/payments/:currency`](#get-payments)
2930
* [Get Exchanges - `GET /v2/exchanges/:base/:counter`](#get-exchanges)
31+
* [Get Exchange Rates - `GET /v2/exchange_rates/:base/:counter`](#get-exchange-rates)
32+
* [Get Normalization - `GET /v2/normalize`](#normalize)
3033
* [Get Reports - `GET /v2/reports/`](#get-reports)
3134
* [Get Stats - `GET /v2/stats/`](#get-stats)
35+
* [Get Capitalization - `GET /v2/capitalization/:currency/:issuer`](#get-capitalization)
36+
* [Get Active Accounts - `GET /v2/active_accounts/:base/:counter`](#get-active-accounts)
37+
* [Get Exchange Volume - `GET /v2/network/exchange_volume`](#get-exchange-volume)
38+
* [Get Payment Volume - `GET /v2/network/payment_volume`](#get-payment-volume)
39+
* [Get Issued Value - `GET /v2/network/issued_value`](#get-issued-value)
3240
* [Get Accounts - `GET /v2/accounts`](#get-accounts)
3341

3442
V2 Account Methods:
@@ -1290,6 +1298,37 @@ A successful response uses the HTTP code **200 OK** and has a JSON body with the
12901298
| marker | String | Pagination marker |
12911299
| transactions | Array of [Transaction object](#transaction-objects) | The requested transactions |
12921300

1301+
## Get Payments ##
1302+
[[Source]<br>](https://github.com/ripple/rippled-historical-database/blob/develop/api/routesV2/getPayments.js "Source")
1303+
1304+
Retrieve Payments over time. Payments are `Payment` type transactions excluding those with the same account as both the source and destination. Results can be returned as individual payments or aggregated to a specific list of intervals if a currency and issuer is provided.
1305+
1306+
```
1307+
GET /v2/payments/{:currency}
1308+
```
1309+
1310+
#### Params ####
1311+
* :currency(string)...base currency of the pair in the format currency[+issuer]
1312+
* start (string)...UTC start time of query range
1313+
* end (string)...UTC end time of query range
1314+
* interval (string)... aggregation interval (currency is required for aggregated results):
1315+
* day
1316+
* week
1317+
* month
1318+
* descending (boolean)...reverse cronological order
1319+
* limit (integer)...max results per page (defaults to 200)
1320+
* marker (string)...pagination key from previously returned response
1321+
* format (string)...format of returned results: 'csv','json' defaults to 'json'
1322+
1323+
#### Response Format ####
1324+
A successful response uses the HTTP code **200 OK** and has a JSON body with the following:
1325+
1326+
| Field | Value | Description |
1327+
|--------|-------|-------------|
1328+
| result | `success` | Indicates that the body represents a successful response. |
1329+
| count | Integer | Number of Transactions returned. |
1330+
| marker | String | Pagination marker |
1331+
| payments | Array of payments objects | The requested payments |
12931332

12941333

12951334

@@ -1307,7 +1346,7 @@ GET /v2/exchanges/{:base}/{:counter}
13071346
* :counter(string)...counter currency of the pair in the format currency[+issuer] (required)
13081347
* start (string)...UTC start time of query range
13091348
* end (string)...UTC end time of query range
1310-
* interval (string)... aggregation interval:
1349+
* interval (string)...aggregation interval:
13111350
* 1minute
13121351
* 5minute
13131352
* 15minute
@@ -1338,6 +1377,33 @@ A successful response uses the HTTP code **200 OK** and has a JSON body with the
13381377

13391378

13401379

1380+
## Get Exchange Rates ##
1381+
[[Source]<br>](https://github.com/ripple/rippled-historical-database/blob/develop/api/routesV2/getExchangeRate.js "Source")
1382+
1383+
Retrieve an exchange rate for a given currency at a specific time. The exchange rate is
1384+
determined by conversion first to XRP and then to the counter currency. The rate is
1385+
derived from the volume weighted average over the calanendar day specified, averaged with
1386+
the volume weighted average of the last 50 trades within the last 14 days.
1387+
1388+
```
1389+
GET /v2/exchange_rates/{:base}/{:counter}
1390+
```
1391+
1392+
#### Params ####
1393+
* :base(string)...base currency of the pair in the format currency[+issuer] (required)
1394+
* :counter(string)...counter currency of the pair in the format currency[+issuer] (required)
1395+
* date (string)...UTC start time of query range (defaults to now)
1396+
* strict (boolean)...disallow rates derived from less than 10 exchanges (defaults to true)
1397+
1398+
#### Response Format ####
1399+
A successful response uses the HTTP code **200 OK** and has a JSON body with the following:
1400+
1401+
| Field | Value | Description |
1402+
|--------|-------|-------------|
1403+
| result | `success` | Indicates that the body represents a successful response. |
1404+
| rate | number | The requested exchange rate |
1405+
1406+
13411407

13421408
## Get Reports ##
13431409
[[Source]<br>](https://github.com/ripple/rippled-historical-database/blob/develop/api/routesV2/reports.js "Source")
@@ -1384,7 +1450,10 @@ GET /v2/stats/{:family}/{:metric}
13841450
* :metric (string)...return only a specific metric from the family subset
13851451
* start (string)...UTC start time of query range
13861452
* end (string)...UTC end time of query range
1387-
* interval (string)...aggregation interval ('hour','day','week', defaults to 'day')
1453+
* interval (string)...aggregation interval:
1454+
* hour
1455+
* day
1456+
* week
13881457
* limit (integer)...max results per page (defaults to 200)
13891458
* marker (string)...pagination key from previously returned response
13901459
* descending (boolean)...reverse cronological order
@@ -1402,6 +1471,169 @@ A successful response uses the HTTP code **200 OK** and has a JSON body with the
14021471
| stats | Array of stats objects | The requested stats |
14031472

14041473

1474+
## Get Capitalization ##
1475+
[[Source]<br>](https://github.com/ripple/rippled-historical-database/blob/develop/api/routesV2/capitalization.js "Source")
1476+
1477+
Get capitalization data for a specific currency + issuer
1478+
1479+
```
1480+
GET /v2/capitaliztion/{:currency+issuer}
1481+
```
1482+
1483+
#### Params ####
1484+
* start (string)...UTC start time of query range
1485+
* end (string)...UTC end time of query range
1486+
* interval (string)...aggregation interval
1487+
* day
1488+
* week
1489+
* month
1490+
* limit (integer)...max results per page (defaults to 200)
1491+
* marker (string)...pagination key from previously returned response
1492+
* descending (boolean)...reverse cronological order
1493+
* adjusted (boolean)...adjust results by removing known issuer owned wallets
1494+
* format (string)...format of returned results: 'csv','json' defaults to 'json'
1495+
1496+
1497+
#### Response Format ####
1498+
A successful response uses the HTTP code **200 OK** and has a JSON body with the following:
1499+
1500+
| Field | Value | Description |
1501+
|--------|-------|-------------|
1502+
| result | `success` | Indicates that the body represents a successful response. |
1503+
| count | Integer | Number of reports returned. |
1504+
| currency | String | Currency requested |
1505+
| issuer | String | Issuer requested |
1506+
| marker | String | Pagination marker |
1507+
| rows | Array of issuer capitalization objects | The requested capitalization data |
1508+
1509+
1510+
1511+
## Get Active Accounts ##
1512+
[[Source]<br>](https://github.com/ripple/rippled-historical-database/blob/develop/api/routesV2/activeAccounts.js "Source")
1513+
1514+
Get active trading accounts for a specific currency pair
1515+
1516+
```
1517+
GET /v2/active_accounts/{:base}/{:counter}
1518+
```
1519+
1520+
#### Params ####
1521+
* :base(string)...base currency of the pair in the format currency[+issuer] (required)
1522+
* :counter(string)...counter currency of the pair in the format currency[+issuer] (required)
1523+
* period (string)...requested period
1524+
* 1day
1525+
* 3day
1526+
* 7day
1527+
* date (string)... start date for the selected period. If absent, the latest period is used.
1528+
* include_exchanges(boolean)...include individual exchanges for each account in the results.
1529+
* format (string)...format of returned results: 'csv','json' defaults to 'json'
1530+
1531+
1532+
#### Response Format ####
1533+
A successful response uses the HTTP code **200 OK** and has a JSON body with the following:
1534+
1535+
| Field | Value | Description |
1536+
|--------|-------|-------------|
1537+
| result | `success` | Indicates that the body represents a successful response. |
1538+
| count | Integer | Number of accounts returned. |
1539+
| exchanges_count | Integer | Total number of exchanges. |
1540+
| accounts | Array of active account objects | Active trading accounts for the period |
1541+
1542+
1543+
1544+
## Get Exchange Volume ##
1545+
[[Source]<br>](https://github.com/ripple/rippled-historical-database/blob/develop/api/routesV2/getMetric.js "Source")
1546+
1547+
Get aggregated exchange volume for a given time period. By default, the rolling 24 hour
1548+
data is returned. If start or end is specified, historical intervals are returned.
1549+
1550+
```
1551+
GET /v2/network/exchange_volume
1552+
```
1553+
1554+
#### Params ####
1555+
* start (string)...UTC start time of query range
1556+
* end (string)...UTC end time of query range
1557+
* interval (string)...aggregation interval
1558+
* day
1559+
* week
1560+
* month
1561+
* limit (integer)...max results per page (defaults to 200)
1562+
* marker (string)...pagination key from previously returned response
1563+
* format (string)...format of returned results: 'csv','json' defaults to 'json'
1564+
1565+
1566+
#### Response Format ####
1567+
A successful response uses the HTTP code **200 OK** and has a JSON body with the following:
1568+
1569+
| Field | Value | Description |
1570+
|--------|-------|-------------|
1571+
| result | `success` | Indicates that the body represents a successful response. |
1572+
| count | Integer | Number of results returned. |
1573+
| rows | Array of exchange volume objects | Exchange volumes for the period selected |
1574+
1575+
1576+
1577+
## Get Payment Volume ##
1578+
[[Source]<br>](https://github.com/ripple/rippled-historical-database/blob/develop/api/routesV2/getMetric.js "Source")
1579+
1580+
Get aggregated payment volume for a given time period. By default, the rolling 24 hour
1581+
data is returned. If start or end is specified, historical intervals are returned.
1582+
1583+
```
1584+
GET /v2/network/payment_volume
1585+
```
1586+
1587+
#### Params ####
1588+
* start (string)...UTC start time of query range
1589+
* end (string)...UTC end time of query range
1590+
* interval (string)...aggregation interval
1591+
* day
1592+
* week
1593+
* month
1594+
* limit (integer)...max results per page (defaults to 200)
1595+
* marker (string)...pagination key from previously returned response
1596+
* format (string)...format of returned results: 'csv','json' defaults to 'json'
1597+
1598+
1599+
#### Response Format ####
1600+
A successful response uses the HTTP code **200 OK** and has a JSON body with the following:
1601+
1602+
| Field | Value | Description |
1603+
|--------|-------|-------------|
1604+
| result | `success` | Indicates that the body represents a successful response. |
1605+
| count | Integer | Number of results returned. |
1606+
| rows | Array of payment volume objects | Payment volumes for the period selected |
1607+
1608+
1609+
1610+
## Get Issued Value ##
1611+
[[Source]<br>](https://github.com/ripple/rippled-historical-database/blob/develop/api/routesV2/getMetric.js "Source")
1612+
1613+
Get aggregated currency capitalization for a given time period. By default, the rolling 24 hour
1614+
data is returned. If start or end is specified, historical intervals are returned.
1615+
1616+
```
1617+
GET /v2/network/issued_value
1618+
```
1619+
1620+
#### Params ####
1621+
* start (string)...UTC start time of query range
1622+
* end (string)...UTC end time of query range
1623+
* limit (integer)...max results per page (defaults to 200)
1624+
* marker (string)...pagination key from previously returned response
1625+
* format (string)...format of returned results: 'csv','json' defaults to 'json'
1626+
1627+
1628+
#### Response Format ####
1629+
A successful response uses the HTTP code **200 OK** and has a JSON body with the following:
1630+
1631+
| Field | Value | Description |
1632+
|--------|-------|-------------|
1633+
| result | `success` | Indicates that the body represents a successful response. |
1634+
| count | Integer | Number of results returned. |
1635+
| rows | Array of issued value objects | Aggregated capitalization for the period selected |
1636+
14051637

14061638

14071639
## Get Accounts ##
@@ -1416,7 +1648,10 @@ GET /v2/accounts
14161648
#### Params ####
14171649
* start (string)...UTC start time of query range
14181650
* end (string)...UTC end time of query range
1419-
* interval (string)...aggregation interval ('hour','day','week', defaults to 'day')
1651+
* interval (string)...aggregation interval
1652+
* hour
1653+
* day
1654+
* week
14201655
* limit (integer)...max results per page (defaults to 200)
14211656
* marker (string)...pagination key from previously returned response
14221657
* descending (boolean)...reverse cronological order
@@ -1437,8 +1672,6 @@ A successful response uses the HTTP code **200 OK** and has a JSON body with the
14371672

14381673

14391674

1440-
1441-
14421675
## Get Account ##
14431676
[[Source]<br>](https://github.com/ripple/rippled-historical-database/blob/develop/api/routesV2/getaccount.js "Source")
14441677

@@ -1462,8 +1695,6 @@ A successful response uses the HTTP code **200 OK** and has a JSON body with the
14621695

14631696

14641697

1465-
1466-
14671698
## Get Account Balances ##
14681699
[[Source]<br>](https://github.com/ripple/rippled-historical-database/blob/develop/api/routesV2/accountBalances .js "Source")
14691700

‎api/apiMap.js‎

Lines changed: 27 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -55,19 +55,43 @@ function generateMap(req, res) {
5555
action: 'Get Transaction',
5656
route: '/v2/transactions/{:tx_hash}',
5757
example: url + '/transactions/3B1A4E1C9BB6A7208EB146BCDB86ECEA6068ED01466D933528CA2B4C64F753EF'
58+
}, {
59+
action: 'Get Payments',
60+
route: '/v2/payments/{:currency+issuer}',
61+
example: url + '/payments/USD+rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B'
5862
}, {
5963
action: 'Get Exchanges',
6064
route: '/v2/exchanges/{:base}/{:counter}',
61-
example: url + '/exchanges/XRP/USD+rMwjYedjc7qqtKYVLiAccJSmCwih4LnE2q'
65+
example: url + '/exchanges/XRP/USD+rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B'
66+
}, {
67+
action: 'Get Capitalization',
68+
route: '/v2/capitalization/{:currency+issuer}',
69+
example: url + '/capitalization/USD+rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B'
70+
}, {
71+
action: 'Get Active Accounts',
72+
route: '/v2/active_accounts/{:base}/{:counter}',
73+
example: url + '/active_accounts/XRP/USD+rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B'
74+
}, {
75+
action: 'Get Exchange Volume',
76+
route: '/v2/network/exchange_volume',
77+
example: url + '/network/exchange_volume'
78+
}, {
79+
action: 'Get Payment Volume',
80+
route: '/v2/network/payment_volume',
81+
example: url + '/network/payment_volume'
82+
}, {
83+
action: 'Get Issued Value',
84+
route: '/v2/network/issued_value',
85+
example: url + '/network/issued_value'
6286
}, {
6387
action: 'Get Exchange Rate',
6488
route: '/v2/exchange_rates/{:base}/{:counter}',
65-
example: url + '/exchange_rates/XRP/USD+rMwjYedjc7qqtKYVLiAccJSmCwih4LnE2q'
89+
example: url + '/exchange_rates/XRP/USD+rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B'
6690
}, {
6791
action: 'Normalize Amount',
6892
route: '/v2/normalize',
6993
example: url + '/normalize?amount=2000&currency=XRP&exchange_currency=USD' +
70-
'&exchange_issuer=rMwjYedjc7qqtKYVLiAccJSmCwih4LnE2q'
94+
'&exchange_issuer=rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B'
7195
}, {
7296
action: 'Get Daily Summary',
7397
route: '/v2/reports/{:date}',

‎api/routesV2/activeAccounts.js‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,8 @@ function activeAccounts(req, res) {
1313
counter: {},
1414
period: req.query.period || '1day',
1515
includeExchanges : req.query.include_exchanges,
16-
limit: Infinity
16+
limit: Infinity,
17+
format: (req.query.format || 'json').toLowerCase()
1718
};
1819

1920
// any of +, |, or .

0 commit comments

Comments
 (0)