ARCHIVE/xrpl-dev-portal
1
0
Fork 0
mirror of https://github.com/XRPLF/xrpl-dev-portal.git synced 2025-11-21 12:15:50 +00:00
Code Issues Packages Projects Releases Wiki Activity

[DOC] charts API - reflect recent breaking changes

Browse Source
This commit is contained in:
mDuo13
2015-06-10 17:24:03 -07:00
parent b218c188ef
commit 25feb9d144
2 changed files with 494 additions and 525 deletions
Download Patch File Download Diff File Expand all files Collapse all files

532
content/charts_api.md
View File

@@ -203,6 +203,8 @@ POST /api/account_offers_exercised
</div> </div>
[Try it! >](charts-api-tool.html#account-offers-exercised)
The request includes the following body parameters: The request includes the following body parameters:
| Field | Value | Description | | Field | Value | Description |
@@ -339,12 +341,11 @@ Retrieve information about the creation of new Ripple accounts.
``` ```
POST /api/accounts_created POST /api/accounts_created
{ {
"startTime": "2014-01-01T10:00:00.000Z", "startTime": "2014-01-01T00:00:00.000Z",
"endTime": "2015-03-15T10:00:00.000Z", "endTime": "2015-03-31T00:00:00.000Z",
"timeIncrement": "month", "timeIncrement": "week",
"descending": true, "descending": true,
"reduce": true, "reduce": true
"format": "json"
} }
``` ```
@@ -353,25 +354,25 @@ POST /api/accounts_created
``` ```
POST /api/accounts_created POST /api/accounts_created
{ {
"startTime": "2015-03-15T09:00:00.000Z", "startTime": "2015-01-01T00:00:00.000Z",
"endTime": "2015-03-15T17:00:00.000Z", "endTime": "2015-02-28T00:00:00.000Z",
"timeIncrement": "week",
"descending": true, "descending": true,
"reduce": false,
"limit": 5,
"offset": 0,
"format": "json" "format": "json"
} }
``` ```
</div> </div>
[Try it! >](charts-api-tool.html#accounts-created)
The request includes the following body parameters: The request includes the following body parameters:
| Field | Value | Description | | Field | Value | Description |
|-------|-------|-------------| |-------|-------|-------------|
| startTime | String ([Date-Time][]) | Retrieve information starting at this time. | | startTime | String ([Date-Time][]) | Retrieve information starting at this time. |
| endTime | String ([Date-Time][]) | Retrieve information ending at this time. | | endTime | String ([Date-Time][]) | Retrieve information ending at this time. |
| timeIncrement | String | (Optional) Divide results into intervals of the specified length: `year`, `month`, `day`, `hour`, `minute`, or `second`. The value `all` collapses the results into just one interval. Defaults to `all`. | | timeIncrement | String | (Optional) Divide results into intervals of the specified length: `week`, `day`, `hour`. The value `all` collapses the results into just one interval. Defaults to `all`. |
| descending | Boolean | (Optional) If true, return results in descending order. Defaults to false. | | descending | Boolean | (Optional) If true, return results in descending order. Defaults to false. |
| reduce | Boolean | (Optional) If `false`, include accounts individually instead of collapsing them into results over time. Ignored if `timeIncrement` is provided. Defaults to `true`. | | reduce | Boolean | (Optional) If `false`, include accounts individually instead of collapsing them into results over time. Ignored if `timeIncrement` is provided. Defaults to `true`. |
| limit | Number | (Optional) If reduce is `false`, this value defines the maximum number of transactions to return in one response. Use with `offset` to paginate results. Defaults to 500. | | limit | Number | (Optional) If reduce is `false`, this value defines the maximum number of transactions to return in one response. Use with `offset` to paginate results. Defaults to 500. |
@@ -387,113 +388,58 @@ The format of the response depends on the `format` and `reduce` parameters from
*Reduced* *Reduced*
``` ```
{ [
"startTime": "2015-03-15T10:00:00+00:00", [
"endTime": "2014-01-01T10:00:00+00:00", "time",
"timeIncrement": "month", "count"
"total": 97417, ],
"results": [ [
{ "2015-03-31T00:00:00+00:00",
"time": "2015-03-01T00:00:00+00:00", 102478
"count": 2388 ]
},
{
"time": "2015-02-01T00:00:00+00:00",
"count": 6770
},
{
"time": "2015-01-01T00:00:00+00:00",
"count": 7584
},
{
"time": "2014-12-01T00:00:00+00:00",
"count": 10760
},
{
"time": "2014-11-01T00:00:00+00:00",
"count": 6834
},
{
"time": "2014-10-01T00:00:00+00:00",
"count": 5787
},
{
"time": "2014-09-01T00:00:00+00:00",
"count": 4146
},
{
"time": "2014-08-01T00:00:00+00:00",
"count": 5301
},
{
"time": "2014-07-01T00:00:00+00:00",
"count": 7820
},
{
"time": "2014-06-01T00:00:00+00:00",
"count": 7031
},
{
"time": "2014-05-01T00:00:00+00:00",
"count": 10421
},
{
"time": "2014-04-01T00:00:00+00:00",
"count": 4771
},
{
"time": "2014-03-01T00:00:00+00:00",
"count": 5195
},
{
"time": "2014-02-01T00:00:00+00:00",
"count": 5299
},
{
"time": "2014-01-01T00:00:00+00:00",
"count": 7310
}
] ]
}
``` ```
*Expanded* *Expanded*
``` ```
{ {
"startTime": "2015-03-15T17:00:00+00:00", "startTime": "2015-02-28T00:00:00+00:00",
"endTime": "2015-03-15T09:00:00+00:00", "endTime": "2015-01-01T00:00:00+00:00",
"total": 5, "timeIncrement": "week",
"total": 13814,
"results": [ "results": [
{ {
"time": "2015-03-15T15:34:20+00:00", "time": "2015-02-23T00:00:00+00:00",
"account": "rK6gVSDPNXeMPSR4p8LKx8yHVKST1qs6gX", "count": 1381
"txHash": "75FB423CD1319A7DA68BD12B0918777D93111FB8FAD964E2A5C5CF99DC35F491",
"ledgerIndex": 12273337
}, },
{ {
"time": "2015-03-15T15:31:10+00:00", "time": "2015-02-16T00:00:00+00:00",
"account": "rUPGhr8vhPuobxnKGbWS5dAvUfL7LmjpNQ", "count": 1551
"txHash": "FB018F1D19DAE75529F13F5B4F296817E62AAA2E032836AEA95A87F68C9C12C4",
"ledgerIndex": 12273295
}, },
{ {
"time": "2015-03-15T14:13:30+00:00", "time": "2015-02-09T00:00:00+00:00",
"account": "rap2yHgBKNKkb8D7PTdQNPEZM1D9YJSDJe", "count": 1827
"txHash": "EF0CB7051983C16775E8FCDAE62760870B29053A751548B17ED526CD62F1A2A1",
"ledgerIndex": 12272263
}, },
{ {
"time": "2015-03-15T14:11:10+00:00", "time": "2015-02-02T00:00:00+00:00",
"account": "rnEffWJFRd1VVFbKoEXjhGR9gtqnJKTt1X", "count": 2017
"txHash": "8CA751FD309BF5767339888AA410786FC2B7007B8C01941A91F7679BF92930B6",
"ledgerIndex": 12272233
}, },
{ {
"time": "2015-03-15T13:42:20+00:00", "time": "2015-01-26T00:00:00+00:00",
"account": "r4anmJmbTQ4C7ei1w2jSmFDxthypWaJTmp", "count": 1690
"txHash": "A19D55662957DCC450FC91DBB3681CD917EFE00D4F902F7A0D196015D832141F", },
"ledgerIndex": 12271842 {
"time": "2015-01-19T00:00:00+00:00",
"count": 1638
},
{
"time": "2015-01-12T00:00:00+00:00",
"count": 1565
},
{
"time": "2015-01-05T00:00:00+00:00",
"count": 2145
} }
] ]
} }
@@ -604,6 +550,8 @@ POST /api/exchange_rates
</div> </div>
[Try it! >](charts-api-tool.html#exchange-rates)
The request includes the following body parameters: The request includes the following body parameters:
| Field | Value | Description | | Field | Value | Description |
@@ -753,6 +701,8 @@ POST /api/issuer_capitalization
</div> </div>
[Try it! >](charts-api-tool.html#issuer-capitalization)
The request includes the following body parameters: The request includes the following body parameters:
| Field | Value | Description | | Field | Value | Description |
@@ -962,6 +912,8 @@ POST /api/ledgers_closed
</div> </div>
[Try it! >](charts-api-tool.html#ledgers-closed)
The request includes the following body parameters: The request includes the following body parameters:
| Field | Value | Description | | Field | Value | Description |
@@ -1162,6 +1114,8 @@ POST /api/market_traders
</div> </div>
[Try it! >](charts-api-tool.html#market-traders)
The request includes the following body parameters: The request includes the following body parameters:
| Field | Value | Description | | Field | Value | Description |
@@ -1817,6 +1771,8 @@ POST /api/offers
</div> </div>
[Try it! >](charts-api-tool.html#offers)
The request includes the following body parameters: The request includes the following body parameters:
| Field | Value | Description | | Field | Value | Description |
@@ -2023,6 +1979,8 @@ POST /api/offers_exercised
</div> </div>
[Try it! >](charts-api-tool.html#offers-exercised)
The request includes the following body parameters: The request includes the following body parameters:
| Field | Value | Description | | Field | Value | Description |
@@ -2233,8 +2191,8 @@ The total volume is normalized in terms of XRP and then optionally converted to
``` ```
POST /api/top_markets POST /api/top_markets
{ {
"startTime": "2015-01-15T00:00:00.000Z", "startTime": "2015-01-07T00:00:00.000Z",
"endTime": "2015-01-16T00:00:00.000Z", "interval": "week",
"exchange": { "exchange": {
"currency": "USD", "currency": "USD",
"issuer": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B" "issuer": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B"
@@ -2244,12 +2202,14 @@ POST /api/top_markets
</div> </div>
[Try it! >](charts-api-tool.html#top-markets)
The request includes the following body parameters: The request includes the following body parameters:
| Field | Value | Description | | Field | Value | Description |
|-------|-------|-------------| |-------|-------|-------------|
| startTime | String ([Date-Time][]) | Retrieve information starting at this time. Defaults to 24 hours before the current time. | | startTime | String ([Date-Time][]) | Retrieve information from the interval containing or starting from this time. Defaults to 24 hours before the current time. |
| endTime | String ([Date-Time][]) | (Optional) Retrieve information ending at this time. Defaults to the current time. | | interval | String | Return results from an interval of this length. |
| exchange | Object ([Currency Object][]) | (Optional) Represent the volume of each market in terms of this currency. Defaults to XRP. | | exchange | Object ([Currency Object][]) | (Optional) Represent the volume of each market in terms of this currency. Defaults to XRP. |
#### Response Format #### #### Response Format ####
@@ -2258,15 +2218,7 @@ An example of a successful response:
```js ```js
{ {
"startTime": "2015-01-15T00:00:00+00:00", "rowkey": "trade_volume|week|20150105000000",
"endTime": "2015-01-16T00:00:00+00:00",
"exchange": {
"currency": "USD",
"issuer": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B"
},
"exchangeRate": 0.01646395158719886,
"total": 2378736.7119640484,
"count": 45086,
"components": [ "components": [
{ {
"base": { "base": {
@@ -2276,10 +2228,10 @@ An example of a successful response:
"counter": { "counter": {
"currency": "XRP" "currency": "XRP"
}, },
"rate": 1, "rate": 0.0004093940882798027,
"count": 3291, "count": 12818,
"amount": 203276.6053861964, "amount": 1058808.8475284327,
"convertedAmount": 203276.6053861964 "convertedAmount": 1058808.8475284327
}, },
{ {
"base": { "base": {
@@ -2289,10 +2241,10 @@ An example of a successful response:
"counter": { "counter": {
"currency": "XRP" "currency": "XRP"
}, },
"rate": 209.0645112082856, "rate": 0.0000015089406113337684,
"count": 2378, "count": 5038,
"amount": 467.1872824011091, "amount": 1211.8976720489186,
"convertedAmount": 97672.28083791517 "convertedAmount": 328802.69694533286
}, },
{ {
"base": { "base": {
@@ -2302,10 +2254,10 @@ An example of a successful response:
"counter": { "counter": {
"currency": "XRP" "currency": "XRP"
}, },
"rate": 0.16300752590344095, "rate": 0.002517187670715517,
"count": 1300, "count": 5792,
"amount": 352600.6074331275, "amount": 1886016.212859644,
"convertedAmount": 57476.55264972454 "convertedAmount": 306740.69197435805
}, },
{ {
"base": { "base": {
@@ -2315,10 +2267,10 @@ An example of a successful response:
"counter": { "counter": {
"currency": "XRP" "currency": "XRP"
}, },
"rate": 0.165410686020017, "rate": 0.002487380215448072,
"count": 1978, "count": 7069,
"amount": 598934.9857105609, "amount": 2631245.752126516,
"convertedAmount": 99070.24686777295 "convertedAmount": 433072.6959400096
}, },
{ {
"base": { "base": {
@@ -2328,10 +2280,10 @@ An example of a successful response:
"counter": { "counter": {
"currency": "XRP" "currency": "XRP"
}, },
"rate": 0.16611418005077094, "rate": 0.0024999228710402563,
"count": 5249, "count": 20660,
"amount": 689671.2643442968, "amount": 1318591.835624731,
"convertedAmount": 114564.17658113135 "convertedAmount": 215936.1429155409
}, },
{ {
"base": { "base": {
@@ -2341,10 +2293,10 @@ An example of a successful response:
"counter": { "counter": {
"currency": "XRP" "currency": "XRP"
}, },
"rate": 1.015674437867591, "rate": 0.0003945533232038895,
"count": 5887, "count": 33575,
"amount": 332291.09141223435, "amount": 1480087.1064381741,
"convertedAmount": 337499.5674785294 "convertedAmount": 1535759.2393204158
}, },
{ {
"base": { "base": {
@@ -2354,10 +2306,10 @@ An example of a successful response:
"counter": { "counter": {
"currency": "XRP" "currency": "XRP"
}, },
"rate": 1.1885584523292927, "rate": 0.00033245421053307723,
"count": 2250, "count": 13892,
"amount": 56085.58908399305, "amount": 326411.42570749344,
"convertedAmount": 66661.00095964746 "convertedAmount": 401952.82176561374
}, },
{ {
"base": { "base": {
@@ -2367,10 +2319,10 @@ An example of a successful response:
"counter": { "counter": {
"currency": "XRP" "currency": "XRP"
}, },
"rate": 208.0331642429944, "rate": 0.0000014787515510977754,
"count": 6260, "count": 22939,
"amount": 1586.032424195194, "amount": 5535.83428387394,
"convertedAmount": 329947.34379731334 "convertedAmount": 1532602.165544437
}, },
{ {
"base": { "base": {
@@ -2380,10 +2332,10 @@ An example of a successful response:
"counter": { "counter": {
"currency": "XRP" "currency": "XRP"
}, },
"rate": 0, "rate": 0.00002019256666183595,
"count": 0, "count": 4,
"amount": 0, "amount": 0.00008287404598700001,
"convertedAmount": 0 "convertedAmount": 0.0016802294164530685
}, },
{ {
"base": { "base": {
@@ -2393,10 +2345,10 @@ An example of a successful response:
"counter": { "counter": {
"currency": "XRP" "currency": "XRP"
}, },
"rate": 0.00845173776394386, "rate": 0.048446318835714555,
"count": 2883, "count": 11387,
"amount": 17970017.17694474, "amount": 90721573.94254778,
"convertedAmount": 151877.8727931037 "convertedAmount": 766639.7972870923
}, },
{ {
"base": { "base": {
@@ -2406,10 +2358,10 @@ An example of a successful response:
"counter": { "counter": {
"currency": "XRP" "currency": "XRP"
}, },
"rate": 0.008480693452054242, "rate": 0.049622732367643606,
"count": 2931, "count": 7604,
"amount": 23369930.598202318, "amount": 97770194.62368087,
"convertedAmount": 198193.21739913648 "convertedAmount": 806617.0035207476
}, },
{ {
"base": { "base": {
@@ -2419,10 +2371,10 @@ An example of a successful response:
"counter": { "counter": {
"currency": "XRP" "currency": "XRP"
}, },
"rate": 0.008684460374378918, "rate": 0.04957853568065961,
"count": 79, "count": 650,
"amount": 4066843.5686033685, "amount": 21241310.716636248,
"convertedAmount": 35318.341820333706 "convertedAmount": 175399.8361451728
}, },
{ {
"base": { "base": {
@@ -2432,10 +2384,10 @@ An example of a successful response:
"counter": { "counter": {
"currency": "XRP" "currency": "XRP"
}, },
"rate": 0.0009481132167155902, "rate": 0.45875087906923134,
"count": 1427, "count": 3309,
"amount": 182823180.8616419, "amount": 643024533.754439,
"convertedAmount": 173337.07409690745 "convertedAmount": 573841.8273378739
}, },
{ {
"base": { "base": {
@@ -2446,10 +2398,10 @@ An example of a successful response:
"currency": "USD", "currency": "USD",
"issuer": "rMwjYedjc7qqtKYVLiAccJSmCwih4LnE2q" "issuer": "rMwjYedjc7qqtKYVLiAccJSmCwih4LnE2q"
}, },
"rate": 1.1885584523292927, "rate": 0.00033245421053307723,
"count": 753, "count": 4408,
"amount": 25970.558828017478, "amount": 89233.81725732498,
"convertedAmount": 30867.5272067553 "convertedAmount": 109885.19953232592
}, },
{ {
"base": { "base": {
@@ -2460,10 +2412,10 @@ An example of a successful response:
"currency": "USD", "currency": "USD",
"issuer": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B" "issuer": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B"
}, },
"rate": 209.0645112082856, "rate": 0.0000015089406113337684,
"count": 868, "count": 1135,
"amount": 214.60263271777458, "amount": 308.8960869071788,
"convertedAmount": 44865.79451315278 "convertedAmount": 83807.29561038432
}, },
{ {
"base": { "base": {
@@ -2474,10 +2426,10 @@ An example of a successful response:
"currency": "USD", "currency": "USD",
"issuer": "rMwjYedjc7qqtKYVLiAccJSmCwih4LnE2q" "issuer": "rMwjYedjc7qqtKYVLiAccJSmCwih4LnE2q"
}, },
"rate": 208.0331642429944, "rate": 0.0000014787515510977754,
"count": 1383, "count": 5705,
"amount": 313.98277229154746, "amount": 1097.9447905182549,
"convertedAmount": 65318.8296375982 "convertedAmount": 303967.29333071
}, },
{ {
"base": { "base": {
@@ -2488,10 +2440,10 @@ An example of a successful response:
"currency": "BTC", "currency": "BTC",
"issuer": "rMwjYedjc7qqtKYVLiAccJSmCwih4LnE2q" "issuer": "rMwjYedjc7qqtKYVLiAccJSmCwih4LnE2q"
}, },
"rate": 209.0645112082856, "rate": 0.0000015089406113337684,
"count": 1426, "count": 1855,
"amount": 352.3729308907017, "amount": 588.0555584971066,
"convertedAmount": 73668.67455969556 "convertedAmount": 159546.6828982718
}, },
{ {
"base": { "base": {
@@ -2502,10 +2454,10 @@ An example of a successful response:
"currency": "USD", "currency": "USD",
"issuer": "rMwjYedjc7qqtKYVLiAccJSmCwih4LnE2q" "issuer": "rMwjYedjc7qqtKYVLiAccJSmCwih4LnE2q"
}, },
"rate": 1, "rate": 0.0004093940882798027,
"count": 1481, "count": 3623,
"amount": 107909.9976469439, "amount": 536607.4024021383,
"convertedAmount": 107909.9976469439 "convertedAmount": 536607.4024021383
}, },
{ {
"base": { "base": {
@@ -2516,10 +2468,10 @@ An example of a successful response:
"currency": "USD", "currency": "USD",
"issuer": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B" "issuer": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B"
}, },
"rate": 0.16300752590344095, "rate": 0.002517187670715517,
"count": 341, "count": 871,
"amount": 114310.06014186383, "amount": 426317.9599118283,
"convertedAmount": 18633.40008959876 "convertedAmount": 69336.13037513298
}, },
{ {
"base": { "base": {
@@ -2530,10 +2482,10 @@ An example of a successful response:
"currency": "USD", "currency": "USD",
"issuer": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B" "issuer": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B"
}, },
"rate": 0.165410686020017, "rate": 0.002487380215448072,
"count": 350, "count": 833,
"amount": 187183.97960387194, "amount": 415914.584286911,
"convertedAmount": 30962.230478233323 "convertedAmount": 68454.74245510166
}, },
{ {
"base": { "base": {
@@ -2544,10 +2496,10 @@ An example of a successful response:
"currency": "USD", "currency": "USD",
"issuer": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B" "issuer": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B"
}, },
"rate": 0.00845173776394386, "rate": 0.048446318835714555,
"count": 154, "count": 441,
"amount": 739711.1344496784, "amount": 2687850.8059423557,
"convertedAmount": 6251.844529438101 "convertedAmount": 22713.59840285114
}, },
{ {
"base": { "base": {
@@ -2558,10 +2510,10 @@ An example of a successful response:
"currency": "USD", "currency": "USD",
"issuer": "rMwjYedjc7qqtKYVLiAccJSmCwih4LnE2q" "issuer": "rMwjYedjc7qqtKYVLiAccJSmCwih4LnE2q"
}, },
"rate": 0.00845173776394386, "rate": 0.048446318835714555,
"count": 1060, "count": 5186,
"amount": 5706197.2332384875, "amount": 27619591.096972037,
"convertedAmount": 48227.282644673694 "convertedAmount": 233398.48284757807
}, },
{ {
"base": { "base": {
@@ -2572,10 +2524,10 @@ An example of a successful response:
"currency": "CNY", "currency": "CNY",
"issuer": "rnuF96W4SZoCJmbHYBFoJZpR8eCaxNvekK" "issuer": "rnuF96W4SZoCJmbHYBFoJZpR8eCaxNvekK"
}, },
"rate": 0.00845173776394386, "rate": 0.048446318835714555,
"count": 219, "count": 1008,
"amount": 1215826.9527283495, "amount": 7269403.650447986,
"convertedAmount": 10275.850570794979 "convertedAmount": 61429.86611439055
}, },
{ {
"base": { "base": {
@@ -2586,12 +2538,21 @@ An example of a successful response:
"currency": "JPY", "currency": "JPY",
"issuer": "r94s8px6kSw1uZ1MV98dhSRTvc6VMPoPcN" "issuer": "r94s8px6kSw1uZ1MV98dhSRTvc6VMPoPcN"
}, },
"rate": 0.00845173776394386, "rate": 0.048446318835714555,
"count": 1138, "count": 2852,
"amount": 9094106.036672123, "amount": 26542137.8118745,
"convertedAmount": 76860.9994194516 "convertedAmount": 224293.4978679679
} }
] ],
"count": 172654,
"endTime": "2015-01-12T00:00:00+00:00",
"exchange": {
"currency": "USD",
"issuer": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B"
},
"exchangeRate": 0.020233489275945527,
"startTime": "2015-01-05T00:00:00+00:00",
"total": 10009613.959742112
} }
``` ```
@@ -2645,6 +2606,8 @@ POST /api/total_network_value
</div> </div>
[Try it! >](charts-api-tool.html#total-network-value)
The request includes the following body parameters: The request includes the following body parameters:
| Field | Value | Description | | Field | Value | Description |
@@ -2892,8 +2855,8 @@ The total amount of money sent, in payments and currency exchanges, for a [curat
``` ```
POST /api/total_value_sent POST /api/total_value_sent
{ {
"startTime": "2014-01-15T00:00:00.000Z", "startTime": "2015-01-01T00:00:00.000Z",
"endTime": "2014-01-16T00:00:00.000Z", "interval": "month",
"exchange": { "exchange": {
"currency": "USD", "currency": "USD",
"issuer": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B" "issuer": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B"
@@ -2903,13 +2866,15 @@ POST /api/total_value_sent
</div> </div>
[Try it! >](charts-api-tool.html#total-value-sent)
The request includes the following body parameters: The request includes the following body parameters:
| Field | Value | Description | | Field | Value | Description |
|-------|-------|-------------| |-------|-------|-------------|
| startTime | String ([Date-Time][]) | Retrieve information starting at this time. Defaults to 24 hours before the current time. | | startTime | String ([Date-Time][]) | (Optional) Retrieve information from the interval containing or starting at this time. Defaults to 24 hours before the current time. |
| endTime | String ([Date-Time][]) | (Optional) Retrieve information ending at this time. Defaults to the current time. | | interval | String | Retrieve information for an interval of this length. Valid values are `month`, `week`, or `day`. |
| exchange | Object ([Currency Object][]) | The currency from the request that is used to express the volume. | | exchange | Object ([Currency Object][]) | (Optional) Represent the volume of each market in terms of this currency. Defaults to XRP. |
#### Response Format #### #### Response Format ####
@@ -2917,128 +2882,129 @@ An example of a successful response:
```js ```js
{ {
"startTime": "2014-01-15T00:00:00+00:00", "rowkey": "transaction_volume|month|20150101000000",
"endTime": "2014-01-16T00:00:00+00:00",
"exchange": {
"currency": "USD",
"issuer": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B"
},
"exchangeRate": 0.021579751827645943,
"total": 755505.9176608312,
"count": 12435,
"components": [ "components": [
{ {
"currency": "USD", "currency": "USD",
"issuer": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B", "issuer": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B",
"amount": 41127.707337329506, "amount": 9066039.197471142,
"count": 217, "count": 49673,
"rate": 1, "rate": 1,
"convertedAmount": 41127.707337329506 "convertedAmount": 9066039.197471142
}, },
{ {
"currency": "BTC", "currency": "BTC",
"issuer": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B", "issuer": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B",
"amount": 41.918516276559075, "amount": 12322.744400761932,
"count": 111, "count": 26449,
"rate": 836.3421115008575, "rate": 249.97360755383627,
"convertedAmount": 35058.22041372048 "convertedAmount": 3080360.872822297
}, },
{ {
"currency": "BTC", "currency": "BTC",
"issuer": "rJHygWcTLVpSXkowott6kzgZU6viQSVYM1", "issuer": "rJHygWcTLVpSXkowott6kzgZU6viQSVYM1",
"amount": 1.2768145849842485, "amount": 2.0750693782824463,
"count": 14, "count": 19,
"rate": 849.2864280964847, "rate": 206.3432067399226,
"convertedAmount": 1084.381298222768 "convertedAmount": 428.1764697226175
}, },
{ {
"currency": "USD", "currency": "USD",
"issuer": "rMwjYedjc7qqtKYVLiAccJSmCwih4LnE2q", "issuer": "rMwjYedjc7qqtKYVLiAccJSmCwih4LnE2q",
"amount": 238540.0568303883, "amount": 24169595.842277594,
"count": 205, "count": 121079,
"rate": 0.902112870742654, "rate": 1.0045601252681042,
"convertedAmount": 215190.0554543774 "convertedAmount": 24279812.22699783
}, },
{ {
"currency": "BTC", "currency": "BTC",
"issuer": "rMwjYedjc7qqtKYVLiAccJSmCwih4LnE2q", "issuer": "rMwjYedjc7qqtKYVLiAccJSmCwih4LnE2q",
"amount": 1.2000099999999998, "amount": 119295.11119032024,
"count": 5, "count": 115273,
"rate": 694.0470227860804, "rate": 247.6297232015663,
"convertedAmount": 832.8633678135243 "convertedAmount": 29541015.363359075
}, },
{ {
"currency": "EUR", "currency": "EUR",
"issuer": "rMwjYedjc7qqtKYVLiAccJSmCwih4LnE2q", "issuer": "rMwjYedjc7qqtKYVLiAccJSmCwih4LnE2q",
"amount": 0, "amount": 12161779.117053518,
"count": 0, "count": 34018,
"rate": 0, "rate": 1.202596674172229,
"convertedAmount": 0 "convertedAmount": 14625715.118185826
}, },
{ {
"currency": "CNY", "currency": "CNY",
"issuer": "rnuF96W4SZoCJmbHYBFoJZpR8eCaxNvekK", "issuer": "rnuF96W4SZoCJmbHYBFoJZpR8eCaxNvekK",
"amount": 93632.5764443946, "amount": 14402245.292370766,
"count": 161, "count": 38738,
"rate": 0.16425234833298158, "rate": 0.15857204600050093,
"convertedAmount": 15379.370561459229 "convertedAmount": 2283793.5030123154
}, },
{ {
"currency": "CNY", "currency": "CNY",
"issuer": "razqQKzJRdB4UxFPWf5NEpEG3WMkmwgcXA", "issuer": "razqQKzJRdB4UxFPWf5NEpEG3WMkmwgcXA",
"amount": 26058.7512030993, "amount": 17882680.39132861,
"count": 293, "count": 42097,
"rate": 0.1625146758107911, "rate": 0.16168366526106312,
"convertedAmount": 4234.929503805744 "convertedAmount": 2891337.310362152
}, },
{ {
"currency": "CNY", "currency": "CNY",
"issuer": "rKiCet8SdvWxPXnAgYarFUXMh1zCPz432Y", "issuer": "rKiCet8SdvWxPXnAgYarFUXMh1zCPz432Y",
"amount": 0, "amount": 24416254.92038198,
"count": 0, "count": 134038,
"rate": 0, "rate": 0.16425884742617405,
"convertedAmount": 0 "convertedAmount": 4010585.8916855953
}, },
{ {
"currency": "JPY", "currency": "JPY",
"issuer": "rMAz5ZnK73nyNUL4foAvaxdreczCkG3vA6", "issuer": "rMAz5ZnK73nyNUL4foAvaxdreczCkG3vA6",
"amount": 0, "amount": 1193425912.8648715,
"count": 0, "count": 61429,
"rate": 0, "rate": 0.008080112652674486,
"convertedAmount": 0 "convertedAmount": 9643015.818569047
}, },
{ {
"currency": "JPY", "currency": "JPY",
"issuer": "r94s8px6kSw1uZ1MV98dhSRTvc6VMPoPcN", "issuer": "r94s8px6kSw1uZ1MV98dhSRTvc6VMPoPcN",
"amount": 0, "amount": 561857294.1293701,
"count": 0, "count": 39508,
"rate": 0, "rate": 0.008252613589614441,
"convertedAmount": 0 "convertedAmount": 4636791.140956038
}, },
{ {
"currency": "JPY", "currency": "JPY",
"issuer": "rJRi8WW24gt9X85PHAxfWNPCizMMhqUQwg", "issuer": "rJRi8WW24gt9X85PHAxfWNPCizMMhqUQwg",
"amount": 0, "amount": 214582946.10751072,
"count": 0, "count": 1181,
"rate": 0, "rate": 0.008380754739008903,
"convertedAmount": 0 "convertedAmount": 1798367.0425010128
}, },
{ {
"currency": "KRW", "currency": "KRW",
"issuer": "rUkMKjQitpgAM5WTGk79xpjT38DEJY283d", "issuer": "rUkMKjQitpgAM5WTGk79xpjT38DEJY283d",
"amount": 0, "amount": 6893715627.324748,
"count": 0, "count": 12289,
"rate": 0, "rate": 0.0008985058881862472,
"convertedAmount": 0 "convertedAmount": 6194044.082632835
}, },
{ {
"currency": "XRP", "currency": "XRP",
"amount": 20509892.479722, "amount": 8211627045.779512,
"count": 11429, "count": 1052459,
"rate": 0.021579751827645943, "rate": 0.017264153697157482,
"convertedAmount": 442598.3897241026 "convertedAmount": 141766791.42207274
} }
] ],
"count": 1728250,
"endTime": "2015-02-01T00:00:00+00:00",
"exchange": {
"currency": "USD",
"issuer": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B"
},
"exchangeRate": 0.017264153697157482,
"startTime": "2015-01-01T00:00:00+00:00",
"total": 253818097.16709763
} }
``` ```
@@ -3105,6 +3071,8 @@ POST /api/transaction_stats
</div> </div>
[Try it! >](charts-api-tool.html#transaction-stats)
The request includes the following body parameters: The request includes the following body parameters:
| Field | Value | Description | | Field | Value | Description |
@@ -3320,6 +3288,8 @@ POST /api/value_sent
</div> </div>
[Try it! >](charts-api-tool.html#value-sent)
The request includes the following body parameters: The request includes the following body parameters:
| Field | Value | Description | | Field | Value | Description |

9
js/apitool-methods-charts.js
View File

@@ -33,10 +33,9 @@ Request('Accounts Created', {
body: { body: {
"startTime": TIME_20140101, "startTime": TIME_20140101,
"endTime": "2015-03-31T00:00:00.000Z", "endTime": "2015-03-31T00:00:00.000Z",
"timeIncrement": "month", "timeIncrement": "week",
"descending": true, "descending": true,
"reduce": true, "reduce": true
"format": "json"
} }
}); });
@@ -185,7 +184,7 @@ Request('Top Markets', {
params: {}, params: {},
body: { body: {
"startTime": TIME_20150101, "startTime": TIME_20150101,
"endTime": TIME_20150101_2, "interval": "week",
"exchange": { "exchange": {
"currency": "USD", "currency": "USD",
"issuer": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B" "issuer": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B"
@@ -216,7 +215,7 @@ Request('Total Value Sent', {
params: {}, params: {},
body: { body: {
"startTime": TIME_20150101, "startTime": TIME_20150101,
"endTime": TIME_20150101_2, "interval": "month",
"exchange": { "exchange": {
"currency": "USD", "currency": "USD",
"issuer": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B" "issuer": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B"