diff --git a/content/charts_api.md b/content/charts_api.md index 6db02f59d4..91396827f8 100644 --- a/content/charts_api.md +++ b/content/charts_api.md @@ -116,195 +116,14 @@ To use a method in this document, append the path for that method to the hostnam The API provides the following methods: -* [Account Offers Exercised - `POST /api/account_offers_exercised`](#account-offers-exercised) -* [Account Transaction Stats - `POST /api/account_transaction_stats`](#account-transaction-stats) -* [Account Transactions - `POST /api/account_transactions`](#account-transactions) * [Accounts Created - `POST /api/accounts_created`](#accounts-created) * [Exchange Rates - `POST /api/exchange_rates`](#exchange-rates) * [Issuer Capitalization - `POST /api/issuer_capitalization`](#issuer-capitalization) -* [Ledgers Closed - `POST /api/ledgers_closed`](#ledgers-closed) * [Market Traders - `POST /api/market_traders`](#market-traders) -* [Offers - `POST /api/offers`](#offers) * [Offers Exercised - `POST /api/offers_exercised`](#offers-exercised) * [Top Markets - `POST /api/top_markets`](#top-markets) -* [Total Network Value - `POST /api/total_network_value`](#total-network-value) -* [Total Value Sent - `POST /api/total_value_sent`](#total-value-sent) -* [Transaction Stats - `POST /api/transaction_stats`](#transaction-stats) -* [Value Sent - `POST /api/value_sent`](#value-sent) - -## Account Offers Exercised ## -[[Source]
](https://github.com/ripple/ripple-data-api/blob/master/api/routes/accountOffersExercised.js "Source") - -Retrieve currency-exchange orders being exercised for a single account. - -#### Request Format #### - -
- -*JSON* - -``` -POST /api/account_offers_exercised -{ - "account": "rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn", - "startTime": "2014", - "limit": 5, - "offset": 0, - "format": "json" -} -``` - -*CSV* - -``` -POST /api/account_offers_exercised -{ - "account": "rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn", - "startTime": "2014", - "limit": 5, - "offset": 0, - "format": "csv" -} -``` - -*Array* - -``` -POST /api/account_offers_exercised -{ - "account": "rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn", - "startTime": "2014", - "limit": 5, - "offset": 0 -} -``` - -
- -[Try it! >](charts-api-tool.html#account-offers-exercised) - -The request includes the following body parameters: - -| Field | Value | Description | -|-------|-------|-------------| -| account | String (Ripple address) | Retrieve currency-exchange orders exercised as a result of this account sending a transaction, or another transaction modifying an order previously placed by this account. | -| startTime | String ([Date-Time][]) | (Optional) Retrieve information starting at this time. Defaults to 30 days before `endTime`. | -| endTime | String ([Date-Time][]) | (Optional) Retrieve information ending at this time. Defaults to the current time. | -| descending | Boolean | (Optional) If true, return results in descending order. Defaults to false. | -| limit | Number | (Optional) The maximum number of transactions to return in one response. Use with `offset` to paginate results. Defaults to 500. | -| offest | Number | (Optional) The number of transactions to skip before returning results. Use with `limit` to paginate results. Defaults to 0. | -| format | String | (Optional) The [Response Format][] to use: `csv` or `json`. If omitted, defaults to a CSV-like JSON array format. | - -#### Response Format #### - -The format of the response depends on the `format` parameter from the request. See [Response Format][] for details. Examples of successful responses: - -
- -*JSON* - -``` -{ - "account": "rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn", - "startTime": "2014-01-01T00:00:00+00:00", - "endTime": "2015-03-09T21:05:27+00:00", - "results": [ - { - "base": { - "currency": "XRP", - "issuer": null, - "amount": 0.00001 - }, - "counter": { - "currency": "USD", - "issuer": "rsP3mgGb2tcYUrxiLFiHJiQXhsziegtwBc", - "amount": 5.080000065049717e-8 - }, - "type": "buy", - "rate": 196.8503937007874, - "counterparty": "rUrgXPxenRbjnFDXKWUhH8mBJcQ2CyPfkG", - "time": "2014-09-17T21:47:00+00:00", - "txHash": "9D591B18EDDD34F0B6CF4223A2940AEA2C3CC778925BABF289E0011CD8FA056E", - "ledgerIndex": 8924146 - } - ] -} -``` - -*CSV* - -``` -baseCurrency, baseIssuer, baseAmount, counterCurrency, counterIssuer, counterAmount, type, rate, counterparty, time, txHash, ledgerIndex -XRP, , 0.00001, USD, rsP3mgGb2tcYUrxiLFiHJiQXhsziegtwBc, 5.080000065049717e-8, buy, 196.8503937007874, rUrgXPxenRbjnFDXKWUhH8mBJcQ2CyPfkG, 2014-09-17T21:47:00+00:00, 9D591B18EDDD34F0B6CF4223A2940AEA2C3CC778925BABF289E0011CD8FA056E, 8924146 -``` - -*Array* - -``` -[ - [ - "baseCurrency", - "baseIssuer", - "baseAmount", - "counterCurrency", - "counterIssuer", - "counterAmount", - "type", - "rate", - "counterparty", - "time", - "txHash", - "ledgerIndex" - ], - [ - "XRP", - null, - 0.00001, - "USD", - "rsP3mgGb2tcYUrxiLFiHJiQXhsziegtwBc", - 5.080000065049717e-8, - "buy", - 196.8503937007874, - "rUrgXPxenRbjnFDXKWUhH8mBJcQ2CyPfkG", - "2014-09-17T21:47:00+00:00", - "9D591B18EDDD34F0B6CF4223A2940AEA2C3CC778925BABF289E0011CD8FA056E", - 8924146 - ] -] -``` - -
- -Each result in the response describes an individual transaction that exercised a currency exchange on the account. This includes [OfferCreate](transactions.html#offercreate) and cross-currency [Payment](transactions.html#payment) transactions that the account sent, as well as transactions that consumed an offer that the account had previously placed. - -| Field | Type | Description | -|-------|------|-------------| -| base | Object ([Currency Amount][Currency Object]) | (JSON format only) Amount of one currency exchanged in this transaction. | -| baseCurrency | String ([currency name][Currency Object]) | (CSV and array formats only) Name of the base currency exchanged in this transaction. | -| baseIssuer | String ([currency issuer][Currency Object]) | (CSV and array formats only) Issuer of the base currency exchanged in this transaction. | -| baseAmount | String ([currency amount][Currency Object]) | (CSV and array formats only) Quantity of the base currency exchanged in this transaction. | -| counter | Object ([Currency Amount][Currency Object]) | (JSON format only) Amount of the other currency exchanged in this transaction. | -| counterCurrency | String ([currency name][Currency Object]) | (CSV and array formats only) Name of the counter currency exchanged in this transaction. | -| counterIssuer | String ([currency issuer][Currency Object]) | (CSV and array formats only) Issuer of the counter currency exchanged in this transaction. | -| counterAmount | String ([currency amount][Currency Object]) | (CSV and array formats only) Quantity of the counter currency exchanged in this transaction. | -| type | String | Either `buy` or `sell`. If the specified account sent the transaction, `buy` means the account acquired the counter currency. If another account sent the transaction, `buy` means the specified account acquired the base currency. (In both cases, `sell` means the reverse.) | -| rate | Number | The exchange ratio between the base and counter currency. | -| counterparty | String (Ripple address) | The other account involved in this exchange. | -| time | String ([Date-Time][]) | The time this transaction occurred, as defined by the close time of the ledger that included it. | -| txHash | String (Transaction Hash) | The identifying hash of the Ripple transaction that performed this exchange, as a hex string. | -| ledgerIndex | Number | The sequence number of the ledger that included this transaction. | - - -## Account Transaction Stats ## -[[Source]
](https://github.com/ripple/ripple-data-api/blob/develop/api/routes/accountTransactionStats.js "Source") - -**DEPRECATED** This API method may return inaccurate results. Do not use it. - -## Account Transactions ## -[[Source]
](https://github.com/ripple/ripple-data-api/blob/develop/api/routes/accountTransactions.js "Source") - -**DEPRECATED** This API method may return inaccurate results. Do not use it. +As of August 19, 2015, the following methods are no longer available: Account Transaction Stats, Account Transactions, Account Offers Exercised, Ledgers Closed, Offers, Total Network Value, Total Value Sent, Transaction Stats, and Value Sent. ## Accounts Created ## [[Source]
](https://github.com/ripple/ripple-data-api/blob/develop/api/routes/accountsCreated.js "Source") @@ -844,215 +663,6 @@ A successful result contains a **JSON array** of objects representing the issuer The list of gateway names and hot wallets is defined by the [gateways.json](https://github.com/ripple/ripple-data-api/blob/a6c23a8c1bc5f073f2dd2bf32e8d763b66b6a2e3/api/gateways.json) file in the server tree. In the future, this may be [expanded to use host-meta](https://ripplelabs.atlassian.net/browse/RD-75). -## Ledgers Closed ## -[[Source]
](https://github.com/ripple/ripple-data-api/blob/develop/api/routes/ledgersClosed.js "Source") - -Retrieve information about ledgers closed over time. - -#### Request Format #### - -
- -*Reduced* - -``` -POST /api/ledgers_closed -{ - "startTime": "2014-01-01T10:00:00.000Z", - "endTime": "2015-01-01T10:00:00.000Z", - "timeIncrement": "month", - "descending": false, - "reduce": true, - "format": "json" -} -``` - -*Expanded* - -``` -POST /api/ledgers_closed -{ - "startTime": "2015-01-01T10:00:00.000Z", - "endTime": "2015-01-02T10:00:00.000Z", - "descending": false, - "reduce": false, - "limit": 50, - "offset": 0, - "format": "json" -} -``` - -*Minimal* - -``` -POST /api/ledgers_closed -{} -``` - -
- -[Try it! >](charts-api-tool.html#ledgers-closed) - -The request includes the following body parameters: - -| Field | Value | Description | -|-------|-------|-------------| -| startTime | String ([Date-Time][]) | (Optional) Retrieve information starting at this time. Defaults to 30 days before `endTime`. | -| endTime | String ([Date-Time][]) | (Optional) Retrieve information ending at this time. Defaults to the current 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`. Ignored if `reduce` is `false`. | -| descending | Boolean | (Optional) If true, return results with the most recent first. Defaults to true. | -| reduce | Boolean | (Optional) If `false`, include ledgers individually instead of collapsing them into results over time. Defaults to `true`. | -| limit | Number | (Optional) The maximum number of ledgers to return in one response. Use with `offset` to paginate results. Ignored if `reduce` is false. Defaults to 500. | -| offest | Number | (Optional) The number of transactions to skip before returning results. Use with `limit` to paginate results. Ignored if `reduce` is false. Defaults to 0. | -| format | String | (Optional) The [Response Format][] to use: `csv` or `json`. If omitted, defaults to a CSV-like JSON array format. | - -#### Response Format #### - -The format of the response depends on the `format` and `reduce` parameters from the request. See [Response Format][] for details. Examples of successful responses: - -
- -*Reduced* - -``` -{ - "startTime": "2014-01-01T00:00:00+00:00", - "endTime": "2015-01-01T00:00:00+00:00", - "timeIncrement": "month", - "total": 6655524, - "results": [ - { - "time": "2014-01-01T00:00:00+00:00", - "count": 551361 - }, - { - "time": "2014-02-01T00:00:00+00:00", - "count": 528527 - }, - { - "time": "2014-03-01T00:00:00+00:00", - "count": 565889 - }, - { - "time": "2014-04-01T00:00:00+00:00", - "count": 546201 - }, - { - "time": "2014-05-01T00:00:00+00:00", - "count": 569552 - }, - { - "time": "2014-06-01T00:00:00+00:00", - "count": 551485 - }, - { - "time": "2014-07-01T00:00:00+00:00", - "count": 569394 - }, - { - "time": "2014-08-01T00:00:00+00:00", - "count": 558809 - }, - { - "time": "2014-09-01T00:00:00+00:00", - "count": 504121 - }, - { - "time": "2014-10-01T00:00:00+00:00", - "count": 558358 - }, - { - "time": "2014-11-01T00:00:00+00:00", - "count": 547955 - }, - { - "time": "2014-12-01T00:00:00+00:00", - "count": 603870 - }, - { - "time": "2015-01-01T00:00:00+00:00", - "count": 2 - } - ] -} -``` - -*Expanded* - -``` -{ - "startTime": "2015-01-01T00:00:00+00:00", - "endTime": "2015-01-02T00:00:00+00:00", - "total": 10, - "results": [ - { - "time": "2015-01-01T00:00:00+00:00", - "ledgerIndex": 10852618 - }, - { - "time": "2015-01-01T00:00:00+00:00", - "ledgerIndex": 10852619 - }, - { - "time": "2015-01-01T00:00:10+00:00", - "ledgerIndex": 10852620 - }, - { - "time": "2015-01-01T00:00:10+00:00", - "ledgerIndex": 10852621 - }, - { - "time": "2015-01-01T00:00:20+00:00", - "ledgerIndex": 10852622 - }, - { - "time": "2015-01-01T00:00:20+00:00", - "ledgerIndex": 10852623 - }, - { - "time": "2015-01-01T00:00:20+00:00", - "ledgerIndex": 10852624 - }, - { - "time": "2015-01-01T00:00:30+00:00", - "ledgerIndex": 10852625 - }, - { - "time": "2015-01-01T00:00:30+00:00", - "ledgerIndex": 10852626 - }, - { - "time": "2015-01-01T00:00:40+00:00", - "ledgerIndex": 10852627 - } - ] -} -``` - -*Minimal* - -``` -581851 -``` - -
- -**If results are reduced** (the default), then each result represents an interval of time, with the following attributes, in order: - -| Field | Type | Description | -|-------|------|-------------| -| time | String ([Date-Time][]) | The start time of this interval. | -| count | Number | The number of ledgers that closed during this interval. | - -**If the results are not reduced** (the request used `"reduce":false`), then each result represents an individual ledger, with the following attributes: - -| Field | Type | Description | -|-------|------|-------------| -| time | String ([Date-Time][]) | The approximate time this ledger closed. | -| ledgerIndex | Number | The sequence number of this ledger. | - -**If neither reduce nor timeIncrement are provided**, the response body is simply an integer indicating the number of ledgers closed during the requested window. - ## Market Traders ## [[Source]
](https://github.com/ripple/ripple-data-api/blob/develop/api/routes/marketTraders.js "Source") @@ -1696,214 +1306,6 @@ If transactions are included, each transaction is represented as an array with t | Number | The sequence number of the ledger that included this transaction. | -## Offers ## -[[Source]
](https://github.com/ripple/ripple-data-api/blob/develop/api/routes/offers.js "Source") - -Returns all currency-exchange orders and cancellations over time for a specified currency pair, including unfulfilled offers. - -#### Request Format #### - -
- -*Reduced* - -``` -POST /api/offers -{ - "base": { - "currency": "GBP", - "issuer": "rMwjYedjc7qqtKYVLiAccJSmCwih4LnE2q" - }, - "counter": { - "currency": "XRP" - }, - "startTime": "2015-03-01T10:00:00.000Z", - "endTime": "2015-03-07T10:00:00.000Z", - "timeIncrement": "day", - "descending": false, - "reduce": true, - "format": "json" -} -``` - -*Expanded* - -``` -POST /api/offers -{ - "base": { - "currency": "GBP", - "issuer": "rMwjYedjc7qqtKYVLiAccJSmCwih4LnE2q" - }, - "counter": { - "currency": "XRP" - }, - "startTime": "2015-03-01T10:00:00.000Z", - "endTime": "2015-03-07T10:00:00.000Z", - "descending": false, - "reduce": false, - "limit": 5, - "offset": 0, - "format": "json" -} -``` - -
- -[Try it! >](charts-api-tool.html#offers) - -The request includes the following body parameters: - -| Field | Value | Description | -|-------|-------|-------------| -| base | Object ([Currency Object][]) | One of the currencies being exchanged. | -| counter | Object ([Currency Object][]) | The other of the currencies being exchanged. | -| startTime | String ([Date-Time][]) | Retrieve information starting 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`. | -| descending | Boolean | (Optional) If true, return results in descending order. Defaults to false. | -| reduce | Boolean | (Optional) If `false`, include transactions individually instead of collapsing them into results over time. Defaults to `true`. Ignored if `timeIncrement` is provided. | -| 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. | -| offset | Number | (Optional) If reduce is `false`, this value defines a number of transactions to skip before returning results. Use with `limit` to paginate results. Defaults to 0. | -| format | String | (Optional) The [Response Format][] to use: `csv` or `json`. If omitted, defaults to a CSV-like JSON array format. | - -#### Response Format #### - -The format of the response depends on the `format` and `reduce` parameters from the request. See [Response Format][] for details. Examples of successful responses: - -
- -*Reduced* - -``` -{ - "base": { - "currency": "GBP", - "issuer": "rMwjYedjc7qqtKYVLiAccJSmCwih4LnE2q" - }, - "counter": { - "currency": "XRP" - }, - "startTime": "2015-03-01T00:00:00+00:00", - "endTime": "2015-03-07T00:00:00+00:00", - "timeIncrement": "day", - "results": [ - { - "time": "2015-03-01T00:00:00.000Z", - "OfferCreate": 14, - "OfferCancel": 15 - }, - { - "time": "2015-03-02T00:00:00.000Z", - "OfferCreate": 7, - "OfferCancel": 6 - }, - { - "time": "2015-03-03T00:00:00.000Z", - "OfferCreate": 23, - "OfferCancel": 23 - }, - { - "time": "2015-03-05T00:00:00.000Z", - "OfferCreate": 0, - "OfferCancel": 1 - } - ] -} -``` - -*Expanded* - -``` -{ - "base": { - "currency": "GBP", - "issuer": "rMwjYedjc7qqtKYVLiAccJSmCwih4LnE2q" - }, - "counter": { - "currency": "XRP" - }, - "startTime": "2015-03-01T00:00:00+00:00", - "endTime": "2015-03-07T00:00:00+00:00", - "results": [ - { - "type": "OfferCancel", - "account": "rUBLCjWdsPPMkppdFXVJWhHnr3FNqCzgG3", - "baseAmount": 21244.787159, - "counterAmount": 170.88055684, - "price": 124.3253624161118, - "time": "2015-03-01T01:45:40+00:00", - "txHash": "C604881B175DEB22EC385BDD823899D35C9634F1686B3879A149704EB5EC0D81", - "ledgerIndex": 11992359 - }, - { - "type": "OfferCreate", - "account": "rUBLCjWdsPPMkppdFXVJWhHnr3FNqCzgG3", - "baseAmount": 21567.217829, - "counterAmount": 170.88055684, - "price": 126.21223986994579, - "time": "2015-03-01T01:46:50+00:00", - "txHash": "BBC91163FBD9F51338CFE96F14C3C0622DCA192C39B89BCB99D35549FECA0D4B", - "ledgerIndex": 11992373 - }, - { - "type": "OfferCancel", - "account": "rUBLCjWdsPPMkppdFXVJWhHnr3FNqCzgG3", - "baseAmount": 21567.217829, - "counterAmount": 170.88055684, - "price": 126.21223986994579, - "time": "2015-03-01T12:10:50+00:00", - "txHash": "BB0F8E6395CDE8D64B04638CAA3953D74AB791770D8123B39AF8BC0CBE81FEB9", - "ledgerIndex": 12000709 - }, - { - "type": "OfferCreate", - "account": "rUBLCjWdsPPMkppdFXVJWhHnr3FNqCzgG3", - "baseAmount": 22015.655577, - "counterAmount": 170.88055684, - "price": 128.8365158922898, - "time": "2015-03-01T12:11:40+00:00", - "txHash": "E0A861F84489E29ED5003913DA57E7EE2BBDDDD6B207E906D8B276F9956316C4", - "ledgerIndex": 12000721 - }, - { - "type": "OfferCancel", - "account": "rUBLCjWdsPPMkppdFXVJWhHnr3FNqCzgG3", - "baseAmount": 22015.655577, - "counterAmount": 170.88055684, - "price": 128.8365158922898, - "time": "2015-03-01T13:10:50+00:00", - "txHash": "3EA9920CC8466E2CC50F2DF37D5A43A06B4DC8251E7CB66B015EAC482F0691DD", - "ledgerIndex": 12001477 - } - ] -} -``` - -
- -**If results are reduced** (the default), then each result represents an interval of time, with the following attributes, in order: - -| Field | Type | Description | -|-------|------|-------------| -| time | String ([Date-Time][]) | The start time of this interval. | -| OfferCreate | Number | The number of [currency-exchange order creation transactions](transactions.html#offercreate) in this interval. | -| OfferCancel | Number | The number of [currency-exchange order cancellation transactions](transactions.html#offercancel) in this interval. | - -**Note:** An `OfferCreate`-type transaction can cancel a previous order in addition to creating a new one. - -**If the results are not reduced** (the request used `"reduce":false`), then each result represents an individual transaction, with the following attributes: - -| Field | Type | Description | -|-------|------|-------------| -| type | String | The [type of this transaction](transactions.html): `OfferCreate` or `OfferCancel`. -| account | String (Ripple Address) | The account that sent this transaction. | -| baseAmount | Object ([Currency Amount][Currency Object]) | The amount of the base currency exchanged in this transaction. | -| counterAmount | Object ([Currency Amount][Currency Object]) | The amount of the counter currency exchanged in this transaction. | -| price | Number | The amount of counter currency received for each unit of the base currency spent in this transaction. | -| time | String ([Date-Time][]) | The approximate time this transaction occurred. | -| txHash | String (Transaction Hash) | The identifying hash of this transaction. | -| ledgerIndex | Number | The sequence number of the ledger where this transaction occurred. | ## Offers Exercised ## @@ -2561,812 +1963,4 @@ Each member of the `components` array has the following fields: **Note:** If there are no trades in a market during the requested period, the `rate` is defined as 0. -## Total Network Value ## -[[Source]
](https://github.com/ripple/ripple-data-api/blob/develop/api/routes/totalNetworkValue.js "Source") - -Retrieve the total amount of currency held in the network, as of a specified time. - -#### Request Format #### - -
- -*Request* - -``` -POST /api/total_network_value -{ - "time": "2014-12-24T00:00:00.000Z", - "exchange":{ - "currency": "USD", - "issuer": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B" - } -} -``` - -
- -[Try it! >](charts-api-tool.html#total-network-value) - -The request includes the following body parameters: - -| Field | Value | Description | -|-------|-------|-------------| -| time | Object ([Date-Time][]) | (Optional) Calculate results at this point in time. Defaults to the current time. | -| exchange | Object ([Currency Object][]) | (Optional) Express the total network value in terms of this currency. Defaults to XRP. | - -#### Response Format #### - -An example of a successful response: - -```js -{ - "time": "2014-12-24T00:00:00+00:00", - "exchange": { - "currency": "USD", - "issuer": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B" - }, - "exchangeRate": 0.02390745076867089, - "total": 2403965823.842066, - "components": [ - { - "currency": "USD", - "issuer": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B", - "name": "Bitstamp", - "hotwallets": [ - "rrpNnNLKrartuEqfJGpqyDwPj1AFPg9vn1", - "rGFuMiw48HdbnrUbkRYuitXTmfrDBNTCnX" - ], - "amount": 2646521.4813476186, - "rate": 1, - "convertedAmount": 2646521.4813476186 - }, - { - "currency": "USD", - "issuer": "rMwjYedjc7qqtKYVLiAccJSmCwih4LnE2q", - "name": "SnapSwap", - "hotwallets": [ - "ra7JkEzrgeKHdzKgo4EUUVBnxggY4z37kt", - "rQsAshmCjPsxkYnxY9GnmBTAeEUaePDAie", - "rEk9i7G8ac1kUs1mFjtze1qjj9FzGvXAG", - "rsTQ7iwrCik9Ugc3zbpcbo2K3SbAdYJss1", - "rwm98fCBS8tV1YB8CGho8zUPW5J7N41th2", - "rnd8KJ4qeip6FPJvC1fyv82nW2Lm8C8KjQ", - "r5ymZSvtdNgbKVc8ay1Jhmq5f9QgnvEtj" - ], - "amount": 3423391.3201022753, - "rate": 1.0133549934987702, - "convertedAmount": 3469110.688925987 - }, - { - "currency": "BTC", - "issuer": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B", - "name": "Bitstamp", - "hotwallets": [ - "rrpNnNLKrartuEqfJGpqyDwPj1AFPg9vn1", - "rGFuMiw48HdbnrUbkRYuitXTmfrDBNTCnX" - ], - "amount": 4618.960079657584, - "rate": 339.1489364416104, - "convertedAmount": 1566515.3984821255 - }, - { - "currency": "BTC", - "issuer": "rMwjYedjc7qqtKYVLiAccJSmCwih4LnE2q", - "name": "SnapSwap", - "hotwallets": [ - "ra7JkEzrgeKHdzKgo4EUUVBnxggY4z37kt", - "rQsAshmCjPsxkYnxY9GnmBTAeEUaePDAie", - "rEk9i7G8ac1kUs1mFjtze1qjj9FzGvXAG", - "rsTQ7iwrCik9Ugc3zbpcbo2K3SbAdYJss1", - "rwm98fCBS8tV1YB8CGho8zUPW5J7N41th2", - "rnd8KJ4qeip6FPJvC1fyv82nW2Lm8C8KjQ", - "r5ymZSvtdNgbKVc8ay1Jhmq5f9QgnvEtj" - ], - "amount": 4553.083622174116, - "rate": 335.89151565461424, - "convertedAmount": 1529342.1587542647 - }, - { - "currency": "BTC", - "issuer": "rJHygWcTLVpSXkowott6kzgZU6viQSVYM1", - "name": "Justcoin", - "hotwallets": [], - "amount": 214.02645083481798, - "rate": 289.21948875946936, - "convertedAmount": 61900.62069144976 - }, - { - "currency": "EUR", - "issuer": "rMwjYedjc7qqtKYVLiAccJSmCwih4LnE2q", - "name": "SnapSwap", - "hotwallets": [ - "ra7JkEzrgeKHdzKgo4EUUVBnxggY4z37kt", - "rQsAshmCjPsxkYnxY9GnmBTAeEUaePDAie", - "rEk9i7G8ac1kUs1mFjtze1qjj9FzGvXAG", - "rsTQ7iwrCik9Ugc3zbpcbo2K3SbAdYJss1", - "rwm98fCBS8tV1YB8CGho8zUPW5J7N41th2", - "rnd8KJ4qeip6FPJvC1fyv82nW2Lm8C8KjQ", - "r5ymZSvtdNgbKVc8ay1Jhmq5f9QgnvEtj" - ], - "amount": 377998.6458813907, - "rate": 1.2709529373414195, - "convertedAmount": 480418.4892940326 - }, - { - "currency": "CNY", - "issuer": "rnuF96W4SZoCJmbHYBFoJZpR8eCaxNvekK", - "name": "rippleCN", - "hotwallets": [ - "rNaptDNfFXo1quhKwMaNPf66iwPqA8YLky", - "rno91tGDJeRcnM7EMXj8KG9UTyxRGMMz8s" - ], - "amount": 4654048.165312849, - "rate": 0.1618097193244357, - "convertedAmount": 753070.227351677 - }, - { - "currency": "CNY", - "issuer": "razqQKzJRdB4UxFPWf5NEpEG3WMkmwgcXA", - "name": "RippleChina", - "hotwallets": [ - "r45dBj4S3VvMMYXxr9vHX4Z4Ma6ifPMCkK" - ], - "amount": 2233083.979247972, - "rate": 0.1586128864797496, - "convertedAmount": 354195.8957002061 - }, - { - "currency": "CNY", - "issuer": "rKiCet8SdvWxPXnAgYarFUXMh1zCPz432Y", - "name": "Ripple Fox", - "hotwallets": [ - "rLSnkKvMfPD9abLoQFxQJMYyZqJcsqkL3o", - "rPcQaiyDxMwLr7Q9eFmn5VnVx2RN57MUmN", - "r3ipidkRUZWq8JYVjnSnNMf3v7o69vgLEW" - ], - "amount": 854758.6787252785, - "rate": 0.16085453749001152, - "convertedAmount": 137491.811931928 - }, - { - "currency": "JPY", - "issuer": "rMAz5ZnK73nyNUL4foAvaxdreczCkG3vA6", - "name": "Ripple Trade Japan", - "hotwallets": [ - "r3bStftDydy4dKEUBc9YMabTTk98uZzMpF" - ], - "amount": 61129214.7353749, - "rate": 0.007831461299902996, - "convertedAmount": 478731.07949354843 - }, - { - "currency": "JPY", - "issuer": "r94s8px6kSw1uZ1MV98dhSRTvc6VMPoPcN", - "name": "TokyoJPY", - "hotwallets": [], - "amount": 175691868.2021911, - "rate": 0.008018224568263696, - "convertedAmount": 1408736.8540629558 - }, - { - "currency": "JPY", - "issuer": "rJRi8WW24gt9X85PHAxfWNPCizMMhqUQwg", - "name": "Ripple Market Japan", - "hotwallets": [], - "amount": 29743906.757837094, - "rate": 0.007931783750900699, - "convertedAmount": 235922.23631011773 - }, - { - "currency": "XAU", - "issuer": "r9Dr5xwkeLegBeXq6ujinjSBLQzQ1zQGjH", - "name": "Ripple Singapore", - "hotwallets": [ - "rL4A1qbTkrJXT644gyzmLVk6uudyMagJ9Q" - ], - "amount": 52.747091158245624, - "rate": 0, - "convertedAmount": 0 - }, - { - "currency": "XAU", - "issuer": "rrh7rf1gV2pXAoqA8oYbpHd8TKv5ZQeo67", - "name": "GBI", - "hotwallets": [], - "amount": 0, - "rate": 0, - "convertedAmount": 0 - }, - { - "currency": "KRW", - "issuer": "rUkMKjQitpgAM5WTGk79xpjT38DEJY283d", - "name": "Pax Moneta", - "hotwallets": [ - "rhLSigWL4J9JBBW1JFMBvaduDkVghG7cc2" - ], - "amount": 135974484.5037933, - "rate": 0.0008632373432934944, - "convertedAmount": 117378.25275875695 - }, - { - "currency": "XRP", - "amount": 99999222492.58995, - "rate": 0.02390745076867089, - "convertedAmount": 2390726488.646961 - } - ] -} -``` - -A successful result contains the following fields: - -| Field | Type | Description | -|-------|------|-------------| -| time | Object ([Date-Time][]) | Values are calculated for this time, from the request. | -| exchange | Object ([Currency Object][]) | Values are expressed in this currency, from the request. | -| exchangeRate | Number | The amount of the `exchange` currency necessary to buy 1 XRP. | -| total | Number | The total value of all currency issued by [a selection of large gateways](https://github.com/ripple/ripple-data-api/blob/develop/api/library/metrics/networkValue.js), and all XRP in the network (including including XRP that is [held in reserve by Ripple Labs](https://www.ripplelabs.com/xrp-distribution/)). | -| components | Array | A list of the gateways and XRP that contributed to the `total` value. | - -Each member of the `components` array is an object representing a currency issued by a specific gateway, except for one member that represents the XRP native to the network. Each object has the following properties: - -| Field | Type | Description | -|-------|------|-------------| -| currency | String | Currency code for this currency. | -| issuer | String (Ripple Address) | (Omitted for XRP) The Ripple account of the gateway issuing this currency. | -| name | String | (Omitted for XRP) The name of the gateway issuing this currency. | -| hotwallets | Array of Strings | (Omitted for XRP) Each member of this list is the Ripple Address of an account that the gateway uses as a hot wallet. | -| amount | Number | The total amount of this currency issued as of the requested time. | -| rate | Number | The amount of the `exchange` currency necessary to buy 1 unit of this currency. (This is `0` if no amount exists at the time.) | -| convertedAmount | Number | The total amount of this currency issued as of the requested time, converted to the `exchange` currency. | - -## Total Value Sent ## -[[Source]
](https://github.com/ripple/ripple-data-api/blob/develop/api/routes/totalValueSent.js "Source") - -The total amount of money sent, in payments and currency exchanges, for a [curated list of currencies and issuers](https://github.com/ripple/ripple-data-api/blob/develop/api/library/metrics/transactionVolume.js). Results are normalized to a single currency. - -#### Request Format #### - -
- -*Request* - -``` -POST /api/total_value_sent -{ - "startTime": "2015-01-01T00:00:00.000Z", - "interval": "month", - "exchange": { - "currency": "USD", - "issuer": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B" - } -} -``` - -
- -[Try it! >](charts-api-tool.html#total-value-sent) - -The request includes the following body parameters: - -| Field | Value | Description | -|-------|-------|-------------| -| startTime | String ([Date-Time][]) | (Optional) Retrieve information from the interval containing or starting at this time. Defaults to 24 hours before the current time. | -| interval | String | Retrieve information for an interval of this length. Valid values are `month`, `week`, or `day`. | -| exchange | Object ([Currency Object][]) | (Optional) Represent the volume of each market in terms of this currency. Defaults to XRP. | - -#### Response Format #### - -An example of a successful response: - -```js -{ - "rowkey": "transaction_volume|month|20150101000000", - "components": [ - { - "currency": "USD", - "issuer": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B", - "amount": 9066039.197471142, - "count": 49673, - "rate": 1, - "convertedAmount": 9066039.197471142 - }, - { - "currency": "BTC", - "issuer": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B", - "amount": 12322.744400761932, - "count": 26449, - "rate": 249.97360755383627, - "convertedAmount": 3080360.872822297 - }, - { - "currency": "BTC", - "issuer": "rJHygWcTLVpSXkowott6kzgZU6viQSVYM1", - "amount": 2.0750693782824463, - "count": 19, - "rate": 206.3432067399226, - "convertedAmount": 428.1764697226175 - }, - { - "currency": "USD", - "issuer": "rMwjYedjc7qqtKYVLiAccJSmCwih4LnE2q", - "amount": 24169595.842277594, - "count": 121079, - "rate": 1.0045601252681042, - "convertedAmount": 24279812.22699783 - }, - { - "currency": "BTC", - "issuer": "rMwjYedjc7qqtKYVLiAccJSmCwih4LnE2q", - "amount": 119295.11119032024, - "count": 115273, - "rate": 247.6297232015663, - "convertedAmount": 29541015.363359075 - }, - { - "currency": "EUR", - "issuer": "rMwjYedjc7qqtKYVLiAccJSmCwih4LnE2q", - "amount": 12161779.117053518, - "count": 34018, - "rate": 1.202596674172229, - "convertedAmount": 14625715.118185826 - }, - { - "currency": "CNY", - "issuer": "rnuF96W4SZoCJmbHYBFoJZpR8eCaxNvekK", - "amount": 14402245.292370766, - "count": 38738, - "rate": 0.15857204600050093, - "convertedAmount": 2283793.5030123154 - }, - { - "currency": "CNY", - "issuer": "razqQKzJRdB4UxFPWf5NEpEG3WMkmwgcXA", - "amount": 17882680.39132861, - "count": 42097, - "rate": 0.16168366526106312, - "convertedAmount": 2891337.310362152 - }, - { - "currency": "CNY", - "issuer": "rKiCet8SdvWxPXnAgYarFUXMh1zCPz432Y", - "amount": 24416254.92038198, - "count": 134038, - "rate": 0.16425884742617405, - "convertedAmount": 4010585.8916855953 - }, - { - "currency": "JPY", - "issuer": "rMAz5ZnK73nyNUL4foAvaxdreczCkG3vA6", - "amount": 1193425912.8648715, - "count": 61429, - "rate": 0.008080112652674486, - "convertedAmount": 9643015.818569047 - }, - { - "currency": "JPY", - "issuer": "r94s8px6kSw1uZ1MV98dhSRTvc6VMPoPcN", - "amount": 561857294.1293701, - "count": 39508, - "rate": 0.008252613589614441, - "convertedAmount": 4636791.140956038 - }, - { - "currency": "JPY", - "issuer": "rJRi8WW24gt9X85PHAxfWNPCizMMhqUQwg", - "amount": 214582946.10751072, - "count": 1181, - "rate": 0.008380754739008903, - "convertedAmount": 1798367.0425010128 - }, - { - "currency": "KRW", - "issuer": "rUkMKjQitpgAM5WTGk79xpjT38DEJY283d", - "amount": 6893715627.324748, - "count": 12289, - "rate": 0.0008985058881862472, - "convertedAmount": 6194044.082632835 - }, - { - "currency": "XRP", - "amount": 8211627045.779512, - "count": 1052459, - "rate": 0.017264153697157482, - "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 -} -``` - -A successful result contains the following fields: - -| Field | Type | Description | -|-------|------|-------------| -| startTime | Object ([Date-Time][]) | The starting time from the request. | -| endTime | Object ([Date-Time][]) | The ending time from the request. | -| exchange | Object ([Currency Object][]) | Totals are normalize to this currency from the request. | -| exchangeRate | Number | The amount of the `exchange` currency necessary to buy 1 XRP. | -| total | Number | The total value sent in the network, normalized to the `exchange` currency, during the requested time period. | -| count | Number | The number of transactions processed to calculate this result. | -| components | Array | An array of the currencies used to calculate this total. | - -Each member of the `components` array is an Object with the following fields: - -| Field | Type | Description | -|-------|------|-------------| -| currency | String | Currency code for this currency. | -| issuer | String (Ripple Address) | (Omitted for XRP) The Ripple account of the gateway issuing this currency. | -| amount | Number | The total amount of this currency sent during the requested time period. | -| count | Number | The total number of transactions that sent this currency during the requested time period. | -| rate | Number | The amount of the `exchange` currency necessary to buy 1 unit of this currency. (This is 0 if there are no transactions for this currency in the requested time period.) | -| convertedAmount | Number | The total amount of this currency sent during the requested time period, converted to the `exchange` currency. | - -## Transaction Stats ## -[[Source]
](https://github.com/ripple/ripple-data-api/blob/develop/api/routes/transactionStats.js "Source") - -Retrieve information about Ripple transactions during a specific time frame. - -#### Request Format #### - -
- -*Reduced* - -``` -POST /api/transaction_stats -{ - "startTime": "2015-01-15T10:00:00.000Z", - "endTime": "2015-01-15T07:00:00.000Z", - "timeIncrement": "hour", - "descending": false, - "reduce": true, - "format": "json" -} -``` - -*Expanded* - -``` -POST /api/transaction_stats -{ - "startTime": "2015-01-15 07:00 Z", - "endTime": "2015-01-15 07:59 Z", - "descending": true, - "reduce": false, - "limit": 10, - "offset": 0, - "format": "json" -} -``` - -
- -[Try it! >](charts-api-tool.html#transaction-stats) - -The request includes the following body parameters: - -| Field | Value | Description | -|-------|-------|-------------| -| startTime | String ([Date-Time][]) | Retrieve information starting 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`. | -| descending | Boolean | (Optional) If true, return results in descending order. Defaults to false. | -| reduce | Boolean | (Optional) If `false`, include transactions 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. | -| offset | Number | (Optional) If reduce is `false`, this value defines a number of transactions to skip before returning results. Use with `limit` to paginate results. Defaults to 0. | -| format | String | (Optional) The [Response Format][] to use: `csv` or `json`. If omitted, defaults to a CSV-like JSON array format. | - -#### Response Format #### - -The format of the response depends on the `format` and `reduce` parameters from the request. See [Response Format][] for details. Examples of successful responses: - -
- -*Reduced* - -``` -{ - "startTime": "2015-01-15T07:00:00+00:00", - "endTime": "2015-01-15T10:00:00+00:00", - "timeIncrement": "hour", - "results": [ - { - "OfferCancel": 3843, - "OfferCreate": 12593, - "TrustSet": 24, - "Payment": 2686, - "AccountSet": 139, - "time": "2015-01-15T07:00:00+00:00" - }, - { - "OfferCancel": 4680, - "OfferCreate": 12836, - "Payment": 3484, - "AccountSet": 153, - "TrustSet": 32, - "time": "2015-01-15T08:00:00+00:00" - }, - { - "OfferCancel": 3996, - "OfferCreate": 10659, - "Payment": 1527, - "AccountSet": 133, - "TrustSet": 24, - "time": "2015-01-15T09:00:00+00:00" - }, - { - "OfferCancel": 14, - "OfferCreate": 26, - "Payment": 3, - "time": "2015-01-15T10:00:00+00:00" - } - ] -} -``` - -*Expanded* - -``` -{ - "startTime": "2015-01-15T07:59:00+00:00", - "endTime": "2015-01-15T07:00:00+00:00", - "results": [ - { - "time": "2015-01-15T07:59:00+00:00", - "type": "OfferCancel", - "account": "rEepZ4ok2UWuvBedU54XjfjxeiePexxEsq", - "txHash": "3C32492DBB8D8CF3E605EA76EDFB9EF6FD80F7BAE7DF939CDEBC245CD7B4DBC8", - "ledgerIndex": 11130426 - }, - { - "time": "2015-01-15T07:59:00+00:00", - "type": "OfferCancel", - "account": "rHsZHqa5oMQNL5hFm4kfLd47aEMYjPstpg", - "txHash": "054D836321179C5BEECB0CF08A2880BE235088B527AFB5ED249AE35FDECDAAEC", - "ledgerIndex": 11130426 - }, - { - "time": "2015-01-15T07:59:00+00:00", - "type": "OfferCancel", - "account": "rhUWKrgoGztYKxbuaZMeLc3PdviRrCpdhz", - "txHash": "44785B97D4E5FE72AFAD0E536D477402D86D9583143A3F0CE5A7AFD65FAF22B9", - "ledgerIndex": 11130426 - }, - { - "time": "2015-01-15T07:59:00+00:00", - "type": "OfferCancel", - "account": "rhUWKrgoGztYKxbuaZMeLc3PdviRrCpdhz", - "txHash": "952B9371F38EB027A9DB7D75F5E5DD5141B6D753C2EB3B6101BE62AE13814B8E", - "ledgerIndex": 11130426 - }, - { - "time": "2015-01-15T07:59:00+00:00", - "type": "OfferCreate", - "account": "r3cS9gS86hjwLwb6rg2usGcXYxwcrvJwBH", - "txHash": "D44BFB81C585272AA633D70C16F200C9E08D0544C8FE430B42E93DB529CCF397", - "ledgerIndex": 11130426 - }, - { - "time": "2015-01-15T07:59:00+00:00", - "type": "OfferCreate", - "account": "rBSZe33F5oxHTbxSF1nZJooVDpcrrqNFp3", - "txHash": "7E48425E313E56F3CF4CD8B8995CA9AAEADA52A0559EDD5703DD899109A57135", - "ledgerIndex": 11130426 - }, - { - "time": "2015-01-15T07:59:00+00:00", - "type": "OfferCreate", - "account": "rBSZe33F5oxHTbxSF1nZJooVDpcrrqNFp3", - "txHash": "C53FCCA0C53C39FAFA95B754268635B8187AEB80D6DDC74AAB9DCBFE4B07C664", - "ledgerIndex": 11130426 - }, - { - "time": "2015-01-15T07:59:00+00:00", - "type": "OfferCreate", - "account": "rGFpans8aW7XZNEcNky6RHKyEdLvXPMnUn", - "txHash": "716971CA2C2168EF4C06BA4408F27E6FB519148F52154B5CADA29A083E7A0B96", - "ledgerIndex": 11130426 - }, - { - "time": "2015-01-15T07:59:00+00:00", - "type": "OfferCreate", - "account": "rJnZ4YHCUsHvQu7R6mZohevKJDHFzVD6Zr", - "txHash": "0A57DFB995947FF8E87324B903D8E25917B3E0C09F4C24F93132AECDC7849362", - "ledgerIndex": 11130426 - }, - { - "time": "2015-01-15T07:59:00+00:00", - "type": "OfferCreate", - "account": "rJnZ4YHCUsHvQu7R6mZohevKJDHFzVD6Zr", - "txHash": "17AC61741060D5561D813ABFEFA1A7939273CAA21A7B329CBBFC562EBFE98DB9", - "ledgerIndex": 11130426 - } - ] -} -``` - -
- -*Note:* In JSON format, the `startTime` and `endTime` parameters at the top level are switched when the request specifies `"descending": true`. This is a bug. See [RD-110](https://ripplelabs.atlassian.net/browse/RD-110) for more details. - -**If the results are reduced** (the default), then each result represents an interval of time, with the following attributes: - -| Field | Type | Description | -|-------|------|-------------| -| time | String ([Date-Time][]) | The time at which this interval begins. | -| Payment | Number | (May be omitted) The number of Payment transactions during this interval sent by the specified account. | -| OfferCreate | Number | (May be omitted) The number of OfferCreate transactions during this interval sent by the specified account. | -| OfferCancel | Number | (May be omitted) The number of OfferCancel transactions during this interval sent by the specified account. | -| TrustSet | Number | (May be omitted) The number of TrustSet transactions during this interval sent by the specified account. | -| AccountSet | Number | (May be omitted) The number of AccountSet transactions during this interval sent by the specified account. | -| SetFee | Number | (May be omitted) The number of SetFee pseudo-transactions during this interval sent by the specified account. Since SetFee is a pseudo-transaction, this transaction type only appears for [ACCOUNT_ZERO](https://wiki.ripple.com/Accounts#ACCOUNT_ZERO). | -| SetRegularKey | Number | (May be omitted) The number of SetRegularKey transactions during this interval sent by the specified account. | - -Each of the transaction type attributes is omitted when there is no data. In CSV or array format, columns are included for each type that has a nonzero value in any interval. In JSON format, each interval includes fields only for the types that have nonzero values in that particular interval. - -**If the results are not reduced** (the request used `"reduce": false`), then each result represents an individual transaction, with the following attributes, in order: - -| Field | Type | Description | -|-------|------|-------------| -| time | String ([Date-Time][]) | The time this transaction occurred. | -| type | String | The transaction type. Valid types are: `AccountSet`, `OfferCancel`, `OfferCreate`, `Payment`, `SetFee`, `SetRegularKey`, and `TrustSet` | -| account | String (Ripple Address) | The address of the account that sent this transaction. | -| txHash | String (Transaction Hash) | The identifying hash of this transaction. | -| ledgerIndex | Number (Ledger Index) | The identifying sequence number of the ledger that included this transaction. | - - -## Value Sent ## -[[Source]
](https://github.com/ripple/ripple-data-api/blob/develop/api/routes/valueSent.js "Source") - -Retrieve the total amount of a single currency sent, in payments and currency exchanges, during a specific time period. - -#### Request Format #### - -
- -*Reduced* - -``` -POST /api/value_sent -{ - "currency": "JPY", - "issuer": "r94s8px6kSw1uZ1MV98dhSRTvc6VMPoPcN", - "startTime": "2015-01-15 08:00 Z", - "endTime": "2015-01-15 10:59 Z", - "timeIncrement": "hour", - "descending": false, - "reduce": true, - "format": "json" -} -``` - -*Expanded* - -``` -POST /api/value_sent -{ - "currency": "JPY", - "issuer": "r94s8px6kSw1uZ1MV98dhSRTvc6VMPoPcN", - "startTime": "2015-01-15 08:00 Z", - "endTime": "2015-01-15 08:01 Z", - "reduce": false, - "limit": 3, - "offset": 0, - "format": "json" -} -``` - -
- -[Try it! >](charts-api-tool.html#value-sent) - -The request includes the following body parameters: - -| Field | Value | Description | -|-------|-------|-------------| -| currency | String | Three-letter [ISO 4217 Currency Code](http://www.xe.com/iso4217.php) string, or a 160-bit hex string according to Ripple's internal [Currency format](https://wiki.ripple.com/Currency_format). | -| issuer | String | Account address of the counterparty holding the currency. Usually an issuing gateway in the Ripple network. Omitted or `null` for XRP. | -| startTime | String ([Date-Time][]) | Retrieve information starting 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`. | -| descending | Boolean | (Optional) If true, return results in descending order. Defaults to false. | -| reduce | Boolean | (Optional) If `false`, include transactions 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. | -| offset | Number | (Optional) If reduce is `false`, this value defines a number of transactions to skip before returning results. Use with `limit` to paginate results. Defaults to 0. | -| format | String | (Optional) The [Response Format][] to use: `csv` or `json`. If omitted, defaults to a CSV-like JSON array format. | - -#### Response Format #### - -The format of the response depends on the `format` and `reduce` parameters from the request. See [Response Format][] for details. Examples of successful responses: - -
- -*Reduced* - -``` -{ - "currency": "JPY", - "issuer": "r94s8px6kSw1uZ1MV98dhSRTvc6VMPoPcN", - "startTime": "2015-01-15T08:00:00+00:00", - "endTime": "2015-01-15T10:59:00+00:00", - "timeIncrement": "hour", - "results": [ - { - "time": "2015-01-15T08:00:00+00:00", - "amount": 1152046.1607243735, - "count": 190 - }, - { - "time": "2015-01-15T09:00:00+00:00", - "amount": 483892.1115109554, - "count": 84 - }, - { - "time": "2015-01-15T10:00:00+00:00", - "amount": 485985.50256177614, - "count": 72 - } - ] -} -``` - -*Expanded* - -``` -{ - "currency": "JPY", - "issuer": "r94s8px6kSw1uZ1MV98dhSRTvc6VMPoPcN", - "startTime": "2015-01-15T08:00:00+00:00", - "endTime": "2015-01-15T08:01:00+00:00", - "results": [ - { - "time": "2015-01-15T08:00:00+00:00", - "amount": 18081.50257044235, - "account": "rPCFVxAqP2XdaPmih1ZSjmCPNxoyMiy2ne", - "destination": null, - "txHash": "64520542AB1F3EEF516DE3E07E4958F3C07AC668D4B3DE769AF08D305AFA50D1", - "ledgerIndex": 11130438 - }, - { - "time": "2015-01-15T08:01:00+00:00", - "amount": 0.0000010567819117568433, - "account": "rfU3YWd1TnYryvryQTQ9xwyCSqzMTbnyW6", - "destination": null, - "txHash": "52B282E616B2B9AD5E34B3BDE2D6D0AB44D06298590D3A949C2D7817D3057957", - "ledgerIndex": 11130451 - } - ] -} -``` - -
- -**If the results are reduced** (the default), then each result represents an interval of time, with the following attributes: - -| Field | Type | Description | -|-------|------|-------------| -| time | String ([Date-Time][]) | The time at which this interval begins. | -| amount | Number | The total amount of the requested currency sent during this interval | -| count | Number | The total number of transactions in this interval that contributed to the `amount`. | - - -**If the results are not reduced** (the request used `"reduce": false`), then each result represents an individual transaction, with the following attributes, in order: - -| Field | Type | Description | -|-------|------|-------------| -| time | String ([Date-Time][]) | The time this transaction occurred. | -| amount | Number | The amount of the requested currency sent in this transaction. | -| account | String (Ripple Address) | The address of the account that sent this transaction. | -| destination | String (Ripple Address) | The address of the account that received the funds. Due to [RD-111](https://ripplelabs.atlassian.net/browse/RD-111), this value is always returned as `null` instead. | -| txHash | String (Transaction Hash) | The identifying hash of this transaction. | -| ledgerIndex | Number (Ledger Index) | The identifying sequence number of the ledger that included this transaction. | diff --git a/js/apitool-methods-charts.js b/js/apitool-methods-charts.js index ce2ee64846..034e866497 100644 --- a/js/apitool-methods-charts.js +++ b/js/apitool-methods-charts.js @@ -9,20 +9,21 @@ var TIME_20150101 = "2015-01-01T00:00:00.000Z"; var TIME_20150101_2 = "2015-01-01T02:00:00.000Z"; -Request('Account Offers Exercised', { - method: POST, - path: "/api/account_offers_exercised", - description: "Retrieve currency-exchange orders being exercised for a single account.", - link: "#account-offers-exercised", - params: {}, - body: { - account: DEFAULT_ADDRESS_1, - startTime: TIME_20140101, - limit: 5, - offset: 0, - format: "json" - } -}); +//DEPRECATED and shut down! +//Request('Account Offers Exercised', { +// method: POST, +// path: "/api/account_offers_exercised", +// description: "Retrieve currency-exchange orders being exercised for a single account.", +// link: "#account-offers-exercised", +// params: {}, +// body: { +// account: DEFAULT_ADDRESS_1, +// startTime: TIME_20140101, +// limit: 5, +// offset: 0, +// format: "json" +// } +//}); Request('Accounts Created', { method: POST, @@ -94,21 +95,22 @@ Request('Issuer Capitalization', { } }); -Request('Ledgers Closed', { - method: POST, - path: "/api/ledgers_closed", - description: "Retrieve information about ledgers closed over time.", - link: "#ledgers-closed", - params: {}, - body: { - "startTime": TIME_20140101, - "endTime": TIME_20150101, - "timeIncrement": "month", - "descending": false, - "reduce": true, - "format": "json" - } -}); +//DEPRECATED and removed! +//Request('Ledgers Closed', { +// method: POST, +// path: "/api/ledgers_closed", +// description: "Retrieve information about ledgers closed over time.", +// link: "#ledgers-closed", +// params: {}, +// body: { +// "startTime": TIME_20140101, +// "endTime": TIME_20150101, +// "timeIncrement": "month", +// "descending": false, +// "reduce": true, +// "format": "json" +// } +//}); Request('Market Traders', { method: POST, @@ -130,28 +132,29 @@ Request('Market Traders', { } }); -Request('Offers', { - method: POST, - path: "/api/offers", - description: "Returns all currency-exchange orders and cancellations over time for a specified currency pair, including unfulfilled offers.", - link: "#offers", - params: {}, - body: { - "base": { - "currency": "GBP", - "issuer": "rMwjYedjc7qqtKYVLiAccJSmCwih4LnE2q" - }, - "counter": { - "currency": "XRP" - }, - "startTime": "2015-03-01T00:00:00.000Z", - "endTime": "2015-03-07T00:00:00.000Z", - "timeIncrement": "day", - "descending": false, - "reduce": true, - "format": "json" - } -}); +//DEPRECATED and removed! +//Request('Offers', { +// method: POST, +// path: "/api/offers", +// description: "Returns all currency-exchange orders and cancellations over time for a specified currency pair, including unfulfilled offers.", +// link: "#offers", +// params: {}, +// body: { +// "base": { +// "currency": "GBP", +// "issuer": "rMwjYedjc7qqtKYVLiAccJSmCwih4LnE2q" +// }, +// "counter": { +// "currency": "XRP" +// }, +// "startTime": "2015-03-01T00:00:00.000Z", +// "endTime": "2015-03-07T00:00:00.000Z", +// "timeIncrement": "day", +// "descending": false, +// "reduce": true, +// "format": "json" +// } +//}); Request('Offers Exercised', { method: POST, @@ -192,69 +195,73 @@ Request('Top Markets', { } }); -Request('Total Network Value', { - method: POST, - path: "/api/total_network_value", - description: "Retrieve the total amount of currency held in the network, as of a specified time.", - link: "#total-network-value", - params: {}, - body: { - "time": TIME_20150101, - "exchange":{ - "currency": "USD", - "issuer": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B" - } - } -}); +//DEPRECATED and removed! +//Request('Total Network Value', { +// method: POST, +// path: "/api/total_network_value", +// description: "Retrieve the total amount of currency held in the network, as of a specified time.", +// link: "#total-network-value", +// params: {}, +// body: { +// "time": TIME_20150101, +// "exchange":{ +// "currency": "USD", +// "issuer": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B" +// } +// } +//}); -Request('Total Value Sent', { - method: POST, - path: "/api/total_value_sent", - description: "The total amount of money sent, in payments and currency exchanges, for a curated list of currencies and issuers.", - link: "#total-value-sent", - params: {}, - body: { - "startTime": TIME_20150101, - "interval": "month", - "exchange": { - "currency": "USD", - "issuer": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B" - } - } -}); +//DEPRECATED and removed! +//Request('Total Value Sent', { +// method: POST, +// path: "/api/total_value_sent", +// description: "The total amount of money sent, in payments and currency exchanges, for a curated list of currencies and issuers.", +// link: "#total-value-sent", +// params: {}, +// body: { +// "startTime": TIME_20150101, +// "interval": "month", +// "exchange": { +// "currency": "USD", +// "issuer": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B" +// } +// } +//}); -Request('Transaction Stats', { - method: POST, - path: "/api/transaction_stats", - description: "Retrieve information about Ripple transactions during a specific time frame.", - link: "#transaction-stats", - params: {}, - body: { - "startTime": TIME_20150101, - "endTime": TIME_20150101_2, - "timeIncrement": "hour", - "descending": true, - "reduce": true, - "format": "json" - } -}); +//DEPRECATED and removed! +//Request('Transaction Stats', { +// method: POST, +// path: "/api/transaction_stats", +// description: "Retrieve information about Ripple transactions during a specific time frame.", +// link: "#transaction-stats", +// params: {}, +// body: { +// "startTime": TIME_20150101, +// "endTime": TIME_20150101_2, +// "timeIncrement": "hour", +// "descending": true, +// "reduce": true, +// "format": "json" +// } +//}); -Request('Value Sent', { - method: POST, - path: "/api/value_sent", - description: "Retrieve the total amount of a single currency sent, in payments and currency exchanges, during a specific time period.", - link: "#value-sent", - params: {}, - body: { - "currency": "JPY", - "issuer": "r94s8px6kSw1uZ1MV98dhSRTvc6VMPoPcN", - "startTime": TIME_20150101, - "endTime": TIME_20150101_2, - "timeIncrement": "hour", - "descending": false, - "reduce": true, - "format": "json" - } -}); +//DEPRECATED and removed! +//Request('Value Sent', { +// method: POST, +// path: "/api/value_sent", +// description: "Retrieve the total amount of a single currency sent, in payments and currency exchanges, during a specific time period.", +// link: "#value-sent", +// params: {}, +// body: { +// "currency": "JPY", +// "issuer": "r94s8px6kSw1uZ1MV98dhSRTvc6VMPoPcN", +// "startTime": TIME_20150101, +// "endTime": TIME_20150101_2, +// "timeIncrement": "hour", +// "descending": false, +// "reduce": true, +// "format": "json" +// } +//}); //---------- End req. List ---------------------------//