ARCHIVE/xrpl-dev-portal
1
0
Fork 0
mirror of https://github.com/XRPLF/xrpl-dev-portal.git synced 2025-11-20 19:55:54 +00:00
Code Issues Packages Projects Releases Wiki Activity

data v2.1.0 - style edits

Browse Source
This commit is contained in:
mDuo13
2016-04-18 17:40:29 -07:00
parent d3cca26317
commit 9e12ef118f
2 changed files with 219 additions and 215 deletions
Download Patch File Download Diff File Expand all files Collapse all files

184
content/reference-data-api.md
View File

@@ -111,7 +111,7 @@ A successful response uses the HTTP code **200 OK** and has a JSON body with the
| Field | Value | Description |
|--------|-------|-------------|
| result | `success` | Indicates that the body represents a successful response. |
| result | String | The value `success` indicates that this is a successful response. |
| ledger | [Ledger object](#ledger-objects) | The requested ledger |
#### Example ####
@@ -181,7 +181,7 @@ A successful response uses the HTTP code **200 OK** and has a JSON body with the
| Field | Value | Description |
|--------|-------|-------------|
| result | `success` | Indicates that the body represents a successful response. |
| result | String | The value `success` indicates that this is a successful response. |
| transaction | [Transaction object](#transaction-objects) | The requested transaction |
#### Example ####
@@ -281,7 +281,7 @@ Optionally, you can include the following query parameters:
| type | String | Filter transactions to a specific [transaction type](reference-transaction-format.html). |
| result | String | Filter transactions for a specific [transaction result](reference-transaction-format.html#transaction-results). |
| binary | Boolean | If true, return transactions in binary form. Defaults to false. |
| limit | Integer | Max results per page (defaults to 20). Cannot be more than 100. |
| limit | Integer | Maximum results per page. Defaults to 20. Cannot be more than 100. |
| marker | String | [Pagination](#pagination) marker from a previous response. |
#### Response Format ####
@@ -289,7 +289,7 @@ A successful response uses the HTTP code **200 OK** and has a JSON body with the
| Field | Value | Description |
|--------|-------|-------------|
| result | `success` | Indicates that the body represents a successful response. |
| result | String | The value `success` indicates that this is a successful response. |
| count | Integer | Number of Transactions returned. |
| marker | String | (May be omitted) Pagination marker |
| transactions | Array of [Transaction object](#transaction-objects) | The requested transactions |
@@ -449,7 +449,7 @@ Optionally, you can also include the following query parameters:
| end | String - [Timestamp][] | Filter results to this time and earlier. |
| interval | String | If provided and `currency` is also specified, return results aggregated into intervals of the specified length instead of individual payments. Valid intervals are `day`, `week`, or `month`. |
| descending | Boolean | Reverse chronological order. |
| limit | Integer | Max results per page (defaults to 200). Cannot be more than 1000. |
| limit | Integer | Maximum results per page. Defaults to 200. Cannot be more than 1000. |
| marker | String | [Pagination](#pagination) key from previously returned response. |
| format | String | Format of returned results: `csv` or `json`. Defaults to `json`. |
@@ -460,7 +460,7 @@ A successful response uses the HTTP code **200 OK** and has a JSON body with the
| Field | Value | Description |
|--------|-------|-------------|
| result | `success` | Indicates that the body represents a successful response. |
| result | String | The value `success` indicates that this is a successful response. |
| count | Integer | Number of Transactions returned |
| marker | String | (May be omitted) [Pagination](#pagination) marker |
| payments | Array of [Payment Objects][], or array of aggregate objects | The requested payments |
@@ -606,7 +606,7 @@ A successful response uses the HTTP code **200 OK** and has a JSON body with the
| Field | Value | Description |
|--------|-------|-------------|
| result | `success` | Indicates that the body represents a successful response. |
| result | String | The value `success` indicates that this is a successful response. |
| count | Integer | Number of Transactions returned. |
| marker | String | (May be omitted) [Pagination](#pagination) marker |
| exchanges | Array of [Exchange Objects][] | The requested exchanges |
@@ -732,7 +732,7 @@ A successful response uses the HTTP code **200 OK** and has a JSON body with the
| Field | Value | Description |
|--------|-------|-------------|
| result | `success` | Indicates that the body represents a successful response. |
| result | String | The value `success` indicates that this is a successful response. |
| rate | Number | The requested exchange rate, or `0` if the exchange rate could not be determined. |
All exchange rates are calcuated by converting the base currency and counter currency to XRP.
@@ -796,7 +796,7 @@ A successful response uses the HTTP code **200 OK** and has a JSON body with the
| Field | Value | Description |
|--------|-------|-------------|
| result | `success` | Indicates that the body represents a successful response. |
| result | String | The value `success` indicates that this is a successful response. |
| amount | Number | Pre-conversion amount specified in the request |
| converted | Number | Post-conversion amount of the `exchange_currency`, or `0` if the exchange rate could not be determined. |
| rate | Number | Exchange rate used to calculate the conversion, or `0` if the exchange rate could not be determined. |
@@ -857,7 +857,7 @@ Optionally, you can also include the following query parameters:
| accounts | Boolean | If true, include lists of counterparty accounts. Defaults to false. |
| payments | Boolean | If true, include lists of individual payments. Defaults to false. |
| format | String | Format of returned results: `csv` or `json`. Defaults to `json`. |
| limit | Integer | Max results per page (defaults to 200). Cannot be more than 1000. |
| limit | Integer | Maximum results per page. Defaults to 200. Cannot be more than 1000. |
| marker | String | [Pagination](#pagination) key from previously returned response |
#### Response Format ####
@@ -866,7 +866,7 @@ A successful response uses the HTTP code **200 OK** and has a JSON body with the
| Field | Value | Description |
|--------|-------|-------------|
| result | `success` | Indicates that the body represents a successful response. |
| result | String | The value `success` indicates that this is a successful response. |
| date | String - [Timestamp][] | The date for which this report applies. |
| count | Integer | Number of reports returned. |
| marker | String | (May be omitted) [Pagination](#pagination) marker. |
@@ -1017,7 +1017,7 @@ Optionally, you can also include the following query parameters:
| start | String - [Timestamp][] | Filter results to this time and later. |
| end | String - [Timestamp][] | Filter results to this time and earlier |
| interval | String | Aggregation interval (`hour`,`day`,`week`, defaults to `day`) |
| limit | Integer | Max results per page (defaults to 200). Cannot be more than 1000. |
| limit | Integer | Maximum results per page. Defaults to 200. Cannot be more than 1000. |
| marker | String | [Pagination](#pagination) key from previously returned response. |
| descending | Boolean | If true, return results in reverse chronological order. Defaults to false. |
| format | String | Format of returned results: `csv` or `json`. Defaults to `json`. |
@@ -1052,7 +1052,7 @@ A successful response uses the HTTP code **200 OK** and has a JSON body with the
| Field | Value | Description |
|--------|-------|-------------|
| result | `success` | Indicates that the body represents a successful response. |
| result | String | The value `success` indicates that this is a successful response. |
| count | Integer | Number of reports returned. |
| marker | String | (May be omitted) [Pagination](#pagination) marker |
| stats | Array of stats objects | The requested stats. Omits metrics with a value of 0, and intervals that have no nonzero metrics. |
@@ -1126,7 +1126,7 @@ Optionally, you can also include the following query parameters:
| start | String - [Timestamp][] | Start time of query range. Defaults to `2013-01-01T00:00:00Z`. |
| end | String - [Timestamp][] | End time of query range. Defaults to the current time. |
| interval | String | Aggregation interval - `day`, `week`, or `month`. Defaults to `day`. |
| limit | Integer | Max results per page (defaults to 200). Cannot be more than 1000. |
| limit | Integer | Maximum results per page. Defaults to 200. Cannot be more than 1000. |
| marker | String | [Pagination](#pagination) key from previously returned response |
| descending | Boolean | If true, return results in reverse chronological order. Defaults to false. |
| adjusted | Boolean | If true, do not count known issuer-owned wallets towards market capitalization. Defaults to true. |
@@ -1140,7 +1140,7 @@ A successful response uses the HTTP code **200 OK** and has a JSON body with the
| Field | Value | Description |
|--------|-------|-------------|
| result | `success` | Indicates that the body represents a successful response. |
| result | String | The value `success` indicates that this is a successful response. |
| count | Integer | Number of reports returned. |
| currency | String | Currency requested |
| issuer | String | Issuer requested |
@@ -1259,7 +1259,7 @@ A successful response uses the HTTP code **200 OK** and has a JSON body with the
| Field | Value | Description |
|--------|-------|-------------|
| result | `success` | Indicates that the body represents a successful response. |
| result | String | The value `success` indicates that this is a successful response. |
| count | Integer | Number of accounts returned. |
| exchanges\_count | Integer | Total number of exchanges in the period. |
| accounts | Array of active Account Trading Objects | Active trading accounts for the period |
@@ -1400,7 +1400,7 @@ Optionally, you can include the following query parameters:
| interval | String | Aggregation interval - valid intervals are `day`, `week`, or `month`. Defaults to `day`. |
| exchange\_currency | String - [Currency Code][] | Normalize all amounts to use this as a display currency. If not XRP, `exchange_issuer` is also required. Defaults to XRP. |
| exchange\_issuer | String - [Address][] | Normalize results to the specified `currency` issued by this issuer. |
| limit | Integer | Max results per page. Defaults to 200. Cannot be more than 1000. |
| limit | Integer | Maximum results per page. Defaults to 200. Cannot be more than 1000. |
| marker | String | [Pagination](#pagination) key from previously returned response |
| format | String | Format of returned results: `csv` or `json`. Defaults to `json`. |
@@ -1409,7 +1409,7 @@ A successful response uses the HTTP code **200 OK** and has a JSON body with the
| Field | Value | Description |
|--------|-------|-------------|
| result | `success` | Indicates that the body represents a successful response. |
| result | String | The value `success` indicates that this is a successful response. |
| count | Integer | Number of results returned. |
| rows | Array of exchange [Volume Objects][] | Exchange volumes for each interval in the requested time period. (By default, this method only returns the most recent interval.) |
@@ -1548,7 +1548,7 @@ Optionally, you can include the following query parameters:
| interval | String | Aggregation interval - valid intervals are `day`, `week`, or `month`. Defaults to `day`. |
| exchange\_currency | String - [Currency Code][] | Normalize all amounts to use this as a display currency. If not XRP, `exchange_issuer` is also required. Defaults to XRP. |
| exchange\_issuer | String - [Address][] | Normalize results to the specified `currency` issued by this issuer. |
| limit | Integer | Max results per page. Defaults to 200. Cannot be more than 1000. |
| limit | Integer | Maximum results per page. Defaults to 200. Cannot be more than 1000. |
| marker | String | [Pagination](#pagination) key from previously returned response |
| format | String | Format of returned results: `csv` or `json`. Defaults to `json`. |
@@ -1557,7 +1557,7 @@ A successful response uses the HTTP code **200 OK** and has a JSON body with the
| Field | Value | Description |
|--------|-------|-------------|
| result | `success` | Indicates that the body represents a successful response. |
| result | String | The value `success` indicates that this is a successful response. |
| count | Integer | Number of results returned. |
| rows | Array of payment [Volume Objects][] | Payment volumes for each interval in the requested time period. (By default, this method only returns the most recent interval.) |
@@ -1676,7 +1676,7 @@ Optionally, you can include the following query parameters:
| end | String - [Timestamp][] | End time of query range. Defaults to the end of the most recent interval. |
| exchange\_currency | String - [Currency Code][] | Normalize all amounts to use this as a display currency. If not XRP, `exchange_issuer` is also required. Defaults to XRP. |
| exchange\_issuer | String - [Address][] | Normalize results to the specified `currency` issued by this issuer. |
| limit | Integer | Max results per page. Defaults to 200. Cannot be more than 1000. |
| limit | Integer | Maximum results per page. Defaults to 200. Cannot be more than 1000. |
| marker | String | [Pagination](#pagination) key from previously returned response |
| format | String | Format of returned results: `csv` or `json`. Defaults to `json`. |
@@ -1686,7 +1686,7 @@ A successful response uses the HTTP code **200 OK** and has a JSON body with the
| Field | Value | Description |
|--------|-------|-------------|
| result | `success` | Indicates that the body represents a successful response. |
| result | String | The value `success` indicates that this is a successful response. |
| count | Integer | Number of results returned. |
| rows | Array of Issued Value Objects | Aggregated capitalization at the requested point(s) in time. |
@@ -1760,7 +1760,7 @@ Response:
## Get Top Currencies ##
[[Source]<br>](https://github.com/ripple/rippled-historical-database/blob/develop/api/routesV2/network/topCurrencies.js "Source")
Returns the top currencies on the Ripple Consensus Ledger over a rolling 30 day window. The currencies are ordered from highest ranked to lowest, where the rank is determined by the volume and count of transactions and the number of unique counterparties. By default, returns the top currencies for the most recent date available. You can query historical data by date. _(New in [v2.1.0][])_
Returns the top currencies on the Ripple Consensus Ledger, ordered from highest rank to lowest. The ranking is determined by the volume and count of transactions and the number of unique counterparties. By default, returns results for the 30-day rolling window ending on the current date. You can specify a date to get results for the 30-day window ending on that date. _(New in [v2.1.0][])_
#### Request Format ####
@@ -1783,6 +1783,7 @@ GET /v2/network/top_currencies/2016-01-01
[Try it! >](data-api-v2-tool.html#get-top-currencies)
This method does not accept any query parameters.
#### Response Format ####
@@ -1790,10 +1791,10 @@ A successful response uses the HTTP code **200 OK** and has a JSON body with the
| Field | Value | Description |
|--------|-------|-------------|
| result | `success` | Indicates that the body represents a successful response. |
| result | String | The value `success` indicates that this is a successful response. |
| date | String - [Timestamp][] | The time at which this data was measured. |
| count | Integer | Number of results returned. |
| currencies | Array of Top Currency Objects | A currency + issuer, and the metrics measured for inclusion and ranking |
| count | Integer | Number of objects in the `currencies` field. |
| currencies | Array of Top Currency Objects | The top currencies for this data sample. Each member represents one currency, by currency code and issuer. |
Each Top Currency Object has the following fields:
@@ -1801,9 +1802,9 @@ Each Top Currency Object has the following fields:
|--------|-------|-------------|
| currency | String - [Currency Code][] | The currency this object describes |
| issuer | String - [Address][] | The Ripple address that issues this currency |
| avg_exchange_count | [String - Number][] | Daily average number of exchanges |
| avg_exchange_count | [String - Number][] | Daily average number of [exchanges](#exchange-objects) |
| avg_exchange_volume | [String - Number][] | Daily average volume of exchanges, normalized to XRP |
| avg_payment_count | [String - Number][] | Daily average number of payments |
| avg_payment_count | [String - Number][] | Daily average number of [payments](#payment-objects) |
| avg_payment_volume | [String - Number][] | Daily average volume of payments, normalized to XRP |
| issued_value | [String - Number][] | Total amount of this currency issued by this issuer, normalized to XRP |
@@ -1860,8 +1861,7 @@ Response:
## Get Top Markets ##
[[Source]<br>](https://github.com/ripple/rippled-historical-database/blob/develop/api/routesV2/network/topMarkets.js "Source")
Returns the top exchange markets on the Ripple Consensus Ledger over a rolling 30 day window. The markets are ordered from highest ranked to lowest, where the rank is determined by the number and volume of exchanges and the number of counterparties participating. By default, returns top markets for the latest date available. You can query historical data by date. _(New in [v2.1.0][])_
Returns the top exchange markets on the Ripple Consensus Ledger, ordered from highest rank to lowest. The rank is determined by the number and volume of exchanges and the number of counterparties participating. By default, returns top markets for the 30-day rolling window ending on the current date. You can specify a date to get results for the 30-day window ending on that date. _(New in [v2.1.0][])_
#### Request Format ####
@@ -1881,6 +1881,8 @@ GET /v2/network/top_markets/2016-01-01
<!--</div>-->
This method does not accept any query parameters.
[Try it! >](data-api-v2-tool.html#get-top-markets)
@@ -1890,10 +1892,10 @@ A successful response uses the HTTP code **200 OK** and has a JSON body with the
| Field | Value | Description |
|--------|-------|-------------|
| result | `success` | Indicates that the body represents a successful response. |
| date | String - [Timestamp][] | The time at which this data was measured. |
| count | Integer | Number of results returned. |
| markets | Array of Top Market Objects | A currency pair and the metrics measured for inclusion and ranking |
| result | String | The value `success` indicates that this is a successful response. |
| date | String - [Timestamp][] | The end of the rolling window over which this data was calculated. |
| count | Integer | Number of results in the `markets` field. |
| markets | Array of Top Market Objects | The top markets for this data sample. Each member represents a currency pair. |
Each Top Market object has the following fields:
@@ -1905,7 +1907,7 @@ Each Top Market object has the following fields:
| counter_issuer | String - [Address][] | (Omitted if `counter_currency` is XRP) The Ripple address that issues the counter currency |
| avg_base_volume | String | Daily average volume in terms of the base currency |
| avg_counter_volume | String | Daily average volume in terms of the counter currency |
| avg_exchange_count | String | Daily average number of exchanges |
| avg_exchange_count | String | Daily average number of [exchanges](#exchange-objects) |
| avg_volume | String | Daily average volume, normalized to XRP |
#### Example ####
@@ -2233,7 +2235,7 @@ Optionally, you can include the following query parameters:
| start | String - [Timestamp][] | Start time of query range |
| end | String - [Timestamp][] | End time of query range |
| interval | String | Aggregation interval (`hour`,`day`,`week`). If omitted, return individual accounts. Not compatible with the `parent` parameter. |
| limit | Integer | Max results per page (defaults to 200). Cannot be more than 1,000. |
| limit | Integer | Maximum results per page. Defaults to 200. Cannot be more than 1,000. |
| marker | String | [Pagination](#pagination) key from previously returned response |
| descending | Boolean | Reverse chronological order |
| parent | String | Filter results to children of the specified parent account. Not compatible with the `interval` parameter. |
@@ -2245,8 +2247,8 @@ A successful response uses the HTTP code **200 OK** and has a JSON body with the
| Field | Value | Description |
|--------|-------|-------------|
| result | `success` | Indicates that the body represents a successful response. |
| count | Integer | Number of reports returned. |
| result | String | The value `success` indicates that this is a successful response. |
| count | Integer | Number of accounts returned. |
| marker | String | (May be omitted) [Pagination](#pagination) marker |
| accounts | Array | If the request used the `interval` query parameter, each member of the array is an interval object. Otherwise, this field is an array of [account creation objects](#account-creation-objects). |
@@ -2336,7 +2338,7 @@ A successful response uses the HTTP code **200 OK** and has a JSON body with the
| Field | Value | Description |
|--------|-------|-------------|
| result | `success` | Indicates that the body represents a successful response. |
| result | String | The value `success` indicates that this is a successful response. |
| account | Object - [Account Creation](#account-creation-objects) | The requested account |
#### Example ####
@@ -2392,25 +2394,25 @@ Optionally, you can also include the following query parameters:
| Field | Value | Description |
|--------------|---------|-------------|
| ledger_index | Integer | Index of ledger for historical balances |
| ledger_hash | String | Ledger hash for historical balances |
| ledger_index | Integer | Index of ledger for historical balances. |
| ledger_hash | String | Ledger hash for historical balances. |
| date | String | UTC date for historical balances. |
| currency | String | Restrict results to specified currency |
| counterparty | String | Restrict results to specified counterparty/issuer |
| limit | Integer | Max results per page (defaults to 200). Cannot be greater than 400, but you can use the value `all` to return all results. (Caution: When using limit=all to retrieve very many results, the request may time out. Large gateways can have several tens of thousands of results.) |
| format | String | Format of returned results: `csv`,`json` defaults to `json` |
| currency | String | Restrict results to specified currency. |
| counterparty | String | Restrict results to specified counterparty/issuer. |
| limit | Integer | Maximum results per page. Defaults to 200. Cannot be greater than 400, but you can use the value `all` to return all results. (Caution: When using limit=all to retrieve very many results, the request may time out. Large gateways can have several tens of thousands of results.) |
| format | String | Format of returned results: `csv` or `json`. Defaults to `json`. |
#### Response Format ####
A successful response uses the HTTP code **200 OK** and has a JSON body with the following:
| Field | Value | Description |
|--------|-------|-------------|
| result | `success` | Indicates that the body represents a successful response. |
| ledger_index | Integer | ledger index for balances query |
| close_time | String | close time of the ledger |
| limit | String | number of results returned, if limit was exceeded |
| marker | String | (May be omitted) [Pagination](#pagination) marker |
| balances | Array of [Balance Object][]s | The requested balances |
| result | String | The value `success` indicates that this is a successful response. |
| ledger_index | Integer | ledger index for balances query. |
| close_time | String | close time of the ledger. |
| limit | String | number of results returned, if limit was exceeded. |
| marker | String | (May be omitted) [Pagination](#pagination) marker. |
| balances | Array of [Balance Object][]s | The requested balances. |
#### Example ####
@@ -2481,7 +2483,7 @@ Optionally, you can also include the following query parameters:
| ledger\_index | Integer | Get orders as of this ledger. Not compatible with `ledger_hash` or `date`. |
| ledger\_hash | String | Get orders as of this ledger. Not compatible with `ledger_index` or `date`. |
| date | String - [Timestamp][] | Get orders at this time. Not compatible with `ledger_index` or `ledger_hash`. |
| limit | Integer | Max results per page (defaults to 200). Cannot be greater than 400. |
| limit | Integer | Maximum results per page. Defaults to 200. Cannot be greater than 400. |
| format | String | Format of returned results: `csv` or `json`. Defaults to `json`. |
If none of `ledger_index`, `ledger_hash`, or `date` are specified, the API uses the most current data available.
@@ -2491,18 +2493,18 @@ A successful response uses the HTTP code **200 OK** and has a JSON body with the
| Field | Value | Description |
|--------|-------|-------------|
| result | `success` | Indicates that the body represents a successful response. |
| result | String | The value `success` indicates that this is a successful response. |
| ledger\_index | Integer | `ledger_index` of the ledger version used. |
| close\_time | String | Close time of the ledger version used. |
| limit | String | The `limit` from the request. |
| orders | Array of order objects | The requested orders |
| orders | Array of order objects | The requested orders. |
Each order object has the following fields:
| Field | Value | Description |
|------------------------------|--------|-------------|
| specification | Object | Details of this order's current state. |
| specification.direction | String | Either `buy` or `sell` |
| specification.direction | String | Either `buy` or `sell`. |
| specification.quantity | [Balance Object][] | The maximum amount of the base currency this order would buy or sell (depending on the direction). This value decreases as the order gets partially filled. |
| specification.totalPrice | [Balance Object][] | The maximum amount of the counter currency that will be spent or gained in order to buy or sell the base currency. This value decreases as the order gets partially filled. |
| properties | Object | Details of how the order was placed. |
@@ -2604,17 +2606,17 @@ Optionally, you can also include the following query parameters:
| Field | Value | Description |
|--------------|---------|-------------|
| start | String | UTC start time of query range |
| end | String | UTC end time of query range |
| start | String - [Timestamp][] | Start time of query range. Defaults to the earliest date available. |
| end | String - [Timestamp][] | End time of query range. Defaults to the current date. |
| min_sequence | String | Minimum sequence number to query |
| max_sequence | String | Max sequence number to query |
| type | String | Restrict results to a specified [transaction type](reference-transaction-format.html) |
| result | String | Restrict results to specified transaction result |
| binary | Boolean | Return results in binary format |
| descending | Boolean | Reverse chronological order |
| limit | Integer | Max results per page (defaults to 20). Cannot be more than 1,000. |
| limit | Integer | Maximum results per page. Defaults to 20. Cannot be more than 1,000. |
| marker | String | [Pagination](#pagination) key from previously returned response |
| format | String | Format of returned results: `csv`,`json` defaults to `json` |
| format | String | Format of returned results: `csv` or `json`. Defaults to `json`. |
#### Response Format ####
@@ -2623,7 +2625,7 @@ A successful response uses the HTTP code **200 OK** and has a JSON body with the
| Field | Value | Description |
|--------|-------|-------------|
| result | `success` | Indicates that the body represents a successful response. |
| result | String | The value `success` indicates that this is a successful response. |
| count | Integer | The number of objects contained in the `transactions` field. |
| marker | String | (May be omitted) [Pagination](#pagination) marker |
| transactions | Array of [transaction objects](#transaction-objects) | All transactions matching the request. |
@@ -2744,7 +2746,7 @@ A successful response uses the HTTP code **200 OK** and has a JSON body with the
| Field | Value | Description |
|--------|-------|-------------|
| result | `success` | Indicates that the body represents a successful response. |
| result | String | The value `success` indicates that this is a successful response. |
| transaction | [transaction object](#transaction-objects) | requested transaction |
#### Example ####
@@ -2795,7 +2797,7 @@ This method requires the following URL parameters:
| Field | Value | Description |
|----------|--------|-------------|
| :address | String | Ripple address to query |
| :address | String | Ripple address to query. |
Optionally, you can also include the following query parameters:
@@ -2810,9 +2812,9 @@ Optionally, you can also include the following query parameters:
| source\_tag | Integer | Filter results to specified source tag |
| destination\_tag | Integer | Filter results to specified destination tag |
| descending | Boolean | Reverse chronological order |
| limit | Integer | Max results per page (defaults to 200). Cannot be more than 1,000. |
| limit | Integer | Maximum results per page. Defaults to 200. Cannot be more than 1,000. |
| marker | String | [Pagination](#pagination) key from previously returned response |
| format | String | Format of returned results: `csv`,`json` defaults to `json` |
| format | String | Format of returned results: `csv` or `json`. Defaults to `json`. |
#### Response Format ####
@@ -2821,7 +2823,7 @@ A successful response uses the HTTP code **200 OK** and has a JSON body with the
| Field | Value | Description |
|--------|-------|-------------|
| result | `success` | Indicates that the body represents a successful response. |
| result | String | The value `success` indicates that this is a successful response. |
| count | Integer | The number of objects contained in the `payments` field. |
| marker | String | (May be omitted) [Pagination](#pagination) marker |
| payments | Array of [payment objects][] | All payments matching the request. |
@@ -2908,7 +2910,7 @@ This method requires the following URL parameters:
| Field | Value | Description |
|----------|--------|-------------|
| :address | String | Ripple address to query |
| :address | String | Ripple address to query. |
| :base | String | Base currency of the pair, as a [Currency Code][], followed by `+` and the issuer [Address][] unless it's XRP. |
| :counter | String | Counter currency of the pair, as a [Currency Code][], followed by `+` and the issuer [Address][] unless it's XRP. |
@@ -2920,9 +2922,9 @@ Optionally, you can also include the following query parameters:
| start | String - [Timestamp][] | Start time of query range |
| end | String - [Timestamp][] | End time of query range |
| descending | Boolean | Reverse chronological order |
| limit | Integer | Max results per page (defaults to 200). Cannot be more than 1000. |
| limit | Integer | Maximum results per page. Defaults to 200. Cannot be more than 1000. |
| marker | String | [Pagination](#pagination) key from previously returned response |
| format | String | Format of returned results: `csv`,`json` defaults to `json` |
| format | String | Format of returned results: `csv` or `json`. Defaults to `json`. |
#### Response Format ####
@@ -2930,7 +2932,7 @@ A successful response uses the HTTP code **200 OK** and has a JSON body with the
| Field | Value | Description |
|--------|-------|-------------|
| result | `success` | Indicates that the body represents a successful response. |
| result | String | The value `success` indicates that this is a successful response. |
| count | Integer | Number of exchanges returned. |
| marker | String | (May be omitted) [Pagination](#pagination) marker |
| exchanges | Array of [Exchange Objects][] | The requested exchanges |
@@ -3019,7 +3021,7 @@ This method requires the following URL parameters:
| Field | Value | Description |
|----------|--------|-------------|
| :address | String | Ripple address to query |
| :address | String | Ripple address to query. |
Optionally, you can also include the following query parameters:
@@ -3031,7 +3033,7 @@ Optionally, you can also include the following query parameters:
| start | String - [Timestamp][] | Start time of query range. |
| end | String - [Timestamp][] | End time of query range. |
| descending | Boolean | If true, return results in reverse chronological order. Defaults to false. |
| limit | Integer | Max results per page (defaults to 200). Cannot be more than 1000. |
| limit | Integer | Maximum results per page. Defaults to 200. Cannot be more than 1000. |
| marker | String | [Pagination](#pagination) key from previously returned response. |
| format | String | Format of returned results: `csv` or`json`. Defaults to `json`. |
@@ -3041,7 +3043,7 @@ A successful response uses the HTTP code **200 OK** and has a JSON body with the
| Field | Value | Description |
|--------|-------|-------------|
| result | `success` | Indicates that the body represents a successful response. |
| result | String | The value `success` indicates that this is a successful response. |
| count | Integer | Number of balance changes returned. |
| marker | String | (May be omitted) [Pagination](#pagination) marker. |
| exchanges | Array of [balance change descriptors][] | The requested balance changes. |
@@ -3127,7 +3129,7 @@ This method requires the following URL parameters:
| Field | Value | Description |
|----------|--------|-------------|
| :address | String | Ripple address to query |
| :address | String | Ripple address to query. |
| :date | String | (Optional) UTC date for single report. If omitted, use the `start` and `end` query parameters. |
@@ -3135,12 +3137,12 @@ Optionally, you can also include the following query parameters:
| Field | Value | Description |
|------------|---------|-------------|
| start | String | UTC start time of query range. Defaults to start of current date. Ignored if `date` specified. |
| end | String | UTC end time of query range. Defaults to current date. Ignored if `date` specified. |
| start | String - [Timestamp][] | Start time of query range. Defaults to start of current date. Ignored if `date` specified. |
| end | String - [Timestamp][] | End time of query range. Defaults to current date. Ignored if `date` specified. |
| accounts | Boolean | If true, provide lists with addresses of all `sending_counterparties` and `receiving_counterparties` in results. Otherwise, return only the number of sending and receiving counterparties. |
| payments | Boolean | Include [Payment Summary Objects][] in the `payments` field for each interval, with the payments that occurred during that interval. |
| descending | Boolean | If true, sort results with most recent first. By default, sort results with oldest first. |
| format | String | Format of returned results: `csv`,`json` defaults to `json` |
| format | String | Format of returned results: `csv` or `json`. Defaults to `json`. |
#### Response Format ####
@@ -3148,8 +3150,8 @@ A successful response uses the HTTP code **200 OK** and has a JSON body with the
| Field | Value | Description |
|--------|-------|-------------|
| result | `success` | Indicates that the body represents a successful response. |
| count | Integer | Number of reports returned. |
| result | String | The value `success` indicates that this is a successful response. |
| count | Integer | Number of reports in the `reports` field. |
| reports | Array of [Reports Objects][] | Daily summaries of account activity for the given account and date range. |
#### Example ####
@@ -3233,19 +3235,19 @@ This method requires the following URL parameters:
| Field | Value | Description |
|----------|--------|-------------|
| :address | String | Ripple address to query |
| :address | String | Ripple address to query. |
Optionally, you can also include the following query parameters:
| Field | Value | Description |
|------------|---------|-------------|
| start | String | UTC start time of query range. Defaults to start of current date. |
| end | String | UTC end time of query range. Defaults to current date. |
| limit | Integer | Max results per page (defaults to 200). Cannot be more than 1000. |
| start | String - [Timestamp][] | Start time of query range. Defaults to the earliest date available. |
| end | String - [Timestamp][] | End time of query range. Defaults to the current date. |
| limit | Integer | Maximum results per page. Defaults to 200. Cannot be more than 1000. |
| descending | Boolean | If true, sort results with most recent first. By default, sort results with oldest first. |
| marker | String | [Pagination](#pagination) key from previously returned response. |
| format | String | Format of returned results: `csv`,`json` defaults to `json` |
| format | String | Format of returned results: `csv` or `json`. Defaults to `json`. |
#### Response Format ####
@@ -3253,15 +3255,15 @@ A successful response uses the HTTP code **200 OK** and has a JSON body with the
| Field | Value | Description |
|--------|-------|-------------|
| result | `success` | Indicates that the body represents a successful response. |
| count | Integer | Number of reports returned. |
| result | String | The value `success` indicates that this is a successful response. |
| count | Integer | Number of transaction stats objects in the `rows` field. |
| rows | Array of Transaction Stats Objects | Daily summaries of account transaction activity for the given account. |
Each Transaction Stats Object has the following fields:
| Field | Value | Description |
|--------|-------|-------------|
| date | String - [Timestamp][] | The date this transaction stats object describes. |
| date | String - [Timestamp][] | This object describes activity on this date. |
| transaction\_count | Integer | The total number of transactions sent by the account on this date. |
| result | Object | Map of [transaction result codes](reference-transaction-format.html#transaction-results), indicating how many of each result code occurred in the transactions sent by this account on this date. |
| type | Object | Map of [transaction types](reference-transaction-format.html), indicating how many of each transaction type the account sent on this date. |
@@ -3331,7 +3333,7 @@ This method requires the following URL parameters:
| Field | Value | Description |
|----------|--------|-------------|
| :address | String | Ripple address to query |
| :address | String | Ripple address to query. |
Optionally, you can also include the following query parameters:
@@ -3340,7 +3342,7 @@ Optionally, you can also include the following query parameters:
|------------|---------|-------------|
| start | String - [Timestamp][] | Start time of query range. Defaults to the start of the most recent interval. |
| end | String - [Timestamp][] | End time of query range. Defaults to the end of the most recent interval. |
| limit | Integer | Max results per page (defaults to 200). Cannot be more than 1000. |
| limit | Integer | Maximum results per page. Defaults to 200. Cannot be more than 1000. |
| marker | String | [Pagination](#pagination) key from previously returned response. |
| descending | Boolean | If true, sort results with most recent first. By default, sort results with oldest first. |
| format | String | Format of returned results: `csv` or `json`. Defaults to `json`. |
@@ -3351,15 +3353,15 @@ A successful response uses the HTTP code **200 OK** and has a JSON body with the
| Field | Value | Description |
|--------|-------|-------------|
| result | `success` | Indicates that the body represents a successful response. |
| count | Integer | Number of reports returned. |
| result | String | The value `success` indicates that this is a successful response. |
| count | Integer | Number of value stats objects in the `rows` field. |
| rows | Array of Value Stats Objects | Daily summaries of account value for the given account. |
Each Value Stats Object has the following fields:
| Field | Value | Description |
|--------|-------|-------------|
| date | String - [Timestamp][] | This date this object describes. |
| date | String - [Timestamp][] | This object describes activity on this date. |
| value | [String - Number][] | The total of all currency held by this account, normalized to XRP. |
| balance_change_count | Number | The number of times the account's balance changed on this date. |

250
reference-data-api.html
View File

@@ -266,8 +266,8 @@
<tbody>
<tr>
<td>result</td>
<td><code>success</code></td>
<td>Indicates that the body represents a successful response.</td>
<td>String</td>
<td>The value <code>success</code> indicates that this is a successful response.</td>
</tr>
<tr>
<td>ledger</td>
@@ -354,8 +354,8 @@
<tbody>
<tr>
<td>result</td>
<td><code>success</code></td>
<td>Indicates that the body represents a successful response.</td>
<td>String</td>
<td>The value <code>success</code> indicates that this is a successful response.</td>
</tr>
<tr>
<td>transaction</td>
@@ -474,7 +474,7 @@
<tr>
<td>limit</td>
<td>Integer</td>
<td>Max results per page (defaults to 20). Cannot be more than 100.</td>
<td>Maximum results per page. Defaults to 20. Cannot be more than 100.</td>
</tr>
<tr>
<td>marker</td>
@@ -496,8 +496,8 @@
<tbody>
<tr>
<td>result</td>
<td><code>success</code></td>
<td>Indicates that the body represents a successful response.</td>
<td>String</td>
<td>The value <code>success</code> indicates that this is a successful response.</td>
</tr>
<tr>
<td>count</td>
@@ -685,7 +685,7 @@
<tr>
<td>limit</td>
<td>Integer</td>
<td>Max results per page (defaults to 200). Cannot be more than 1000.</td>
<td>Maximum results per page. Defaults to 200. Cannot be more than 1000.</td>
</tr>
<tr>
<td>marker</td>
@@ -712,8 +712,8 @@
<tbody>
<tr>
<td>result</td>
<td><code>success</code></td>
<td>Indicates that the body represents a successful response.</td>
<td>String</td>
<td>The value <code>success</code> indicates that this is a successful response.</td>
</tr>
<tr>
<td>count</td>
@@ -948,8 +948,8 @@
<tbody>
<tr>
<td>result</td>
<td><code>success</code></td>
<td>Indicates that the body represents a successful response.</td>
<td>String</td>
<td>The value <code>success</code> indicates that this is a successful response.</td>
</tr>
<tr>
<td>count</td>
@@ -1107,8 +1107,8 @@
<tbody>
<tr>
<td>result</td>
<td><code>success</code></td>
<td>Indicates that the body represents a successful response.</td>
<td>String</td>
<td>The value <code>success</code> indicates that this is a successful response.</td>
</tr>
<tr>
<td>rate</td>
@@ -1199,8 +1199,8 @@
<tbody>
<tr>
<td>result</td>
<td><code>success</code></td>
<td>Indicates that the body represents a successful response.</td>
<td>String</td>
<td>The value <code>success</code> indicates that this is a successful response.</td>
</tr>
<tr>
<td>amount</td>
@@ -1287,7 +1287,7 @@
<tr>
<td>limit</td>
<td>Integer</td>
<td>Max results per page (defaults to 200). Cannot be more than 1000.</td>
<td>Maximum results per page. Defaults to 200. Cannot be more than 1000.</td>
</tr>
<tr>
<td>marker</td>
@@ -1309,8 +1309,8 @@
<tbody>
<tr>
<td>result</td>
<td><code>success</code></td>
<td>Indicates that the body represents a successful response.</td>
<td>String</td>
<td>The value <code>success</code> indicates that this is a successful response.</td>
</tr>
<tr>
<td>date</td>
@@ -1489,7 +1489,7 @@
<tr>
<td>limit</td>
<td>Integer</td>
<td>Max results per page (defaults to 200). Cannot be more than 1000.</td>
<td>Maximum results per page. Defaults to 200. Cannot be more than 1000.</td>
</tr>
<tr>
<td>marker</td>
@@ -1593,8 +1593,8 @@
<tbody>
<tr>
<td>result</td>
<td><code>success</code></td>
<td>Indicates that the body represents a successful response.</td>
<td>String</td>
<td>The value <code>success</code> indicates that this is a successful response.</td>
</tr>
<tr>
<td>count</td>
@@ -1694,7 +1694,7 @@
<tr>
<td>limit</td>
<td>Integer</td>
<td>Max results per page (defaults to 200). Cannot be more than 1000.</td>
<td>Maximum results per page. Defaults to 200. Cannot be more than 1000.</td>
</tr>
<tr>
<td>marker</td>
@@ -1732,8 +1732,8 @@
<tbody>
<tr>
<td>result</td>
<td><code>success</code></td>
<td>Indicates that the body represents a successful response.</td>
<td>String</td>
<td>The value <code>success</code> indicates that this is a successful response.</td>
</tr>
<tr>
<td>count</td>
@@ -1916,8 +1916,8 @@
<tbody>
<tr>
<td>result</td>
<td><code>success</code></td>
<td>Indicates that the body represents a successful response.</td>
<td>String</td>
<td>The value <code>success</code> indicates that this is a successful response.</td>
</tr>
<tr>
<td>count</td>
@@ -2137,7 +2137,7 @@
<tr>
<td>limit</td>
<td>Integer</td>
<td>Max results per page. Defaults to 200. Cannot be more than 1000.</td>
<td>Maximum results per page. Defaults to 200. Cannot be more than 1000.</td>
</tr>
<tr>
<td>marker</td>
@@ -2164,8 +2164,8 @@
<tbody>
<tr>
<td>result</td>
<td><code>success</code></td>
<td>Indicates that the body represents a successful response.</td>
<td>String</td>
<td>The value <code>success</code> indicates that this is a successful response.</td>
</tr>
<tr>
<td>count</td>
@@ -2352,7 +2352,7 @@
<tr>
<td>limit</td>
<td>Integer</td>
<td>Max results per page. Defaults to 200. Cannot be more than 1000.</td>
<td>Maximum results per page. Defaults to 200. Cannot be more than 1000.</td>
</tr>
<tr>
<td>marker</td>
@@ -2379,8 +2379,8 @@
<tbody>
<tr>
<td>result</td>
<td><code>success</code></td>
<td>Indicates that the body represents a successful response.</td>
<td>String</td>
<td>The value <code>success</code> indicates that this is a successful response.</td>
</tr>
<tr>
<td>count</td>
@@ -2546,7 +2546,7 @@
<tr>
<td>limit</td>
<td>Integer</td>
<td>Max results per page. Defaults to 200. Cannot be more than 1000.</td>
<td>Maximum results per page. Defaults to 200. Cannot be more than 1000.</td>
</tr>
<tr>
<td>marker</td>
@@ -2573,8 +2573,8 @@
<tbody>
<tr>
<td>result</td>
<td><code>success</code></td>
<td>Indicates that the body represents a successful response.</td>
<td>String</td>
<td>The value <code>success</code> indicates that this is a successful response.</td>
</tr>
<tr>
<td>count</td>
@@ -2674,7 +2674,7 @@
</code></pre>
<h2 id="get-top-currencies">Get Top Currencies</h2>
<p><a href="https://github.com/ripple/rippled-historical-database/blob/develop/api/routesV2/network/topCurrencies.js" title="Source">[Source]<br/></a></p>
<p>Returns the top currencies on the Ripple Consensus Ledger over a rolling 30 day window. The currencies are ordered from highest ranked to lowest, where the rank is determined by the volume and count of transactions and the number of unique counterparties. By default, returns the top currencies for the most recent date available. You can query historical data by date. <em>(New in <a href="https://github.com/ripple/rippled-historical-database/releases/tag/v2.1.0">v2.1.0</a>)</em></p>
<p>Returns the top currencies on the Ripple Consensus Ledger, ordered from highest rank to lowest. The ranking is determined by the volume and count of transactions and the number of unique counterparties. By default, returns results for the 30-day rolling window ending on the current date. You can specify a date to get results for the 30-day window ending on that date. <em>(New in <a href="https://github.com/ripple/rippled-historical-database/releases/tag/v2.1.0">v2.1.0</a>)</em></p>
<h4 id="request-format-14">Request Format</h4>
<div class="multicode">
<p><em>Most Recent</em></p>
@@ -2685,6 +2685,7 @@
</code></pre>
</div>
<p><a class="button" href="data-api-v2-tool.html#get-top-currencies">Try it! &gt;</a></p>
<p>This method does not accept any query parameters.</p>
<h4 id="response-format-14">Response Format</h4>
<p>A successful response uses the HTTP code <strong>200 OK</strong> and has a JSON body with the following:</p>
<table>
@@ -2698,8 +2699,8 @@
<tbody>
<tr>
<td>result</td>
<td><code>success</code></td>
<td>Indicates that the body represents a successful response.</td>
<td>String</td>
<td>The value <code>success</code> indicates that this is a successful response.</td>
</tr>
<tr>
<td>date</td>
@@ -2709,12 +2710,12 @@
<tr>
<td>count</td>
<td>Integer</td>
<td>Number of results returned.</td>
<td>Number of objects in the <code>currencies</code> field.</td>
</tr>
<tr>
<td>currencies</td>
<td>Array of Top Currency Objects</td>
<td>A currency + issuer, and the metrics measured for inclusion and ranking</td>
<td>The top currencies for this data sample. Each member represents one currency, by currency code and issuer.</td>
</tr>
</tbody>
</table>
@@ -2741,7 +2742,7 @@
<tr>
<td>avg_exchange_count</td>
<td><a href="#numbers-and-precision">String - Number</a></td>
<td>Daily average number of exchanges</td>
<td>Daily average number of <a href="#exchange-objects">exchanges</a></td>
</tr>
<tr>
<td>avg_exchange_volume</td>
@@ -2751,7 +2752,7 @@
<tr>
<td>avg_payment_count</td>
<td><a href="#numbers-and-precision">String - Number</a></td>
<td>Daily average number of payments</td>
<td>Daily average number of <a href="#payment-objects">payments</a></td>
</tr>
<tr>
<td>avg_payment_volume</td>
@@ -2808,7 +2809,7 @@
</code></pre>
<h2 id="get-top-markets">Get Top Markets</h2>
<p><a href="https://github.com/ripple/rippled-historical-database/blob/develop/api/routesV2/network/topMarkets.js" title="Source">[Source]<br/></a></p>
<p>Returns the top exchange markets on the Ripple Consensus Ledger over a rolling 30 day window. The markets are ordered from highest ranked to lowest, where the rank is determined by the number and volume of exchanges and the number of counterparties participating. By default, returns top markets for the latest date available. You can query historical data by date. <em>(New in <a href="https://github.com/ripple/rippled-historical-database/releases/tag/v2.1.0">v2.1.0</a>)</em></p>
<p>Returns the top exchange markets on the Ripple Consensus Ledger, ordered from highest rank to lowest. The rank is determined by the number and volume of exchanges and the number of counterparties participating. By default, returns top markets for the 30-day rolling window ending on the current date. You can specify a date to get results for the 30-day window ending on that date. <em>(New in <a href="https://github.com/ripple/rippled-historical-database/releases/tag/v2.1.0">v2.1.0</a>)</em></p>
<h4 id="request-format-15">Request Format</h4>
<div class="multicode">
<p><em>Most Recent</em></p>
@@ -2818,6 +2819,7 @@
<pre><code>GET /v2/network/top_markets/2016-01-01
</code></pre>
</div>
<p>This method does not accept any query parameters.</p>
<p><a class="button" href="data-api-v2-tool.html#get-top-markets">Try it! &gt;</a></p>
<h4 id="response-format-15">Response Format</h4>
<p>A successful response uses the HTTP code <strong>200 OK</strong> and has a JSON body with the following:</p>
@@ -2832,23 +2834,23 @@
<tbody>
<tr>
<td>result</td>
<td><code>success</code></td>
<td>Indicates that the body represents a successful response.</td>
<td>String</td>
<td>The value <code>success</code> indicates that this is a successful response.</td>
</tr>
<tr>
<td>date</td>
<td>String - <a href="#timestamps">Timestamp</a></td>
<td>The time at which this data was measured.</td>
<td>The end of the rolling window over which this data was calculated.</td>
</tr>
<tr>
<td>count</td>
<td>Integer</td>
<td>Number of results returned.</td>
<td>Number of results in the <code>markets</code> field.</td>
</tr>
<tr>
<td>markets</td>
<td>Array of Top Market Objects</td>
<td>A currency pair and the metrics measured for inclusion and ranking</td>
<td>The top markets for this data sample. Each member represents a currency pair.</td>
</tr>
</tbody>
</table>
@@ -2895,7 +2897,7 @@
<tr>
<td>avg_exchange_count</td>
<td>String</td>
<td>Daily average number of exchanges</td>
<td>Daily average number of <a href="#exchange-objects">exchanges</a></td>
</tr>
<tr>
<td>avg_volume</td>
@@ -3269,7 +3271,7 @@ Content-Type: image/svg+xml
<tr>
<td>limit</td>
<td>Integer</td>
<td>Max results per page (defaults to 200). Cannot be more than 1,000.</td>
<td>Maximum results per page. Defaults to 200. Cannot be more than 1,000.</td>
</tr>
<tr>
<td>marker</td>
@@ -3311,13 +3313,13 @@ Content-Type: image/svg+xml
<tbody>
<tr>
<td>result</td>
<td><code>success</code></td>
<td>Indicates that the body represents a successful response.</td>
<td>String</td>
<td>The value <code>success</code> indicates that this is a successful response.</td>
</tr>
<tr>
<td>count</td>
<td>Integer</td>
<td>Number of reports returned.</td>
<td>Number of accounts returned.</td>
</tr>
<tr>
<td>marker</td>
@@ -3430,8 +3432,8 @@ Content-Type: image/svg+xml
<tbody>
<tr>
<td>result</td>
<td><code>success</code></td>
<td>Indicates that the body represents a successful response.</td>
<td>String</td>
<td>The value <code>success</code> indicates that this is a successful response.</td>
</tr>
<tr>
<td>account</td>
@@ -3496,12 +3498,12 @@ Content-Type: image/svg+xml
<tr>
<td>ledger_index</td>
<td>Integer</td>
<td>Index of ledger for historical balances</td>
<td>Index of ledger for historical balances.</td>
</tr>
<tr>
<td>ledger_hash</td>
<td>String</td>
<td>Ledger hash for historical balances</td>
<td>Ledger hash for historical balances.</td>
</tr>
<tr>
<td>date</td>
@@ -3511,22 +3513,22 @@ Content-Type: image/svg+xml
<tr>
<td>currency</td>
<td>String</td>
<td>Restrict results to specified currency</td>
<td>Restrict results to specified currency.</td>
</tr>
<tr>
<td>counterparty</td>
<td>String</td>
<td>Restrict results to specified counterparty/issuer</td>
<td>Restrict results to specified counterparty/issuer.</td>
</tr>
<tr>
<td>limit</td>
<td>Integer</td>
<td>Max results per page (defaults to 200). Cannot be greater than 400, but you can use the value <code>all</code> to return all results. (Caution: When using limit=all to retrieve very many results, the request may time out. Large gateways can have several tens of thousands of results.)</td>
<td>Maximum results per page. Defaults to 200. Cannot be greater than 400, but you can use the value <code>all</code> to return all results. (Caution: When using limit=all to retrieve very many results, the request may time out. Large gateways can have several tens of thousands of results.)</td>
</tr>
<tr>
<td>format</td>
<td>String</td>
<td>Format of returned results: <code>csv</code>,<code>json</code> defaults to <code>json</code></td>
<td>Format of returned results: <code>csv</code> or <code>json</code>. Defaults to <code>json</code>.</td>
</tr>
</tbody>
</table>
@@ -3543,33 +3545,33 @@ Content-Type: image/svg+xml
<tbody>
<tr>
<td>result</td>
<td><code>success</code></td>
<td>Indicates that the body represents a successful response.</td>
<td>String</td>
<td>The value <code>success</code> indicates that this is a successful response.</td>
</tr>
<tr>
<td>ledger_index</td>
<td>Integer</td>
<td>ledger index for balances query</td>
<td>ledger index for balances query.</td>
</tr>
<tr>
<td>close_time</td>
<td>String</td>
<td>close time of the ledger</td>
<td>close time of the ledger.</td>
</tr>
<tr>
<td>limit</td>
<td>String</td>
<td>number of results returned, if limit was exceeded</td>
<td>number of results returned, if limit was exceeded.</td>
</tr>
<tr>
<td>marker</td>
<td>String</td>
<td>(May be omitted) <a href="#pagination">Pagination</a> marker</td>
<td>(May be omitted) <a href="#pagination">Pagination</a> marker.</td>
</tr>
<tr>
<td>balances</td>
<td>Array of <a href="#balance-objects-and-balance-change-objects">Balance Object</a>s</td>
<td>The requested balances</td>
<td>The requested balances.</td>
</tr>
</tbody>
</table>
@@ -3657,7 +3659,7 @@ Content-Type: image/svg+xml
<tr>
<td>limit</td>
<td>Integer</td>
<td>Max results per page (defaults to 200). Cannot be greater than 400.</td>
<td>Maximum results per page. Defaults to 200. Cannot be greater than 400.</td>
</tr>
<tr>
<td>format</td>
@@ -3680,8 +3682,8 @@ Content-Type: image/svg+xml
<tbody>
<tr>
<td>result</td>
<td><code>success</code></td>
<td>Indicates that the body represents a successful response.</td>
<td>String</td>
<td>The value <code>success</code> indicates that this is a successful response.</td>
</tr>
<tr>
<td>ledger_index</td>
@@ -3701,7 +3703,7 @@ Content-Type: image/svg+xml
<tr>
<td>orders</td>
<td>Array of order objects</td>
<td>The requested orders</td>
<td>The requested orders.</td>
</tr>
</tbody>
</table>
@@ -3723,7 +3725,7 @@ Content-Type: image/svg+xml
<tr>
<td>specification.direction</td>
<td>String</td>
<td>Either <code>buy</code> or <code>sell</code></td>
<td>Either <code>buy</code> or <code>sell</code>.</td>
</tr>
<tr>
<td>specification.quantity</td>
@@ -3850,13 +3852,13 @@ Content-Type: image/svg+xml
<tbody>
<tr>
<td>start</td>
<td>String</td>
<td>UTC start time of query range</td>
<td>String - <a href="#timestamps">Timestamp</a></td>
<td>Start time of query range. Defaults to the earliest date available.</td>
</tr>
<tr>
<td>end</td>
<td>String</td>
<td>UTC end time of query range</td>
<td>String - <a href="#timestamps">Timestamp</a></td>
<td>End time of query range. Defaults to the current date.</td>
</tr>
<tr>
<td>min_sequence</td>
@@ -3891,7 +3893,7 @@ Content-Type: image/svg+xml
<tr>
<td>limit</td>
<td>Integer</td>
<td>Max results per page (defaults to 20). Cannot be more than 1,000.</td>
<td>Maximum results per page. Defaults to 20. Cannot be more than 1,000.</td>
</tr>
<tr>
<td>marker</td>
@@ -3901,7 +3903,7 @@ Content-Type: image/svg+xml
<tr>
<td>format</td>
<td>String</td>
<td>Format of returned results: <code>csv</code>,<code>json</code> defaults to <code>json</code></td>
<td>Format of returned results: <code>csv</code> or <code>json</code>. Defaults to <code>json</code>.</td>
</tr>
</tbody>
</table>
@@ -3918,8 +3920,8 @@ Content-Type: image/svg+xml
<tbody>
<tr>
<td>result</td>
<td><code>success</code></td>
<td>Indicates that the body represents a successful response.</td>
<td>String</td>
<td>The value <code>success</code> indicates that this is a successful response.</td>
</tr>
<tr>
<td>count</td>
@@ -4066,8 +4068,8 @@ Content-Type: image/svg+xml
<tbody>
<tr>
<td>result</td>
<td><code>success</code></td>
<td>Indicates that the body represents a successful response.</td>
<td>String</td>
<td>The value <code>success</code> indicates that this is a successful response.</td>
</tr>
<tr>
<td>transaction</td>
@@ -4115,7 +4117,7 @@ Content-Type: image/svg+xml
<tr>
<td>:address</td>
<td>String</td>
<td>Ripple address to query</td>
<td>Ripple address to query.</td>
</tr>
</tbody>
</table>
@@ -4172,7 +4174,7 @@ Content-Type: image/svg+xml
<tr>
<td>limit</td>
<td>Integer</td>
<td>Max results per page (defaults to 200). Cannot be more than 1,000.</td>
<td>Maximum results per page. Defaults to 200. Cannot be more than 1,000.</td>
</tr>
<tr>
<td>marker</td>
@@ -4182,7 +4184,7 @@ Content-Type: image/svg+xml
<tr>
<td>format</td>
<td>String</td>
<td>Format of returned results: <code>csv</code>,<code>json</code> defaults to <code>json</code></td>
<td>Format of returned results: <code>csv</code> or <code>json</code>. Defaults to <code>json</code>.</td>
</tr>
</tbody>
</table>
@@ -4199,8 +4201,8 @@ Content-Type: image/svg+xml
<tbody>
<tr>
<td>result</td>
<td><code>success</code></td>
<td>Indicates that the body represents a successful response.</td>
<td>String</td>
<td>The value <code>success</code> indicates that this is a successful response.</td>
</tr>
<tr>
<td>count</td>
@@ -4287,7 +4289,7 @@ Content-Type: image/svg+xml
<tr>
<td>:address</td>
<td>String</td>
<td>Ripple address to query</td>
<td>Ripple address to query.</td>
</tr>
<tr>
<td>:base</td>
@@ -4329,7 +4331,7 @@ Content-Type: image/svg+xml
<tr>
<td>limit</td>
<td>Integer</td>
<td>Max results per page (defaults to 200). Cannot be more than 1000.</td>
<td>Maximum results per page. Defaults to 200. Cannot be more than 1000.</td>
</tr>
<tr>
<td>marker</td>
@@ -4339,7 +4341,7 @@ Content-Type: image/svg+xml
<tr>
<td>format</td>
<td>String</td>
<td>Format of returned results: <code>csv</code>,<code>json</code> defaults to <code>json</code></td>
<td>Format of returned results: <code>csv</code> or <code>json</code>. Defaults to <code>json</code>.</td>
</tr>
</tbody>
</table>
@@ -4356,8 +4358,8 @@ Content-Type: image/svg+xml
<tbody>
<tr>
<td>result</td>
<td><code>success</code></td>
<td>Indicates that the body represents a successful response.</td>
<td>String</td>
<td>The value <code>success</code> indicates that this is a successful response.</td>
</tr>
<tr>
<td>count</td>
@@ -4450,7 +4452,7 @@ Content-Type: image/svg+xml
<tr>
<td>:address</td>
<td>String</td>
<td>Ripple address to query</td>
<td>Ripple address to query.</td>
</tr>
</tbody>
</table>
@@ -4492,7 +4494,7 @@ Content-Type: image/svg+xml
<tr>
<td>limit</td>
<td>Integer</td>
<td>Max results per page (defaults to 200). Cannot be more than 1000.</td>
<td>Maximum results per page. Defaults to 200. Cannot be more than 1000.</td>
</tr>
<tr>
<td>marker</td>
@@ -4519,8 +4521,8 @@ Content-Type: image/svg+xml
<tbody>
<tr>
<td>result</td>
<td><code>success</code></td>
<td>Indicates that the body represents a successful response.</td>
<td>String</td>
<td>The value <code>success</code> indicates that this is a successful response.</td>
</tr>
<tr>
<td>count</td>
@@ -4608,7 +4610,7 @@ Content-Type: image/svg+xml
<tr>
<td>:address</td>
<td>String</td>
<td>Ripple address to query</td>
<td>Ripple address to query.</td>
</tr>
<tr>
<td>:date</td>
@@ -4629,13 +4631,13 @@ Content-Type: image/svg+xml
<tbody>
<tr>
<td>start</td>
<td>String</td>
<td>UTC start time of query range. Defaults to start of current date. Ignored if <code>date</code> specified.</td>
<td>String - <a href="#timestamps">Timestamp</a></td>
<td>Start time of query range. Defaults to start of current date. Ignored if <code>date</code> specified.</td>
</tr>
<tr>
<td>end</td>
<td>String</td>
<td>UTC end time of query range. Defaults to current date. Ignored if <code>date</code> specified.</td>
<td>String - <a href="#timestamps">Timestamp</a></td>
<td>End time of query range. Defaults to current date. Ignored if <code>date</code> specified.</td>
</tr>
<tr>
<td>accounts</td>
@@ -4655,7 +4657,7 @@ Content-Type: image/svg+xml
<tr>
<td>format</td>
<td>String</td>
<td>Format of returned results: <code>csv</code>,<code>json</code> defaults to <code>json</code></td>
<td>Format of returned results: <code>csv</code> or <code>json</code>. Defaults to <code>json</code>.</td>
</tr>
</tbody>
</table>
@@ -4672,13 +4674,13 @@ Content-Type: image/svg+xml
<tbody>
<tr>
<td>result</td>
<td><code>success</code></td>
<td>Indicates that the body represents a successful response.</td>
<td>String</td>
<td>The value <code>success</code> indicates that this is a successful response.</td>
</tr>
<tr>
<td>count</td>
<td>Integer</td>
<td>Number of reports returned.</td>
<td>Number of reports in the <code>reports</code> field.</td>
</tr>
<tr>
<td>reports</td>
@@ -4760,7 +4762,7 @@ Content-Type: image/svg+xml
<tr>
<td>:address</td>
<td>String</td>
<td>Ripple address to query</td>
<td>Ripple address to query.</td>
</tr>
</tbody>
</table>
@@ -4776,18 +4778,18 @@ Content-Type: image/svg+xml
<tbody>
<tr>
<td>start</td>
<td>String</td>
<td>UTC start time of query range. Defaults to start of current date.</td>
<td>String - <a href="#timestamps">Timestamp</a></td>
<td>Start time of query range. Defaults to the earliest date available.</td>
</tr>
<tr>
<td>end</td>
<td>String</td>
<td>UTC end time of query range. Defaults to current date.</td>
<td>String - <a href="#timestamps">Timestamp</a></td>
<td>End time of query range. Defaults to the current date.</td>
</tr>
<tr>
<td>limit</td>
<td>Integer</td>
<td>Max results per page (defaults to 200). Cannot be more than 1000.</td>
<td>Maximum results per page. Defaults to 200. Cannot be more than 1000.</td>
</tr>
<tr>
<td>descending</td>
@@ -4802,7 +4804,7 @@ Content-Type: image/svg+xml
<tr>
<td>format</td>
<td>String</td>
<td>Format of returned results: <code>csv</code>,<code>json</code> defaults to <code>json</code></td>
<td>Format of returned results: <code>csv</code> or <code>json</code>. Defaults to <code>json</code>.</td>
</tr>
</tbody>
</table>
@@ -4819,13 +4821,13 @@ Content-Type: image/svg+xml
<tbody>
<tr>
<td>result</td>
<td><code>success</code></td>
<td>Indicates that the body represents a successful response.</td>
<td>String</td>
<td>The value <code>success</code> indicates that this is a successful response.</td>
</tr>
<tr>
<td>count</td>
<td>Integer</td>
<td>Number of reports returned.</td>
<td>Number of transaction stats objects in the <code>rows</code> field.</td>
</tr>
<tr>
<td>rows</td>
@@ -4847,7 +4849,7 @@ Content-Type: image/svg+xml
<tr>
<td>date</td>
<td>String - <a href="#timestamps">Timestamp</a></td>
<td>The date this transaction stats object describes.</td>
<td>This object describes activity on this date.</td>
</tr>
<tr>
<td>transaction_count</td>
@@ -4923,7 +4925,7 @@ Content-Type: image/svg+xml
<tr>
<td>:address</td>
<td>String</td>
<td>Ripple address to query</td>
<td>Ripple address to query.</td>
</tr>
</tbody>
</table>
@@ -4950,7 +4952,7 @@ Content-Type: image/svg+xml
<tr>
<td>limit</td>
<td>Integer</td>
<td>Max results per page (defaults to 200). Cannot be more than 1000.</td>
<td>Maximum results per page. Defaults to 200. Cannot be more than 1000.</td>
</tr>
<tr>
<td>marker</td>
@@ -4982,13 +4984,13 @@ Content-Type: image/svg+xml
<tbody>
<tr>
<td>result</td>
<td><code>success</code></td>
<td>Indicates that the body represents a successful response.</td>
<td>String</td>
<td>The value <code>success</code> indicates that this is a successful response.</td>
</tr>
<tr>
<td>count</td>
<td>Integer</td>
<td>Number of reports returned.</td>
<td>Number of value stats objects in the <code>rows</code> field.</td>
</tr>
<tr>
<td>rows</td>
@@ -5010,7 +5012,7 @@ Content-Type: image/svg+xml
<tr>
<td>date</td>
<td>String - <a href="#timestamps">Timestamp</a></td>
<td>This date this object describes.</td>
<td>This object describes activity on this date.</td>
</tr>
<tr>
<td>value</td>