ARCHIVE/xrpl-dev-portal
1
0
Fork 0
mirror of https://github.com/XRPLF/xrpl-dev-portal.git synced 2026-06-06 02:06:51 +00:00
Code Issues Packages Projects Releases Wiki Activity

data v2 - peer review edits

Browse Source
This commit is contained in:
mDuo13
2015-11-30 18:16:25 -08:00
parent 85f840a028
commit a8ae2171ea
2 changed files with 191 additions and 180 deletions
Download Patch File Download Diff File Expand all files Collapse all files

191
content/data_v2.md
View File

@@ -255,14 +255,14 @@ Optionally, you can include the following query parameters:
| Field | Value | Description |
|------------|-------|-------------|
| start | String - [Timestamp][] | Filter results to this time and later |
| end | String - [Timestamp][] | Filter results to this time and earlier |
| descending | Boolean | reverse chronological order |
| type | String | filter transactions for a specific transaction type |
| result | String | filter transactions for a specific transaction result |
| binary | Boolean | return transactions in binary form |
| limit | Integer | max results per page (defaults to 20). Cannot be more than 100. |
| marker | String | The pagination marker from a previous response |
| start | String - [Timestamp][] | Filter results to this time and later. |
| end | String - [Timestamp][] | Filter results to this time and earlier. |
| descending | Boolean | If true, return results in reverse chronological order. Defaults to false. |
| type | String | Filter transactions to a specific [transaction type](transactions.html). |
| result | String | Filter transactions for a specific [transaction result](transactions.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. |
| marker | String | [Pagination](#pagination) marker from a previous response. |
#### Response Format ####
A successful response uses the HTTP code **200 OK** and has a JSON body with the following:
@@ -423,12 +423,12 @@ Optionally, you can also include the following query parameters:
| Field | Value | Description |
|------------|---------|-------------|
| start | String - [Timestamp][] | Filter results to this time and later |
| end | String - [Timestamp][] | Filter results to this time and earlier |
| start | String - [Timestamp][] | Filter results to this time and later. |
| 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 cronological order |
| descending | Boolean | Reverse chronological order. |
| limit | Integer | Max results per page (defaults to 200). Cannot be more than 1000. |
| marker | String | Pagination key from previously returned response |
| marker | String | [Pagination](#pagination) key from previously returned response. |
| format | String | Format of returned results: `csv` or `json`. Defaults to `json`. |
@@ -439,8 +439,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 Transactions returned. |
| marker | String | (May be omitted) Pagination marker |
| 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 |
@@ -567,15 +567,15 @@ Optionally, you can also include the following query parameters:
| Field | Value | Description |
|-------------|-------|-------------|
| start | String - [Timestamp][] | Filter results to this time and later |
| end | String - [Timestamp][] | Filter results to this time and earlier |
| interval | String | Aggregation interval: `1minute`, `5minute`, `15minute`, `30minute`, `1hour`, `2hour`, `4hour`, `1day`, `3day`, `7day`, or `1month` |
| descending | Boolean | reverse chronological order |
| reduce | Boolean | aggregate all individual results. |
| limit | Integer | max results per page (defaults to 200). Cannot be more than 20,000 if `reduce` is true. Otherwise cannot be more than 1,000. |
| marker | String | pagination key from previously returned response |
| autobridged | Boolean | return only results from autobridged exchanges |
| format | String | format of returned results: `csv`,`json` defaults to `json` |
| start | String - [Timestamp][] | Filter results to this time and later. |
| end | String - [Timestamp][] | Filter results to this time and earlier. |
| interval | String | Aggregation interval: `1minute`, `5minute`, `15minute`, `30minute`, `1hour`, `2hour`, `4hour`, `1day`, `3day`, `7day`, or `1month`. Defaults to non-aggregated results. |
| descending | Boolean | If true, return results in reverse chronological order. |
| reduce | Boolean | Aggregate all individual results. Defaults to false. |
| limit | Integer | Maximum results per page (defaults to 200). Cannot be more than 20,000 if `reduce` is true. Otherwise cannot be more than 1,000. |
| marker | String | [Pagination](#pagination) key from previously returned response. |
| autobridged | Boolean | If true, filter results to autobridged exchanges only. |
| 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:
@@ -584,7 +584,7 @@ A successful response uses the HTTP code **200 OK** and has a JSON body with the
|--------|-------|-------------|
| result | `success` | Indicates that the body represents a successful response. |
| count | Integer | Number of Transactions returned. |
| marker | String | (May be omitted) Pagination marker |
| marker | String | (May be omitted) [Pagination](#pagination) marker |
| exchanges | Array of [Exchange Objects][] | The requested exchanges |
#### Example ####
@@ -814,7 +814,7 @@ GET /v2/reports/{:date}
<!--</div>-->
This method requires the following URL parameters:
This method uses the following URL parameters:
| Field | Value | Description |
|-------|--------|-------------|
@@ -824,11 +824,11 @@ Optionally, you can also include the following query parameters:
| Field | Value | Description |
|----------|---------|-------------|
| accounts | Boolean | Include lists of counterparty accounts |
| payments | Boolean | Include lists of individual payments |
| 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. |
| marker | String | Pagination key from previously returned response |
| marker | String | [Pagination](#pagination) key from previously returned response |
#### Response Format ####
@@ -839,7 +839,7 @@ A successful response uses the HTTP code **200 OK** and has a JSON body with the
| result | `success` | Indicates that the body represents 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 marker. |
| marker | String | (May be omitted) [Pagination](#pagination) marker. |
| reports | Array of [Reports Objects][] | The requested reports. Each report pertains to a single account. |
**WARNING:** This method may return a very large amount of data (more than 1 megabyte), which may cause poor performance in your client application.
@@ -983,13 +983,13 @@ Optionally, you can also include the following query parameters:
|------------|---------|-------------|
| family | String | If provided, filter results to a single family of stats: `type`, `result`, or `metric`. By default, provides all stats from all families. |
| metrics | String | Filter results to one or more metrics (in a comma-separated list). Requires the `family` of the metrics to be specified. By default, provides all metrics in the family. |
| end | String - [Timestamp][] | Filter results to this time and earlier |
| 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. |
| marker | String | Pagination key from previously returned response |
| descending | Boolean | Reverse chronological order |
| format | String | Format of returned results: `csv`,`json` defaults to `json` |
| 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`. |
##### Families and Metrics #####
@@ -997,7 +997,7 @@ The `family` and `metrics` query parameters provide a way to filter results to a
| Family | Included Metrics | Meaning |
|--------|------------------|---------|
| type | All Ripple transaction types, including `Payment`, `AccountSet`, `SetRegularKey`, `OfferCreate`, `OfferCancel`, `TrustSet`. | Number of transactions of the given type that occurred during the interval. |
| type | All Ripple [transaction types](transactions.html), including `Payment`, `AccountSet`, `SetRegularKey`, `OfferCreate`, `OfferCancel`, `TrustSet`. | Number of transactions of the given type that occurred during the interval. |
| result | All [transaction result codes](transactions.html#transaction-results) (string codes, not the numeric codes), including `tesSUCCESS`, `tecPATH_DRY`, and many others. | Number of transactions that resulted in the given code during the interval. |
| metric | Data-API defined Special Transaction Metrics. | (Varies) |
@@ -1023,7 +1023,7 @@ A successful response uses the HTTP code **200 OK** and has a JSON body with the
|--------|-------|-------------|
| result | `success` | Indicates that the body represents a successful response. |
| count | Integer | Number of reports returned. |
| marker | String | (May be omitted) Pagination marker |
| 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. |
#### Example ####
@@ -1065,7 +1065,7 @@ Response:
## Get Capitalization ##
[[Source]<br>](https://github.com/ripple/rippled-historical-database/blob/develop/api/routesV2/capitalization.js "Source")
Get capitalization data for a specific currency and issuer. _(New in [v2.0.4][])_
Get the total amount of a single currency issued by a single issuer, also known as the [market capitalization](https://en.wikipedia.org/wiki/Market_capitalization). _(New in [v2.0.4][])_
#### Request Format ####
@@ -1090,15 +1090,17 @@ Optionally, you can also include the following query parameters:
| Field | Value | Description |
|------------|---------|-------------|
| start | String - [Timestamp][] | Start time of query range. Defaults to the most recent sample. |
| end | String - [Timestamp][] | End time of query range |
| 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. |
| marker | String | Pagination key from previously returned response |
| descending | Boolean | Reverse cronological order |
| adjusted | Boolean | If true, adjust results by removing known issuer owned wallets. Defaults to true. |
| 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. |
| format | String | Format of returned results: `csv` or `json`. Defaults to `json`. |
If the request omits both `start` and `end`, the API returns only the most recent sample.
#### Response Format ####
A successful response uses the HTTP code **200 OK** and has a JSON body with the following:
@@ -1109,10 +1111,10 @@ A successful response uses the HTTP code **200 OK** and has a JSON body with the
| count | Integer | Number of reports returned. |
| currency | String | Currency requested |
| issuer | String | Issuer requested |
| marker | String | (May be omitted) Pagination marker |
| marker | String | (May be omitted) [Pagination](#pagination) marker |
| rows | Array of issuer capitalization objects | The requested capitalization data |
Each issuer capitalization object has the following fields:
Each **issuer capitalization object** has the following fields:
| Field | Value | Description |
|--------|-------|-------------|
@@ -1338,6 +1340,8 @@ Response:
Get aggregated exchange volume for a given time period. _(New in [v2.0.4][])_
The API returns results in units of a single _display currency_ rather than many different currencies. The conversion uses standard rates to and from XRP.
#### Request Format ####
<!--<div class='multicode'>-->
@@ -1360,7 +1364,7 @@ Optionally, you can include the following query parameters:
| 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. |
| marker | String | Pagination key from previously returned response |
| marker | String | [Pagination](#pagination) key from previously returned response |
| format | String | Format of returned results: `csv` or `json`. Defaults to `json`. |
#### Response Format ####
@@ -1482,6 +1486,8 @@ Response:
Get aggregated payment volume for a given time period. _(New in [v2.0.4][])_
The API returns results in units of a single _display currency_ rather than many different currencies. The conversion uses standard rates to and from XRP.
#### Request Format ####
<!--<div class='multicode'>-->
@@ -1504,7 +1510,7 @@ Optionally, you can include the following query parameters:
| 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. |
| marker | String | Pagination key from previously returned response |
| marker | String | [Pagination](#pagination) key from previously returned response |
| format | String | Format of returned results: `csv` or `json`. Defaults to `json`. |
#### Response Format ####
@@ -1520,8 +1526,8 @@ Each object in the `components` array of the Volume Objects represent the volume
| Field | Value | Description |
|--------|--------|-------------|
| currency | String - [Currency Code][] | This object represents payment volume for this currency. |
| issuer | String - [Address][] | (Omitted for XRP) This object represents payment volume for the currency issued by this account. |
| currency | String - [Currency Code][] | The currency of this payment volume object. |
| issuer | String - [Address][] | (Omitted for XRP) The issuer of this payment volume object. |
| amount | Number | Total payment volume for this currency during the interval, in units of the currency itself. |
| count | Number | The total number of payments in this currency |
| rate | Number | The exchange rate between this currency and the display currency. |
@@ -1605,7 +1611,9 @@ Response:
## Get Issued Value ##
[[Source]<br>](https://github.com/ripple/rippled-historical-database/blob/develop/api/routesV2/network/getMetric.js "Source")
Get total capitalization for a selection of major gateways over time. By default, returns only the most recent measurement. _(New in [v2.0.4][])_
Get the total value of all currencies issued by a selection of major gateways over time. By default, returns only the most recent measurement. _(New in [v2.0.4][])_
The API returns results in units of a single _display currency_ rather than many different currencies. The conversion uses standard rates to and from XRP.
#### Request Format ####
@@ -1628,7 +1636,7 @@ Optionally, you can include the following query parameters:
| 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. |
| marker | String | Pagination key from previously returned response |
| marker | String | [Pagination](#pagination) key from previously returned response |
| format | String | Format of returned results: `csv` or `json`. Defaults to `json`. |
#### Response Format ####
@@ -1711,7 +1719,7 @@ Response:
## Get All Gateways ##
[[Source]<br>](https://github.com/ripple/rippled-historical-database/blob/develop/api/routesV2/gateways.js "Source")
Get information about known gateways. _(New in [v2.0.4][])_
Get information about [known gateways](https://github.com/ripple/rippled-historical-database/blob/v2.0.4/api/gateways/gateways.json). _(New in [v2.0.4][])_
#### Request Format ####
@@ -1732,16 +1740,13 @@ This method takes no query parameters.
A successful response uses the HTTP code **200 OK** and has a JSON body.
Each field in the top level JSON object is a [Currency Code][]. The content of each field is an array of gateway objects that issue that currency.
Each gateway object represents a gateway, and has the following fields:
Each field in the top level JSON object is a [Currency Code][]. The content of each field is an array of objects, representing gateways that issue that currency. Each object has the following fields:
| Field | Value | Description |
|----------|---------|-------------|
| name | String | A human-readable proper name for the gateway. |
| account | String - [Address][] | The issuing account (cold wallet) that issues the currency. |
| featured | Boolean | Whether this gateway considered a "featured" issuer of the currency. Ripple, Inc. decides which gateways to feature based on responsible business practices, volume, and other measures. |
| featured | Boolean | Whether this gateway is considered a "featured" issuer of the currency. Ripple, Inc. decides which gateways to feature based on responsible business practices, volume, and other measures. |
| label | String | (May be omitted) Only provided when the [Currency Code][] is a 40-character hexadecimal value. This is an alternate human-readable name for the currency issued by this gateway.
| assets | Array of Strings | Graphics filenames available for this gateway, if any. (Mostly, these are logos used by Ripple Charts.) |
@@ -1808,7 +1813,7 @@ Response:
## Get Gateway ##
[[Source]<br>](https://github.com/ripple/rippled-historical-database/blob/develop/api/routesV2/gateways.js "Source")
Get information about a specific known gateway. _(New in [v2.0.4][])_
Get information about a specific gateway from [the Data API's list of known gateways](https://github.com/ripple/rippled-historical-database/blob/v2.0.4/api/gateways/gateways.json). _(New in [v2.0.4][])_
#### Request Format ####
@@ -1838,9 +1843,9 @@ A successful response uses the HTTP code **200 OK** and has a JSON body with the
|-------------|--------|-------------|
| name | String | Human-readable name of the gateway
| start\_date | String - [Timestamp][] | The approximate date of the first time exchanges for this gateway's currencies appeared in the ledger. |
| accounts | Array | A list of issuing accounts used by this gateway. (Gateways may use different issuing accounts for different currencies.) |
| hotwallets | Array of [Address][]es | The addresses of the Ripple accounts this gateway uses as hot wallets. |
| domain | String | The domain name where this gateway does business. Typically it has a `ripple.txt` hosted there. |
| accounts | Array | A list of [issuing accounts](gateway_guide.html#hot-and-cold-wallets) (cold wallets) used by this gateway. (Gateways may use different issuing accounts for different currencies.) |
| hotwallets | Array of [Address][]es | The addresses of the Ripple accounts this gateway uses as [hot wallets](gateway_guide.html#hot-and-cold-wallets). |
| domain | String | The domain name where this gateway does business. Typically the gateway hosts a [`ripple.txt`](https://wiki.ripple.com/Ripple.txt) there. |
| normalized | String | A normalized version of the `name` field suitable for including in URLs. |
| assets | Array of Strings | Graphics filenames available for this gateway, if any. (Mostly, these are logos used by Ripple Charts.) |
@@ -1848,7 +1853,7 @@ Each object in the `accounts` field array has the following fields:
| Field | Value | Description |
|------------|--------|-------------|
| address | String | The [Address][] of an issuing account (cold wallet) used by this gateway. |
| address | String | The [Address][] of an [issuing account](gateway_guide.html#hot-and-cold-wallets) (cold wallet) used by this gateway. |
| currencies | Object | Each field in this object is a [Currency Code][] corresponding to a currency issued from this address. Each value is an object with a `featured` boolean indicating whether that currency is featured. Ripple, Inc. decides which currencies and gateways to feature based on responsible business practices, volume, and other measures. |
#### Example ####
@@ -1981,7 +1986,7 @@ Optionally, you can include the following query parameters:
| 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. |
| marker | String | Pagination key from previously returned response |
| 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. |
| reduce | Boolean | Return a count of results only |
@@ -1994,7 +1999,7 @@ A successful response uses the HTTP code **200 OK** and has a JSON body with the
|--------|-------|-------------|
| result | `success` | Indicates that the body represents a successful response. |
| count | Integer | Number of reports returned. |
| marker | String | (May be omitted) Pagination marker |
| 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). |
##### Interval Objects #####
@@ -2152,7 +2157,7 @@ A successful response uses the HTTP code **200 OK** and has a JSON body with the
| 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 marker |
| marker | String | (May be omitted) [Pagination](#pagination) marker |
| balances | Array of [Balance Object][]s | The requested balances |
#### Example ####
@@ -2232,13 +2237,15 @@ This method requires the following URL parameters:
Optionally, you can also include the following query parameters:
| Field | Value | Description |
|--------------|---------|-------------|
| ledger_index | Integer | Index of ledger for historical orders |
| ledger_hash | String | Ledger hash for historical orders |
| date | String | UTC date for historical orders. |
| limit | Integer | Max results per page (defaults to 200). Cannot be greater than 400. |
| format | String | Format of returned results: `csv` or `json`. Defaults to `json`. |
| Field | Value | Description |
|---------------|---------|-------------|
| 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. |
| 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.
#### Response Format ####
A successful response uses the HTTP code **200 OK** and has a JSON body with the following:
@@ -2246,9 +2253,9 @@ 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. |
| ledger_index | Integer | ledger index for orders query |
| close_time | String | close time of the ledger |
| limit | String | number of results returned, if limit was exceeded |
| 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 |
Each order object has the following fields:
@@ -2258,7 +2265,7 @@ Each order object has the following fields:
| specification | Object | Details of this order's current state. |
| 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 spent or gained in order to buy or sell the base currency. 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. |
| properties.maker | String - [Address][] | The Ripple account that placed the order. |
| properties.sequence | Number | The sequence number of the transaction that placed this order. |
@@ -2360,12 +2367,12 @@ Optionally, you can also include the following query parameters:
| end | String | UTC end time of query range |
| 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 |
| type | String | Restrict results to a specified [transaction type](transactions.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. |
| marker | String | Pagination key from previously returned response |
| marker | String | [Pagination](#pagination) key from previously returned response |
| format | String | Format of returned results: `csv`,`json` defaults to `json` |
@@ -2377,7 +2384,7 @@ A successful response uses the HTTP code **200 OK** and has a JSON body with the
|--------|-------|-------------|
| result | `success` | Indicates that the body represents a successful response. |
| count | Integer | The number of objects contained in the `transactions` field. |
| marker | String | (May be omitted) Pagination marker |
| marker | String | (May be omitted) [Pagination](#pagination) marker |
| transactions | Array of [transaction objects](#transaction-objects) | All transactions matching the request. |
#### Example ####
@@ -2557,7 +2564,7 @@ Optionally, you can also include the following query parameters:
| issuer | String | Restrict results to specified issuer |
| descending | Boolean | Reverse chronological order |
| limit | Integer | Max results per page (defaults to 200). Cannot be more than 1,000. |
| marker | String | Pagination key from previously returned response |
| marker | String | [Pagination](#pagination) key from previously returned response |
| format | String | Format of returned results: `csv`,`json` defaults to `json` |
@@ -2569,7 +2576,7 @@ A successful response uses the HTTP code **200 OK** and has a JSON body with the
|--------|-------|-------------|
| result | `success` | Indicates that the body represents a successful response. |
| count | Integer | The number of objects contained in the `payments` field. |
| marker | String | (May be omitted) Pagination marker |
| marker | String | (May be omitted) [Pagination](#pagination) marker |
| payments | Array of [payment objects][] | All payments matching the request. |
#### Example ####
@@ -2664,7 +2671,7 @@ Optionally, you can also include the following query parameters:
| 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. |
| marker | String | Pagination key from previously returned response |
| marker | String | [Pagination](#pagination) key from previously returned response |
| format | String | Format of returned results: `csv`,`json` defaults to `json` |
@@ -2675,7 +2682,7 @@ A successful response uses the HTTP code **200 OK** and has a JSON body with the
|--------|-------|-------------|
| result | `success` | Indicates that the body represents a successful response. |
| count | Integer | Number of exchanges returned. |
| marker | String | (May be omitted) Pagination marker |
| marker | String | (May be omitted) [Pagination](#pagination) marker |
| exchanges | Array of [Exchange Objects][] | The requested exchanges |
#### Example ####
@@ -2767,14 +2774,14 @@ Optionally, you can also include the following query parameters:
| Field | Value | Description |
|------------|---------|-------------|
| currency | String | Restrict results to specified currency |
| issuer | String | Restrict results to specified counterparty/issuer |
| start | String - [Timestamp][] | Start time of query range |
| end | String - [Timestamp][] | End time of query range |
| descending | Boolean | Reverse chronological order |
| currency | String | Restrict results to specified currency. |
| issuer | String | Restrict results to specified counterparty/issuer. |
| 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. |
| marker | String | Pagination key from previously returned response |
| format | String | Format of returned results: `csv`,`json` defaults to `json` |
| marker | String | [Pagination](#pagination) key from previously returned response. |
| format | String | Format of returned results: `csv` or`json`. Defaults to `json`. |
#### Response Format ####
@@ -2784,8 +2791,8 @@ A successful response uses the HTTP code **200 OK** and has a JSON body with the
|--------|-------|-------------|
| result | `success` | Indicates that the body represents a successful response. |
| count | Integer | Number of balance changes returned. |
| marker | String | (May be omitted) Pagination marker |
| exchanges | Array of [balance change descriptors][] | The requested balance changes |
| marker | String | (May be omitted) [Pagination](#pagination) marker. |
| exchanges | Array of [balance change descriptors][] | The requested balance changes. |
#### Example ####
@@ -3056,7 +3063,7 @@ Currencies in Ripple can be represented in two ways:
Many queries may return more data than is reasonable to return in a single HTTP response. The Data API uses a "limit and marker" system to control how much is returned in a single response ("page") and to query for additional content.
The `limit` query parameter to many requests restricts the response to a specific number of results in the response. The types of results and default values vary by based on the method. Most of the time, the `limit` is **200** by default, and can be set as high as **1000**. Any value over the maximum `limit` value is treated as the maximum instead.
The `limit` query parameter to many requests restricts the response to a specific number of results in the response. The types of results and default values vary based on the method. For most methods, the `limit` is **200** by default, and can be set as high as **1000**. If you specify a `limit` larger than the maximum, the API uses the maximum value instead.
When a query has additional objects that are not contained in the current response, the JSON response contains a top-level field `marker` which indicates that you can retrieve additional results by including the contents of the `marker` field as the `marker` query parameter of a subsequent request. For the follow-up request, you should use the same parameters as the initial request. When the response omits the `marker` parameter, that indicates that you have reached the end of the queryable data.
@@ -3191,7 +3198,7 @@ A Payment Summary Object contains a reduced amount of information about a single
## Payment Objects ##
[Payment Objects]: #payment-objects
In the Data API, a Payment Object represents an event where one account sent value to another account. This mostly lines up with Ripple transactions of the `Payment` transaction type, except that the Data API does not consider a transaction to be a payment if the sending `Account` and the `Destination` account are the same, or if the transaction failed.
In the Data API, a Payment Object represents an event where one account sent value to another account. This mostly lines up with Ripple transactions of the `Payment` [transaction type](transactions.html), except that the Data API does not consider a transaction to be a payment if the sending `Account` and the `Destination` account are the same, or if the transaction failed.
Payment objects have the following fields:

180
data_api_v2.html
View File

@@ -428,42 +428,42 @@
<tr>
<td>start</td>
<td>String - <a href="#timestamps">Timestamp</a></td>
<td>Filter results to this time and later</td>
<td>Filter results to this time and later.</td>
</tr>
<tr>
<td>end</td>
<td>String - <a href="#timestamps">Timestamp</a></td>
<td>Filter results to this time and earlier</td>
<td>Filter results to this time and earlier.</td>
</tr>
<tr>
<td>descending</td>
<td>Boolean</td>
<td>reverse chronological order</td>
<td>If true, return results in reverse chronological order. Defaults to false.</td>
</tr>
<tr>
<td>type</td>
<td>String</td>
<td>filter transactions for a specific transaction type</td>
<td>Filter transactions to a specific <a href="transactions.html">transaction type</a>.</td>
</tr>
<tr>
<td>result</td>
<td>String</td>
<td>filter transactions for a specific transaction result</td>
<td>Filter transactions for a specific <a href="transactions.html#transaction-results">transaction result</a>.</td>
</tr>
<tr>
<td>binary</td>
<td>Boolean</td>
<td>return transactions in binary form</td>
<td>If true, return transactions in binary form. Defaults to false.</td>
</tr>
<tr>
<td>limit</td>
<td>Integer</td>
<td>max results per page (defaults to 20). Cannot be more than 100.</td>
<td>Max results per page (defaults to 20). Cannot be more than 100.</td>
</tr>
<tr>
<td>marker</td>
<td>String</td>
<td>The pagination marker from a previous response</td>
<td><a href="#pagination">Pagination</a> marker from a previous response.</td>
</tr>
</tbody>
</table>
@@ -648,12 +648,12 @@
<tr>
<td>start</td>
<td>String - <a href="#timestamps">Timestamp</a></td>
<td>Filter results to this time and later</td>
<td>Filter results to this time and later.</td>
</tr>
<tr>
<td>end</td>
<td>String - <a href="#timestamps">Timestamp</a></td>
<td>Filter results to this time and earlier</td>
<td>Filter results to this time and earlier.</td>
</tr>
<tr>
<td>interval</td>
@@ -663,7 +663,7 @@
<tr>
<td>descending</td>
<td>Boolean</td>
<td>Reverse cronological order</td>
<td>Reverse chronological order.</td>
</tr>
<tr>
<td>limit</td>
@@ -673,7 +673,7 @@
<tr>
<td>marker</td>
<td>String</td>
<td>Pagination key from previously returned response</td>
<td><a href="#pagination">Pagination</a> key from previously returned response.</td>
</tr>
<tr>
<td>format</td>
@@ -701,12 +701,12 @@
<tr>
<td>count</td>
<td>Integer</td>
<td>Number of Transactions returned.</td>
<td>Number of Transactions returned</td>
</tr>
<tr>
<td>marker</td>
<td>String</td>
<td>(May be omitted) Pagination marker</td>
<td>(May be omitted) <a href="#pagination">Pagination</a> marker</td>
</tr>
<tr>
<td>payments</td>
@@ -873,47 +873,47 @@
<tr>
<td>start</td>
<td>String - <a href="#timestamps">Timestamp</a></td>
<td>Filter results to this time and later</td>
<td>Filter results to this time and later.</td>
</tr>
<tr>
<td>end</td>
<td>String - <a href="#timestamps">Timestamp</a></td>
<td>Filter results to this time and earlier</td>
<td>Filter results to this time and earlier.</td>
</tr>
<tr>
<td>interval</td>
<td>String</td>
<td>Aggregation interval: <code>1minute</code>, <code>5minute</code>, <code>15minute</code>, <code>30minute</code>, <code>1hour</code>, <code>2hour</code>, <code>4hour</code>, <code>1day</code>, <code>3day</code>, <code>7day</code>, or <code>1month</code></td>
<td>Aggregation interval: <code>1minute</code>, <code>5minute</code>, <code>15minute</code>, <code>30minute</code>, <code>1hour</code>, <code>2hour</code>, <code>4hour</code>, <code>1day</code>, <code>3day</code>, <code>7day</code>, or <code>1month</code>. Defaults to non-aggregated results.</td>
</tr>
<tr>
<td>descending</td>
<td>Boolean</td>
<td>reverse chronological order</td>
<td>If true, return results in reverse chronological order.</td>
</tr>
<tr>
<td>reduce</td>
<td>Boolean</td>
<td>aggregate all individual results.</td>
<td>Aggregate all individual results. Defaults to false.</td>
</tr>
<tr>
<td>limit</td>
<td>Integer</td>
<td>max results per page (defaults to 200). Cannot be more than 20,000 if <code>reduce</code> is true. Otherwise cannot be more than 1,000.</td>
<td>Maximum results per page (defaults to 200). Cannot be more than 20,000 if <code>reduce</code> is true. Otherwise cannot be more than 1,000.</td>
</tr>
<tr>
<td>marker</td>
<td>String</td>
<td>pagination key from previously returned response</td>
<td><a href="#pagination">Pagination</a> key from previously returned response.</td>
</tr>
<tr>
<td>autobridged</td>
<td>Boolean</td>
<td>return only results from autobridged exchanges</td>
<td>If true, filter results to autobridged exchanges only.</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>
@@ -941,7 +941,7 @@
<tr>
<td>marker</td>
<td>String</td>
<td>(May be omitted) Pagination marker</td>
<td>(May be omitted) <a href="#pagination">Pagination</a> marker</td>
</tr>
<tr>
<td>exchanges</td>
@@ -1221,7 +1221,7 @@
<pre><code>GET /v2/reports/{:date}
</code></pre>
</div>
<p>This method requires the following URL parameters:</p>
<p>This method uses the following URL parameters:</p>
<table>
<thead>
<tr>
@@ -1251,12 +1251,12 @@
<tr>
<td>accounts</td>
<td>Boolean</td>
<td>Include lists of counterparty accounts</td>
<td>If true, include lists of counterparty accounts. Defaults to false.</td>
</tr>
<tr>
<td>payments</td>
<td>Boolean</td>
<td>Include lists of individual payments</td>
<td>If true, include lists of individual payments. Defaults to false.</td>
</tr>
<tr>
<td>format</td>
@@ -1271,7 +1271,7 @@
<tr>
<td>marker</td>
<td>String</td>
<td>Pagination key from previously returned response</td>
<td><a href="#pagination">Pagination</a> key from previously returned response</td>
</tr>
</tbody>
</table>
@@ -1304,7 +1304,7 @@
<tr>
<td>marker</td>
<td>String</td>
<td>(May be omitted) Pagination marker.</td>
<td>(May be omitted) <a href="#pagination">Pagination</a> marker.</td>
</tr>
<tr>
<td>reports</td>
@@ -1450,9 +1450,9 @@
<td>Filter results to one or more metrics (in a comma-separated list). Requires the <code>family</code> of the metrics to be specified. By default, provides all metrics in the family.</td>
</tr>
<tr>
<td>end</td>
<td>start</td>
<td>String - <a href="#timestamps">Timestamp</a></td>
<td>Filter results to this time and earlier</td>
<td>Filter results to this time and later.</td>
</tr>
<tr>
<td>end</td>
@@ -1472,17 +1472,17 @@
<tr>
<td>marker</td>
<td>String</td>
<td>Pagination key from previously returned response</td>
<td><a href="#pagination">Pagination</a> key from previously returned response.</td>
</tr>
<tr>
<td>descending</td>
<td>Boolean</td>
<td>Reverse chronological order</td>
<td>If true, return results in reverse chronological order. Defaults to false.</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>
@@ -1499,7 +1499,7 @@
<tbody>
<tr>
<td>type</td>
<td>All Ripple transaction types, including <code>Payment</code>, <code>AccountSet</code>, <code>SetRegularKey</code>, <code>OfferCreate</code>, <code>OfferCancel</code>, <code>TrustSet</code>.</td>
<td>All Ripple <a href="transactions.html">transaction types</a>, including <code>Payment</code>, <code>AccountSet</code>, <code>SetRegularKey</code>, <code>OfferCreate</code>, <code>OfferCancel</code>, <code>TrustSet</code>.</td>
<td>Number of transactions of the given type that occurred during the interval.</td>
</tr>
<tr>
@@ -1582,7 +1582,7 @@
<tr>
<td>marker</td>
<td>String</td>
<td>(May be omitted) Pagination marker</td>
<td>(May be omitted) <a href="#pagination">Pagination</a> marker</td>
</tr>
<tr>
<td>stats</td>
@@ -1619,7 +1619,7 @@
</code></pre>
<h2 id="get-capitalization">Get Capitalization</h2>
<p><a href="https://github.com/ripple/rippled-historical-database/blob/develop/api/routesV2/capitalization.js" title="Source">[Source]<br/></a></p>
<p>Get capitalization data for a specific currency and issuer. <em>(New in <a href="https://github.com/ripple/rippled-historical-database/releases/tag/v0.0.4-rc2">v2.0.4</a>)</em></p>
<p>Get the total amount of a single currency issued by a single issuer, also known as the <a href="https://en.wikipedia.org/wiki/Market_capitalization">market capitalization</a>. <em>(New in <a href="https://github.com/ripple/rippled-historical-database/releases/tag/v0.0.4-rc2">v2.0.4</a>)</em></p>
<h4 id="request-format-9">Request Format</h4>
<div class="multicode">
<p><em>REST</em></p>
@@ -1656,12 +1656,12 @@
<tr>
<td>start</td>
<td>String - <a href="#timestamps">Timestamp</a></td>
<td>Start time of query range. Defaults to the most recent sample.</td>
<td>Start time of query range. Defaults to <code>2013-01-01T00:00:00Z</code>.</td>
</tr>
<tr>
<td>end</td>
<td>String - <a href="#timestamps">Timestamp</a></td>
<td>End time of query range</td>
<td>End time of query range. Defaults to the current time.</td>
</tr>
<tr>
<td>interval</td>
@@ -1676,17 +1676,17 @@
<tr>
<td>marker</td>
<td>String</td>
<td>Pagination key from previously returned response</td>
<td><a href="#pagination">Pagination</a> key from previously returned response</td>
</tr>
<tr>
<td>descending</td>
<td>Boolean</td>
<td>Reverse cronological order</td>
<td>If true, return results in reverse chronological order. Defaults to false.</td>
</tr>
<tr>
<td>adjusted</td>
<td>Boolean</td>
<td>If true, adjust results by removing known issuer owned wallets. Defaults to true.</td>
<td>If true, do not count known issuer-owned wallets towards market capitalization. Defaults to true.</td>
</tr>
<tr>
<td>format</td>
@@ -1695,6 +1695,7 @@
</tr>
</tbody>
</table>
<p>If the request omits both <code>start</code> and <code>end</code>, the API returns only the most recent sample.</p>
<h4 id="response-format-9">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>
@@ -1729,7 +1730,7 @@
<tr>
<td>marker</td>
<td>String</td>
<td>(May be omitted) Pagination marker</td>
<td>(May be omitted) <a href="#pagination">Pagination</a> marker</td>
</tr>
<tr>
<td>rows</td>
@@ -1738,7 +1739,7 @@
</tr>
</tbody>
</table>
<p>Each issuer capitalization object has the following fields:</p>
<p>Each <strong>issuer capitalization object</strong> has the following fields:</p>
<table>
<thead>
<tr>
@@ -2066,6 +2067,7 @@
<h2 id="get-exchange-volume">Get Exchange Volume</h2>
<p><a href="https://github.com/ripple/rippled-historical-database/blob/develop/api/routesV2/network/getMetric.js" title="Source">[Source]<br/></a></p>
<p>Get aggregated exchange volume for a given time period. <em>(New in <a href="https://github.com/ripple/rippled-historical-database/releases/tag/v0.0.4-rc2">v2.0.4</a>)</em></p>
<p>The API returns results in units of a single <em>display currency</em> rather than many different currencies. The conversion uses standard rates to and from XRP.</p>
<h4 id="request-format-11">Request Format</h4>
<div class="multicode">
<p><em>REST</em></p>
@@ -2115,7 +2117,7 @@
<tr>
<td>marker</td>
<td>String</td>
<td>Pagination key from previously returned response</td>
<td><a href="#pagination">Pagination</a> key from previously returned response</td>
</tr>
<tr>
<td>format</td>
@@ -2279,6 +2281,7 @@
<h2 id="get-payment-volume">Get Payment Volume</h2>
<p><a href="https://github.com/ripple/rippled-historical-database/blob/develop/api/routesV2/network/getMetric.js" title="Source">[Source]<br/></a></p>
<p>Get aggregated payment volume for a given time period. <em>(New in <a href="https://github.com/ripple/rippled-historical-database/releases/tag/v0.0.4-rc2">v2.0.4</a>)</em></p>
<p>The API returns results in units of a single <em>display currency</em> rather than many different currencies. The conversion uses standard rates to and from XRP.</p>
<h4 id="request-format-12">Request Format</h4>
<div class="multicode">
<p><em>REST</em></p>
@@ -2328,7 +2331,7 @@
<tr>
<td>marker</td>
<td>String</td>
<td>Pagination key from previously returned response</td>
<td><a href="#pagination">Pagination</a> key from previously returned response</td>
</tr>
<tr>
<td>format</td>
@@ -2378,12 +2381,12 @@
<tr>
<td>currency</td>
<td>String - <a href="#currency-code">Currency Code</a></td>
<td>This object represents payment volume for this currency.</td>
<td>The currency of this payment volume object.</td>
</tr>
<tr>
<td>issuer</td>
<td>String - <a href="#addresses">Address</a></td>
<td>(Omitted for XRP) This object represents payment volume for the currency issued by this account.</td>
<td>(Omitted for XRP) The issuer of this payment volume object.</td>
</tr>
<tr>
<td>amount</td>
@@ -2475,7 +2478,8 @@
</code></pre>
<h2 id="get-issued-value">Get Issued Value</h2>
<p><a href="https://github.com/ripple/rippled-historical-database/blob/develop/api/routesV2/network/getMetric.js" title="Source">[Source]<br/></a></p>
<p>Get total capitalization for a selection of major gateways over time. By default, returns only the most recent measurement. <em>(New in <a href="https://github.com/ripple/rippled-historical-database/releases/tag/v0.0.4-rc2">v2.0.4</a>)</em></p>
<p>Get the total value of all currencies issued by a selection of major gateways over time. By default, returns only the most recent measurement. <em>(New in <a href="https://github.com/ripple/rippled-historical-database/releases/tag/v0.0.4-rc2">v2.0.4</a>)</em></p>
<p>The API returns results in units of a single <em>display currency</em> rather than many different currencies. The conversion uses standard rates to and from XRP.</p>
<h4 id="request-format-13">Request Format</h4>
<div class="multicode">
<p><em>REST</em></p>
@@ -2520,7 +2524,7 @@
<tr>
<td>marker</td>
<td>String</td>
<td>Pagination key from previously returned response</td>
<td><a href="#pagination">Pagination</a> key from previously returned response</td>
</tr>
<tr>
<td>format</td>
@@ -2643,7 +2647,7 @@
</code></pre>
<h2 id="get-all-gateways">Get All Gateways</h2>
<p><a href="https://github.com/ripple/rippled-historical-database/blob/develop/api/routesV2/gateways.js" title="Source">[Source]<br/></a></p>
<p>Get information about known gateways. <em>(New in <a href="https://github.com/ripple/rippled-historical-database/releases/tag/v0.0.4-rc2">v2.0.4</a>)</em></p>
<p>Get information about <a href="https://github.com/ripple/rippled-historical-database/blob/v2.0.4/api/gateways/gateways.json">known gateways</a>. <em>(New in <a href="https://github.com/ripple/rippled-historical-database/releases/tag/v0.0.4-rc2">v2.0.4</a>)</em></p>
<h4 id="request-format-14">Request Format</h4>
<div class="multicode">
<p><em>REST</em></p>
@@ -2653,8 +2657,7 @@
<p>This method takes no 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.</p>
<p>Each field in the top level JSON object is a <a href="#currency-code">Currency Code</a>. The content of each field is an array of gateway objects that issue that currency.</p>
<p>Each gateway object represents a gateway, and has the following fields:</p>
<p>Each field in the top level JSON object is a <a href="#currency-code">Currency Code</a>. The content of each field is an array of objects, representing gateways that issue that currency. Each object has the following fields:</p>
<table>
<thead>
<tr>
@@ -2677,7 +2680,7 @@
<tr>
<td>featured</td>
<td>Boolean</td>
<td>Whether this gateway considered a "featured" issuer of the currency. Ripple, Inc. decides which gateways to feature based on responsible business practices, volume, and other measures.</td>
<td>Whether this gateway is considered a "featured" issuer of the currency. Ripple, Inc. decides which gateways to feature based on responsible business practices, volume, and other measures.</td>
</tr>
<tr>
<td>label</td>
@@ -2744,7 +2747,7 @@
</code></pre>
<h2 id="get-gateway">Get Gateway</h2>
<p><a href="https://github.com/ripple/rippled-historical-database/blob/develop/api/routesV2/gateways.js" title="Source">[Source]<br/></a></p>
<p>Get information about a specific known gateway. <em>(New in <a href="https://github.com/ripple/rippled-historical-database/releases/tag/v0.0.4-rc2">v2.0.4</a>)</em></p>
<p>Get information about a specific gateway from <a href="https://github.com/ripple/rippled-historical-database/blob/v2.0.4/api/gateways/gateways.json">the Data API's list of known gateways</a>. <em>(New in <a href="https://github.com/ripple/rippled-historical-database/releases/tag/v0.0.4-rc2">v2.0.4</a>)</em></p>
<h4 id="request-format-15">Request Format</h4>
<div class="multicode">
<p><em>REST</em></p>
@@ -2793,17 +2796,17 @@
<tr>
<td>accounts</td>
<td>Array</td>
<td>A list of issuing accounts used by this gateway. (Gateways may use different issuing accounts for different currencies.)</td>
<td>A list of <a href="gateway_guide.html#hot-and-cold-wallets">issuing accounts</a> (cold wallets) used by this gateway. (Gateways may use different issuing accounts for different currencies.)</td>
</tr>
<tr>
<td>hotwallets</td>
<td>Array of <a href="#addresses">Address</a>es</td>
<td>The addresses of the Ripple accounts this gateway uses as hot wallets.</td>
<td>The addresses of the Ripple accounts this gateway uses as <a href="gateway_guide.html#hot-and-cold-wallets">hot wallets</a>.</td>
</tr>
<tr>
<td>domain</td>
<td>String</td>
<td>The domain name where this gateway does business. Typically it has a <code>ripple.txt</code> hosted there.</td>
<td>The domain name where this gateway does business. Typically the gateway hosts a <a href="https://wiki.ripple.com/Ripple.txt"><code>ripple.txt</code></a> there.</td>
</tr>
<tr>
<td>normalized</td>
@@ -2830,7 +2833,7 @@
<tr>
<td>address</td>
<td>String</td>
<td>The <a href="#addresses">Address</a> of an issuing account (cold wallet) used by this gateway.</td>
<td>The <a href="#addresses">Address</a> of an <a href="gateway_guide.html#hot-and-cold-wallets">issuing account</a> (cold wallet) used by this gateway.</td>
</tr>
<tr>
<td>currencies</td>
@@ -2968,7 +2971,7 @@ Content-Type: image/svg+xml
<tr>
<td>marker</td>
<td>String</td>
<td>Pagination key from previously returned response</td>
<td><a href="#pagination">Pagination</a> key from previously returned response</td>
</tr>
<tr>
<td>descending</td>
@@ -3016,7 +3019,7 @@ Content-Type: image/svg+xml
<tr>
<td>marker</td>
<td>String</td>
<td>(May be omitted) Pagination marker</td>
<td>(May be omitted) <a href="#pagination">Pagination</a> marker</td>
</tr>
<tr>
<td>accounts</td>
@@ -3256,7 +3259,7 @@ Content-Type: image/svg+xml
<tr>
<td>marker</td>
<td>String</td>
<td>(May be omitted) Pagination marker</td>
<td>(May be omitted) <a href="#pagination">Pagination</a> marker</td>
</tr>
<tr>
<td>balances</td>
@@ -3348,17 +3351,17 @@ Content-Type: image/svg+xml
<tr>
<td>ledger_index</td>
<td>Integer</td>
<td>Index of ledger for historical orders</td>
<td>Get orders as of this ledger. Not compatible with <code>ledger_hash</code> or <code>date</code>.</td>
</tr>
<tr>
<td>ledger_hash</td>
<td>String</td>
<td>Ledger hash for historical orders</td>
<td>Get orders as of this ledger. Not compatible with <code>ledger_index</code> or <code>date</code>.</td>
</tr>
<tr>
<td>date</td>
<td>String</td>
<td>UTC date for historical orders.</td>
<td>String - <a href="#timestamps">Timestamp</a></td>
<td>Get orders at this time. Not compatible with <code>ledger_index</code> or <code>ledger_hash</code>.</td>
</tr>
<tr>
<td>limit</td>
@@ -3372,6 +3375,7 @@ Content-Type: image/svg+xml
</tr>
</tbody>
</table>
<p>If none of <code>ledger_index</code>, <code>ledger_hash</code>, or <code>date</code> are specified, the API uses the most current data available.</p>
<h4 id="response-format-20">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>
@@ -3391,17 +3395,17 @@ Content-Type: image/svg+xml
<tr>
<td>ledger_index</td>
<td>Integer</td>
<td>ledger index for orders query</td>
<td><code>ledger_index</code> of the ledger version used.</td>
</tr>
<tr>
<td>close_time</td>
<td>String</td>
<td>close time of the ledger</td>
<td>Close time of the ledger version used.</td>
</tr>
<tr>
<td>limit</td>
<td>String</td>
<td>number of results returned, if limit was exceeded</td>
<td>The <code>limit</code> from the request.</td>
</tr>
<tr>
<td>orders</td>
@@ -3438,7 +3442,7 @@ Content-Type: image/svg+xml
<tr>
<td>specification.totalPrice</td>
<td><a href="#balance-objects-and-balance-change-objects">Balance Object</a></td>
<td>The maximum amount of the counter currency that will spent or gained in order to buy or sell the base currency. This value decreases as the order gets partially filled.</td>
<td>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.</td>
</tr>
<tr>
<td>properties</td>
@@ -3575,7 +3579,7 @@ Content-Type: image/svg+xml
<tr>
<td>type</td>
<td>String</td>
<td>Restrict results to a specified transaction type</td>
<td>Restrict results to a specified <a href="transactions.html">transaction type</a></td>
</tr>
<tr>
<td>result</td>
@@ -3600,7 +3604,7 @@ Content-Type: image/svg+xml
<tr>
<td>marker</td>
<td>String</td>
<td>Pagination key from previously returned response</td>
<td><a href="#pagination">Pagination</a> key from previously returned response</td>
</tr>
<tr>
<td>format</td>
@@ -3633,7 +3637,7 @@ Content-Type: image/svg+xml
<tr>
<td>marker</td>
<td>String</td>
<td>(May be omitted) Pagination marker</td>
<td>(May be omitted) <a href="#pagination">Pagination</a> marker</td>
</tr>
<tr>
<td>transactions</td>
@@ -3869,7 +3873,7 @@ Content-Type: image/svg+xml
<tr>
<td>marker</td>
<td>String</td>
<td>Pagination key from previously returned response</td>
<td><a href="#pagination">Pagination</a> key from previously returned response</td>
</tr>
<tr>
<td>format</td>
@@ -3902,7 +3906,7 @@ Content-Type: image/svg+xml
<tr>
<td>marker</td>
<td>String</td>
<td>(May be omitted) Pagination marker</td>
<td>(May be omitted) <a href="#pagination">Pagination</a> marker</td>
</tr>
<tr>
<td>payments</td>
@@ -4024,7 +4028,7 @@ Content-Type: image/svg+xml
<tr>
<td>marker</td>
<td>String</td>
<td>Pagination key from previously returned response</td>
<td><a href="#pagination">Pagination</a> key from previously returned response</td>
</tr>
<tr>
<td>format</td>
@@ -4057,7 +4061,7 @@ Content-Type: image/svg+xml
<tr>
<td>marker</td>
<td>String</td>
<td>(May be omitted) Pagination marker</td>
<td>(May be omitted) <a href="#pagination">Pagination</a> marker</td>
</tr>
<tr>
<td>exchanges</td>
@@ -4156,27 +4160,27 @@ 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>issuer</td>
<td>String</td>
<td>Restrict results to specified counterparty/issuer</td>
<td>Restrict results to specified counterparty/issuer.</td>
</tr>
<tr>
<td>start</td>
<td>String - <a href="#timestamps">Timestamp</a></td>
<td>Start time of query range</td>
<td>Start time of query range.</td>
</tr>
<tr>
<td>end</td>
<td>String - <a href="#timestamps">Timestamp</a></td>
<td>End time of query range</td>
<td>End time of query range.</td>
</tr>
<tr>
<td>descending</td>
<td>Boolean</td>
<td>Reverse chronological order</td>
<td>If true, return results in reverse chronological order. Defaults to false.</td>
</tr>
<tr>
<td>limit</td>
@@ -4186,12 +4190,12 @@ Content-Type: image/svg+xml
<tr>
<td>marker</td>
<td>String</td>
<td>Pagination key from previously returned response</td>
<td><a href="#pagination">Pagination</a> key from previously returned response.</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>
@@ -4219,12 +4223,12 @@ Content-Type: image/svg+xml
<tr>
<td>marker</td>
<td>String</td>
<td>(May be omitted) Pagination marker</td>
<td>(May be omitted) <a href="#pagination">Pagination</a> marker.</td>
</tr>
<tr>
<td>exchanges</td>
<td>Array of <a href="#balance-change-descriptors">balance change descriptors</a></td>
<td>The requested balance changes</td>
<td>The requested balance changes.</td>
</tr>
</tbody>
</table>
@@ -4501,7 +4505,7 @@ Content-Type: image/svg+xml
</ul>
<h2 id="pagination">Pagination</h2>
<p>Many queries may return more data than is reasonable to return in a single HTTP response. The Data API uses a "limit and marker" system to control how much is returned in a single response ("page") and to query for additional content.</p>
<p>The <code>limit</code> query parameter to many requests restricts the response to a specific number of results in the response. The types of results and default values vary by based on the method. Most of the time, the <code>limit</code> is <strong>200</strong> by default, and can be set as high as <strong>1000</strong>. Any value over the maximum <code>limit</code> value is treated as the maximum instead.</p>
<p>The <code>limit</code> query parameter to many requests restricts the response to a specific number of results in the response. The types of results and default values vary based on the method. For most methods, the <code>limit</code> is <strong>200</strong> by default, and can be set as high as <strong>1000</strong>. If you specify a <code>limit</code> larger than the maximum, the API uses the maximum value instead.</p>
<p>When a query has additional objects that are not contained in the current response, the JSON response contains a top-level field <code>marker</code> which indicates that you can retrieve additional results by including the contents of the <code>marker</code> field as the <code>marker</code> query parameter of a subsequent request. For the follow-up request, you should use the same parameters as the initial request. When the response omits the <code>marker</code> parameter, that indicates that you have reached the end of the queryable data.</p>
<p>When a <code>marker</code> is or would be present, the response contains a <a href="https://tools.ietf.org/html/rfc5988#section-5"><code>Link</code> header</a> with <code>rel="next"</code>. This is a full URL to the next page of results. You can use this to paginate over results when the response is in <code>csv</code> format instead of <code>json</code>. <em>(New in <a href="https://github.com/ripple/rippled-historical-database/releases/tag/v0.0.4-rc2">v2.0.4</a>)</em></p>
<h2 id="transaction-objects">Transaction Objects</h2>
@@ -4915,7 +4919,7 @@ Content-Type: image/svg+xml
</tbody>
</table>
<h2 id="payment-objects">Payment Objects</h2>
<p>In the Data API, a Payment Object represents an event where one account sent value to another account. This mostly lines up with Ripple transactions of the <code>Payment</code> transaction type, except that the Data API does not consider a transaction to be a payment if the sending <code>Account</code> and the <code>Destination</code> account are the same, or if the transaction failed.</p>
<p>In the Data API, a Payment Object represents an event where one account sent value to another account. This mostly lines up with Ripple transactions of the <code>Payment</code> <a href="transactions.html">transaction type</a>, except that the Data API does not consider a transaction to be a payment if the sending <code>Account</code> and the <code>Destination</code> account are the same, or if the transaction failed.</p>
<p>Payment objects have the following fields:</p>
<table>
<thead>