diff --git a/content/references/client-libraries.md b/content/references/client-libraries.md new file mode 100644 index 0000000000..33b969c407 --- /dev/null +++ b/content/references/client-libraries.md @@ -0,0 +1,19 @@ +--- +html: client-libraries.html +parent: references.html +blurb: Use these libraries to access the XRP Ledger from your programming language of choice. +--- +# Client Libraries + +These client libraries simplify some of the common work of accessing and processing XRP Ledger data, and present it in a form that matches with the native conventions of their respective programming languages. + +For other programming languages, you can access the XRP Ledger through the [HTTP APIs](rippled-api.html). + +| Language | Library Name | Get Started | API Reference | Source Code | +|----------|--------------|-------------|---------------|-------------| +| **Python** | `xrpl-py` | [Get Started](get-started-using-python.html) | [API Reference](https://xrpl-py.readthedocs.io/) | [Repo](https://github.com/XRPLF/xrpl-py) | +| **JavaScript** / **TypeScript** | `ripple-lib` | [Get Started](get-started-with-rippleapi-for-javascript.html) | [API Reference](rippleapi-reference.html) | [Repo](https://github.com/ripple/ripple-lib) | +| **C++** | `rippled` Signing Library | [Get Started](https://github.com/ripple/rippled/tree/develop/Builds/linux#signing-library) | | (Part of [`rippled`](https://github.com/ripple/rippled/)) | +| **Java** | `xrpl4j` | [README](https://github.com/XRPLF/xrpl4j#readme) | [API Reference](https://github.com/XRPLF/xrpl4j/tree/main/xrpl4j-integration-tests) | [Repo](https://github.com/XRPLF/xrpl4j) | + +**Tip:** To add a client library not listed here, please [suggest changes to this page]({{target.github_forkurl}}/edit/{{target.github_branch}}/content/{{currentpage.md}})! diff --git a/content/references/data-api.ja.md b/content/references/data-api.ja.md index e8a4fe49f5..610044fd8c 100644 --- a/content/references/data-api.ja.md +++ b/content/references/data-api.ja.md @@ -2,11 +2,8 @@ html: data-api.html parent: references.html blurb: XRP Ledger分析と履歴データに対するRESTfulインターフェイスです。 -curated_anchors: - - name: APIメソッドリファレンス - anchor: "#apiメソッドリファレンス" - - name: APIの規則 - anchor: "#apiの規則" +status: removed +nav_omit: true --- # Ripple Data API v2 @@ -14,5298 +11,4 @@ curated_anchors: Ripple Data API v2を使用すると、XRP Ledgerの変更に関する情報（トランザクション履歴や処理済みの分析データなど）にアクセスできます。このような情報は専用データベースに保管されるので、`rippled`サーバーで保持する必要のある履歴レジャーバージョンの数が少なくなります。Data API v2は[XRP Charts](https://xrpcharts.ripple.com/)や[ripple.com](https://www.ripple.com)などのアプリケーションのデータソースとしても機能します。 -Rippleは可能な限り完全なトランザクションレコードが含まれているData APIのライブインスタンスを以下のアドレスで公開しています。 - -[**https://data.ripple.com**](https://data.ripple.com) - - -## 詳細情報 -Ripple Data API v2はHistorical Database v1および[Charts API](https://github.com/ripple/ripple-data-api/)を置き換えます。 - -* [APIメソッド](#apiメソッドリファレンス) -* [APIの規則](#apiの規則) -* [ソースコード（Github）](https://github.com/ripple/rippled-historical-database) -* [リリースノート](https://github.com/ripple/rippled-historical-database/releases) - -[v2.0.4]: https://github.com/ripple/rippled-historical-database/releases/tag/v2.0.4 -[v2.0.5]: https://github.com/ripple/rippled-historical-database/releases/tag/v2.0.5 -[v2.0.6]: https://github.com/ripple/rippled-historical-database/releases/tag/v2.0.6 -[v2.0.7]: https://github.com/ripple/rippled-historical-database/releases/tag/v2.0.7 -[v2.0.8]: https://github.com/ripple/rippled-historical-database/releases/tag/v2.0.8 -[v2.1.0]: https://github.com/ripple/rippled-historical-database/releases/tag/v2.1.0 -[v2.2.0]: https://github.com/ripple/rippled-historical-database/releases/tag/v2.2.0 -[v2.3.0]: https://github.com/ripple/rippled-historical-database/releases/tag/v2.3.0 -[v2.3.2]: https://github.com/ripple/rippled-historical-database/releases/tag/v2.3.2 -[v2.3.5]: https://github.com/ripple/rippled-historical-database/releases/tag/v2.3.5 -[v2.3.7]: https://github.com/ripple/rippled-historical-database/releases/tag/v2.3.7 -[v2.4.0]: https://github.com/ripple/rippled-historical-database/releases/tag/v2.4.0 - - -# APIメソッドリファレンス - -Data API v2は、以下のメソッドを備えたREST APIです。 - -レジャーコンテンツメソッド: - -* [Get Ledger - `GET /v2/ledgers/{ledger_identifier}`](#get-ledger) -* [Get Transaction - `GET /v2/transactions/{hash}`](#get-transaction) -* [Get Transactions - `GET /v2/transactions/`](#get-transactions) -* [Get Payments - `GET /v2/payments/{currency}`](#get-payments) -* [Get Exchanges - `GET /v2/exchanges/{base}/{counter}`](#get-exchanges) -* [Get Exchange Rates - `GET /v2/exchange_rates/{base}/{counter}`](#get-exchange-rates) -* [Normalize - `GET /v2/normalize`](#normalize) -* [Get Daily Reports - `GET /v2/reports/`](#get-daily-reports) -* [Get Stats - `GET /v2/stats/`](#get-stats) -* [Get Active Accounts - `GET /v2/active_accounts/{base}/{counter}`](#get-active-accounts) -* [Get Exchange Volume - `GET /v2/network/exchange_volume`](#get-exchange-volume) -* [Get Payment Volume - `GET /v2/network/payment_volume`](#get-payment-volume) -* [Get External Markets - `GET /v2/network/external_markets`](#get-external-markets) -* [Get XRP Distribution - `GET /v2/network/xrp_distribution`](#get-xrp-distribution) -* [Get Top Currencies - `GET /v2/network/top_currencies`](#get-top-currencies) -* [Get Top Markets - `GET /v2/network/top_markets`](#get-top-markets) - -アカウントメソッド: - -* [Get Account - `GET /v2/accounts/{address}`](#get-account) -* [Get Accounts - `GET /v2/accounts`](#get-accounts) -* [Get Account Balances - `GET /v2/accounts/{address}/balances`](#get-account-balances) -* [Get Account Orders - `GET /v2/accounts/{address}/orders`](#get-account-orders) -* [Get Account Transaction History - `GET /v2/accounts/{address}/transactions`](#get-account-transaction-history) -* [Get Transaction By Account and Sequence - `GET /v2/accounts/{address}/transactions/{sequence}`](#get-transaction-by-account-and-sequence) -* [Get Account Payments - `GET /v2/accounts/{address}/payments`](#get-account-payments) -* [Get Account Exchanges - `GET /v2/accounts/{address}/exchanges`](#get-account-exchanges) -* [Get Account Balance Changes - `GET /v2/accounts/{address}/balance_changes`](#get-account-balance-changes) -* [Get Account Reports - `GET /v2/accounts/{address}/reports`](#get-account-reports) -* [Get Account Transaction Stats - `GET /v2/accounts/{address}/stats/transactions`](#get-account-transaction-stats) -* [Get Account Value Stats - `GET /v2/accounts/{address}/stats/value`](#get-account-value-stats) - -外部情報メソッド: - -* [Get All Gateways - `GET /v2/gateways`](#get-all-gateways) -* [Get Gateway - `GET /v2/gateways/{gateway}`](#get-gateway) -* [Get Currency Image - `GET /v2/currencies/{currencyimage}`](#get-currency-image) - -検証ネットワークメソッド: - -* [Get Transaction Costs - `GET /v2/network/fees`](#get-transaction-costs) -* [Get Fee Stats - `GET /v2/network/fee_stats`](#get-fee-stats) -* [Get Ledger Validations - `GET /v2/ledger/{hash}/validations`](#get-ledger-validations) -* [Get Ledger Validation - `GET /v2/ledger/{hash}/validations/{pubkey}`](#get-ledger-validation) -* [Get Topology - `GET /v2/network/topology`](#get-topology) -* [Get Topology Nodes - `GET /v2/network/topology/nodes`](#get-topology-nodes) -* [Get Topology Node - `GET /v2/network/topology/nodes/{pubkey}`](#get-topology-node) -* [Get Topology Links - `GET /v2/network/topology/links`](#get-topology-links) -* [Get Validator - `GET /v2/network/validators/{pubkey}`](#get-validator) -* [Get Validators - `GET /v2/network/validators`](#get-validators) -* [Get Validator Manifests - `GET /v2/network/validators/{pubkey}/manifests`](#get-validator-manifests) -* [Get Single Validator Reports - `GET /v2/network/validators/{pubkey}/reports`](#get-single-validator-reports) -* [Get Daily Validator Reports - `GET /v2/network/validator_reports`](#get-daily-validator-reports) -* [Get `rippled` Versions - `GET /v2/network/rippled_versions`](#get-rippled-versions) - -健全性チェック: - -* [API Health Check - `GET /v2/health/api`](#health-check-api) -* [Importer Health Check - `GET /v2/health/importer`](#health-check-ledger-importer) -* [Nodes ETL Health Check - `GET /v2/health/nodes_etl`](#health-check-nodes-etl) -* [Validations ETL Health Check - `GET /v2/health/validations_etl`](#health-check-validations-etl) - - -## Get Ledger -[[ソース]](https://github.com/ripple/rippled-historical-database/blob/master/api/routes/getLedger.js "Source") - -ハッシュ、インデックス、または日付を指定して特定のレジャーを取得するか、または最新の検証済みレジャーを取得します。 - -#### 要求フォーマット - - - -*REST* - -``` -GET /v2/ledgers/{identifier} -``` - - - -[試してみる>](data-api-v2-tool.html#get-ledger) - -このメソッドには以下のURLパラメーターを指定する必要があります。 - -| フィールド | 値 | 説明 | -|:--------------------|:----------------------------------------------------|:--| -| `ledger_identifier` | レジャー[ハッシュ][]、[レジャーインデックス][]、または[タイムスタンプ][] | _（省略可）_ 取得するレジャーのID。16進数のハッシュ全体、整数のシーケンス番号、または日時のいずれかです。日時を指定すると、その指定した日時の時点で最新であった閉鎖済みレジャーが取得されます。省略すると、最新の検証済みレジャーが取得されます。 | - -オプションで、以下のクエリーパラメーターを指定できます。 - -| フィールド | 値 | 説明 | -|:---------------|:--------|:--------------------------------------------------| -| `transactions` | ブール値 | `true`の場合は、このレジャーに含まれるすべてのトランザクションの識別用ハッシュが含まれます。 | -| `binary` | ブール値 | `true`の場合は、このレジャーのすべてのトランザクションが16進フォーマットのバイナリデータとして含まれます。（このフィールドが指定されている場合、`transactions`をオーバーライドします。） | -| `expand` | ブール値 | `true`の場合、このレジャーのすべてのトランザクションが入れ子のJSONオブジェクトとして含まれます。（このフィールドが指定されている場合は、`binary`と`transactions`をオーバーライドします。） | - -#### 応答フォーマット - -成功した場合の応答では、HTTPコード**200 OK**と以下の内容のJSON本文が返されます。 - -| フィールド | 値 | 説明 | -|:---------|:---------------------------------|:-------------------------------| -| `result` | 文字列 | 値が`success`の場合は、成功した場合の応答であることを示します。 | -| `ledger` | [レジャーオブジェクト](#レジャーオブジェクト) | 要求されたレジャー。 | - -#### 例 - -要求: - -``` -GET /v2/ledgers/3170DA37CE2B7F045F889594CBC323D88686D2E90E8FFD2BBCD9BAD12E416DB5 -``` - -応答: - -``` -200 OK -{ - "result": "success", - "ledger": { - "ledger_hash": "3170da37ce2b7f045f889594cbc323d88686d2e90e8ffd2bbcd9bad12e416db5", - "ledger_index": 8317037, - "parent_hash": "aff6e04f07f441abc6b4133f8c50c65935b817a85b895f06dba098b3fbc1be90", - "total_coins": 99999980165594400, - "close_time_res": 10, - "accounts_hash": "8ad73e49a34d8b9c31bc13b8a97c56981e45ee70225ef4892e8b198fec5a1f7d", - "transactions_hash": "33e0b9c5fd7766343e67854aed4222f5ed9c9507e0ec0d7ae7d54d0f17adb98e", - "close_time": 1408047740, - "close_time_human": "2014-08-14T20:22:20+00:00" - } -} -``` - - - -## Get Ledger Validations -[[ソース]](https://github.com/ripple/rippled-historical-database/blob/master/api/routes/getLedger.js "Source") - -特定のレジャーハッシュについて記録されたすべての検証を取得します。このデータセットには、検証済みレジャーチェーン外部のレジャーバージョンが含まれます。_（新規: [v2.2.0][]）_ - -**注記:** Data APIは、すべてのバリデーションを網羅する包括的な記録を持っていません。応答には、Data APIに記録されているデータのみが含まれています。一部のレジャーバージョン、特に古いレジャーは、コンセンサスによって検証済みであっても検証が取得できないことがあります。 - -#### 要求フォーマット - - - -*REST* - -``` -GET /v2/ledgers/{ledger_hash}/validations -``` - - - -[試してみる>](data-api-v2-tool.html#get-ledger-validations) - -このメソッドには以下のURLパラメーターを指定する必要があります。 - -| フィールド | 値 | 説明 | -|:--------------|:---------|:-----------------------------------------| -| `ledger_hash` | [ハッシュ][] | 検証を取得するレジャーのハッシュ。 | - -オプションで、以下のクエリーパラメーターを指定できます。 - -| フィールド | 値 | 説明 | -|:---------|:--------|:--------------------------------------------------------| -| `limit` | 整数 | ページあたりの最大結果件数。デフォルトは200です。1000を超える値は指定できません。 | -| `marker` | 文字列 | 前に返された応答の[ページネーション](#ページネーション)キー。 | -| `format` | 文字列 | 返される結果のフォーマットは`csv`または`json`です。デフォルトは`json`です。 | - -#### 応答フォーマット - -成功した場合の応答では、HTTPコード**200 OK**と以下の内容のJSON本文が返されます。 - -| フィールド | 値 | 説明 | -|:--------------|:--------------------------------|:---------------------------| -| `result` | 文字列 - `success` | 本文が成功した場合の応答を表しています。 | -| `ledger_hash` | 文字列 - [ハッシュ][] | 要求したレジャーバージョンの識別用ハッシュ。 | -| `count` | 整数 | 返された検証の数。 | -| `marker` | 文字列 | （省略される場合があります）[ページネーション](#ページネーション)マーカー。 | -| `validations` | [検証オブジェクト][]の配列 | このレジャーバージョンのすべての既知の検証投票。 | - - -#### 例 - -要求: - -``` -GET /v2/ledgers/A10E9E338BA365D2B768814EC8B0A9A2D8322C0040735E20624AF711C5A593E7/validations?limit=2 -``` - -応答: - -``` -200 OK -{ - "result": "success", - "ledger_hash": "A10E9E338BA365D2B768814EC8B0A9A2D8322C0040735E20624AF711C5A593E7", - "count": 2, - "marker": "A10E9E338BA365D2B768814EC8B0A9A2D8322C0040735E20624AF711C5A593E7|n9KDJnMxfjH5Ez8DeWzWoE9ath3PnsmkUy3GAHiVjE7tn7Q7KhQ2|20160608001732", - "validations": [ - { - "count": 27, - "first_datetime": "2016-06-08T00:17:32.352Z", - "last_datetime": "2016-06-08T00:17:32.463Z", - "ledger_hash": "A10E9E338BA365D2B768814EC8B0A9A2D8322C0040735E20624AF711C5A593E7", - "reporter_public_key": "n9KJb7NMxGySRcjCqh69xEPMUhwJx22qntYYXsnUqYgjsJhNoW7g", - "signature": "304402204C751D0033070EBC008786F0ECCA8E29195FD7DD8D22498EB6E4E732905FC7090220091F458976904E7AE4633A1EC405175E6A126798E4896DD452853B887B1E6359", - "validation_public_key": "n949f75evCHwgyP4fPVgaHqNHxUVN15PsJEZ3B3HnXPcPjcZAoy7" - }, - { - "count": 3, - "first_datetime": "2016-06-08T00:17:32.653Z", - "last_datetime": "2016-06-08T00:17:32.673Z", - "ledger_hash": "A10E9E338BA365D2B768814EC8B0A9A2D8322C0040735E20624AF711C5A593E7", - "reporter_public_key": "n9JCK5AML7Ejv3TcJmnvJk5qeYhf7Q9YwScjz5PhtUbtWCKH3NAm", - "signature": "3045022100A48E5AF6EA9D0ACA6FDE18536081A7D2182535579EA580C3D0B0F18C2556C5D30220521615A3D677376069F8F3E608B59F14482DDE4CD2A304DE578B6CCE2F5E8D54", - "validation_public_key": "n9K6YbD1y9dWSAG2tbdFwVCtcuvUeNkBwoy9Z6BmeMra9ZxsMTuo" - } - ] -} -``` - - - -## Get Ledger Validation -[[ソース]](https://github.com/ripple/rippled-historical-database/blob/master/api/routes/getLedger.js "Source") - -特定のバリデータの特定のレジャーハッシュについて記録された検証投票を取得します。このデータセットには、検証済みレジャーチェーン外部のレジャーバージョンが含まれます。_（新規: [v2.2.0][]）_ - -**注記:** Data APIは、すべてのバリデーションを網羅する包括的な記録を持っていません。応答には、Data APIに記録されているデータのみが含まれています。一部のレジャーバージョン、特に古いレジャーは、コンセンサスによって検証済みであっても検証が取得できないことがあります。 - -#### 要求フォーマット - - - -*REST* - -``` -GET /v2/ledgers/{ledger_hash}/validations/{pubkey} -``` - - - -[試してみる>](data-api-v2-tool.html#get-ledger-validation) - -このメソッドには以下のURLパラメーターを指定する必要があります。 - -| フィールド | 値 | 説明 | -|:--------------|:--------------------------------|:---------------------------| -| `ledger_hash` | [ハッシュ][] | 検証を取得するレジャーのハッシュ。 | -| `pubkey` | 文字列 - Base-58 [公開鍵][] | バリデータの公開鍵。 | - -この要求はクエリーパラメーターをとりません。 - -#### 応答フォーマット - -成功した場合の応答では、HTTPコード**200 OK**と、以下の追加フィールドを持つ **[検証オブジェクト][]** を含むJSON本文が返されます。 - -| フィールド | 値 | 説明 | -|:---------|:-------|:---------------------------------------------------------| -| `result` | 文字列 | 値が`success`の場合は、成功した場合の応答であることを示します。 | - -#### 例 - -要求: - -``` -GET /v2/ledgers/A10E9E338BA365D2B768814EC8B0A9A2D8322C0040735E20624AF711C5A593E7/validations/n949f75evCHwgyP4fPVgaHqNHxUVN15PsJEZ3B3HnXPcPjcZAoy7 -``` - -応答: - -``` -200 OK -{ - "count": 27, - "first_datetime": "2016-06-08T00:17:32.352Z", - "last_datetime": "2016-06-08T00:17:32.463Z", - "ledger_hash": "A10E9E338BA365D2B768814EC8B0A9A2D8322C0040735E20624AF711C5A593E7", - "reporter_public_key": "n9KJb7NMxGySRcjCqh69xEPMUhwJx22qntYYXsnUqYgjsJhNoW7g", - "signature": "304402204C751D0033070EBC008786F0ECCA8E29195FD7DD8D22498EB6E4E732905FC7090220091F458976904E7AE4633A1EC405175E6A126798E4896DD452853B887B1E6359", - "validation_public_key": "n949f75evCHwgyP4fPVgaHqNHxUVN15PsJEZ3B3HnXPcPjcZAoy7", - "result": "success" -} -``` - - - -## Get Transaction -[[ソース]](https://github.com/ripple/rippled-historical-database/blob/master/api/routes/getTransactions.js "Source") - -識別用ハッシュに基づいて特定のトランザクションを取得します。 - -#### 要求フォーマット - - - -*REST* - -``` -GET /v2/transactions/{hash} -``` - - - -[試してみる>](data-api-v2-tool.html#get-transaction) - -このメソッドには以下のURLパラメーターを指定する必要があります。 - -| フィールド | 値 | 説明 | -|:-------|:------------------|:-----------------------------------------| -| `hash` | 文字列 - [ハッシュ][] | トランザクションの識別用ハッシュ。 | - -オプションで、以下のクエリーパラメーターを指定できます。 - -| フィールド | 値 | 説明 | -|:---------|:--------|:--------------------------------------------------------| -| `binary` | ブール値 | `true`の場合、バイナリフォーマットのトランザクションデータを16進文字列として返します。それ以外の場合、トランザクションデータを入れ子のJSONとして返します。デフォルトは`false`です。 | - -#### 応答フォーマット - -成功した場合の応答では、HTTPコード**200 OK**と以下の内容のJSON本文が返されます。 - -| フィールド | 値 | 説明 | -|:--------------|:-----------------------|:------------------------------------| -| `result` | 文字列 | 値が`success`の場合は、成功した場合の応答であることを示します。 | -| `transaction` | [トランザクションオブジェクト][] | 要求されたトランザクション。 | - -[トランザクションオブジェクト]: #トランザクションオブジェクト - -#### 例 - -要求: - -``` -GET /v2/transactions/03EDF724397D2DEE70E49D512AECD619E9EA536BE6CFD48ED167AE2596055C9A -``` - -応答（サイズが大きいため一部省略）: - -```js -200 OK -{ - "result": "success", - "transaction": { - "ledger_index": 8317037, - "date": "2014-08-14T20:22:20+00:00", - "hash": "03EDF724397D2DEE70E49D512AECD619E9EA536BE6CFD48ED167AE2596055C9A", - "tx": { - "TransactionType": "OfferCreate", - "Flags": 131072, - "Sequence": 159244, - "TakerPays": { - "value": "0.001567373", - "currency": "BTC", - "issuer": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B" - }, - "TakerGets": "146348921", - "Fee": "64", - "SigningPubKey": "02279DDA900BC53575FC5DFA217113A5B21C1ACB2BB2AEFDD60EA478A074E9E264", - "TxnSignature": "3045022100D81FFECC36A3DEF0922EB5D16F1AA5AA0804C30A18ED3B512093A75E87C81AD602206B221E22A4E3158785C109E7508624AD3DE5C0E06108D34FA709FCC9575C9441", - "Account": "r2d2iZiCcJmNL6vhUGFjs8U8BuUq6BnmT" - }, - "meta": { - "TransactionIndex": 0, - "AffectedNodes": [ - { - "ModifiedNode": { - "LedgerEntryType": "AccountRoot", - "PreviousTxnLgrSeq": 8317036, - "PreviousTxnID": "A56793D47925BED682BFF754806121E3C0281E63C24B62ADF7078EF86CC2AA53", - "LedgerIndex": "2880A9B4FB90A306B576C2D532BFE390AB3904642647DCF739492AA244EF46D1", - "PreviousFields": { - "Balance": "275716601760" - }, - "FinalFields": { - "Flags": 0, - "Sequence": 326323, - "OwnerCount": 27, - "Balance": "275862935331", - "Account": "rfCFLzNJYvvnoGHWQYACmJpTgkLUaugLEw", - "RegularKey": "rfYqosNivHQFJ6KpArouxoci3QE3huKNYe" - } - } - }, - - ... - ], - "TransactionResult": "tesSUCCESS" - } - } -} -``` - - - - - -## Get Transactions -[[ソース]](https://github.com/ripple/rippled-historical-database/blob/master/api/routes/getTransactions.js "Source") - -時刻に基づいて複数のトランザクションを取得します。 - -#### 要求フォーマット - - - -*REST* - -``` -GET /v2/transactions/ -``` - - - -[試してみる>](data-api-v2-tool.html#get-transactions) - -オプションで、以下のクエリーパラメーターを指定できます。 - -| フィールド | 値 | 説明 | -|:-------------|:-----------------------|:-------------------------------------| -| `start` | 文字列 - [タイムスタンプ][] | この時刻以降の結果に絞り込みます。 | -| `end` | 文字列 - [タイムスタンプ][] | この時刻以前の結果に絞り込みます。 | -| `descending` | ブール値 | `true`の場合、結果が逆時系列で返されます。デフォルトは`false`です。 | -| `type` | 文字列 | 特定の[トランザクションタイプ](transaction-types.html)にトランザクションを絞り込みます。 | -| `result` | 文字列 | 特定の[トランザクション結果](transaction-results.html)でトランザクションを絞り込みます。 | -| `binary` | ブール値 | `true`の場合、トランザクションをバイナリフォーマットで返します。デフォルトは`false`です。 | -| `limit` | 整数 | ページあたりの最大結果件数。デフォルトは20です。100を超える値は指定できません。 | -| `marker` | 文字列 | 前の応答の[ページネーション](#ページネーション)マーカー。 | - -#### 応答フォーマット -成功した場合の応答では、HTTPコード**200 OK**と以下の内容のJSON本文が返されます。 - -| フィールド | 値 | 説明 | -|:---------------|:---------------------------------|:-------------------------| -| `result` | 文字列 | 値が`success`の場合は、成功した場合の応答であることを示します。 | -| `count` | 整数 | 返されたトランザクションの数。 | -| `marker` | 文字列 | （省略される場合があります）ページネーションマーカー。 | -| `transactions` | [トランザクションオブジェクト][]の配列。 | 要求されたトランザクション。 | - -[トランザクションオブジェクト]: #トランザクションオブジェクト - -#### 例 - -要求: - -``` -GET /v2/transactions/?result=tecPATH_DRY&limit=2&type=Payment -``` - -応答: - -``` -200 OK -{ - "result": "success", - "count": 2, - "marker": "20130106022000|000000053869|00000", - "transactions": [ - { - "hash": "B8E4335A94438EC8209135A4E861A4C88F988C651B819DDAF2E8C55F9B41E589", - "date": "2013-01-02T20:13:40+00:00", - "ledger_index": 40752, - "ledger_hash": "55A900C2BA9483DC83F8FC065DE7789570662365BDE98EB75C5F4CE4F9B43214", - "tx": { - "TransactionType": "Payment", - "Flags": 0, - "Sequence": 61, - "Amount": { - "value": "96", - "currency": "USD", - "issuer": "rJ6VE6L87yaVmdyxa9jZFXSAdEFSoTGPbE" - }, - "Fee": "10", - "SigningPubKey": "02082622E4DA1DC6EA6B38A48956D816881E000ACF0C5F5B52863B9F698799D474", - "TxnSignature": "304402200A0746192EBC7BC3C1B9D657F42B6345A49D75FE23EF340CB6F0427254C139D00220446BF9169C94AEDC87F56D01DB011866E2A67E2AADDCC45C4D11422550D044CB", - "Account": "rB5TihdPbKgMrkFqrqUC3yLdE8hhv4BdeY", - "Destination": "rJ6VE6L87yaVmdyxa9jZFXSAdEFSoTGPbE" - }, - "meta": { - "TransactionIndex": 0, - "AffectedNodes": [ - { - "ModifiedNode": { - "LedgerEntryType": "AccountRoot", - "PreviousTxnLgrSeq": 40212, - "PreviousTxnID": "F491DC8B5E51045D4420297293199039D5AE1EA0C6D62CAD9A973E3C89E40CD6", - "LedgerIndex": "9B242A0D59328CE964FFFBFF7D3BBF8B024F9CB1A212923727B42F24ADC93930", - "PreviousFields": { - "Sequence": 61, - "Balance": "8178999999999400" - }, - "FinalFields": { - "Flags": 0, - "Sequence": 62, - "OwnerCount": 6, - "Balance": "8178999999999390", - "Account": "rB5TihdPbKgMrkFqrqUC3yLdE8hhv4BdeY" - } - } - } - ], - "TransactionResult": "tecPATH_DRY" - } - }, - { - "hash": "1E1C14BF5E61682F3DC9D035D9908816497B8E8843E05C0EE98E06DFDDDAE920", - "date": "2013-01-05T08:43:10+00:00", - "ledger_index": 51819, - "ledger_hash": "88ED10E4E31FC7580285CF173B264690B0E8688A3FC9F5F9C62F1A295B96269D", - "tx": { - "TransactionType": "Payment", - "Flags": 0, - "Sequence": 10, - "Amount": { - "value": "2", - "currency": "EUR", - "issuer": "rfitr7nL7MX85LLKJce7E3ATQjSiyUPDfj" - }, - "Fee": "10", - "SigningPubKey": "03FDDCD97668B686100E60653FD1E5210A8310616669AACB3A1FCC6D2C090CCB32", - "TxnSignature": "304402204F9BB7E37C14A3A3762E2A7DADB9A28D1AFFB3797521229B6FB98BA666B5491B02204F69AAEAFAC8FA473E52042FF06035AB3618A54E0B76C9852766D55184E98598", - "Account": "rhdAw3LiEfWWmSrbnZG3udsN7PoWKT56Qo", - "Destination": "rfitr7nL7MX85LLKJce7E3ATQjSiyUPDfj" - }, - "meta": { - "TransactionIndex": 0, - "AffectedNodes": [ - { - "ModifiedNode": { - "LedgerEntryType": "AccountRoot", - "PreviousTxnLgrSeq": 51814, - "PreviousTxnID": "5EC1C179996BD87E2EB11FE60A37ADD0FB2229ADC7D13B204FAB04FABED8A38D", - "LedgerIndex": "AC1B67084F84839A3158A4E38618218BF9016047B1EE435AECD4B02226AB2105", - "PreviousFields": { - "Sequence": 10, - "Balance": "10000999910" - }, - "FinalFields": { - "Flags": 0, - "Sequence": 11, - "OwnerCount": 2, - "Balance": "10000999900", - "Account": "rhdAw3LiEfWWmSrbnZG3udsN7PoWKT56Qo" - } - } - } - ], - "TransactionResult": "tecPATH_DRY" - } - } - ] -} -``` - - - -## Get Payments -[[ソース]](https://github.com/ripple/rippled-historical-database/blob/master/api/routes/getPayments.js "Source") - -Paymentを経時的に取得します。Paymentは、トランザクションの送金元が同時に送金先ではない`Payment`タイプのトランザクションと定義されます。_（新規: [v2.0.4][]）_ - -結果は個別のペイメントとして返されるか、または通貨とイシュアーが指定されている場合には特定の間隔でリストに集約されます。 - -#### 要求フォーマット - - - -*REST - 全通貨* - -``` -GET /v2/payments/ -``` - -*REST - 特定の通貨* - -``` -GET /v2/payments/{currency} -``` - - - -[試してみる>](data-api-v2-tool.html#get-payments) - -このメソッドでは以下のURLパラメーターを使用します。 - -| フィールド | 値 | 説明 | -|:-----------|:-------|:-------------------------------------------------------| -| `currency` | 文字列 | _（省略可）_ 通貨コード、`+`、相手側アドレスの順。（あるいは`XRP`のみ（相手側なし）。）省略すると、全通貨のペイメントが返されます。 | - -オプションで、以下のクエリーパラメーターを指定できます。 - -| フィールド | 値 | 説明 | -|:-------------|:-----------------------|:-------------------------------------| -| `start` | 文字列 - [タイムスタンプ][] | この時刻以降の結果に絞り込みます。 | -| `end` | 文字列 - [タイムスタンプ][] | この時刻以前の結果に絞り込みます。 | -| `descending` | ブール値 | `true`の場合、結果が逆時系列で返されます。デフォルトは`false`です。 | -| `limit` | 整数 | ページあたりの最大結果件数。デフォルトは200です。1000を超える値は指定できません。 | -| `marker` | 文字列 | 前に返された応答の[ページネーション](#ページネーション)キー。 | -| `format` | 文字列 | 返される結果のフォーマットは`csv`または`json`です。デフォルトは`json`です。 | - -結果を集計するための`interval`パラメーターは、[v2.3.5][]で削除されました。 - -#### 応答フォーマット - -成功した場合の応答では、HTTPコード**200 OK**と以下の内容のJSON本文が返されます。 - -| フィールド | 値 | 説明 | -|:-----------|:-----------------------------|:---------------------------------| -| `result` | 文字列 | 値が`success`の場合は、成功した場合の応答であることを示します。 | -| `count` | 整数 | 返されたペイメントの件数。 | -| `marker` | 文字列 | （省略される場合があります）[ページネーション](#ページネーション)マーカー。 | -| `payments` | [ペイメントオブジェクト][]の配列 | 要求されたペイメント。 | - - -#### 例 - -要求: - -``` -GET /v2/payments/BTC+rMwjYedjc7qqtKYVLiAccJSmCwih4LnE2q?limit=2 -``` - -応答: - -``` -200 OK -{ - "result": "success", - "count": 2, - "marker": "20131124004240|000003504935|00002", - "payments": [ - { - "amount": "100.0", - "delivered_amount": "100.0", - "destination_balance_changes": [ - { - "counterparty": "rMwjYedjc7qqtKYVLiAccJSmCwih4LnE2q", - "currency": "BTC", - "value": "100" - } - ], - "transaction_cost": "1.0E-5", - "source_balance_changes": [ - { - "counterparty": "rwm98fCBS8tV1YB8CGho8zUPW5J7N41th2", - "currency": "BTC", - "value": "-100" - } - ], - "tx_index": 3, - "currency": "BTC", - "destination": "rwm98fCBS8tV1YB8CGho8zUPW5J7N41th2", - "executed_time": "2013-09-27T04:03:00Z", - "issuer": "rMwjYedjc7qqtKYVLiAccJSmCwih4LnE2q", - "ledger_index": 2424349, - "source": "rMwjYedjc7qqtKYVLiAccJSmCwih4LnE2q", - "source_currency": "BTC", - "tx_hash": "EDDE2601C38F886E1183B5E7E1BFD936105C76E3648E3FAD2A6C55E90BABDB47" - }, - { - "amount": "0.2", - "delivered_amount": "0.2", - "destination_balance_changes": [ - { - "counterparty": "rMwjYedjc7qqtKYVLiAccJSmCwih4LnE2q", - "currency": "BTC", - "value": "0.2" - } - ], - "transaction_cost": "1.5E-5", - "max_amount": "0.202", - "source_balance_changes": [ - { - "counterparty": "rMwjYedjc7qqtKYVLiAccJSmCwih4LnE2q", - "currency": "BTC", - "value": "-0.2" - } - ], - "tx_index": 1, - "currency": "BTC", - "destination": "rHfcNvcg8pBqBxtSvD9Ma8gF17uxauB31o", - "executed_time": "2013-11-20T23:52:30Z", - "issuer": "rMwjYedjc7qqtKYVLiAccJSmCwih4LnE2q", - "ledger_index": 3445885, - "source": "rwm98fCBS8tV1YB8CGho8zUPW5J7N41th2", - "source_currency": "BTC", - "tx_hash": "F30D6CED4B0C37660F6DD741C9CA49F0BCB2D2648CDB8FC8AD6CFD86A86384E2" - } - ] -} -``` - - - - - -## Get Exchanges -[[ソース]](https://github.com/ripple/rippled-historical-database/blob/master/api/routes/getExchanges.js "Source") - -特定の通貨ペアの取引を経時的に取得します。結果は取引ごとに個別に返されるか、または特定の間隔でリストにまとめられます。 - -#### 要求フォーマット - - - -*REST* - -``` -GET /v2/exchanges/{base}/{counter} -``` - - - -[試してみる>](data-api-v2-tool.html#get-exchanges) - -このメソッドには以下のURLパラメーターを指定する必要があります。 - -| フィールド | 値 | 説明 | -|:----------|:-------|:--------------------------------------------------------| -| `base` | 文字列 | ペアのベース通貨。[通貨コード][]、`+`、イシュアーの[アドレス][]の順で指定します（ただし、ベース通貨がXRPの場合を除く）。 | -| `counter` | 文字列 | ペアのクオート通貨。[通貨コード][]、`+`、イシュアーの[アドレス][]の順で指定します（ただし、クオート通貨がXRPの場合を除く）。 | - -オプションで、以下のクエリーパラメーターを指定できます。 - -| フィールド | 値 | 説明 | -|:--------------|:-----------------------|:------------------------------------| -| `start` | 文字列 - [タイムスタンプ][] | この時刻以降の結果に絞り込みます。 | -| `end` | 文字列 - [タイムスタンプ][] | この時刻以前の結果に絞り込みます。 | -| `interval` | 文字列 | 収集間隔: `1minute`、`5minute`、`15minute`、`30minute`、`1hour`、`2hour`、`4hour`、`1day`、`3day`、`7day`、または`1month`。デフォルトでは結果は収集されません。 | -| `descending` | ブール値 | `true`の場合、結果が逆時系列で返されます。 | -| `reduce` | ブール値 | `true`の場合、個々の結果がすべてまとめられます。デフォルトは`false`です。 | -| `limit` | 整数 | ページあたりの最大結果件数。デフォルトは200です。`reduce`がtrueの場合、指定できる最大値は20,000です。それ以外の場合は、指定できる最大値は1,000です。 | -| `marker` | 文字列 | 前に返された応答の[ページネーション](#ページネーション)キー。 | -| `autobridged` | ブール値 | `true`の場合は、オートブリッジングされた取引のみに結果が絞り込まれます。 | -| `format` | 文字列 | 返される結果のフォーマットは`csv`または`json`です。デフォルトは`json`です。 | - -#### 応答フォーマット -成功した場合の応答では、HTTPコード**200 OK**と以下の内容のJSON本文が返されます。 - -| フィールド | 値 | 説明 | -|:------------|:------------------------------|:-------------------------------| -| `result` | 文字列 | 値が`success`の場合は、成功した場合の応答であることを示します。 | -| `count` | 整数 | 返されたトランザクションの数。 | -| `marker` | 文字列 | （省略される場合があります）[ページネーション](#ページネーション)マーカー。 | -| `exchanges` | [取引オブジェクト][]の配列 | 要求された取引。 | - -#### 例 - -要求: - -``` -GET /v2/exchanges/USD+rMwjYedjc7qqtKYVLiAccJSmCwih4LnE2q/XRP?descending=true&limit=3&result=tesSUCCESS&type=OfferCreate -``` - -応答: - -``` -200 OK -{ - "result": "success", - "count": 3, - "marker": "USD|rMwjYedjc7qqtKYVLiAccJSmCwih4LnE2q|XRP||20151021222220|000016612683|00017|00000", - "exchanges": [ - { - "base_amount": 4.98954834453577, - "counter_amount": 1047.806201, - "node_index": 9, - "rate": 210.00021000021, - "tx_index": 0, - "buyer": "rpP2JgiMyTF5jR5hLG3xHCPi1knBb1v9cM", - "executed_time": "2015-10-21T23:09:50", - "ledger_index": 16613308, - "offer_sequence": 1010056, - "provider": "rpP2JgiMyTF5jR5hLG3xHCPi1knBb1v9cM", - "seller": "rK2o63evRPdRoMT2ZaW72wsHsFzcjnRLLq", - "taker": "rK2o63evRPdRoMT2ZaW72wsHsFzcjnRLLq", - "tx_hash": "25600A10E5395D45A9D514E1EC3D98C341C5451FD21C48FA9D104C310EC29D6B", - "tx_type": "Payment", - "base_currency": "USD", - "base_issuer": "rMwjYedjc7qqtKYVLiAccJSmCwih4LnE2q", - "counter_currency": "XRP" - }, - { - "base_amount": 0.0004716155440678037, - "counter_amount": 0.1, - "node_index": 3, - "rate": 212.03711637126, - "tx_index": 0, - "buyer": "rfh3pFHkCXv3TgzsEJgyCzF1CduZHCLi9o", - "executed_time": "2015-10-21T23:09:50", - "ledger_index": 16613308, - "offer_sequence": 158081, - "provider": "rfh3pFHkCXv3TgzsEJgyCzF1CduZHCLi9o", - "seller": "rK2o63evRPdRoMT2ZaW72wsHsFzcjnRLLq", - "taker": "rK2o63evRPdRoMT2ZaW72wsHsFzcjnRLLq", - "tx_hash": "25600A10E5395D45A9D514E1EC3D98C341C5451FD21C48FA9D104C310EC29D6B", - "tx_type": "Payment", - "base_currency": "USD", - "base_issuer": "rMwjYedjc7qqtKYVLiAccJSmCwih4LnE2q", - "counter_currency": "XRP" - }, - { - "base_amount": 0.0004714169229390923, - "counter_amount": 0.1, - "node_index": 3, - "rate": 212.1264535361624, - "tx_index": 17, - "autobridged_currency": "USD", - "autobridged_issuer": "rMwjYedjc7qqtKYVLiAccJSmCwih4LnE2q", - "buyer": "rfh3pFHkCXv3TgzsEJgyCzF1CduZHCLi9o", - "executed_time": "2015-10-21T22:22:20", - "ledger_index": 16612683, - "offer_sequence": 158059, - "provider": "rfh3pFHkCXv3TgzsEJgyCzF1CduZHCLi9o", - "seller": "rpP2JgiMyTF5jR5hLG3xHCPi1knBb1v9cM", - "taker": "rpP2JgiMyTF5jR5hLG3xHCPi1knBb1v9cM", - "tx_hash": "F05F670B06D641D7F6FE18E450DDB2C7A4DDF76D580C34C820939DC22AD9F582", - "tx_type": "OfferCreate", - "base_currency": "USD", - "base_issuer": "rMwjYedjc7qqtKYVLiAccJSmCwih4LnE2q", - "counter_currency": "XRP" - } - ] -} -``` - - - -## Get Exchange Rates -[[ソース]](https://github.com/ripple/rippled-historical-database/blob/master/api/routes/getExchangeRate.js "Source") - -指定された通貨ペアの特定の時点での為替レートを取得します。 - -#### 要求フォーマット - - - -*REST* - -``` -GET /v2/exchange_rates/{base}/{counter} -``` - - - -[試してみる>](data-api-v2-tool.html#get-exchange-rates) - -このメソッドには以下のURLパラメーターを指定する必要があります。 - -| フィールド | 値 | 説明 | -|:----------|:-------|:--------------------------------------------------------| -| `base` | 文字列 | ペアのベース通貨を、[通貨コード][]、`+`、イシュアーの[アドレス][]の順で指定します。XRPの場合は`+`とイシュアーを省略します。 | -| `counter` | 文字列 | ペアのクオート通貨。[通貨コード][]、`+`、イシュアーの[アドレス][]の順で指定します。XRPの場合は`+`とイシュアーを省略します。 | - - -オプションで、以下のクエリーパラメーターを指定できます。 - -| フィールド | 値 | 説明 | -|:---------|:-----------------------|:-----------------------------------------| -| `date` | 文字列 - [タイムスタンプ][] | 指定された時点の為替レートを返します。デフォルトは現行時刻です。 | -| `strict` | ブール値 | `false`の場合、10件未満の取引からレートを導出できます。デフォルトは`true`です。 | - - -#### 応答フォーマット -成功した場合の応答では、HTTPコード**200 OK**と以下の内容のJSON本文が返されます。 - -| フィールド | 値 | 説明 | -|:---------|:-------|:---------------------------------------------------------| -| `result` | 文字列 | 値が`success`の場合は、成功した場合の応答であることを示します。 | -| `rate` | 数値 | 要求された為替レート。為替レートを判別できなかった場合は`0` です。 | - -すべての為替レートは、ベース通貨とクオート通貨をXRPに変換して算出されます。 - -レートは指定されたカレンダー日の出来高加重平均から導出されます。過去14日間における最新50件の取引の加重平均です。 - -#### 例 - -要求: - -``` -GET /v2/exchange_rates/USD+rMwjYedjc7qqtKYVLiAccJSmCwih4LnE2q/XRP?date=2015-11-13T00:00:00Z -``` - -応答: - -``` -200 OK -{ - "result": "success", - "rate": "224.65709" -} -``` - - - - -## Normalize -[[ソース]](https://github.com/ripple/rippled-historical-database/blob/master/api/routes/normalize.js "Source") - -ネットワークの為替レートを使用して、ある通貨とイシュアーからの額を別の通貨とイシュアーの額へ交換します。 - -#### 要求フォーマット - - - -*REST* - -``` -GET /v2/normalize -``` - - - -[試してみる>](data-api-v2-tool.html#normalize) - -少なくとも以下のクエリーパラメーターのいくつかを指定する必要があります。 - -| フィールド | 値 | 説明 | -|:--------------------|:---------------------------|:--------------------------| -| `amount` | 数値 | （必須）正規化する通貨の額。 | -| `currency` | 文字列 - [通貨コード][] | 交換前の`amount`の通貨コード。デフォルトはXRPです。 | -| `issuer` | 文字列 - [アドレス][] | 交換前の通貨のイシュアー。（`currency`がXRP以外の場合には必須です。） | -| `exchange_currency` | 文字列 - [通貨コード][] | 交換後の通貨。デフォルトはXRPです。 | -| `exchange_issuer` | 文字列 - [アドレス][] | 交換後の通貨のイシュアー。（`exchange_currency`がXRP以外の場合には必須です。） | -| `date` | 文字列 - [タイムスタンプ][] | この時点の為替レートに基づいて変換します。デフォルトは現行時刻です。 | -| `strict` | ブール値 | `true`の場合は、10件未満の取引から判別された為替レートは使用されません。デフォルトは`true`です。 | - - -#### 応答フォーマット -成功した場合の応答では、HTTPコード**200 OK**と以下の内容のJSON本文が返されます。 - -| フィールド | 値 | 説明 | -|:------------|:-------|:------------------------------------------------------| -| `result` | 文字列 | 値が`success`の場合は、成功した場合の応答であることを示します。 | -| `amount` | 数値 | 要求に指定されている交換前の額。 | -| `converted` | 数値 | 交換後の`exchange_currency`の額。為替レートを判別できなかった場合は`0`です。 | -| `rate` | 数値 | 交換の計算に使用された為替レート。為替レートを判別できなかった場合は`0`です。 | - -為替レートはすべて、両方の通貨をXRPに交換することで算出されます。 - -#### 例 - -要求: - -``` -GET /v2/normalize?amount=100¤cy=XRP&exchange_currency=USD&exchange_issuer=rMwjYedjc7qqtKYVLiAccJSmCwih4LnE2q -``` - -応答: - -``` -200 OK -{ - "result": "success", - "amount": "100", - "converted": "0.4267798022744489", - "rate": "0.0042677980" -} -``` - - - - -## Get Daily Reports -[[ソース]](https://github.com/ripple/rippled-historical-database/blob/master/api/routes/reports.js "Source") - -1日あたりのアカウント別に集計されたペイメントのサマリーを取得します。 - -#### 要求フォーマット - - - -*REST* - -``` -GET /v2/reports/{date} -``` - - - -[試してみる>](data-api-v2-tool.html#get-daily-reports) - -このメソッドでは以下のURLパラメーターを使用します。 - -| フィールド | 値 | 説明 | -|:-------|:-------|:--------------------------------------------------------------| -| `date` | 文字列 | _（省略可）_ クエリー実行日（UTC）。省略すると現在の日付が使用されます。 | - -オプションで、以下のクエリーパラメーターを指定できます。 - -| フィールド | 値 | 説明 | -|:-----------|:--------|:------------------------------------------------------| -| `accounts` | ブール値 | `true`の場合は、相手側アカウントのリストが含まれます。デフォルトは`false`です。 | -| `payments` | ブール値 | `true`の場合は、個々のペイメントのリストが含まれます。デフォルトは`false`です。 | -| `format` | 文字列 | 返される結果のフォーマットは`csv`または`json`です。デフォルトは`json`です。 | -| `limit` | 整数 | ページあたりの最大結果件数。デフォルトは200です。1000を超える値は指定できません。 | -| `marker` | 文字列 | 前に返された応答の[ページネーション](#ページネーション)キー。 | - -#### 応答フォーマット - -成功した場合の応答では、HTTPコード**200 OK**と以下の内容のJSON本文が返されます。 - -| フィールド | 値 | 説明 | -|:----------|:-----------------------------|:----------------------------------| -| `result` | 文字列 | 値が`success`の場合は、成功した場合の応答であることを示します。 | -| `date` | 文字列 - [タイムスタンプ][] | このレポートが適用される日付。 | -| `count` | 整数 | 返されたレポートの数。 | -| `marker` | 文字列 | （省略される場合があります）[ページネーション](#ページネーション)マーカー。 | -| `reports` | [レポートオブジェクト][]の配列 | 要求されたレポート。各レポートは1つのアカウントに関連します。 | - -**注意:** このメソッドでは非常に大量のデータ（1 MB以上）が返されることがあり、クライアントアプリケーションのパフォーマンスを低下させる可能性があります。 - -#### 例 - -要求: - -``` -GET /v2/reports/2015-08-19T00:00:00Z?accounts=true&payments=true -``` - -応答（サイズが大きいため一部省略）: - -``` -{ - "result": "success", - "date": "2015-08-19T00:00:00Z", - "count": 2, - "marker": "20150819000000|r2nt4zXDP6Be5FNrLsiuuTEBETbGR9RFw", - "reports": [ - { - "account": "r2LXq2rZWSgQ1thhKiEytzi1smg6oEn8A", - "date": "2015-08-19T00:00:00Z", - "high_value_received": "7000", - "high_value_sent": "3400", - "payments": [ - { - "tx_hash": "A032EFBB219B1102BBD9BCCB91EDC6EAA8185509574FA476A2D3FE6BA79B04EF", - "amount": "1700", - "type": "received" - }, - { - "tx_hash": "8B059360DC83777CDCABA84824C169651AFD6A7AB44E8742A3B8C6BC2AAF7384", - "amount": "40", - "type": "received" - }, - - ...(additional results trimmed)... - - { - "tx_hash": "76041BD6546389B5EC2CDBAA543200CF7B8D300F34F908BA5CA8523B0CA158C8", - "amount": "1400", - "type": "sent" - } - ], - "payments_received": 155, - "payments_sent": 49, - "receiving_counterparties": [ - "rDMFJrKg2jyoNG6WDWJknXDEKZ6ywNFGwD", - "r4XXHxraHLuCiLmLMw96FTPXXywZSnWSyR", - - ...(additional results trimmed)... - - - "rp1C4Ld6uGjurFpempUJ8q5hPSWhak5EQf" - ], - "sending_counterparties": [ - "rwxcJVWZSEgN2DmLZYYjyagHjMx5jQ7BAa", - - ...(additional results trimmed)... - - - "rBK1rLjbWsSU9EuST1cAz9RsiYdJPVGXXA" - ], - "total_value": "210940", - "total_value_received": "100540", - "total_value_sent": "110400" - }, - { - "account": "r2adXWaWFJt9mHeoWN77iHJozDz2FDAPA", - "date": "2015-08-19T00:00:00Z", - "high_value_received": "7400", - "high_value_sent": "15900", - "payments": [ - { - "tx_hash": "9C7EA76D467AE58E6AEFAAC7994D42FB4E7FA72BFA22F90260937386D76BDB64", - "amount": "900", - "type": "sent" - }, - - ...(additional results trimmed)... - - - { - "tx_hash": "EC25427964419394BB5D06343BC74235C33655C1F70523C688F9A201957D65BA", - "amount": "100", - "type": "sent" - } - ], - "payments_received": 43, - "payments_sent": 62, - "receiving_counterparties": [ - "rB4cyZxrBrTmJcWZSBc8YoW2t3bafiKRp", - - ...(additional results trimmed)... - - - "rKybkw3Pu74VfJfrWr7QJbVPJNarnKP2EJ" - ], - "sending_counterparties": [ - "rNRCXw8PQRjvTwMDDLZVvuLHSKqqXUXQHv", - "r7CLMVEuNvK2yXTPLPnkWMqzkkXuopWeL", - - ...(additional results trimmed)... - - - "ranyeoYRhvwiFABzDvxSVyqQKp1bMkFsaX" - ], - "total_value": "117600", - "total_value_received": "54700", - "total_value_sent": "62900" - } - ] -} -``` - - - -## Get Stats -[[ソース]](https://github.com/ripple/rippled-historical-database/blob/master/api/routes/stats.js "Source") - -XRP Ledgerでのトランザクションアクティビティの統計情報を、さまざまな時間間隔で取得します。 - -#### 要求フォーマット - - - -*REST* - -``` -GET /v2/stats -``` - - - -[試してみる>](data-api-v2-tool.html#get-stats) - -オプションで、以下のクエリーパラメーターを指定できます。 - -| フィールド | 値 | 説明 | -|:-------------|:-----------------------|:-------------------------------------| -| `family` | 文字列 | 指定されている場合は、結果が`type`、`result`、または`metric`のいずれか1つの統計ファミリーに絞り込まれます。デフォルトでは、すべてのファミリーのすべての統計情報が返されます。 | -| `metrics` | 文字列 | 結果を1つ以上のメトリック（カンマ区切りリスト）に絞り込みます。メトリックの`family`を指定する必要があります。デフォルトでは、当該ファミリーのすべてのメトリックが返されます。 | -| `start` | 文字列 - [タイムスタンプ][] | この時刻以降の結果に絞り込みます。 | -| `end` | 文字列 - [タイムスタンプ][] | この時刻以前の結果に絞り込みます。 | -| `interval` | 文字列 | 収集間隔（`hour`、`day`、または`week`）。デフォルトは`day`です。 | -| `limit` | 整数 | ページあたりの最大結果件数。デフォルトは200です。1000を超える値は指定できません。 | -| `marker` | 文字列 | 前に返された応答の[ページネーション](#ページネーション)キー。 | -| `descending` | ブール値 | `true`の場合、結果が逆時系列で返されます。デフォルトは`false`です。 | -| `format` | 文字列 | 返される結果のフォーマットは`csv`または`json`です。デフォルトは`json`です。 | - -##### ファミリーとメトリクス - -クエリーパラメーター`family`と`metrics`を使用すると、任意の間隔ですべてのトランザクションに適用できるあらゆるメトリクスの特定のサブセットに結果を絞り込むことができます。各メトリクスは以下のように特定のファミリーに関連付けられています。 - -| ファミリー | 含まれるメトリクス | 意味 | -|:---------|:-----------------|:--------| -| `type` | XRP Ledgerのすべての[トランザクションタイプ](transaction-formats.html)（`Payment`、`AccountSet`、`OfferCreate`など）。 | 所定の間隔内に発生した、指定されたタイプのトランザクションの数。 | -| `result` | `tesSUCCESS`、`tecPATH_DRY`などを含む、すべての[トランザクション結果コード](transaction-results.html)（数値コードではなく文字列コード）。 | 所定の間隔内に指定された結果コードを取得したトランザクションの数。 | -| `metric` | Data-API定義の特殊トランザクションメトリクス。 | （場合により異なる） | - -##### 特殊トランザクションメトリクス - -Data APIは各間隔ごとに以下の値を導出します。これらのメトリクスは`metric`ファミリーの一部です。 - -| フィールド | 値 | 説明 | -|:-------------------|:-------|:-----------------------------------------------| -| `accounts_created` | 数値 | この間隔内に資金供給を受けた新しいアカウントの数。 | -| `exchanges_count` | 数値 | この間隔内に発生した通貨取引の数。 | -| `ledger_count` | 数値 | この間隔内に閉鎖されたレジャーの数。 | -| `ledger_interval` | 数値 | この間隔内におけるレジャーの平均閉鎖間隔（秒数）。 | -| `payments_count` | 数値 | この間隔におけるアカウント間決済数。 | -| `tx_per_ledger` | 数値 | この間隔におけるレジャーあたりの平均トランザクション数。 | - -値が0のメトリクスは結果から省略されます。 - -#### 応答フォーマット -成功した場合の応答では、HTTPコード**200 OK**と以下の内容のJSON本文が返されます。 - -| フィールド | 値 | 説明 | -|:---------|:-----------------------|:-----------------------------------------| -| `result` | 文字列 | 値が`success`の場合は、成功した場合の応答であることを示します。 | -| `count` | 整数 | 返されたレポートの数。 | -| `marker` | 文字列 | （省略される場合があります）[ページネーション](#ページネーション)マーカー。 | -| `stats` | 統計情報オブジェクトの配列 | 要求された統計情報。値が0のメトリクスと、0以外のメトリクスのない間隔は省略されます。 | - -#### 例 - -要求: - -``` -GET /v2/stats/?start=2015-08-30&end=2015-08-31&interval=day&family=metric&metrics=accounts_created,exchanges_count,ledger_count,payments_count -``` - -応答: - -``` -200 OK -{ - "result": "success", - "count": 2, - "stats": [ - { - "accounts_created": 15, - "exchanges_count": 19368, - "ledger_count": 20307, - "payments_count": 24763, - "date": "2015-08-30T00:00:00Z" - }, - { - "accounts_created": 18, - "exchanges_count": 17192, - "ledger_count": 19971, - "payments_count": 30894, - "date": "2015-08-31T00:00:00Z" - } - ] -} -``` - - - -## Get Active Accounts -[[ソース]](https://github.com/ripple/rippled-historical-database/blob/master/api/routes/activeAccounts.js "Source") - -特定の通貨ペアの取引を実際に行っているアカウントに関する情報を取得します。_（新規: [v2.0.4][]）_ - -#### 要求フォーマット - - - -*REST* - -``` -GET /v2/active_accounts/{base}/{counter} -``` - - - -[試してみる>](data-api-v2-tool.html#get-active-accounts) - -このメソッドには以下のURLパラメーターを指定する必要があります。 - -| フィールド | 値 | 説明 | -|:----------|:-------|:--------------------------------------------------------| -| `base` | 文字列 | ペアのベース通貨。[通貨コード][]、`+`、イシュアーの[アドレス][]の順で指定します（ベース通貨がXRPの場合を除く）。 | -| `counter` | 文字列 | ペアのクオート通貨。[通貨コード][]、`+`、イシュアーの[アドレス][]の順で指定します（ただし、クオート通貨がXRPの場合を除く）。 | - -オプションで、以下のクエリーパラメーターを指定できます。 - -| フィールド | 値 | 説明 | -|:--------------------|:--------|:---------------------------------------------| -| `period` | 文字列 | 選択した期間中の取引アクティビティの結果を取得します。有効期間は`1day`、`3day`、`7day`です。デフォルトは`1day`です。 | -| `date` | 文字列 | この日に始まる期間の結果を取得します。デフォルトは、直近の期間です。 | -| `include_exchanges` | ブール値 | 各アカウントの個々の取引を結果に含めます。 | -| `format` | 文字列 | 返される結果のフォーマットは`csv`または`json`です。デフォルトは`json`です。 | - -#### 応答フォーマット -成功した場合の応答では、HTTPコード**200 OK**と以下の内容のJSON本文が返されます。 - -| フィールド | 値 | 説明 | -|:------------------|:----------------------------------------|:---------------| -| `result` | 文字列 | 値が`success`の場合は、成功した場合の応答であることを示します。 | -| `count` | 整数 | 返されたアカウントの数。 | -| `exchanges_count` | 整数 | 当該期間の取引の合計数。 | -| `accounts` | アクティブなアカウント取引オブジェクトの配列。 | 当該期間のアクティブな取引アカウント。 | - -各**アカウント取引オブジェクト**は、当該期間における1つのアカウントのアクティビティを表し、以下のフィールドが含まれています。 - -| フィールド | 値 | 説明 | -|:----------------------|:---------------------|:------------------------------| -| `buy` | オブジェクト | ベース通貨を購入する通貨取引のサマリー。 | -| `buy.base_volume` | 数値 | このアカウントが当該期間に購入したベース通貨の額。 | -| `buy.counter_volume` | 数値 | このアカウントが当該期間に売却したクオート通貨の額。 | -| `buy.count` | 数値 | 当該期間にベース通貨を購入した取引の数。 | -| `sell` | オブジェクト | ベース通貨を売却する通貨取引のサマリー。 | -| `sell.base_volume` | 数値 | このアカウントが当該期間に売却したベース通貨の額。 | -| `sell.counter_volume` | 数値 | このアカウントが当該期間に購入したクオート通貨の額。 | -| `sell.count` | 数値 | 当該期間にベース通貨を売却した取引の数。 | -| `account` | 文字列 - [アドレス][] | このオブジェクトが表すアクティビティのアドレス。 | -| `base_volume` | 数値 | このアカウントが当該期間中に売買したベース通貨の総額。 | -| `counter_volume` | 数値 | このアカウントが当該期間中に売買したクオート通貨の総額。 | -| `count` | 数値 | このアカウントが当該期間中に行った取引の合計数。 | - -#### 例 - -要求: - -``` -GET /v2/active_accounts/XRP/USD+rMwjYedjc7qqtKYVLiAccJSmCwih4LnE2q -``` - -応答: - -``` -200 OK -{ - "result": "success", - "count": 12, - "exchanges_count": 11, - "accounts": [ - { - "buy": { - "base_volume": 0, - "counter_volume": 0, - "count": 0 - }, - "sell": { - "base_volume": 13084.822874, - "counter_volume": 54.499328645454604, - "count": 4 - }, - "account": "rGBQhB8EH5DmqMmfKPLchpqr3MR19pv6zN", - "base_volume": 13084.822874, - "counter_volume": 54.499328645454604, - "count": 4 - }, - { - "buy": { - "base_volume": 12597.822874, - "counter_volume": 52.4909286454546, - "count": 1 - }, - "sell": { - "base_volume": 0, - "counter_volume": 0, - "count": 0 - }, - "account": "rQE5Z3FgVnRMbVfS6xiVQFgB4J3X162FVD", - "base_volume": 12597.822874, - "counter_volume": 52.4909286454546, - "count": 1 - }, - - ...(additional results trimmed)... - - { - "buy": { - "base_volume": 1.996007, - "counter_volume": 0.008782427920595, - "count": 1 - }, - "sell": { - "base_volume": 0, - "counter_volume": 0, - "count": 0 - }, - "account": "rD8LigXE7165r3VWhSQ4FwzJy7PNrTMwUq", - "base_volume": 1.996007, - "counter_volume": 0.008782427920595, - "count": 1 - }, - { - "buy": { - "base_volume": 0, - "counter_volume": 0, - "count": 0 - }, - "sell": { - "base_volume": 0.1, - "counter_volume": 0.0004821658905462904, - "count": 1 - }, - "account": "rfh3pFHkCXv3TgzsEJgyCzF1CduZHCLi9o", - "base_volume": 0.1, - "counter_volume": 0.0004821658905462904, - "count": 1 - } - ] -} -``` - - - -## Get Exchange Volume -[[ソース]](https://github.com/ripple/rippled-historical-database/blob/master/api/routes/network/getMetric.js "Source") - -指定された期間における取引量の合計を取得します。_（新規: [v2.0.4][]）_ - -APIは、結果を複数の種類の通貨ではなく1つの _表示通貨_ 単位で返します。XRPと他の通貨の取引には、標準レートが使用されます。 - -#### 要求フォーマット - - - -*REST* - -``` -GET /v2/network/exchange_volume -``` - - - -[試してみる>](data-api-v2-tool.html#get-exchange-volume) - -オプションで、以下のクエリーパラメーターを指定できます。 - -| フィールド | 値 | 説明 | -|:--------------------|:---------------------------|:--------------------------| -| `live` | 文字列 | この時間の長さのライブローリングウィンドウを返します。有効な値は`day`、`hour`、`minute`です。_（新規: [v2.3.0][]）_ | -| `exchange_currency` | 文字列 - [通貨コード][] | すべての額を正規化し、この通貨を表示通貨として使用します。XRP以外の場合は`exchange_issuer`も必要です。デフォルトはXRPです。 | -| `exchange_issuer` | 文字列 - [アドレス][] | 結果を、このイシュアーが発行した特定の`currency`に正規化します。 | -| `format` | 文字列 | 返される結果のフォーマットは`csv`または`json`です。デフォルトは`json`です。 | - -`start`、`end`、`interval`、`limit`、および`marker`パラメーターは[v2.3.5][]で削除されました。 - -#### 応答フォーマット -成功した場合の応答では、HTTPコード**200 OK**と以下の内容のJSON本文が返されます。 - -| フィールド | 値 | 説明 | -|:---------|:-------------------------------------|:---------------------------| -| `result` | 文字列 | 値が`success`の場合は、成功した場合の応答であることを示します。 | -| `count` | 整数 | 返された結果の数。 | -| `rows` | 取引[取引量オブジェクト][]の配列。 | 要求された期間における各間隔の取引量。（デフォルトでは、この配列には直近の完全な間隔だけが含まれます。`live`が指定されており`interval`が指定されていない場合は、この配列には指定されたローリングウィンドウが含まれます。） | - -取引量オブジェクトの`components`配列内の各オブジェクトは、2種類の通貨間のマーケットにおける取引量を表し、以下のフィールドが含まれています。 - -| フィールド | 値 | 説明 | -|:-------------------|:-------|:-----------------------------------------------| -| `count` | 数値 | この間隔内にこのマーケットで行われた取引の件数。 | -| `rate` | 数値 | ベース通貨から表示通貨への為替レート。 | -| `amount` | 数値 | このマーケットにおける取引量（ベース通貨単位）。 | -| `base` | オブジェクト | このマーケットにおけるベース通貨の`currency`と`issuer`。XRPの場合は`issuer`はありません。 | -| `counter` | オブジェクト | このマーケットにおけるクオート通貨の`currency`と`issuer`。XRPの場合は`issuer`はありません。 | -| `converted_amount` | 数値 | このマーケットにおける合計取引量（表示通貨に変換）。_（[v2.1.0][]より古いバージョンでは、これは`convertedAmount`でした。）_ | - -#### 例 - -要求: - -``` -GET /v2/network/exchange_volume?exchange_currency=USD&exchange_issuer=rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B -``` - - -応答: - -``` -200 OK -{ - "result": "success", - "count": 1, - "rows": [ - { - "components": [ - { - "count": 1711, - "rate": 5.514373809662552e-8, - "amount": 333.7038784107369, - "base": { - "currency": "BTC", - "issuer": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B" - }, - "counter": { - "currency": "XRP" - }, - "converted_amount": 117720.99268355068 - }, - { - "count": 1977, - "rate": 0.000019601413454357618, - "amount": 74567.72531650064, - "base": { - "currency": "USD", - "issuer": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B" - }, - "counter": { - "currency": "XRP" - }, - "converted_amount": 74003.51871932109 - }, - - ...(additional results trimmed) ... - - { - "count": 3, - "rate": 0.022999083584408355, - "amount": 85.40728674708998, - "base": { - "currency": "CNY", - "issuer": "razqQKzJRdB4UxFPWf5NEpEG3WMkmwgcXA" - }, - "counter": { - "currency": "USD", - "issuer": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B" - }, - "converted_amount": 12.72863756671683 - }, - { - "count": 3, - "rate": 1.7749889023209692e-7, - "amount": 570.687912196755, - "base": { - "currency": "JPY", - "issuer": "r94s8px6kSw1uZ1MV98dhSRTvc6VMPoPcN" - }, - "counter": { - "currency": "BTC", - "issuer": "rMwjYedjc7qqtKYVLiAccJSmCwih4LnE2q" - }, - "converted_amount": 4.4137945368632545 - } - ], - "count": 11105, - "endTime": "2015-09-11T19:58:58+00:00", - "exchange": { - "currency": "USD", - "issuer": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B" - }, - "exchangeRate": 0.004410567085248279, - "startTime": "2015-11-10T00:06:04+00:00", - "total": 442442.5974313684 - } - ] -} -``` - - - - - -## Get Payment Volume -[[ソース]](https://github.com/ripple/rippled-historical-database/blob/master/api/routes/network/getMetric.js "Source") - -指定された期間のペイメントの合計取引量を取得します。_（新規: [v2.0.4][]）_ - -APIは、結果を複数の種類の通貨ではなく1つの _表示通貨_ 単位で返します。XRPと他の通貨の取引には、標準レートが使用されます。 - -#### 要求フォーマット - - - -*REST* - -``` -GET /v2/network/payment_volume -``` - - - -[試してみる>](data-api-v2-tool.html#get-payment-volume) - -オプションで、以下のクエリーパラメーターを指定できます。 - -| フィールド | 値 | 説明 | -|:--------------------|:---------------------------|:--------------------------| -| `live` | 文字列 | この時間の長さのライブローリングウィンドウを返します。有効な値は`day`、`hour`、`minute`です。_（新規: [v2.3.0][]）_ | -| `exchange_currency` | 文字列 - [通貨コード][] | すべての額を正規化し、この通貨を表示通貨として使用します。XRP以外の場合は`exchange_issuer`も必要です。デフォルトはXRPです。 | -| `exchange_issuer` | 文字列 - [アドレス][] | 結果を、このイシュアーが発行した特定の`currency`に正規化します。 | -| `format` | 文字列 | 返される結果のフォーマットは`csv`または`json`です。デフォルトは`json`です。 | - -`start`、`end`、`interval`、`limit`、および`marker`パラメーターは[v2.3.5][]で削除されました。 - -#### 応答フォーマット -成功した場合の応答では、HTTPコード**200 OK**と以下の内容のJSON本文が返されます。 - -| フィールド | 値 | 説明 | -|:---------|:------------------------------------|:----------------------------| -| `result` | 文字列 | 値が`success`の場合は、成功した場合の応答であることを示します。 | -| `count` | 整数 | 返された結果の数。 | -| `rows` | ペイメントの[取引量オブジェクト][]の配列。 | 要求された期間における各間隔のペイメントの取引量。（デフォルトでは、この配列には最新の間隔だけが含まれます。`live`が指定されており`interval`が指定されていない場合は、この配列には指定されたローリングウィンドウが含まれます。） | - -取引量オブジェクトの`components`配列の各オブジェクトは、1つの通貨とイシュアーのペイメントの取引量を表し、以下のフィールドが含まれています。 - -| フィールド | 値 | 説明 | -|:-------------------|:---------------------------|:---------------------------| -| `currency` | 文字列 - [通貨コード][] | このペイメントの取引量オブジェクトの通貨。 | -| `issuer` | 文字列 - [アドレス][] | （XRPの場合は省略）このペイメントの取引量オブジェクトのイシュアー。 | -| `amount` | 数値 | 当該間隔内におけるこの通貨でのペイメントの合計額（当該通貨単位）。 | -| `count` | 数値 | この通貨でのペイメントの合計件数。 | -| `rate` | 数値 | この通貨と表示通貨間の為替レート。 | -| `converted_amount` | 数値 | この通貨のペイメントの合計額（表示通貨に変換）。_（[v2.1.0][]より古いバージョンでは、これは`convertedAmount`でした。）_ | - -#### 例 - -要求: - -``` -GET /v2/network/payment_volume -``` - -応答: - -``` -200 OK -{ - "result": "success", - "count": 1, - "rows": [ - { - "components": [ - { - "currency": "USD", - "issuer": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B", - "amount": 87279.59029136538, - "count": 331, - "rate": 0.004412045860957953, - "converted_amount": 19782113.1153009 - }, - { - "currency": "USD", - "issuer": "rMwjYedjc7qqtKYVLiAccJSmCwih4LnE2q", - "amount": 0, - "count": 0, - "rate": 0.00451165816091143, - "converted_amount": 0 - }, - { - "currency": "BTC", - "issuer": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B", - "amount": 279.03077460240354, - "count": 107, - "rate": 0.000013312520335244644, - "converted_amount": 20960026.169024874 - }, - - ...(additional results trimmed) ... - - { - "currency": "MXN", - "issuer": "rG6FZ31hDHN1K5Dkbma3PSB5uVCuVVRzfn", - "amount": 49263.13280138676, - "count": 19, - "rate": 0.07640584677247926, - "converted_amount": 644756.0609868265 - }, - { - "currency": "XRP", - "amount": 296246369.30089426, - "count": 8691, - "rate": 1, - "converted_amount": 296246369.30089426 - } - ], - "count": 9388, - "endTime": "2015-09-11T19:58:59+00:00", - "exchange": { - "currency": "XRP" - }, - "exchangeRate": 1, - "startTime": "2015-11-10T00:19:04+00:00", - "total": 390754174.7837752 - } - ] -} -``` - - - -## Get External Markets -[[ソース]](https://github.com/ripple/rippled-historical-database/blob/master/api/routes/network/externalMarkets.js "Source") - -指定のローリング間隔におけるレジャー外の取引のリストから、取引量の合計を取得します。 - -APIは、結果を複数の種類の通貨ではなく1つの _表示通貨_ 単位で返します。XRPと他の通貨の取引には、標準レートが使用されます。 - -#### 要求フォーマット #### - - - -*REST* - -``` -GET /v2/network/external_markets -``` - - - -[試してみる>](data-api-v2-tool.html#get-external-markets) - -オプションで、以下のクエリーパラメーターを指定できます。 - -| フィールド | 値 | 説明 | -|:--------------------|:---------------------------|:--------------------------| -| `period` | 文字列 | 集約期間 - 有効な間隔は`1hour`、`1day`、`3day`、`7day`、`30day`です。デフォルトは`1day`です。 | -| `exchange_currency` | 文字列 - [通貨コード][] | すべての額を正規化し、この通貨を表示通貨として使用します。XRP以外の場合は`exchange_issuer`も必要です。デフォルトはXRPです。 | -| `exchange_issuer` | 文字列 - [アドレス][] | 結果を、このイシュアーが発行した特定の`currency`に正規化します。 | - - -#### 応答フォーマット #### -成功した場合の応答では、HTTPコード**200 OK**と以下の内容のJSON本文が返されます。 - -| フィールド | 値 | 説明 | -|:--------------|:-------|:----------------------------------------------------| -| `result` | 文字列 | 値が`success`の場合は、成功した場合の応答であることを示します。 | -| `data` | オブジェクト | 指定の期間のデータが含まれています。 | -| `data.date` | 文字列 | この期間が計算された日付。 | -| `data.total` | 数値 | 当該期間に取引されたXRPの合計額。 | -| `data.period` | 文字列 | 照会された期間の名前。 | - -取引量オブジェクトの`components`配列の各オブジェクトは、1つの外部マーケットの取引量を表します。マーケットによってはすべてのフィールドが表示されるわけではありません。 - -| フィールド | 値 | 説明 | -|:-------------------|:-------|:-----------------------------------------------| -| `source` | 文字列 | 特定の外部マーケットのドメイン名。 | -| `base_volume` | 数値 | ベース通貨（XRP）単位での取引量。 | -| `counter_volume` | 数値 | クオート通貨単位での取引量。 | -| `base_currecy` | 文字列 | マーケットペアのベース通貨。 | -| `counter_currency` | 文字列 | マーケットペアのクオート通貨。 | -| `rate` | 数値 | 為替レート。 | - -#### 例 #### - -要求: - -``` -GET /v2/network/external_markets -``` - - -応答: - -``` -200 OK - -{ - "result": "success", - "data": { - "components": [ - { - "base_volume": "52847221.256202064", - "counter_volume": "619.8111371100003", - "source": "poloniex.com", - "base_currency": "XRP", - "counter_currency": "BTC", - "rate": "0.0000117284" - }, - { - "base_volume": "389955.29648717004", - "counter_volume": "3212.07137265", - "source": "poloniex.com", - "base_currency": "XRP", - "counter_currency": "USD", - "rate": "0.00823702" - }, - { - "base_volume": "6025268.09143092", - "counter_volume": "70.57870572291264", - "count": 250, - "source": "kraken.com", - "base_currency": "XRP", - "counter_currency": "BTC", - "rate": "0.0000117138" - }, - { - "base_volume": "4141962.161763998", - "source": "btc38.com", - "base_currency": "XRP", - "counter_currency": "CNY" - }, - { - "base_volume": "303505", - "source": "btc38.com", - "base_currency": "XRP", - "counter_currency": "BTC" - }, - { - "base_volume": "1275008.2922999999", - "source": "jubi.com", - "base_currency": "XRP", - "counter_currency": "CNY" - } - ], - "date": "2016-10-31T20:45:20Z", - "period": "1day", - "total": "64982920.098184146" - } -} -``` - - - -## Get XRP Distribution -[[ソース]](https://github.com/ripple/rippled-historical-database/blob/master/api/routes/network/xrpDistribution.js "Source") - -現存し、流通しているXRPの合計額に関する情報を週単位で取得します。_（新規: [v2.2.0][]）_ - -#### 要求フォーマット - - - -*REST* - -``` -GET /v2/network/xrp_distribution -``` - - - -[試してみる>](data-api-v2-tool.html#get-xrp-distribution) - -オプションで、以下のクエリーパラメーターを指定できます。 - -| フィールド | 値 | 説明 | -|:-------------|:-----------------------|:-------------------------------------| -| `start` | 文字列 - [タイムスタンプ][] | 照会範囲の開始時刻。デフォルトは、最新間隔の開始時刻です。 | -| `end` | 文字列 - [タイムスタンプ][] | 照会範囲の終了時刻。デフォルトは、最新間隔の終了時刻です。 | -| `limit` | 整数 | ページあたりの最大結果件数。デフォルトは200です。1000を超える値は指定できません。 | -| `marker` | 文字列 | 前に返された応答の[ページネーション](#ページネーション)キー。 | -| `descending` | ブール値 | `true`の場合、結果が逆時系列で返されます。デフォルトは`false`です。 | -| `format` | 文字列 | 返される結果のフォーマットは`csv`または`json`です。デフォルトは`json`です。 | - -#### 応答フォーマット - -成功した場合の応答では、HTTPコード**200 OK**と以下の内容のJSON本文が返されます。 - -| フィールド | 値 | 説明 | -|:---------|:------------------------------|:----------------------------------| -| `result` | 文字列 | 値が`success`の場合、本文は成功した場合の応答を表しています。 | -| `count` | 整数 | 返された行の数。 | -| `rows` | 流通量オブジェクトの配列 | XRP流通量の週次スナップショット。 | - -各流通量オブジェクトのフィールドを次に示します。 - -| フィールド | 値 | 説明 | -|:----------------|:-----------------------|:----------------------------------| -| `date` | 文字列 - [タイムスタンプ][] | このスナップショットの時刻。 | -| `total` | 文字列 | 現存するXRPの合計。 | -| `undistributed` | 文字列 | Ripple（企業）が保有するXRPの総額。 | -| `distributed` | 文字列 | Ripple以外が保有するXRPの総額。 | - -#### 例 - -要求: - -``` -GET /v2/network/xrp_distribution -``` - -応答: - -``` -200 OK -{ - "result": "success", - "count": 171, - "rows": [ - { - "date": "2016-04-10T00:00:00Z", - "distributed": "34918644255.77274", - "total": "99997725821.25714", - "undistributed": "65079081565.4844" - }, - ... - ] -} -``` - - - -## Get Top Currencies -[[ソース]](https://github.com/ripple/rippled-historical-database/blob/master/api/routes/network/topCurrencies.js "Source") - -XRP Ledgerの上位通貨を、ランクが高いものから順に返します。このランクは、トランザクションの額と件数、および一意の取引相手の数に基づいて決定します。デフォルトでは、現在の日付で終了する30日間ローリングウィンドウの結果が返されます。結果を取得する30日間ローリングウィンドウの最終日の日付を指定できます。_（新規: [v2.1.0][]）_ - - -#### 要求フォーマット - - - -*最新* - -``` -GET /v2/network/top_currencies -``` - -*日付指定* - -``` -GET /v2/network/top_currencies/{date} -``` - - - -[試してみる>](data-api-v2-tool.html#get-top-currencies) - -このメソッドでは以下のURLパラメーターを使用します。 - -| フィールド | 値 | 説明 | -|:-------|:-----------------------|:-------------------------------------------| -| `date` | 文字列 - ISO 8601の日付 | _（省略可）_ 照会する過去の日付。省略すると、利用可能な最新の日付が使用されます。 | - -オプションで、以下のクエリーパラメーターを指定できます。 - -| フィールド | 値 | 説明 | -|:---------|:--------|:--------------------------------------------------------| -| `limit` | 整数 | ページあたりの最大結果件数。デフォルトは1000です。1000を超える値は指定できません。 | -| `format` | 文字列 | 返される結果のフォーマットは`csv`または`json`です。デフォルトは`json`です。 | - -#### 応答フォーマット - -成功した場合の応答では、HTTPコード**200 OK**と以下の内容のJSON本文が返されます。 - -| フィールド | 値 | 説明 | -|:-------------|:------------------------------|:------------------------------| -| `result` | 文字列 | 値が`success`の場合は、成功した場合の応答であることを示します。 | -| `date` | 文字列 - [タイムスタンプ][] | このデータが測定された時点。 | -| `count` | 整数 | `currencies`フィールドに含まれているオブジェクトの数。 | -| `currencies` | 上位通貨オブジェクトの配列 | このデータサンプルの上位通貨。各メンバーは1つの通貨を通貨コードとイシュアーで表します。 | - -各上位通貨オブジェクトのフィールドを次に示します。 - -| フィールド | 値 | 説明 | -|:----------------------|:---------------------------|:------------------------| -| `currency` | 文字列 - [通貨コード][] | このオブジェクトが表す通貨。 | -| `issuer` | 文字列 - [アドレス][] | この通貨を発行するXRP Ledgerアドレス。 | -| `avg_exchange_count` | [文字列 - 数値][] | 1日あたりの平均[取引](#取引オブジェクト)件数。 | -| `avg_exchange_volume` | [文字列 - 数値][] | 1日あたりの平均取引量（XRPに正規化）。 | -| `avg_payment_count` | [文字列 - 数値][] | 1日あたりの平均[ペイメント](#ペイメントオブジェクト)件数。 | -| `avg_payment_volume` | [文字列 - 数値][] | 1日あたりの平均ペイメント取引量（XRPに正規化）。 | -| `issued_value` | [文字列 - 数値][] | このイシュアーが発行したこの通貨の合計額（XRPに正規化）。 | - -#### 例 - -要求: - -``` -GET /v2/network/top_currencies/2016-04-14?limit=2 -``` - -応答: - -``` -200 OK -{ - "result": "success", - "date": "2016-04-14T00:00:00Z", - "count": 2, - "currencies": [ - { - "avg_exchange_count": "8099.967741935484", - "avg_exchange_volume": "3.5952068085531615E7", - "avg_payment_count": "624.28125", - "avg_payment_volume": "3910190.139488101", - "issued_value": "1.5276205395328993E8", - "currency": "CNY", - "issuer": "rKiCet8SdvWxPXnAgYarFUXMh1zCPz432Y" - }, - { - "avg_exchange_count": "3003.2258064516127", - "avg_exchange_volume": "3.430482029838605E7", - "avg_payment_count": "257.4375", - "avg_payment_volume": "501442.0789529095", - "issued_value": "2.6289124450524995E8", - "currency": "USD", - "issuer": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B" - } - ] -} -``` - - - -## Get Top Markets -[[ソース]](https://github.com/ripple/rippled-historical-database/blob/master/api/routes/network/topMarkets.js "Source") - -XRP Ledgerの上位マーケットを、ランクが高いものから順に返します。このランクは、取引の数と量、および参加取引相手の数に基づいて決定します。デフォルトでは、現在の日付で終わる30日間ローリングウィンドウにおける上位のマーケットが返されます。結果を取得する30日間ローリングウィンドウの最終日の日付を指定できます。_（新規: [v2.1.0][]）_ - -#### 要求フォーマット - - - -*最新* - -``` -GET /v2/network/top_markets -``` - -*日付指定* - -``` -GET /v2/network/top_markets/{date} -``` - - - -[試してみる>](data-api-v2-tool.html#get-top-markets) - -このメソッドでは以下のURLパラメーターを使用します。 - -| フィールド | 値 | 説明 | -|:-------|:-----------------------|:-------------------------------------------| -| `date` | 文字列 - ISO 8601の日付 | _（省略可）_ 照会する過去の日付。省略すると、利用可能な最新の日付が使用されます。 | - -オプションで、以下のクエリーパラメーターを指定できます。 - -| フィールド | 値 | 説明 | -|:---------|:--------|:--------------------------------------------------------| -| `limit` | 整数 | ページあたりの最大結果件数。デフォルトは1000です。1000を超える値は指定できません。 | -| `format` | 文字列 | 返される結果のフォーマットは`csv`または`json`です。デフォルトは`json`です。 | - -#### 応答フォーマット - -成功した場合の応答では、HTTPコード**200 OK**と以下の内容のJSON本文が返されます。 - -| フィールド | 値 | 説明 | -|:----------|:----------------------------|:-----------------------------------| -| `result` | 文字列 | 値が`success`の場合は、成功した場合の応答であることを示します。 | -| `date` | 文字列 - [タイムスタンプ][] | このデータの計算対象であるローリングウィンドウの終了時刻。 | -| `count` | 整数 | `markets`フィールドに含まれている結果の数。 | -| `markets` | 上位マーケットオブジェクトの配列 | このデータサンプルの上位マーケット。各メンバーは通貨ペアを表します。 | - -各上位マーケットオブジェクトのフィールドを次に示します。 - -| フィールド | 値 | 説明 | -|:---------------------|:---------------------------|:-------------------------| -| `base_currency` | 文字列 - [通貨コード][] | このマーケットのベース通貨。 | -| `base_issuer` | 文字列 - [アドレス][] | （`base_currency`がXRPの場合は省略）ベース通貨を発行するXRP Ledgerアドレス。 | -| `counter_currency` | 文字列 - [通貨コード][] | このマーケットのクオート通貨。 | -| `counter_issuer` | 文字列 - [アドレス][] | （`counter_currency`がXRPの場合は省略）クオート通貨を発行するXRP Ledgerアドレス。 | -| `avg_base_volume` | 文字列 | 1日あたりのベース通貨単位での平均取引量。 | -| `avg_counter_volume` | 文字列 | 1日あたりのクオート通貨単位での平均取引量。 | -| `avg_exchange_count` | 文字列 | 1日あたりの平均[取引](#取引オブジェクト)件数。 | -| `avg_volume` | 文字列 | 1日あたりの平均取引量（XRPに正規化）。 | - -#### 例 - -要求: - -``` -GET /v2/network/top_markets/2015-12-31 -``` - -応答: - -``` -200 OK -{ - "result": "success", - "date": "2015-12-31T00:00:00Z", - "count": 58, - "markets": [ - { - "avg_base_volume": "116180.98607935428", - "avg_counter_volume": "1.6657039295476614E7", - "avg_exchange_count": "1521.4603174603174", - "avg_volume": "1.6657039295476614E7", - "base_currency": "USD", - "base_issuer": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B", - "counter_currency": "XRP" - }, - { - "avg_base_volume": "410510.0286920887", - "avg_counter_volume": "9117398.719214212", - "avg_exchange_count": "1902.1587301587301", - "avg_volume": "9117398.719214212", - "base_currency": "CNY", - "base_issuer": "rKiCet8SdvWxPXnAgYarFUXMh1zCPz432Y", - "counter_currency": "XRP" - }, - ... - ] -} -``` - - - -## Get Transaction Costs -[[ソース]](https://github.com/ripple/rippled-historical-database/blob/master/api/routes/network/getFees.js "Source") - -レジャー、時間、または日ごとに[トランザクションコスト](transaction-cost.html)の統計情報を返します。このデータは、特定の間隔またはレジャーで支払われたトランザクションコストの最小値、最大値、および合計を示します。_（新規: [v2.2.0][]）_ - -#### 要求フォーマット - - - -*REST* - -``` -GET /v2/network/fees -``` - - - -[試してみる>](data-api-v2-tool.html#get-transaction-costs) - -オプションで、以下のクエリーパラメーターを指定できます。 - -| フィールド | 値 | 説明 | -|:-------------|:-----------------------|:-------------------------------------| -| `start` | 文字列 - [タイムスタンプ][] | 照会範囲の開始時刻。デフォルトでは、利用可能な最も古いデータから開始します。 | -| `end` | 文字列 - [タイムスタンプ][] | 照会範囲の終了時刻。デフォルトでは、利用可能な最も新しいデータから開始します。 | -| `interval` | 文字列 | 収集間隔 - 有効な間隔は`ledger`、`hour`、`day`です。デフォルトは`ledger`です。 | -| `descending` | ブール値 | `true`の場合は、結果が最新のものから順にソートされます。デフォルトでは、結果が最も古いものから順にソートされます。 | -| `limit` | 整数 | ページあたりの最大結果件数。デフォルトは200です。1000を超える値は指定できません。 | -| `marker` | 文字列 | 前に返された応答の[ページネーション](#ページネーション)キー。 | -| `format` | 文字列 | 返される結果のフォーマットは`csv`または`json`です。デフォルトは`json`です。 | - -#### 応答フォーマット - -成功した場合の応答では、HTTPコード**200 OK**と以下の内容のJSON本文が返されます。 - -| フィールド | 値 | 説明 | -|:---------|:-----------------------------|:-----------------------------------| -| `result` | 文字列 | 値が`success`の場合は、成功した場合の応答であることを示します。 | -| `marker` | 文字列 | （省略される場合があります）[ページネーション](#ページネーション)マーカー。 | -| `count` | 整数 | `markets`フィールドに含まれている結果の数。 | -| `rows` | 手数料サマリーオブジェクトの配列 | 各間隔のトランザクションコストの統計情報。 | - -各手数料サマリーオブジェクトのフィールドを次に示します。 - -| フィールド | 値 | 説明 | -|:---------------|:---------------------------|:-------------------------------| -| `avg` | 数値 | この間隔内に支払われたトランザクションコストの平均。 | -| `min` | 数値 | この間隔内に支払われたトランザクションコストの最小額。 | -| `max` | 数値 | この間隔内に支払われたトランザクションコストの最大額。 | -| `total` | 数値 | トランザクションコストにより消却されたXRPの合計。 | -| `tx_count` | 数値 | この間隔のトランザクションの数。 | -| `date` | 文字列 - [タイムスタンプ][] | この間隔の開始時刻（時間間隔）とこのレジャーの閉鎖時刻（`ledger`間隔）。 | -| `ledger_index` | 整数 - [レジャーインデックス][] | （`ledger`間隔の場合にのみ含まれます）このオブジェクトが表すレジャー。 | - -#### 例 - -要求: - -``` -GET /v2/network/fees?interval=day&limit=3&descending=true -``` - -応答: - -``` -200 OK -{ - "result": "success", - "marker": "day|20160603000000", - "count": 3, - "rows": [ - { - "avg": 0.011829, - "max": 15, - "min": 0.01, - "total": 6682.15335, - "tx_count": 564918, - "date": "2016-06-06T00:00:00Z" - }, - { - "avg": 0.011822, - "max": 4.963071, - "min": 0.01, - "total": 5350.832025, - "tx_count": 452609, - "date": "2016-06-05T00:00:00Z" - }, - { - "avg": 0.012128, - "max": 15, - "min": 0.01, - "total": 5405.126404, - "tx_count": 445689, - "date": "2016-06-04T00:00:00Z" - } - ] -} -``` - - - - -## Get Fee Stats -[[ソース]](https://github.com/ripple/rippled-historical-database/blob/master/api/routes/network/getFeeStats.js "Source") - -`rippled`の[`fee`コマンド](fee.html)から導出されたメトリクスのスナップショットを返します。_（新規: [v2.3.2][]）_ - -#### 要求フォーマット - - - -*REST* - -``` -GET /v2/network/fee_stats -``` - - - -[試してみる>](data-api-v2-tool.html#get-fee-stats) - -オプションで、以下のクエリーパラメーターを指定できます。 - -| フィールド | 値 | 説明 | -|:-------------|:-----------------------|:-------------------------------------| -| `start` | 文字列 - [タイムスタンプ][] | 照会範囲の開始時刻。デフォルトでは、利用可能な最も古いデータから開始します。 | -| `end` | 文字列 - [タイムスタンプ][] | 照会範囲の終了時刻。デフォルトでは、利用可能な最新データで終了します。 | -| `interval` | 文字列 | スナップショットの間隔。有効な間隔は`minute`、`hour`、`day`です。デフォルトの間隔は5秒です。 | -| `descending` | ブール値 | `true`の場合は、結果が最新のものから順にソートされます。デフォルトでは、結果が最も古いものから順にソートされます。 | -| `limit` | 整数 | ページあたりの最大結果件数。デフォルトは200です。1000を超える値は指定できません。 | -| `marker` | 文字列 | 前に返された応答の[ページネーション](#ページネーション)キー。 | -| `format` | 文字列 | 返される結果のフォーマットは`csv`または`json`です。デフォルトは`json`です。 | - -#### 応答フォーマット - -成功した場合の応答では、HTTPコード**200 OK**と以下の内容のJSON本文が返されます。 - -| フィールド | 値 | 説明 | -|:---------|:-----------------------------|:-----------------------------------| -| `result` | 文字列 | 値が`success`の場合は、成功した場合の応答であることを示します。 | -| `marker` | 文字列 | （省略される場合があります）[ページネーション](#ページネーション)マーカー。 | -| `count` | 整数 | `markets`フィールドに含まれている結果の数。 | -| `rows` | 手数料サマリーオブジェクトの配列 | 各間隔のトランザクションコストの統計情報。 | - -各**手数料サマリーオブジェクト**のフィールドを次に示します。 - -| フィールド | 値 | 説明 | -|:-----------------------|:-----------------------|:---------------------------| -| `date` | 文字列 - [タイムスタンプ][] | スナップショットの取得日時。 | -| `current_ledger_size` | 数値 | 指定時刻での現行レジャーのトランザクション数。 | -| `expected_ledger_size` | 数値 | 指定時刻に次のレジャーで予想されるトランザクションの数。 | -| `current_queue_size` | 数値 | 将来のレジャーに追加されるようキューに入れられているトランザクションの数。 | -| `pct_max_queue_size` | 数値 | 現在のキューサイズ（最大キューサイズに対する割合で表されます）。 | -| `median_fee` | 数値 | 現行レジャーのトランザクションの手数料の中央値。 | -| `minimum_fee` | 数値 | 任意のレジャーに追加する際の最小手数料。 | -| `open_ledger_fee` | 数値 | スナップショットの取得時点でオープンしていたレジャーに追加するコストのしきい値。 | - -#### 例 - -要求: - -``` -GET /v2/network/fee_stats -``` - -応答: - -``` -200 OK -{ - result: "success", - marker: "raw|20160701032100", - count: 200, - rows: [ - { - current_ledger_size: 39, - current_queue_size: 0, - date: "2016-07-01T00:00:00Z", - expected_ledger_size: 59, - median_fee: 0.005, - minimum_fee: 0.00001, - open_ledger_fee: 0.00001, - pct_max_queue_size: 0 - }, - { - current_ledger_size: 33, - current_queue_size: 0, - date: "2016-07-01T00:01:00Z", - expected_ledger_size: 59, - median_fee: 0.00543, - minimum_fee: 0.00001, - open_ledger_fee: 0.00001, - pct_max_queue_size: 0 - }, - ... - ] -} -``` - - - - -## Get Topology -[[ソース]](https://github.com/ripple/rippled-historical-database/blob/master/api/routes/network/getTopology.js "Source") - -既知の`rippled`サーバーと、これらのサーバー間のピアツーピア接続を取得します。_（新規: [v2.2.0][]）_ - - -#### 要求フォーマット - - - -*REST* - -``` -GET /v2/network/topology -``` - - - -[試してみる>](data-api-v2-tool.html#get-topology) - -オプションで、以下のクエリーパラメーターを指定できます。 - -| フィールド | 値 | 説明 | -|:----------|:-----------------------|:----------------------------------------| -| `date` | 文字列 - [タイムスタンプ][] | 過去のクエリーの日時。デフォルトでは、利用可能な最新のデータが使用されます。 | -| `verbose` | ブール値 | `true`の場合、各サーバーに関する追加の詳細情報が含まれます（使用可能な場合）。デフォルトは`false`です。 | - -#### 応答フォーマット - -成功した場合の応答では、HTTPコード**200 OK**と以下の内容のJSON本文が返されます。 - -| フィールド | 値 | 説明 | -|:-------------|:----------------------------|:--------------------------------| -| `result` | 文字列 | 値が`success`の場合、本文は成功した場合の応答を表しています。 | -| `date` | 文字列 - [タイムスタンプ][] | この測定の時刻。 | -| `node_count` | 整数 | トポロジー内の`rippled`サーバーの数。 | -| `link_count` | 整数 | トポロジー内のリンクの数。 | -| `nodes` | [サーバーオブジェクト][]の配列 | ピアツーピアネットワーク内の`rippled`サーバーの詳細。 | -| `links` | [リンクオブジェクト][]の配列 | ピアツーピアネットワーク内の`rippled`サーバー間のネットワーク接続。 | - -#### 例 - -要求: - -``` -GET /v2/network/topology -``` - -応答: - -``` -200 OK -{ - "result": "success", - "date": "2016-06-06T23:51:04Z", - "node_count": 115, - "link_count": 1913, - "nodes": [ - { - "node_public_key": "n94fDXS3ta92gRSi7DKngh47S7Rg4z1FuNsahvbiakFEg51dLeVa", - "version": "rippled-0.31.0-rc1", - "uptime": 266431, - "inbound_count": 24, - "last_updated": "2016-06-03T21:50:57Z" - }, - { - "node_public_key": "n94h5KNspwUGLaGcdHGxruYNmExWHjPkLcMvwsNrivR9czRp6Lor", - "ip": "104.247.221.178", - "port": 51235, - "version": "rippled-0.31.0", - "uptime": 608382, - "inbound_count": 10, - "outbound_count": 11, - "city": "Atlanta", - "country": "United States", - "country_code": "US", - "isp": "QuickPacket, LLC", - "last_updated": "2016-05-28T06:29:43Z", - "lat": "-84.3846", - "long": "33.8379", - "postal_code": "30305", - "region": "Georgia", - "region_code": "GA", - "timezone": "America/New_York" - }, - - ... - ], - "links": [ - { - "source": "n94Extku8HiQVY8fcgxeot4bY7JqK2pNYfmdnhgf6UbcmgucHFY8", - "target": "n9KcFAX2bCuwF4vGF8gZZcpQQ6nyqm44e5TUygb3zvdZEpiJE5As" - }, - { - "source": "n94Extku8HiQVY8fcgxeot4bY7JqK2pNYfmdnhgf6UbcmgucHFY8", - "target": "n9LGAj7PjvfTmEGQ75JaRKba6GQmVwFCnJTSHgX2HDXzxm6d2JpM" - }, - - ... - ] -} -``` - - - -## Get Topology Nodes -[[ソース]](https://github.com/ripple/rippled-historical-database/blob/master/api/routes/network/getNodes.js "Source") - -既知の`rippled`ノードを取得します。（これは[Get Topologyメソッド](#get-topology)で返されるデータのサブセットです。）_（新規: [v2.2.0][]）_ - -#### 要求フォーマット - - - -*REST* - -``` -GET /v2/network/topology/nodes -``` - - - -[試してみる>](data-api-v2-tool.html#get-topology-nodes) - -オプションで、以下のクエリーパラメーターを指定できます。 - -| フィールド | 値 | 説明 | -|:----------|:-----------------------|:----------------------------------------| -| `date` | 文字列 - [タイムスタンプ][] | 過去のクエリーの日時。デフォルトは最新データです。 | -| `verbose` | ブール値 | `true`の場合は、各サーバーのすべての詳細が返されます。デフォルトは`false`です。 | -| `format` | 文字列 | 返される結果のフォーマットは`csv`または`json`です。デフォルトは`json`です。 | - -#### 応答フォーマット - -成功した場合の応答では、HTTPコード**200 OK**と以下の内容のJSON本文が返されます。 - -| フィールド | 値 | 説明 | -|:---------|:----------------------------|:------------------------------------| -| `result` | 文字列 | 値が`success`の場合、本文は成功した場合の応答を表しています。 | -| `date` | 文字列 - [タイムスタンプ][] | このデータが測定された時点。 | -| `count` | 整数 | 記述される`rippled`サーバーの数。 | -| `nodes` | [サーバーオブジェクト][]の配列 | トポロジー内の`rippled`サーバーの詳細。 | - -#### 例 - -要求: - -``` -GET /v2/network/topology/nodes -``` - -応答: - -``` -200 OK -{ - "result": "success", - "date": "2016-06-08T00:36:53Z", - "count": 116, - "nodes": [ - { - "node_public_key": "n94BuARkPiYLrMuAVZqMQFhTAGpo12dqUPiH3yrzEnhaEcXfLAnV", - "version": "rippled-0.30.1", - "uptime": 122424, - "inbound_count": 10, - "last_updated": "2016-06-06T14:36:52Z" - }, - { - "node_public_key": "n94h5KNspwUGLaGcdHGxruYNmExWHjPkLcMvwsNrivR9czRp6Lor", - "ip": "104.247.221.178", - "port": 51235, - "version": "rippled-0.31.2", - "uptime": 38649, - "inbound_count": 10, - "outbound_count": 11, - "city": "Atlanta", - "country": "United States", - "country_code": "US", - "isp": "QuickPacket, LLC", - "last_updated": "2016-06-07T13:53:12Z", - "lat": "-84.3846", - "long": "33.8379", - "postal_code": "30305", - "region": "Georgia", - "region_code": "GA", - "timezone": "America/New_York" - }, - - ... - - ] -} -``` - - - -## Get Topology Node -[[ソース]](https://github.com/ripple/rippled-historical-database/blob/master/api/routes/network/getNodes.js "Source") - -1つの`rippled`サーバーに関する情報を、そのバリデータの公開鍵ではなく[ノードの公開鍵](#公開鍵)に基づいて取得します。_（新規: [v2.2.0][]）_ - -#### 要求フォーマット - - - -*REST* - -``` -GET /v2/network/topology/nodes/{pubkey} -``` - - - -[試してみる>](data-api-v2-tool.html#get-topology-node) - -このメソッドには以下のURLパラメーターを指定する必要があります。 - -| フィールド | 値 | 説明 | -|:---------|:--------------------------------|:--------------------------------| -| `pubkey` | 文字列 - Base-58 [公開鍵][] | 検索するサーバーのノードの公開鍵。 | - -このメソッドはクエリーパラメーターをとりません。 - -#### 応答フォーマット - -成功した場合の応答では、HTTPコード**200 OK**と、以下の追加フィールドが含まれる **[サーバーオブジェクト][]** を含むJSON本文が返されます。 - -| フィールド | 値 | 説明 | -|:---------|:-------|:---------------------------------------------------------| -| `result` | 文字列 | 値が`success`の場合は、成功した場合の応答であることを示します。 | - -#### 例 - -要求: - -``` -GET /v2/network/topology/nodes/n94h5KNspwUGLaGcdHGxruYNmExWHjPkLcMvwsNrivR9czRp6Lor -``` - -応答: - -``` -200 OK -{ - "node_public_key": "n94h5KNspwUGLaGcdHGxruYNmExWHjPkLcMvwsNrivR9czRp6Lor", - "ip": "104.247.221.178", - "port": 51235, - "version": "rippled-0.31.2", - "uptime": 43342, - "inbound_count": 10, - "outbound_count": 11, - "city": "Atlanta", - "country": "United States", - "country_code": "US", - "isp": "QuickPacket, LLC", - "last_updated": "2016-06-07T13:53:12Z", - "lat": "-84.3846", - "long": "33.8379", - "postal_code": "30305", - "region": "Georgia", - "region_code": "GA", - "timezone": "America/New_York", - "result": "success" -} -``` - - - -## Get Topology Links -[[ソース]](https://github.com/ripple/rippled-historical-database/blob/master/api/routes/network/getLinks.js "Source") - -`rippled`サーバー間のピアツーピア接続に関する情報を取得します。（これは[Get Topologyメソッド](#get-topology)で返されるデータのサブセットです。）_（新規: [v2.2.0][]）_ - -#### 要求フォーマット - - - -*REST* - -``` -GET /v2/network/topology/links -``` - - - -[試してみる>](data-api-v2-tool.html#get-topology-links) - -オプションで、以下のクエリーパラメーターを指定できます。 - -| フィールド | 値 | 説明 | -|:---------|:-----------------------|:-----------------------------------------| -| `date` | 文字列 - [タイムスタンプ][] | 過去のクエリーの日時。デフォルトは、使用可能な最新データです。 | -| `format` | 文字列 | 返される結果のフォーマットは`csv`または`json`です。デフォルトは`json`です。 | - -#### 応答フォーマット - -成功した場合の応答では、HTTPコード**200 OK**と以下の内容のJSON本文が返されます。 - -| フィールド | 値 | 説明 | -|:---------|:--------------------------|:--------------------------------------| -| `result` | 文字列 | 値が`success`の場合、本文は成功した場合の応答を表しています。 | -| `date` | 文字列 - [タイムスタンプ][] | このデータが測定された時点。 | -| `count` | 整数 | 返されたリンクの数。 | -| `links` | [リンクオブジェクト][]の配列 | `rippled`サーバー間のリンク。 | - -#### 例 - -要求: - -``` -GET /v2/network/topology/links -``` - -応答: - -``` -200 OK -{ - result: "success", - date: "2016-03-21T16:38:52Z", - count: 1632, - links: [ - { - source: "n94Extku8HiQVY8fcgxeot4bY7JqK2pNYfmdnhgf6UbcmgucHFY8", - target: "n9JccBLfrDJBLBF2X5N7bUW8251riCwSf9e3VQ3P5fK4gYr5LBu4" - }, - ... - ] -} -``` - - - -## Get Validator -[[ソース]](https://github.com/ripple/rippled-historical-database/blob/master/api/routes/network/getValidators.js "Source") - -[コンセンサスネットワーク](consensus.html)内の1つのバリデータに関する詳細を取得します。_（更新: [v2.4.0][]）_ - - -#### 要求フォーマット - - - -*REST* - -``` -GET /v2/network/validators/{pubkey} -``` - - - -[試してみる>](data-api-v2-tool.html#get-validator) - -このメソッドには以下のURLパラメーターを指定する必要があります。 - -| フィールド | 値 | 説明 | -|:---------|:--------------------------------|:----------------------| -| `pubkey` | 文字列 - Base-58 [公開鍵][] | バリデータの公開鍵。 | - -オプションで、以下のクエリーパラメーターを指定できます。 - -| フィールド | 値 | 説明 | -|:---------|:-------|:---------------------------------------------------------| -| `format` | 文字列 | 返される結果のフォーマットは`csv`または`json`です。デフォルトは`json`です。 | - -#### 応答フォーマット - -成功した場合の応答では、HTTPコード**200 OK**と以下の内容のJSON本文が返されます。 - -| フィールド | 値 | 説明 | -|:------------------------|:--------------------------------|:-----------------| -| `result` | 文字列 | 値が`success`の場合、本文は成功した場合の応答を表しています。 | -| `validation_public_key` | 文字列 - Base-58 [公開鍵][] | このバリデータのバリデータ公開鍵。 | -| `domain` | 文字列 | （省略される場合があります）このバリデータに関連付けられているDNSドメイン。 | -| `chain` | 文字列 | このバリデータが現在フォローしているレジャーハッシュチェーン。値が`main`の場合はメインネットワークを示し、`altnet`の場合はXRP Test Networkを示します。その他のフォークの名前は`chain.{NUMBER}`で、`{NUMBER}`は各フォークの一意の番号です。 | -| `unl` | ブール値 | Trueの場合、バリデータはレジャーチェーンの推奨UNLの一部です。 | -| `current_index` | 数値 | 最新の検証済みレジャーのレジャーインデックス。 | -| `partial` | ブール値 | Trueの場合、最新の検証は部分的な検証です。 | -| `agreement_1h` | 合意オブジェクト | 直近1時間の合意の状況を含むオブジェクト。 | -| `agreement_24h` | 合意オブジェクト | 直近24時間の合意の状況を含むオブジェクト。 | - -#### 合意オブジェクト - -| フィールド | 値 | 説明 | -|:------------------------|:--------------------------------|:-----------------| -| `score` | 文字列 | フォロー対象のレジャーチェーンとの合意のスコア。 | -| `missed` | 整数 | 当該期間内に検証されなかったレジャーの数。 | -| `total` | 整数 | 当該期間内に検証されたレジャーの数。 | -| `incomplete` | ブール値 | Trueの場合は、当該期間全体のデータはカバーされていません。 | - -#### 例 - -要求: - -``` -GET /v2/network/validators/nHBidG3pZK11zQD6kpNDoAhDxH6WLGui6ZxSbUx7LSqLHsgzMPec -``` - -応答: - -``` -200 OK -{ - "validation_public_key": "nHBidG3pZK11zQD6kpNDoAhDxH6WLGui6ZxSbUx7LSqLHsgzMPec", - "domain": "bitso.com", - "chain": "main", - "current_index": 42279525, - "agreement_1h": { - "missed": 0, - "total": 981, - "score": "1.0000", - "incomplete": false - }, - "agreement_24h": { - "missed": 0, - "total": 23519, - "score": "1.0000", - "incomplete": false - }, - "partial": false, - "unl": true, - "result": "success" -} -``` - - - -## Get Validators -[[ソース]](https://github.com/ripple/rippled-historical-database/blob/master/api/routes/network/getValidators.js "Source") - -直近24時間にアクティブであった既知のバリデータのリストを取得します。_（更新: [v2.4.0][]）_ - - -#### 要求フォーマット - - - -*REST* - -``` -GET /v2/network/validators -``` - - - -[試してみる>](data-api-v2-tool.html#get-validators) - -オプションで、以下のクエリーパラメーターを指定できます。 - -| フィールド | 値 | 説明 | -|:---------|:-------|:---------------------------------------------------------| -| `format` | 文字列 | 返される結果のフォーマットは`csv`または`json`です。デフォルトは`json`です。 | - -#### 応答フォーマット - -成功した場合の応答では、HTTPコード**200 OK**と以下の内容のJSON本文が返されます。 - -| フィールド | 値 | 説明 | -|:------------------------|:--------------------------------|:-----------------| -| `result` | 文字列 | 値が`success`の場合、本文は成功した場合の応答を表しています。 | -| `count` | 整数 | 返されたバリデータの数。 | -| `validators` | [バリデータオブジェクト][]の配列 | 直近24時間にアクティブであったバリデータのリスト。 | - -#### バリデータオブジェクト -[バリデータオブジェクト]: #バリデータオブジェクト - -| フィールド | 値 | 説明 | -|:------------------------|:--------------------------------|:-----------------| -| `validation_public_key` | 文字列 - Base-58 [公開鍵][] | このバリデータのバリデータ公開鍵。 | -| `domain` | 文字列 | （省略される場合があります）このバリデータに関連付けられているDNSドメイン。 | -| `chain` | 文字列 | このバリデータが現在フォローしているレジャーハッシュチェーン。値が`main`の場合はメインネットワークを示し、`altnet`の場合はXRP Test Networkを示します。その他のフォークの名前は`chain.{NUMBER}`で、`{NUMBER}`は各フォークの一意の番号です。 | -| `unl` | ブール値 | Trueの場合、バリデータはレジャーチェーンの推奨UNLの一部です。 | -| `current_index` | 数値 | 最新の検証済みレジャーのレジャーインデックス。 | -| `partial` | ブール値 | Trueの場合、最新の検証は部分的な検証です。 | -| `agreement_1h` | 合意オブジェクト | 直近1時間の合意の状況を含むオブジェクト。 | -| `agreement_24h` | 合意オブジェクト | 直近24時間の合意の状況を含むオブジェクト。 | - -#### 合意オブジェクト - -| フィールド | 値 | 説明 | -|:------------------------|:--------------------------------|:-----------------| -| `score` | 文字列 | フォロー対象のレジャーチェーンとの合意のスコア。 | -| `missed` | 整数 | 当該期間内に検証されなかったレジャーの数。 | -| `total` | 整数 | 当該期間内に検証されたレジャーの数。 | -| `incomplete` | ブール値 | Trueの場合は、当該期間全体のデータはカバーされていません。 | - -#### 例 - -要求: - -``` -GET /v2/network/validators/ -``` - -応答: - -``` -200 OK -{ - "result": "success", - "count": 141, - "validators": [ - { - "validation_public_key": "nHBidG3pZK11zQD6kpNDoAhDxH6WLGui6ZxSbUx7LSqLHsgzMPec", - "domain: "bitso.com", - "chain": "main", - "current_index": 42281151, - "agreement_1h": { - "missed": 0, - "total": 1029, - "score": "1.0000", - "incomplete": false - }, - "agreement_24h": { - "missed": 0, - "total": 23585, - "score": "1.0000", - "incomplete": false - }, - "partial": false, - "unl": true - }, - { - "validation_public_key": "nHUStq4qu3NXaL6T42wbtpR8mare8gWMVYrUzek227c6QeUn6QGN", - "domain": "blockchain.korea.ac.kr", - "chain": "main", - "current_index": 42860792, - "agreement_1h": { - "missed": 0, - "total": 995, - "score": "1.0000", - "incomplete": false - }, - "agreement_24h": { - "missed": 0, - "total": 23478, - "score": "1.0000", - "incomplete": false - }, - "partial": false, - "unl": true - }, - - ... - ] -} -``` - - - -## Get Validator Manifests -[[ソース]](https://github.com/ripple/rippled-historical-database/blob/master/api/routes/network/getManifests.js "Source") - -指定されたバリデータにより署名されたマニフェストを取得します。（マニフェストは _サブキー認証_ とも呼ばれ、バリデータが提案と検証の署名に使用する一時的なキーを指します。）_（新規: [v2.3.7][]）_ - -**注記:** Data APIは、すべてのマニフェストを網羅する包括的な記録を持っていません。応答には、Data APIに記録されているデータのみが含まれています。 - -#### 要求フォーマット - - - -*REST* - -``` -GET /v2/network/validators/{pubkey}/manifests -``` - - - -[試してみる>](data-api-v2-tool.html#get-validator-manifests) - -このメソッドには以下のURLパラメーターを指定する必要があります。 - -| フィールド | 値 | 説明 | -|:----------|:--------------------------------|:----------------------| -| `pubkey` | 文字列 - Base-58 [公開鍵][] | バリデータの公開鍵。 | - -オプションで、以下のクエリーパラメーターを指定できます。 - -| フィールド | 値 | 説明 | -|:---------|:--------|:--------------------------------------------------------| -| `limit` | 整数 | ページあたりの最大結果件数。デフォルトは200です。1000を超える値は指定できません。 | -| `marker` | 文字列 | 前に返された応答の[ページネーション](#ページネーション)キー。 | -| `format` | 文字列 | 返される結果のフォーマットは`csv`または`json`です。デフォルトは`json`です。 | - -#### 応答フォーマット - -成功した場合の応答では、HTTPコード**200 OK**と以下の内容のJSON本文が返されます。 - -| フィールド | 値 | 説明 | -|:------------|:------------------------------|:-------------------------------| -| `result` | 文字列 | 値が`success`の場合、本文は成功した場合の応答を表しています。 | -| `count` | 整数 | 返されたマニフェストの数。 | -| `marker` | 文字列 | （省略される場合があります）[ページネーション](#ページネーション)マーカー。 | -| `manifests` | [マニフェストオブジェクト][]の配列 | 要求されたマニフェスト。 | - -#### マニフェストオブジェクト -[マニフェストオブジェクト]: #マニフェストオブジェクト - -各マニフェストオブジェクトのフィールドを次に示します。 - -| フィールド | 値 | 説明 | -|:-----------------------|:--------------------------------|:------------------| -| `count` | 数値 | Data APIがこのマニフェストを参照した回数。この数値が小さいほど、マニフェストが新しいものであることを意味します。 | -| `ephemeral_public_key` | 文字列 - Base-58 [公開鍵][] | このマニフェストでエンコードされているこのバリデータの一時公開鍵。 | -| `first_datetime` | 文字列 - [タイムスタンプ][] | Data APIがこのマニフェストを最初に参照した時刻。 | -| `last_datetime` | 文字列 - [タイムスタンプ][] | Data APIがこのマニフェストを最後に参照した時刻。 | -| `master_public_key` | 文字列 - Base-58 [公開鍵][] | このバリデータを識別するマスター公開鍵。 | -| `master_signature` | 文字列 - 16進数 | このマニフェストを承認するバリデータのマスターキーの署名。 | -| `sequence` | 数値 | このマニフェストのシーケンス番号。大きなシーケンス番号のマニフェストは古いマニフェストを置き換え、一時キーをローテーションします。 | -| `signature` | 文字列 - 16進数 | このマニフェストにより承認された一時キーによる署名。 | - -#### 例 - -要求: - -``` -GET /v2/network/validator/nHDEmQKb2nbcewdQ1fqCTGcPTcePhJ2Rh6MRftsCaf6UNRQLv7pB/manifests -``` - -応答: - -``` -200 OK -{ - "result": "success", - "count": 2, - "manifests": [ - { - "count": 1, - "ephemeral_public_key": "nHUvPMeNsrwdJd7d65eaYGkKx6bPEcxJGudjVDqwCybtEfrSUE8w", - "first_datetime": "2018-09-06T20:20:08.353Z", - "last_datetime": "2018-09-06T20:20:08.353Z", - "master_public_key": "nHDEmQKb2nbcewdQ1fqCTGcPTcePhJ2Rh6MRftsCaf6UNRQLv7pB", - "master_signature": - "D8E78AD2C10ADA5A91D673C2EA66045926D3ED3D4C77DE4350AAA076379F69B8D0EC492A626EA9228964F694EED9EC63394D051001BA432EC57F2B6031204806", - "sequence": "1", - "signature": - "C794C3D1159932FF8EE7360074E7D17CB59F6646B227EF35D439892C00832648C46FD1958714E153AF4BD0540A7B27011B7F58D357B68B87DCBF5CA81874480C" - }, - { - "count": 1, - "ephemeral_public_key": "n9M7mktkbZCnKWa41LFkZsfXemBGdYsFT6fqJBXa4xupV8X8px7W", - "first_datetime": "2018-09-06T20:20:08.357Z", - "last_datetime": "2018-09-06T20:20:08.357Z", - "master_public_key": "nHDEmQKb2nbcewdQ1fqCTGcPTcePhJ2Rh6MRftsCaf6UNRQLv7pB", - "master_signature": - "F7ECCB90F84ED3FC5E0DE1A6B0B7E835A8D2A94C8E985A74932DE30CD2EDCB46936FD14C39A5AA1BB3583CF888C869167979FEE068C6C34B9B63AB922850090E", - "sequence": "2", - "signature": - "3044022055ED7EFF1245DE21D3C28C57D19301291F0D617CA3A6D3D4CFDF8692D9E0E68502200276215BA986BA61834E0AC71E8590706C851B8F55F0B80A44EECE868F71415F" - } - ] -} -``` - - -## Get Single Validator Reports -[[ソース]](https://github.com/ripple/rippled-historical-database/blob/master/api/routes/network/getValidatorReports.js "Source") - -24時間間隔で1つのバリデータの検証投票の状況を取得します。_（更新: [v2.4.0][]）_ - -#### 要求フォーマット - - - -*REST* - -``` -GET /v2/network/validators/{pubkey}/reports -``` - - - -[試してみる>](data-api-v2-tool.html#get-single-validator-reports) - -このメソッドには以下のURLパラメーターを指定する必要があります。 - -| フィールド | 値 | 説明 | -|:---------|:-------|:----------------------| -| `pubkey` | 文字列 | バリデータの公開鍵。 | - -オプションで、以下のクエリーパラメーターを指定できます。 - -| フィールド | 値 | 説明 | -|:---------|:-----------------------|:-----------------------------------------| -| `start` | 文字列 - [タイムスタンプ][] | 過去のクエリーの開始日時。デフォルトでは、開始日は現在の日付の200日前です。 | -| `end` | 文字列 - [タイムスタンプ][] | 過去のクエリーの終了日時。デフォルトでは、使用可能な最新データで終了します。 | -| `descending` | ブール値 | 結果を逆の順序で返します。 | -| `format` | 文字列 | 返される結果のフォーマットは`csv`または`json`です。デフォルトは`json`です。 | - -#### 応答フォーマット - -成功した場合の応答では、HTTPコード**200 OK**と以下の内容のJSON本文が返されます。 - -| フィールド | 値 | 説明 | -|:-------------|:-----------------------------------------|:-------------------| -| `result` | 文字列 | 値が`success`の場合、本文は成功した場合の応答を表しています。 | -| `count` | 整数 | 返されたバリデータの日次レポートの数。 | -| `reports` | [シングルバリデータレポートオブジェクト][]の配列。 | 当該日の各バリデータのパフォーマンスに関する日次レポート。 | - -##### シングルバリデータレポートオブジェクト -[シングルバリデータレポートオブジェクト]: #シングルバリデータレポートオブジェクト - -各シングルバリデータレポートオブジェクトは、特定日のバリデータのパフォーマンスを表し、以下のフィールドが含まれています。 - -| フィールド | 値 | 説明 | -|:---------------------|:--------------------------------|:-----------------------------| -| `validation_public_key` | 文字列 - Base-58 [公開鍵][] | バリデータの公開鍵。 | -| `date` | 文字列 - [タイムスタンプ][] | このオブジェクトが表す日付の開始時刻。 | -| `chain` | 文字列 | このバリデータが現在フォローしているレジャーハッシュチェーン。値が`main`の場合はメインネットワークを示し、`altnet`の場合はXRP Test Networkを示します。その他のフォークの名前は`chain.{NUMBER}`で、`{NUMBER}`は各フォークの一意の番号です。 | -| `score` | 文字列 | フォロー対象のレジャーチェーンとの合意のスコア。 | -| `missed` | 整数 | 当該期間内に検証されなかったレジャーの数。 | -| `total` | 整数 | 当該期間内に検証されたレジャーの数。 | -| `incomplete` | ブール値 | Trueの場合は、当該期間全体のデータはカバーされていません。 | - -#### 例 - -要求: - -``` -GET /v2/network/validators/n949f75evCHwgyP4fPVgaHqNHxUVN15PsJEZ3B3HnXPcPjcZAoy7/reports -``` - -応答: - -``` -200 OK -{ - "result": "success", - "count": 198, - "reports": [ - { - "date": "2015-11-20T00:00:00Z", - "total_ledgers": 19601, - "main_net_agreement": "1.0", - "main_net_ledgers": 19601, - "alt_net_agreement": "0.0", - "alt_net_ledgers": 0, - "other_ledgers": 0 - }, - { - "date": "2015-11-21T00:00:00Z", - "total_ledgers": 19876, - "main_net_agreement": "1.0", - "main_net_ledgers": 19876, - "alt_net_agreement": "0.0", - "alt_net_ledgers": 0, - "other_ledgers": 0 - }, - - ... - ] -} -``` - - -## Get Daily Validator Reports -[[ソース]](https://github.com/ripple/rippled-historical-database/blob/master/api/routes/network/getValidatorReports.js "Source") - -24時間ですべての既知のバリデータの検証投票の状況とバリデータ情報を取得します。 - -#### 要求フォーマット - - - -*REST* - -``` -GET /v2/network/validator_reports -``` - - - -[試してみる>](data-api-v2-tool.html#get-daily-validator-reports) - -オプションで、以下のクエリーパラメーターを指定できます。 - -| フィールド | 値 | 説明 | -|:---------|:-----------------------|:-----------------------------------------| -| `date` | 文字列 - [タイムスタンプ][] | 照会する日時。デフォルトでは、利用可能な最新のデータが使用されます。 | -| `format` | 文字列 | 返される結果のフォーマットは`csv`または`json`です。デフォルトは`json`です。 | - -#### 応答フォーマット - -成功した場合の応答では、HTTPコード**200 OK**と以下の内容のJSON本文が返されます。 - -| フィールド | 値 | 説明 | -|:----------|:----------------------------------------|:-----------------------| -| `result` | 文字列 | 値が`success`の場合、本文は成功した場合の応答を表しています。 | -| `count` | 整数 | 返されたレポートの数。 | -| `reports` | [日次バリデータレポートオブジェクト][]の配列。 | この期間中にアクティブであった各バリデータのバリデータパフォーマンスの日次サマリー。 | - -#### 日次バリデータレポートオブジェクト -[日次バリデータレポートオブジェクト]: #日次バリデータレポートオブジェクト - -`reports`配列の各メンバーは、当該日のバリデータのパフォーマンスを表し、以下のフィールドが含まれています。 - -| フィールド | 値 | 説明 | -|:---------------------|:--------------------------------|:-----------------------------| -| `validation_public_key` | 文字列 - Base-58 [公開鍵][] | バリデータの公開鍵。 | -| `date` | 文字列 - [タイムスタンプ][] | このオブジェクトが表す日付の開始時刻。 | -| `chain` | 文字列 | このバリデータが現在フォローしているレジャーハッシュチェーン。値が`main`の場合はメインネットワークを示し、`altnet`の場合はXRP Test Networkを示します。その他のフォークの名前は`chain.{NUMBER}`で、`{NUMBER}`は各フォークの一意の番号です。 | -| `score` | 文字列 | フォロー対象のレジャーチェーンとの合意のスコア。 | -| `missed` | 整数 | 当該期間内に検証されなかったレジャーの数。 | -| `total` | 整数 | 当該期間内に検証されたレジャーの数。 | -| `incomplete` | ブール値 - 省略可 | Trueの場合は、当該期間全体のデータはカバーされていません。 | - -#### 例 - -要求: - -``` -GET /v2/network/validator_reports -``` - -応答: - -``` -200 OK -{ - "result": "success", - "count": 27, - "reports": [ - { - "validation_public_key": "n9J2N3FfiUFC4rBX5UBob8JzgDGsYqUou1cwKdsaymS44mZDfnYe", - "date": "2018-10-15T00:00:00Z", - "chain": "main", - "score": "0.6909", - "total": "16127", - "missed": "7216" - } - ] -} -``` - - -## Get rippled Versions -[[ソース]](https://github.com/ripple/rippled-historical-database/blob/master/api/routes/network/getVersions.js "Source") - -公式Ripple Yumリポジトリから入手可能な`rippled`の最新バージョンを報告します。_（新規: [v2.3.0][]）_ - -#### 要求フォーマット - - - -*REST* - -``` -GET /v2/network/rippled_versions -``` - - - -[試してみる>](data-api-v2-tool.html#get-rippled-versions) - - -#### 応答フォーマット - -成功した場合の応答では、HTTPコード**200 OK**と以下の内容のJSON本文が返されます。 - -| フィールド | 値 | 説明 | -|:---------|:-------------------------|:---------------------------------------| -| `result` | 文字列 | 値が`success`の場合、本文は成功した場合の応答を表しています。 | -| `count` | 整数 | 返された行の数。 | -| `rows` | バージョンオブジェクトの配列 | 各リポジトリの最新`rippled`バージョンの説明。 | - -各バージョンオブジェクトのフィールドを次に示します。 - -| フィールド | 値 | 説明 | -|:----------|:-----------------------|:----------------------------------------| -| `date` | 文字列 - [タイムスタンプ][] | この`rippled`バージョンのリリース日。 | -| `repo` | 文字列 | この`rippled`が入手可能なYumリポジトリ。`stable`リポジトリに最新の本番環境バージョンがあります。その他のバージョンは開発テスト用です。 | -| `version` | 文字列 | この`rippled`バージョンを示すバージョン文字列。 | - -#### 例 - -要求: - -``` -GET /v2/network/rippled_versions -``` - -応答: - -``` -200 OK -{ - "result": "success", - "count": 3, - "rows": [ - { - "date": "2016-06-24T00:00:00Z", - "repo": "nightly", - "version": "0.32.0-rc2" - }, - { - "date": "2016-06-24T00:00:00Z", - "repo": "stable", - "version": "0.32.0" - }, - { - "date": "2016-06-24T00:00:00Z", - "repo": "unstable", - "version": "0.32.0-rc1" - } - ] -} -``` - - - -## Get All Gateways -[[ソース]](https://github.com/ripple/rippled-historical-database/blob/master/api/routes/gateways.js "Source") - -[既知のゲートウェイ](https://github.com/ripple/rippled-historical-database/blob/v2.0.4/api/gateways/gateways.json)に関する情報を取得します。_（新規: [v2.0.4][]）_ - -#### 要求フォーマット - - - -*REST* - -``` -GET /v2/gateways/ -``` - - - -[試してみる>](data-api-v2-tool.html#get-all-gateways) - -このメソッドはクエリーパラメーターをとりません。 - -#### 応答フォーマット - -成功した場合の応答では、HTTPコード**200 OK**とJSON本文が返されます。 - -上位JSONオブジェクトの各フィールドは[通貨コード][]です。各フィールドの内容は、当該通貨を発行するゲートウェイを表すオブジェクトの配列です。各オブジェクトのフィールドを次に示します。 - -| フィールド | 値 | 説明 | -|:-----------|:---------------------|:-----------------------------------------| -| `name` | 文字列 | 人間が読み取れる形式のゲートウェイの名前。 | -| `account` | 文字列 - [アドレス][] | この通貨の[発行アドレス](issuing-and-operational-addresses.html)。 | -| `featured` | ブール値 | このゲートウェイが通貨の「主要」イシュアーとして見なされるかどうか。Rippleは、責任あるビジネスプラクティスや取引量などの評価基準に基づいて主要とするゲートウェイを決定します。 | -| `label` | 文字列 | （省略される場合があります）[通貨コード][]が40文字の16進値である場合にのみ出力されます。これは、このゲートウェイが発行した通貨の人間が読める形式の別名です。 | -| `assets` | 文字列の配列 | このゲートウェイに対して利用可能なグラフィックスファイル名（存在する場合）。（ほとんどの場合、XRP Chartsで使用されるロゴのグラフィックスファイル名となります。） | - -#### 例 - -要求: - -``` -GET /v2/gateways/ -``` - -応答: - -``` -200 OK -{ - "AUD": [ - { - "name": "Bitstamp", - "account": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B", - "featured": false, - "assets": [ - "logo.grayscale.svg", - "logo.svg" - ] - }, - { - "name": "Coinex", - "account": "rsP3mgGb2tcYUrxiLFiHJiQXhsziegtwBc", - "featured": false, - "assets": [] - } - ], - -...(additional results trimmed) ... - - "0158415500000000C1F76FF6ECB0BAC600000000": [ - { - "name": "GBI", - "account": "rrh7rf1gV2pXAoqA8oYbpHd8TKv5ZQeo67", - "featured": false, - "label": "XAU (-0.5pa)", - "assets": [] - } - ], - "KRW": [ - { - "name": "EXRP", - "account": "rPxU6acYni7FcXzPCMeaPSwKcuS2GTtNVN", - "featured": true, - "assets": [] - }, - { - "name": "Pax Moneta", - "account": "rUkMKjQitpgAM5WTGk79xpjT38DEJY283d", - "featured": false, - "assets": [] - } - ] -} -``` - - - -## Get Gateway -[[ソース]](https://github.com/ripple/rippled-historical-database/blob/master/api/routes/gateways.js "Source") - - -[Data APIの既知のゲートウェイのリスト](https://github.com/ripple/rippled-historical-database/blob/v2.0.4/api/gateways/gateways.json)から、特定のゲートウェイに関する情報を取得します。_（新規: [v2.0.4][]）_ - -#### 要求フォーマット - - - -*REST* - -``` -GET /v2/gateways/{gateway} -``` - - - -[試してみる>](data-api-v2-tool.html#get-gateway) - -このメソッドには以下のURLパラメーターを指定する必要があります。 - -| フィールド | 値 | 説明 | -|:----------|:-------|:--------------------------------------------------------| -| `gateway` | 文字列 | ゲートウェイの発行[アドレス][]、[URLエンコード名](https://en.wikipedia.org/wiki/Percent-encoding)、または正規化された名前です。 | - -このメソッドはクエリーパラメーターをとりません。 - -#### 応答フォーマット - -成功した場合の応答では、HTTPコード**200 OK**と以下の内容のJSON本文が返されます。 - -| フィールド | 値 | 説明 | -|:-------------|:-----------------------|:-------------------------------------| -| `name` | 文字列 | 人間が読み取れる形式のゲートウェイの名前。 | -| `start_date` | 文字列 - [タイムスタンプ][] | レジャーに記録されているこのゲートウェイの通貨の初回取引のおおよその日付。 | -| `accounts` | 配列 | このゲートウェイが使用する[発行アドレス](issuing-and-operational-addresses.html)のリスト。（ゲートウェイは、異なる通貨に異なる発行アカウントを使用することがあります。） | -| `hotwallets` | [アドレス][]の配列 | このゲートウェイの[運用アドレス](issuing-and-operational-addresses.html)。 | -| `domain` | 文字列 | このゲートウェイのビジネス用ドメイン名。 | -| `normalized` | 文字列 | URLに組み込むことができる`name`フィールドの正規化バージョン。 | -| `assets` | 文字列の配列 | このゲートウェイに対して利用可能なグラフィックスファイル名（存在する場合）。（ほとんどの場合、XRP Chartsで使用されるロゴのグラフィックスファイル名となります。） | - -`accounts`フィールド配列の各オブジェクトには以下のフィールドが含まれています。 - -| フィールド | 値 | 説明 | -|:-------------|:-------|:-----------------------------------------------------| -| `address` | 文字列 | このゲートウェイが使用する[発行アドレス](issuing-and-operational-addresses.html)。 | -| `currencies` | オブジェクト | このオブジェクトの各フィールドは、このアドレスが発行する通貨に対応した[通貨コード][]です。各値は、その通貨が主要通貨であるかどうかを示す`featured` ブール値を含むオブジェクトです。Rippleは、責任あるビジネスプラクティスや取引量などの評価基準に基づいて主要とする通貨とゲートウェイを決定します。 | - -#### 例 - -要求: - -``` -GET /v2/gateways/Gatehub -``` - -応答: - -``` -200 OK -{ - "name": "Gatehub", - "start_date": "2015-02-15T00:00:00Z", - "accounts": [ - { - "address": "rhub8VRN55s94qWKDv6jmDy1pUykJzF3wq", - "currencies": { - "EUR": { - "featured": true - }, - "USD": { - "featured": true - } - } - } - ], - "hotwallets": [ - "rhotcWYdfn6qxhVMbPKGDF3XCKqwXar5J4" - ], - "domain": "gatehub.net", - "normalized": "gatehub", - "assets": [ - "logo.grayscale.svg", - "logo.svg" - ] -} -``` - - - - -## Get Currency Image - -[[ソース]](https://github.com/ripple/rippled-historical-database/blob/master/api/routes/gateways.js#L199 "Source") - -各種通貨のベクターアイコンを取得します。_（新規: [v2.0.4][]）_ - -#### 要求フォーマット - - - -*REST* - -``` -GET /v2/currencies/{currencyimage} -``` - - - -このメソッドには以下のURLパラメーターを指定する必要があります。 - -| フィールド | 値 | 説明 | -|:----------------|:-------|:--------------------------------------------------| -| `currencyimage` | 文字列 | 通貨のイメージファイル（`xrp.svg`など）。利用可能なイメージのリストについては[ソースコード](https://github.com/ripple/rippled-historical-database/tree/develop/api/gateways/currencyAssets)を参照してください。 | - -#### 応答フォーマット -成功した場合の応答にはHTTPコード **200 OK**が含まれており、**Content-Type**ヘッダーは`image/svg+xml`です。これは、コンテンツが[SVGフォーマット](https://en.wikipedia.org/wiki/Scalable_Vector_Graphics)のファイルを表すXMLであることを示しています。 - -#### 例 - -要求: - -``` -GET /v2/currencies/mxn.svg -``` - -応答 - -``` -200 OK -Content-Type: image/svg+xml - - - - - - - - - -``` - - - -## Get Accounts -[[ソース]](https://github.com/ripple/rippled-historical-database/blob/master/api/routes/accounts.js "Source") - -XRP Ledgerでの新しいアカウントの作成に関する情報を取得します。 - -#### 要求フォーマット - - - -*REST* - -``` -GET /v2/accounts -``` - - - -[試してみる>](data-api-v2-tool.html#get-accounts) - -オプションで、以下のクエリーパラメーターを指定できます。 - -| フィールド | 値 | 説明 | -|:-------------|:-----------------------|:-------------------------------------| -| `start` | 文字列 - [タイムスタンプ][] | 照会範囲の開始時刻。 | -| `end` | 文字列 - [タイムスタンプ][] | 照会範囲の終了時刻。 | -| `limit` | 整数 | ページあたりの最大結果件数。デフォルトは200です。1,000を超える値は指定できません。 | -| `marker` | 文字列 | 前に返された応答の[ページネーション](#ページネーション)キー。 | -| `descending` | ブール値 | `true`の場合、結果が逆時系列で返されます。デフォルトは`false`です。 | -| `parent` | 文字列 | 指定された親アカウントの子に結果を絞り込みます。`interval`パラメーターとともに指定することはできません。 | -| `format` | 文字列 | 返される結果のフォーマットは`csv`または`json`です。デフォルトは`json`です。 | - -`interval`および`reduce`パラメーターは[v2.3.5][]で除去されました。 - -#### 応答フォーマット -成功した場合の応答では、HTTPコード**200 OK**と以下の内容のJSON本文が返されます。 - -| フィールド | 値 | 説明 | -|:-----------|:--------|:------------------------------------------------------| -| `result` | 文字列 | 値が`success`の場合は、成功した場合の応答であることを示します。 | -| `count` | 整数 | 返されたアカウントの数。 | -| `marker` | 文字列 | （省略される場合があります）[ページネーション](#ページネーション)マーカー。 | -| `accounts` | 配列 |[アカウント作成オブジェクト](#アカウント作成オブジェクト)の配列。 | - -#### 例 - -要求: - -``` -GET /v1/accounts?parent=rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn -``` - -応答: - -``` -200 OK -{ - "result": "success", - "count": 3, - "accounts": [ - { - "balance": "20.0", - "account": "raKEEVSGnKSD9Zyvxu4z6Pqpm4ABH8FS6n", - "executed_time": "2015-02-09T23:31:40+00:00", - "ledger_index": 11620700, - "parent": "rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn", - "tx_hash": "1D381C0FCA00E8C34A6D4D3A91DAC9F3697B4E66BC49ED3D9B2D6F57D7F15E2E" - }, - { - "balance": "30", - "account": "rUpy3eEg8rqjqfUoLeBnZkscbKbFsKXC3v", - "executed_time": "2015-06-16T21:15:40+00:00", - "ledger_index": 14090928, - "parent": "rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn", - "tx_hash": "60B614622FC67DFCA8D796D7F6AF0B7AEC5E59BB268EA032F810395407DDF8D5" - }, - { - "balance": "50", - "account": "rLFd1FzHMScFhLsXeaxStzv3UC97QHGAbM", - "executed_time": "2015-09-23T23:05:20+00:00", - "ledger_index": 16061430, - "parent": "rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn", - "tx_hash": "FAE331A6D5CB83BCE832E7EBEDBD807EDEFFAF39AB241683EE81A0326A1A6748" - } - ] -} -``` - - -## Get Account -[[ソース]](https://github.com/ripple/rippled-historical-database/blob/master/api/routes/getAccount.js "Source") - -特定のrippleアカウントの作成に関する情報を取得します。 - -#### 要求フォーマット - - - - -*REST* - -``` -GET /v2/accounts/{address} -``` - - - -[試してみる>](data-api-v2-tool.html#get-account) - -このメソッドには以下のURLパラメーターを指定する必要があります。 - -| フィールド | 値 | 説明 | -|:----------|:-------|:-----------------------------| -| `address` | 文字列 | 照会するXRP Ledgerアドレス。 | - -#### 応答フォーマット - -成功した場合の応答では、HTTPコード**200 OK**と以下の内容のJSON本文が返されます。 - -| フィールド | 値 | 説明 | -|:----------|:-------------------------------------------------------|:--------| -| `result` | 文字列 | 値が`success`の場合は、成功した場合の応答であることを示します。 | -| `account` | オブジェクト - [アカウント作成](#アカウント作成オブジェクト) | 要求されたアカウント。 | - -#### 例 - -要求: - -``` -GET /v2/accounts/rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn -``` - -応答: - -``` -200 OK -{ - "result": "success", - "account": { - "address": "rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn", - "parent": "ra5nK24KXen9AHvsdFTKHSANinZseWnPcX", - "initial_balance": "100.0", - "inception": "2014-05-29T17:05:20+00:00", - "ledger_index": 6902264, - "tx_hash": "074415C5DC6DB0029E815EA6FC2629FBC29A2C9D479F5D040AFF94ED58ECC820" - } -} -``` - - - -## Get Account Balances -[[ソース]](https://github.com/ripple/rippled-historical-database/blob/master/api/routes/accountBalances.js "Source") - -特定のXRP Ledgerアカウントが保有または支払い義務のあるすべての残高を取得します。 - - - -*REST* - -``` -GET /v2/accounts/{address}/balances -``` - - - -[試してみる>](data-api-v2-tool.html#get-account-balances) - -このメソッドには以下のURLパラメーターを指定する必要があります。 - -| フィールド | 値 | 説明 | -|:----------|:-------|:-----------------------------| -| `address` | 文字列 | 照会するXRP Ledgerアドレス。 | - -オプションで、以下のクエリーパラメーターを指定できます。 - -| フィールド | 値 | 説明 | -|:---------------|:--------|:--------------------------------------------------| -| `ledger_index` | 整数 | 過去の残高のレジャーのインデックス。 | -| `ledger_hash` | 文字列 | 過去の残高のレジャーハッシュ。 | -| `date` | 文字列 | 過去の残高の日付（UTC）。 | -| `currency` | 文字列 | 指定された通貨に結果を制限します。 | -| `counterparty` | 文字列 | 指定された取引相手/イシュアーに結果を制限します。 | -| `limit` | 整数 | ページあたりの最大結果件数。デフォルトは200です。400よりも大きい値は指定できませんが、値`all` を使用すればすべての結果を返せます。（注意: 非常に大量の結果を取得する際にlimit=allを指定すると、要求がタイムアウトになる可能性があります。大規模なイシュアーの場合は、結果が数万件にのぼることがあります。） | -| `format` | 文字列 | 返される結果のフォーマットは`csv`または`json`です。デフォルトは`json`です。 | - -#### 応答フォーマット -成功した場合の応答では、HTTPコード**200 OK**と以下の内容のJSON本文が返されます。 - -| フィールド | 値 | 説明 | -|:---------------|:-----------------------------|:-----------------------------| -| `result` | 文字列 | 値が`success`の場合は、成功した場合の応答であることを示します。 | -| `ledger_index` | 整数 | 残高クエリーのレジャーインデックス。 | -| `close_time` | 文字列 | レジャーの閉鎖時刻。 | -| `limit` | 文字列 | 制限を超えた場合に返された結果の数。 | -| `marker` | 文字列 | （省略される場合があります）[ページネーション](#ページネーション)マーカー。 | -| `balances` | [残高オブジェクト][]の配列。 | 要求された残高。 | - -#### 例 - -要求: - -``` -GET /v2/accounts/rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn/balances?currency=USD&date=2015-01-01T00:00:00Z&limit=3 -``` - -応答: - -``` -200 OK -{ - "result": "success", - "ledger_index": 10852618, - "close_time": "2015-01-01T00:00:00Z", - "limit": 3, - "balances": [ - { - "currency": "USD", - "counterparty": "ra5nK24KXen9AHvsdFTKHSANinZseWnPcX", - "value": "-11.0301" - }, - { - "currency": "USD", - "counterparty": "rMwjYedjc7qqtKYVLiAccJSmCwih4LnE2q", - "value": "0.0001" - }, - { - "currency": "USD", - "counterparty": "rweYz56rfmQ98cAdRaeTxQS9wVMGnrdsFp", - "value": "0" - } - ] -} -``` - - -## Get Account Orders -[[ソース]](https://github.com/ripple/rippled-historical-database/blob/master/api/routes/accountOrders.js "Source") - -オーダーブックで特定のアカウントが発注したオーダーを取得します。すでに処理されたオーダーは返されません。 - -#### 要求フォーマット - - - -*REST* - -``` -GET /v2/account/{address}/orders -``` - - - -[試してみる>](data-api-v2-tool.html#get-account-orders) - -このメソッドには以下のURLパラメーターを指定する必要があります。 - -| フィールド | 値 | 説明 | -|:----------|:---------------------|:-----------------------------| -| `address` | 文字列 - [アドレス][] | 照会するXRP Ledgerアドレス。 | - -オプションで、以下のクエリーパラメーターを指定できます。 - -| フィールド | 値 | 説明 | -|:---------------|:-----------------------|:-----------------------------------| -| `ledger_index` | 整数 | このレジャーの時点でのオーダーを取得します。`ledger_hash`または`date`と同時に指定することはできません。 | -| `ledger_hash` | 文字列 | このレジャーの時点でのオーダーを取得します。`ledger_index`または`date`と同時に指定することはできません。 | -| `date` | 文字列 - [タイムスタンプ][] | この時刻でのオーダーを取得します。`ledger_index`または`ledger_hash`と同時に指定することはできません。 | -| `limit` | 整数 | ページあたりの最大結果件数。デフォルトは200です。400を超える値は指定できません。 | -| `format` | 文字列 | 返される結果のフォーマットは`csv`または`json`です。デフォルトは`json`です。 | - -`ledger_index`、`ledger_hash`、`date`のいずれも指定されていない場合、APIは利用可能な最新データを使用します。 - -#### 応答フォーマット -成功した場合の応答では、HTTPコード**200 OK**と以下の内容のJSON本文が返されます。 - -| フィールド | 値 | 説明 | -|:---------------|:-----------------------|:-----------------------------------| -| `result` | 文字列 | 値が`success`の場合は、成功した場合の応答であることを示します。 | -| `ledger_index` | 整数 | 使用するレジャーバージョンの`ledger_index`。 | -| `close_time` | 文字列 | 使用するレジャーバージョンの閉鎖時刻。 | -| `limit` | 文字列 | 要求に指定されていた`limit`。 | -| `orders` | オーダーオブジェクトの配列 | 要求されたオーダー。 | - -各オーダーオブジェクトのフィールドを次に示します。 - -| フィールド | 値 | 説明 | -|:-------------------------------|:---------------------|:---------------------| -| `specification` | オブジェクト | このオーダーの現在の状態の詳細。 | -| `specification.direction` | 文字列 | `buy`または`sell`。 | -| `specification.quantity` | [残高オブジェクト][] | このオーダーで（方向に応じて）売却または購入するベース通貨の最大額。オーダーが部分的に約定するとこの値が減少します。 | -| `specification.totalPrice` | [残高オブジェクト][] | ベース通貨の購入または売却のためにオーダーで支出または獲得できるクオート通貨の最大額。オーダーが部分的に約定するとこの値が減少します。 | -| `properties` | オブジェクト | オーダーの発注方法の詳細。 | -| `properties.maker` | 文字列 - [アドレス][] | オーダーを発注したXRP Ledgerアカウント。 | -| `properties.sequence` | 数値 | このオーダーを発注したトランザクションのシーケンス番号。 | -| `properties.makerExchangeRate` | [文字列 - 数値][] | オーダーを送信したアカウントの側から見た為替レート。 | - -#### 例 - -要求: - -``` -GET /v2/accounts/rK5j9n8baXfL4gzUoZsfxBvvsv97P5swaV/orders?limit=2&date=2015-11-11T00:00:00Z -``` - -応答: - -``` -200 OK -{ - "result": "success", - "ledger_index": 17007855, - "close_time": "2015-11-11T00:00:00Z", - "limit": 2, - "orders": [ - { - "specification": { - "direction": "buy", - "quantity": { - "currency": "JPY", - "value": "56798.00687665813", - "counterparty": "r94s8px6kSw1uZ1MV98dhSRTvc6VMPoPcN" - }, - "totalPrice": { - "currency": "USD", - "value": "433.792841227449", - "counterparty": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B" - } - }, - "properties": { - "maker": "rK5j9n8baXfL4gzUoZsfxBvvsv97P5swaV", - "sequence": 7418286, - "makerExchangeRate": "130.9334813270407" - } - }, - { - "specification": { - "direction": "buy", - "quantity": { - "currency": "JPY", - "value": "11557.02705273459", - "counterparty": "r94s8px6kSw1uZ1MV98dhSRTvc6VMPoPcN" - }, - "totalPrice": { - "currency": "USD", - "value": "87.570156003591", - "counterparty": "rhub8VRN55s94qWKDv6jmDy1pUykJzF3wq" - } - }, - "properties": { - "maker": "rK5j9n8baXfL4gzUoZsfxBvvsv97P5swaV", - "sequence": 7418322, - "makerExchangeRate": "131.9744942815983" - } - } - ] -} -``` - - - - -## Get Account Transaction History -[[ソース]](https://github.com/ripple/rippled-historical-database/blob/master/api/routes/accountTransactions.js "Source") - -特定のアカウントに影響を及ぼしたトランザクションの履歴を取得します。これには、そのアカウントから送信されたすべてのトランザクション、アカウントが受領したペイメント、アカウントを通じてRipplingされたペイメントが含まれます。 - -#### 要求フォーマット - - - -*REST* - -``` -GET /v2/accounts/{address}/transactions -``` - - - -[試してみる>](data-api-v2-tool.html#get-account-transaction-history) - -このメソッドには以下のURLパラメーターを指定する必要があります。 - -| フィールド | 値 | 説明 | -|:----------|:---------------------|:-----------------------------| -| `address` | 文字列 - [アドレス][] | 照会するXRP Ledgerアドレス。 | - - -オプションで、以下のクエリーパラメーターを指定できます。 - -| フィールド | 値 | 説明 | -|:---------------|:-----------------------|:-----------------------------------| -| `start` | 文字列 - [タイムスタンプ][] | 照会範囲の開始時刻。デフォルトは、利用可能な最も古い日付です。 | -| `end` | 文字列 - [タイムスタンプ][] | 照会範囲の終了時刻。デフォルトは現在の日付です。 | -| `min_sequence` | 文字列 | 照会対象の最小シーケンス番号。 | -| `max_sequence` | 文字列 | 照会対象の最大シーケンス番号。 | -| `type` | 文字列 | 指定された[トランザクションタイプ](transaction-types.html)に結果を制限します。 | -| `result` | 文字列 | 指定された[トランザクションの結果](transaction-results.html)に結果を制限します。 | -| `binary` | ブール値 | 結果をバイナリフォーマットで返します。 | -| `descending` | ブール値 | `true`の場合、結果が逆時系列で返されます。デフォルトは`false`です。 | -| `limit` | 整数 | ページあたりの最大結果件数。デフォルトは20です。1,000を超える値は指定できません。 | -| `marker` | 文字列 | 前に返された応答の[ページネーション](#ページネーション)キー。 | - -**注記:** このメソッドはCSVフォーマットを返すことができません。生XRP LdgerトランザクションではJSONの結果だけがサポートされています。 - - -#### 応答フォーマット - -成功した場合の応答では、HTTPコード**200 OK**と以下の内容のJSON本文が返されます。 - -| フィールド | 値 | 説明 | -|:---------------|:-----------------------------------------------------|:-----| -| `result` | 文字列 | 値が`success`の場合は、成功した場合の応答であることを示します。 | -| `count` | 整数 | `transactions`フィールドに含まれているオブジェクトの数。 | -| `marker` | 文字列 | （省略される場合があります）[ページネーション](#ページネーション)マーカー。 | -| `transactions` | [トランザクションオブジェクト](#トランザクションオブジェクト)の配列。 | 要求に一致するすべてのトランザクション。 | - -#### 例 - -要求: - -``` -GET /v2/accounts/rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn/transactions?type=Payment&result=tesSUCCESS&limit=1 -``` - -応答: - -``` -200 OK -{ - "result": "success", - "count": 1, - "marker": "rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn|20140602224750|000006979192|00001", - "transactions": [ - { - "hash": "074415C5DC6DB0029E815EA6FC2629FBC29A2C9D479F5D040AFF94ED58ECC820", - "date": "2014-05-29T17:05:20+00:00", - "ledger_index": 6902264, - "tx": { - "TransactionType": "Payment", - "Flags": 0, - "Sequence": 1, - "LastLedgerSequence": 6902266, - "Amount": "100000000", - "Fee": "12", - "SigningPubKey": "032ECFCC409F02057D8556988B89E17D48ECFC8373965036C6BA294AA2B7972971", - "TxnSignature": "30450221008D8E251DA5EA17A29CC9192717860F3B4047E74DF005127A65D9140CAE870C0902201C8E4548D2D3BA11B3E13CE8A167EBC076920E2B1C38547275CAA75FEC436EB9", - "Account": "ra5nK24KXen9AHvsdFTKHSANinZseWnPcX", - "Destination": "rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn" - }, - "meta": { - "TransactionIndex": 1, - "AffectedNodes": [ - { - "CreatedNode": { - "LedgerEntryType": "AccountRoot", - "LedgerIndex": "13F1A95D7AAB7108D5CE7EEAF504B2894B8C674E6D68499076441C4837282BF8", - "NewFields": { - "Sequence": 1, - "Balance": "100000000", - "Account": "rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn" - } - } - }, - { - "ModifiedNode": { - "LedgerEntryType": "AccountRoot", - "PreviousTxnLgrSeq": 6486567, - "PreviousTxnID": "FF9BFF3C200B475CA7EE54F9A98EAB7E92BBDBD2DBE95AC854405D8A85C9D535", - "LedgerIndex": "43EA78783A089B137D5E87610DF3BD4129F989EDD02EFAF6C265924D3A0EF8CE", - "PreviousFields": { - "Sequence": 1, - "Balance": "1000000000" - }, - "FinalFields": { - "Flags": 0, - "Sequence": 2, - "OwnerCount": 0, - "Balance": "899999988", - "Account": "ra5nK24KXen9AHvsdFTKHSANinZseWnPcX" - } - } - } - ], - "TransactionResult": "tesSUCCESS" - } - } - ] -} -``` - - - - -## Get Transaction By Account And Sequence -[[ソース]](https://github.com/ripple/rippled-historical-database/blob/master/api/routes/accountTxSeq.js "Source") - -指定されたアカウントから送信された特定のトランザクションを取得します。 - -#### 要求フォーマット - - - -*REST* - -``` -GET /v2/accounts/{address}/transactions/{sequence} -``` - - - -[試してみる>](data-api-v2-tool.html#get-transaction-by-account-and-sequence) - -このメソッドには以下のURLパラメーターを指定する必要があります。 - -| フィールド | 値 | 説明 | -|:-----------|:--------|:-----------------------------| -| `address` | 文字列 | 照会するXRP Ledgerアドレス。 | -| `sequence` | 整数 | トランザクションのシーケンス番号。 | - - -オプションで、以下のクエリーパラメーターを指定できます。 - -| フィールド | 値 | 説明 | -|:---------|:--------|:--------------------------------------------------------| -| `binary` | ブール値 | `true`の場合、トランザクションをバイナリフォーマットで返します。デフォルトは`false`です。 | - - -#### 応答フォーマット - -成功した場合の応答では、HTTPコード**200 OK**と以下の内容のJSON本文が返されます。 - -| フィールド | 値 | 説明 | -|:--------------|:-------------------------------------------|:----------------| -| `result` | 文字列 | 値が`success`の場合は、成功した場合の応答であることを示します。 | -| `transaction` | [トランザクションオブジェクト](#トランザクションオブジェクト) | 要求されたトランザクション。 | - -#### 例 - -要求: - -``` -GET /v2/accounts/rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn/transactions/10?binary=true -``` - -応答: - -``` -200 OK -{ - "result": "success", - "transaction": { - "hash": "4BFFBB86C12659B6C5BB88F0EB859356DE3433EBACBFD9F50F6E70B2C05CCFE0", - "date": "2014-09-15T19:59:10+00:00", - "ledger_index": 8889812, - "tx": "1200052200000000240000000A68400000000000000A732103AB40A0490F9B7ED8DF29D246BF2D6269820A0EE7742ACDD457BEA7C7D0931EDB74473045022100AA4AF08726FCF0F28AA4A841C45F975C3BF1545648F6907DCB33F6E3DD7E85D6022037365B80AB1972BF8A4280009A0DBCF16A1D562ED0489B155750E48CC939039981144B4E9C06F24296074F7BC48F92A97916C6DC5EA9", - "meta": "201C00000003F8E5110061250087A5C555CBCA96F4C42E0EBC0E75C5AD84B3403FEDF824A7DAFA45ADCA6ECB66AA143C1B5613F1A95D7AAB7108D5CE7EEAF504B2894B8C674E6D68499076441C4837282BF8E6240000000A62400000000DB5852F8814D3484B9ED2556DCE16A3B928B438BA6EE0FF0989E1E72200010000240000000B2D0000000062400000000DB5852572110000000000000000000000070000000300770A6D64756F31332E636F6D81144B4E9C06F24296074F7BC48F92A97916C6DC5EA9E1E1F1031000" - } -} -``` - - - -## Get Account Payments -[[ソース]](https://github.com/ripple/rippled-historical-database/blob/master/api/routes/accountPayments.js "Source") - -指定されたアカウントのペイメントを取得します。 - -#### 要求フォーマット - - - -*REST* - -``` -GET /v2/accounts/{address}/payments -``` - - - -[試してみる>](data-api-v2-tool.html#get-account-payments) - -このメソッドには以下のURLパラメーターを指定する必要があります。 - -| フィールド | 値 | 説明 | -|:----------|:-------|:-----------------------------| -| `address` | 文字列 | 照会するXRP Ledgerアドレス。 | - - -オプションで、以下のクエリーパラメーターを指定できます。 - -| フィールド | 値 | 説明 | -|:------------------|:---------------------------|:----------------------------| -| `start` | 文字列 - [タイムスタンプ][] | この時刻以降の結果に絞り込みます。 | -| `end` | 文字列 - [タイムスタンプ][] | この時刻以前の結果に絞り込みます。 | -| `type` | 文字列 | ペイメントタイプ - `sent`または`received`。 | -| `currency` | 文字列 - [通貨コード][] | 指定された通貨に結果を絞り込みます。 | -| `issuer` | 文字列 - [アドレス][] | 指定されたイシュアーに結果を絞り込みます。 | -| `source_tag` | 整数 | 指定された送金元タグに結果を絞り込みます。 | -| `destination_tag` | 整数 | 指定された送金先タグに結果を絞り込みます。 | -| `limit` | 整数 | ページあたりの最大結果件数。デフォルトは200です。1,000を超える値は指定できません。 | -| `marker` | 文字列 | 前に返された応答の[ページネーション](#ページネーション)キー。 | -| `format` | 文字列 | 返される結果のフォーマットは`csv`または`json`です。デフォルトは`json`です。 | - - -#### 応答フォーマット - -成功した場合の応答では、HTTPコード**200 OK**と以下の内容のJSON本文が返されます。 - -| フィールド | 値 | 説明 | -|:-----------|:-----------------------------|:---------------------------------| -| `result` | 文字列 | 値が`success`の場合は、成功した場合の応答であることを示します。 | -| `count` | 整数 | `payments`フィールドに含まれているオブジェクトの数。 | -| `marker` | 文字列 | （省略される場合があります）[ページネーション](#ページネーション)マーカー。 | -| `payments` | [ペイメントオブジェクト][]の配列 | 要求に一致するすべてのペイメント。最も古いものから順にソートされています。 | - -#### 例 - -要求: - -``` -GET /v2/accounts/rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn/payments?currency=USD&limit=1 -``` - -応答: - -``` -200 OK -{ - "result": "success", - "count": 1, - "marker": "rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn|20140604191650|000007013674|00000", - "payments": [ - { - "amount": "1.0", - "delivered_amount": "1.0", - "destination_balance_changes": [ - { - "counterparty": "rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn", - "currency": "USD", - "value": "1" - } - ], - "source_balance_changes": [ - { - "counterparty": "ra5nK24KXen9AHvsdFTKHSANinZseWnPcX", - "currency": "USD", - "value": "-1" - } - ], - "tx_index": 1, - "currency": "USD", - "destination": "ra5nK24KXen9AHvsdFTKHSANinZseWnPcX", - "executed_time": "2014-06-02T22:47:50Z", - "issuer": "rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn", - "ledger_index": 6979192, - "source": "rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn", - "source_currency": "USD", - "tx_hash": "7BF105CFE4EFE78ADB63FE4E03A851440551FE189FD4B51CAAD9279C9F534F0E", - "transaction_cost": "1.0E-5" - } - ] -} -``` - - - - -## Get Account Exchanges -[[ソース]](https://github.com/ripple/rippled-historical-database/blob/master/api/routes/accountExchanges.js "Source") - -指定されたアカウントの取引を経時的に取得します。 - -#### 要求フォーマット - -このメソッドには2種類のバリエーションがあります。 - - - -*REST - すべての取引* - -``` -GET /v2/accounts/{address}/exchanges/ -``` - -*REST - 特定の通貨ペア* - -``` -GET /v2/accounts/{address}/exchanges/{base}/{counter} -``` - - - -[試してみる>](data-api-v2-tool.html#get-account-exchanges-all) - -このメソッドには以下のURLパラメーターを指定する必要があります。 - -| フィールド | 値 | 説明 | -|:----------|:-------|:--------------------------------------------------------| -| `address` | 文字列 | 照会するXRP Ledgerアドレス。 | -| `base` | 文字列 | ペアのベース通貨。[通貨コード][]、`+`、イシュアーの[アドレス][]の順で指定します（ベース通貨がXRPの場合を除く）。 | -| `counter` | 文字列 | ペアのクオート通貨。[通貨コード][]、`+`、イシュアーの[アドレス][]の順で指定します（ベース通貨がXRPの場合を除く）。 | - - -オプションで、以下のクエリーパラメーターを指定できます。 - -| フィールド | 値 | 説明 | -|:-------------|:-----------------------|:-------------------------------------| -| `start` | 文字列 - [タイムスタンプ][] | この時刻以降の結果に絞り込みます。 | -| `end` | 文字列 - [タイムスタンプ][] | この時刻以前の結果に絞り込みます。 | -| `descending` | ブール値 | `true`の場合、結果が逆時系列で返されます。デフォルトは`false`です。 | -| `limit` | 整数 | ページあたりの最大結果件数。デフォルトは200です。1000を超える値は指定できません。 | -| `marker` | 文字列 | 前に返された応答の[ページネーション](#ページネーション)キー。 | -| `format` | 文字列 | 返される結果のフォーマットは`csv`または`json`です。デフォルトは`json`です。 | - - -#### 応答フォーマット -成功した場合の応答では、HTTPコード**200 OK**と以下の内容のJSON本文が返されます。 - -| フィールド | 値 | 説明 | -|:------------|:------------------------------|:-------------------------------| -| `result` | 文字列 | 値が`success`の場合は、成功した場合の応答であることを示します。 | -| `count` | 整数 | 返された取引の数。 | -| `marker` | 文字列 | （省略される場合があります）[ページネーション](#ページネーション)マーカー。 | -| `exchanges` | [取引オブジェクト][]の配列 | 要求された取引。 | - -#### 例 - -要求: - -``` -GET /v2/accounts/rsyDrDi9Emy6vPU78qdxovmNpmj5Qh4NKw/exchanges/KRW+rUkMKjQitpgAM5WTGk79xpjT38DEJY283d/XRP?start=2015-08-08T00:00:00Z&end=2015-08-31T00:00:00Z&limit=2 - -``` - -応答: - -``` -200 OK -{ - "result": "success", - "count": 2, - "marker": "rsyDrDi9Emy6vPU78qdxovmNpmj5Qh4NKw|20150810014200|000015162386|00013|00003", - "exchanges": [ - { - "base_amount": 209.3501241148, - "counter_amount": 20.424402, - "rate": 0.097560973925, - "autobridged_currency": "USD", - "autobridged_issuer": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B", - "base_currency": "KRW", - "base_issuer": "rUkMKjQitpgAM5WTGk79xpjT38DEJY283d", - "buyer": "rnAqwsu2BEbCjacoZmsXrpViqd3miZhHbT", - "counter_currency": "XRP", - "executed_time": "2015-08-08T02:57:40", - "ledger_index": 15122851, - "offer_sequence": "1738", - "provider": "rsyDrDi9Emy6vPU78qdxovmNpmj5Qh4NKw", - "seller": "rsyDrDi9Emy6vPU78qdxovmNpmj5Qh4NKw", - "taker": "rnAqwsu2BEbCjacoZmsXrpViqd3miZhHbT", - "tx_hash": "506D109A609A5E0778276CCBB125A4AA7B78428059F069A2CB4F739B861C0C49", - "tx_type": "OfferCreate" - }, - { - "base_amount": 86355.6498758851, - "counter_amount": 8424.941452, - "rate": 0.097560975618, - "base_currency": "KRW", - "base_issuer": "rUkMKjQitpgAM5WTGk79xpjT38DEJY283d", - "buyer": "r9xQi5YT8jqVM3wZhbiV94ZKKvGHaVeSDj", - "client": "rt1.1-26-gbeb68ab", - "counter_currency": "XRP", - "executed_time": "2015-08-08T07:15:00", - "ledger_index": 15126536, - "offer_sequence": "1738", - "provider": "rsyDrDi9Emy6vPU78qdxovmNpmj5Qh4NKw", - "seller": "rsyDrDi9Emy6vPU78qdxovmNpmj5Qh4NKw", - "taker": "r9xQi5YT8jqVM3wZhbiV94ZKKvGHaVeSDj", - "tx_hash": "C897A595DED16ADF5AD52E6FD9CE5DE65C78A93CCAA62A85248DC3015A78F5C4", - "tx_type": "Payment" - } - ] -} -``` - - - - -## Get Account Balance Changes -[[ソース]](https://github.com/ripple/rippled-historical-database/blob/master/api/routes/accountBalanceChanges.js "Source") - -指定されたアカウントの残高変更を経時的に取得します。 - -#### 要求フォーマット - - - -*REST* - -``` -GET /v2/accounts/{address}/balance_changes/ -``` - - - -[試してみる>](data-api-v2-tool.html#get-account-balance-changes) - -このメソッドには以下のURLパラメーターを指定する必要があります。 - -| フィールド | 値 | 説明 | -|:----------|:-------|:-----------------------------| -| `address` | 文字列 | 照会するXRP Ledgerアドレス。 | - - -オプションで、以下のクエリーパラメーターを指定できます。 - -| フィールド | 値 | 説明 | -|:---------------|:-----------------------|:-----------------------------------| -| `currency` | 文字列 | 指定された通貨に結果を制限します。 | -| `counterparty` | 文字列 | 指定された取引相手/イシュアーに結果を制限します。 | -| `start` | 文字列 - [タイムスタンプ][] | 照会範囲の開始時刻。 | -| `end` | 文字列 - [タイムスタンプ][] | 照会範囲の終了時刻。 | -| `descending` | ブール値 | `true`の場合、結果が逆時系列で返されます。デフォルトは`false`です。 | -| `limit` | 整数 | ページあたりの最大結果件数。デフォルトは200です。1000を超える値は指定できません。 | -| `marker` | 文字列 | 前に返された応答の[ページネーション](#ページネーション)キー。 | -| `format` | 文字列 | 返される結果のフォーマットは`csv`または`json`。デフォルトは`json`です。 | - - -#### 応答フォーマット -成功した場合の応答では、HTTPコード**200 OK**と以下の内容のJSON本文が返されます。 - -| フィールド | 値 | 説明 | -|:------------|:----------------------------------------|:---------------------| -| `result` | 文字列 | 値が`success`の場合は、成功した場合の応答であることを示します。 | -| `count` | 整数 | 返された残高変更の数。 | -| `marker` | 文字列 | （省略される場合があります）[ページネーション](#ページネーション)マーカー。 | -| `exchanges` | [残高変更記述][]の配列。 | 要求された残高変更。 | - -#### 例 - -要求: - -``` -GET /v2/accounts/rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn/balance_changes?descending=true&limit=3 -``` - -応答: - -``` -200 OK -{ - "result": "success", - "count": 3, - "marker": "rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn|20160122235211|000018425487|00010|00001", - "balance_changes": [ - { - "amount_change": "-0.012", - "final_balance": "75.169663", - "tx_index": 7, - "change_type": "transaction_cost", - "currency": "XRP", - "executed_time": "2016-01-29T22:57:20Z", - "ledger_index": 18555460, - "tx_hash": "2B44EBE00728D04658E597A85EC4F71D20503B31ABBF556764AD8F7A80BA72F6" - }, - { - "amount_change": "-25.0", - "final_balance": "75.181663", - "node_index": 1, - "tx_index": 4, - "change_type": "payment_source", - "currency": "XRP", - "executed_time": "2016-01-26T08:32:20Z", - "ledger_index": 18489336, - "tx_hash": "E5C6DD25B2DCF534056D98A2EFE3B7CFAE4EBC624854DE3FA436F733A56D8BD9" - }, - { - "amount_change": "-0.01", - "final_balance": "100.181663", - "tx_index": 4, - "change_type": "transaction_cost", - "currency": "XRP", - "executed_time": "2016-01-26T08:32:20Z", - "ledger_index": 18489336, - "tx_hash": "E5C6DD25B2DCF534056D98A2EFE3B7CFAE4EBC624854DE3FA436F733A56D8BD9" - } - ] -} -``` - - - - -## Get Account Reports -[[ソース]](https://github.com/ripple/rippled-historical-database/blob/master/api/routes/accountReports.js "Source") - -アカウントのペイメントアクティビティの日次サマリーを取得します。 - - - -*REST - 日付を省略* - -``` -GET /v2/accounts/{address}/reports/ -``` - -*REST - 日付を指定* - -``` -GET /v2/accounts/{address}/reports/{date} -``` - - - -[試してみる>](data-api-v2-tool.html#get-account-reports-by-day) - -このメソッドには以下のURLパラメーターを指定する必要があります。 - -| フィールド | 値 | 説明 | -|:----------|:-------|:--------------------------------------------------------| -| `address` | 文字列 | 照会するXRP Ledgerアドレス。 | -| `date` | 文字列 | _（省略可）_ 1つのレポートの日付（UTC）。省略すると、`start`および`end`クエリーパラメーターが使用されます。 | - - -オプションで、以下のクエリーパラメーターを指定できます。 - -| フィールド | 値 | 説明 | -|:-------------|:-----------------------|:-------------------------------------| -| `start` | 文字列 - [タイムスタンプ][] | 照会範囲の開始時刻。デフォルトは、現在の日付の開始時刻です。`date`が指定されている場合は無視されます。 | -| `end` | 文字列 - [タイムスタンプ][] | 照会範囲の終了時刻。デフォルトは、現在の日付の終了時刻です。`date`が指定されている場合は無視されます。 | -| `accounts` | ブール値 | `true`の場合、すべての`sending_counterparties`および`receiving_counterparties`のアドレスのリストが結果に含まれます。それ以外の場合、送金側取引相手と受取側取引相手の数のみが返されます。デフォルトは`false`です。 | -| `payments` | ブール値 | [ペイメントサマリーオブジェクト][]を各間隔の`payments`フィールドに指定します。このオブジェクトには、当該間隔で発生したペイメントが含まれています。 | -| `descending` | ブール値 | `true`の場合は、結果が最新のものから順にソートされます。デフォルトでは、結果が最も古いものから順にソートされます。 | -| `format` | 文字列 | 返される結果のフォーマットは`csv`または`json`です。デフォルトは`json`です。 | - - -#### 応答フォーマット -成功した場合の応答では、HTTPコード**200 OK**と以下の内容のJSON本文が返されます。 - -| フィールド | 値 | 説明 | -|:----------|:-----------------------------|:----------------------------------| -| `result` | 文字列 | 値が`success`の場合は、成功した場合の応答であることを示します。 | -| `count` | 整数 | `reports`フィールドに含まれているレポートの数。 | -| `reports` | [レポートオブジェクト][]の配列 | 指定のアカウントと日付範囲のアカウントアクティビティの日次サマリー。 | - -#### 例 - -要求: - -``` -GET /v2/accounts/rMwjYedjc7qqtKYVLiAccJSmCwih4LnE2q/reports?start=2015-08-28T00:00:00&end=2015-08-28T00:00:00&accounts=true&payments=true&descending=true -``` - -応答: - -``` -200 OK -{ - "result": "success", - "count": 1, - "reports": [ - { - "account": "rMwjYedjc7qqtKYVLiAccJSmCwih4LnE2q", - "date": "2015-08-28T00:00:00+00:00", - "high_value_received": 89500.74142547617, - "high_value_sent": 0, - "payments": [ - { - "tx_hash": "F2323EE7494384E77ABB18F31981FEE8C31767BBD27515B55FC3BD6792C4E408", - "amount": 2.7, - "currency": "BTC", - "issuer": "rMwjYedjc7qqtKYVLiAccJSmCwih4LnE2q", - "type": "received" - }, - { - "tx_hash": "FEAD462738EE430E154FF3122D3EE2DD27DDD8BEFBA080A60FE91B78E8865365", - "amount": 3, - "currency": "BTC", - "issuer": "rMwjYedjc7qqtKYVLiAccJSmCwih4LnE2q", - "type": "received" - }, - { - "tx_hash": "383B1D1EABB646AB2EFBBF9E8967FE279BFE5EF86A3B6BCD5BDA287210053116", - "amount": 0.14, - "currency": "BTC", - "issuer": "rMwjYedjc7qqtKYVLiAccJSmCwih4LnE2q", - "type": "received" - } - ], - "payments_received": 3, - "payments_sent": 0, - "receiving_counterparties": [], - "sending_counterparties": [ - "rhi4zZdCeFdfTokzek8D7p9bUWmtEFCZAe", - "rP1hkW1LCiVos6FpzU7itmm9Tk29yqvyk5" - ], - "total_value": 174019.58324753598, - "total_value_received": 174019.58324753598, - "total_value_sent": 0 - } - ] -} -``` - - - -## Get Account Transaction Stats -[[ソース]](https://github.com/ripple/rippled-historical-database/blob/master/api/routes/accountStats.js "Source") - -アカウントのトランザクションアクティビティの日次サマリーを取得します。_（新規: [v2.1.0][]）_ - - - -*REST* - -``` -GET /v2/accounts/{address}/stats/transactions -``` - - - -[試してみる>](data-api-v2-tool.html#get-account-transaction-stats) - -このメソッドには以下のURLパラメーターを指定する必要があります。 - -| フィールド | 値 | 説明 | -|:----------|:-------|:-----------------------------| -| `address` | 文字列 | 照会するXRP Ledgerアドレス。 | - - -オプションで、以下のクエリーパラメーターを指定できます。 - -| フィールド | 値 | 説明 | -|:-------------|:-----------------------|:-------------------------------------| -| `start` | 文字列 - [タイムスタンプ][] | 照会範囲の開始時刻。デフォルトは、利用可能な最も古い日付です。 | -| `end` | 文字列 - [タイムスタンプ][] | 照会範囲の終了時刻。デフォルトは現在の日付です。 | -| `limit` | 整数 | ページあたりの最大結果件数。デフォルトは200です。1000を超える値は指定できません。 | -| `descending` | ブール値 | `true`の場合は、結果が最新のものから順にソートされます。デフォルトでは、結果が最も古いものから順にソートされます。 | -| `marker` | 文字列 | 前に返された応答の[ページネーション](#ページネーション)キー。 | -| `format` | 文字列 | 返される結果のフォーマットは`csv`または`json`です。デフォルトは`json`です。 | - - -#### 応答フォーマット -成功した場合の応答では、HTTPコード**200 OK**と以下の内容のJSON本文が返されます。 - -| フィールド | 値 | 説明 | -|:---------|:-----------------------------------|:-----------------------------| -| `result` | 文字列 | 値が`success`の場合は、成功した場合の応答であることを示します。 | -| `count` | 整数 | `rows`フィールドに含まれているトランザクション統計情報オブジェクトの数。 | -| `rows` | トランザクション統計情報オブジェクトの配列。 | 指定されたアカウントのアカウントアクティビティの日次サマリー。 | - -各トランザクション状況オブジェクトのフィールドを次に示します。 - -| フィールド | 値 | 説明 | -|:--------------------|:-----------------------|:------------------------------| -| `date` | 文字列 - [タイムスタンプ][] | このオブジェクトは、当該日付のアクティビティを表します。 | -| `transaction_count` | 整数 | アカウントが当該日付に送信したトランザクションの合計数。 | -| `result` | オブジェクト | 当該日付でこのアカウントが送信したトランザクションで発生した各結果コードの数を示す[トランザクション結果コード](transaction-results.html)のマップ。 | -| `type` | オブジェクト | アカウントが当該日付に送信した各トランザクションタイプの数を示す[トランザクションタイプ](transaction-formats.html)のマップ。 | - -#### 例 - -要求: - -``` -GET /v2/accounts/rGFuMiw48HdbnrUbkRYuitXTmfrDBNTCnX/stats/transactions?start=2015-01-01&limit=2 -``` - -応答: - -``` -200 OK -{ - "result": "success", - "count": 2, - "marker": "rGFuMiw48HdbnrUbkRYuitXTmfrDBNTCnX|20150116000000", - "rows": [ - { - "date": "2015-01-14T00:00:00Z", - "transaction_count": 44, - "result": { - "tecUNFUNDED_PAYMENT": 1, - "tesSUCCESS": 43 - }, - "type": { - "Payment": 42, - "TrustSet": 2 - } - }, - { - "date": "2015-01-15T00:00:00Z", - "transaction_count": 116, - "result": { - "tesSUCCESS": 116 - }, - "type": { - "Payment": 116 - } - } - ] -} -``` - - - -## Get Account Value Stats -[[ソース]](https://github.com/ripple/rippled-historical-database/blob/master/api/routes/accountStats.js "Source") - -アカウントのトランザクションアクティビティの日次サマリーを取得します。_（新規: [v2.1.0][]）_ - - - -*REST* - -``` -GET /v2/accounts/{address}/stats/value -``` - - - -[試してみる>](data-api-v2-tool.html#get-account-value-stats) - -このメソッドには以下のURLパラメーターを指定する必要があります。 - -| フィールド | 値 | 説明 | -|:----------|:-------|:-----------------------------| -| `address` | 文字列 | 照会するXRP Ledgerアドレス。 | - - -オプションで、以下のクエリーパラメーターを指定できます。 - -| フィールド | 値 | 説明 | -|:-------------|:-----------------------|:-------------------------------------| -| `start` | 文字列 - [タイムスタンプ][] | 照会範囲の開始時刻。デフォルトは、最新間隔の開始時刻です。 | -| `end` | 文字列 - [タイムスタンプ][] | 照会範囲の終了時刻。デフォルトは、最新間隔の終了時刻です。 | -| `limit` | 整数 | ページあたりの最大結果件数。デフォルトは200です。1000を超える値は指定できません。 | -| `marker` | 文字列 | 前に返された応答の[ページネーション](#ページネーション)キー。 | -| `descending` | ブール値 | `true`の場合は、結果が最新のものから順にソートされます。デフォルトでは、結果が最も古いものから順にソートされます。 | -| `format` | 文字列 | 返される結果のフォーマットは`csv`または`json`です。デフォルトは`json`です。 | - - -#### 応答フォーマット -成功した場合の応答では、HTTPコード**200 OK**と以下の内容のJSON本文が返されます。 - -| フィールド | 値 | 説明 | -|:---------|:-----------------------------|:-----------------------------------| -| `result` | 文字列 | 値が`success`の場合は、成功した場合の応答であることを示します。 | -| `count` | 整数 | `rows`フィールドに含まれている価値統計情報オブジェクトの数。 | -| `rows` | 価値統計情報オブジェクトの配列。 | 指定されたアカウントのアカウント価値の日次サマリー。 | - -各価値統計情報オブジェクトのフィールドを次に示します。 - -| フィールド | 値 | 説明 | -|:-----------------------|:-----------------------|:---------------------------| -| `date` | 文字列 - [タイムスタンプ][] | このオブジェクトは、当該日付のアクティビティを表します。 | -| `value` | [文字列 - 数値][] | このアカウントが保有しているすべての通貨の合計額（XRPに正規化）。 | -| `balance_change_count` | 数値 | 当該日付でアカウントの残高が変更された回数。 | - -#### 例 - -要求: - -``` -GET /v2/accounts/rGFuMiw48HdbnrUbkRYuitXTmfrDBNTCnX/stats/value?limit=2&descending=true -``` - -応答: - -``` -200 OK -{ - "result": "success", - "count": 2, - "marker": "rGFuMiw48HdbnrUbkRYuitXTmfrDBNTCnX|20160412000000", - "rows": [ - { - "date": "2016-04-14T00:00:00Z", - "account_value": "7.666658705139822E7", - "balance_change_count": 58 - }, - { - "date": "2016-04-13T00:00:00Z", - "account_value": "1.0022208004947332E8", - "balance_change_count": 184 - } - ] -} -``` - - - - -## Health Check - API -[[ソース]](https://github.com/ripple/rippled-historical-database/blob/master/api/routes/checkHealth.js "Source") - -APIサービスの健全性をチェックします。 - - - -*REST* - -``` -GET /v2/health/api -``` - - - -[試してみる>](data-api-v2-tool.html#api-health-check) - -オプションで、以下のクエリーパラメーターを指定できます。 - -| フィールド | 値 | 説明 | -|:------------|:--------|:-----------------------------------------------------| -| `threshold` | 整数 | データベースがこの期間（秒単位）内に応答しない場合、APIが正常ではないと見なされます。デフォルトは5秒です。 | -| `verbose` | ブール値 | `true`の場合は、データポイントが含まれているJSON応答が返されます。デフォルトでは整数値のみが返されます。 | - -#### 応答フォーマット - -成功した場合の応答では、HTTPコード**200 OK**が返されます。デフォルトでは、応答本文には**整数の正常値のみ**が含まれます。 - -正常値`0`は常に、正常な状況を示します。その他の正常値の定義を次に示します。 - -| 値 | 意味 | -|:------|:---------------------------------------------------------------------| -| `0` | APIサービスが稼働しており、HBaseに対する応答時間は要求の`threshold`値未満である。 | -| `1` | APIサービスが稼働しており、HBaseに対する応答時間は要求の`threshold`値を超えている。 | - -要求のクエリーパラメーターに`verbose=true`が指定されている場合、応答本文は以下のフィールドを含むJSONオブジェクトです。 - -| フィールド | 値 | 説明 | -|:--------------------------|:-----------------------------|:------------------| -| `score` | 0-1 | 前述のように定義される正常値。 | -| `response_time` | 文字列 - 人間が読める形式の時間 | データベースの実際の応答時間。 | -| `response_time_threshold` | 文字列 - 人間が読める形式の時間 | 正常と見なされる最大応答時間。 | - -#### 例 - -要求: - -``` -GET /v2/health/api?verbose=true -``` - -応答: - -``` -200 OK -{ - "score": 0, - "response_time": "0.014s", - "response_time_threshold": "5s" -} -``` - - -## Health Check - Ledger Importer -[[ソース]](https://github.com/ripple/rippled-historical-database/blob/master/api/routes/checkHealth.js "Source") - -Ledger Importer Serviceの健全性をチェックします。 - - - -*REST - Importerの健全性* - -``` -GET /v2/health/importer -``` - - - -[試してみる>](data-api-v2-tool.html#importer-health-check) - -オプションで、以下のクエリーパラメーターを指定できます。 - -| フィールド | 値 | 説明 | -|:-------------|:--------|:----------------------------------------------------| -| `threshold` | 整数 | 最新の検証済みレジャーのインポート後に経過時間がこの時間（秒単位）を超えると、Importerは正常ではないと見なされます。デフォルトは300秒です。 | -| `threshold2` | 整数 | あらゆる種類の最新レジャーのインポート後に経過時間がこの時間（秒単位）を超えると、Importerは正常ではないと見なされます。デフォルトは60秒です。 | -| `verbose` | ブール値 | `true`の場合は、データポイントが含まれているJSON応答が返されます。デフォルトでは整数値のみが返されます。 | - -#### 応答フォーマット - -成功した場合の応答では、HTTPコード**200 OK**が返されます。デフォルトでは、応答本文には**整数の正常値のみ**が含まれます。 - -正常値`0`は常に、正常な状況を示します。その他の正常値の定義を次に示します。 - -| 値 | 意味 | -|:------|:---------------------------------------------------------------------| -| `0` | 最後にインポートされたレジャーの経過時間が`threshold2` （デフォルト: 60）秒よりも短く、最新の検証済みレジャーの経過時間が`threshold` 秒よりも短い。 | -| `1` | 最後にインポートされたレジャーの経過時間が`threshold2` （デフォルト: 60）秒よりも短く、最新の検証済みレジャーの経過時間が`threshold` 秒よりも長い。 | -| `2` | 最後にインポートされたレジャーの経過時間が`threshold2` 秒よりも長い。 | - -要求のクエリーパラメーターに`verbose=true`が指定されている場合、応答本文は以下のフィールドを含むJSONオブジェクトです。 - -| フィールド | 値 | 説明 | -|:---------------------------|:-----------------------------|:-----------------| -| `score` | 0-2 | 前述のように定義される正常値。 | -| `response_time` | 文字列 | データベースの実際の応答時間。 | -| `ledger_gap` | 文字列 - 人間が読める形式の時間 | 最後に保存されたレジャーの閉鎖時刻と現在の時刻の差。 | -| `ledger_gap_threshold` | 文字列 - 人間が読める形式の時間 | 正常と見なされる最大レジャーギャップ。 | -| `valildation_gap` | 文字列 - 人間が読める形式の時間 | 最後にインポートされた検証済みレジャーの閉鎖時刻と現在の時刻の差。 | -| `validation_gap_threshold` | 文字列 - 人間が読める形式の時間 | 正常と見なされる最大検証ギャップ。 | - -#### 例 - -要求: - -``` -GET /v2/health/importer?verbose=true -``` - -応答: - -``` -200 OK -{ - "score": 0, - "response_time": "0.081s", - "ledger_gap": "1.891s", - "ledger_gap_threshold": "5.00m", - "validation_gap": "29.894s", - "validation_gap_threshold": "15.00m" -} -``` - - - -## Health Check - Nodes ETL -[[ソース]](https://github.com/ripple/rippled-historical-database/blob/master/api/routes/checkHealth.js "Source") - -Topology Nodes Extract, Transform, Load（ETL）Serviceの健全性をチェックします。 - - - -*REST - Nodes ETLの健全性* - -``` -GET /v2/health/nodes_etl -``` - - - -[試してみる>](data-api-v2-tool.html#nodes-etl-health-check) - -オプションで、以下のクエリーパラメーターを指定できます。 - -| フィールド | 値 | 説明 | -|:------------|:--------|:-----------------------------------------------------| -| `threshold` | 整数 | 最新データインポート後の経過時間がこの時間（秒単位）を超えると、このサービスは正常でないと見なされます。デフォルトは120秒です。 | -| `verbose` | ブール値 | `true`の場合は、データポイントが含まれているJSON応答が返されます。デフォルトでは整数値のみが返されます。 | - -#### 応答フォーマット - -成功した場合の応答では、HTTPコード**200 OK**が返されます。デフォルトでは、応答本文には**整数の正常値のみ**が含まれます。 - -正常値`0`は常に、正常な状況を示します。その他の正常値の定義を次に示します。 - -| 値 | 意味 | -|:------|:---------------------------------------------------------------------| -| `0` | 最後のトポロジーデータインポート後の経過時間が`threshold` の秒数（デフォルト: 120）よりも短い。 | -| `1` | 最後のトポロジーデータインポート後の経過時間が`threshold`の秒数よりも長い。 | - - -要求のクエリーパラメーターに`verbose=true`が指定されている場合、応答本文は以下のフィールドを含むJSONオブジェクトです。 - -| フィールド | 値 | 説明 | -|:----------------|:-----------------------------|:----------------------------| -| `score` | 0-1 | 前述のように定義される正常値。 | -| `gap` | 文字列 - 人間が読める形式の時間 | データが最後にインポートされた時点と現在の時刻の差。 | -| `gap_threshold` | 文字列 - 人間が読める形式の時間 | 正常と見なされる最大ギャップ。 | -| `message` | 文字列 | ゼロ以外のスコアの理由の説明（該当する場合）。 | - -#### 例 - -要求: - -``` -GET /v2/health/nodes_etl?verbose=true -``` - -応答: - -``` -200 OK -{ - "score": 0, - "gap": "1.891s", - "gap_threshold": "2.00m", -} -``` - - - -## Health Check - Validations ETL -[[ソース]](https://github.com/ripple/rippled-historical-database/blob/master/api/routes/checkHealth.js "Source") - -Validations Extract, Transform, Load（ETL）Serviceの健全性をチェックします。 - - - -*REST - Validations ETLの健全性* - -``` -GET /v2/health/validations_etl -``` - - - -[試してみる>](data-api-v2-tool.html#validations-etl-health-check) - -オプションで、以下のクエリーパラメーターを指定できます。 - -| フィールド | 値 | 説明 | -|:------------|:--------|:-----------------------------------------------------| -| `threshold` | 整数 | 最新データインポート後の経過時間がこの時間（秒単位）を超えると、このサービスは正常でないと見なされます。デフォルトは120秒です。 | -| `verbose` | ブール値 | `true`の場合は、データポイントが含まれているJSON応答が返されます。デフォルトでは整数値のみが返されます。 | - -#### 応答フォーマット - -成功した場合の応答では、HTTPコード**200 OK**が返されます。デフォルトでは、応答本文には**整数の正常値のみ**が含まれます。 - -正常値`0`は常に、正常な状況を示します。その他の正常値の定義を次に示します。 - -| 値 | 意味 | -|:------|:---------------------------------------------------------------------| -| `0` | 最後のトポロジーデータインポート後の経過時間が`threshold` の秒数（デフォルト: 120）よりも短い。 | -| `1` | 最後のトポロジーデータインポート後の経過時間が`threshold`の秒数よりも長い。 | - -要求のクエリーパラメーターに`verbose=true`が指定されている場合、応答本文は以下のフィールドを含むJSONオブジェクトです。 - -| フィールド | 値 | 説明 | -|:----------------|:-----------------------------|:----------------------------| -| `score` | 0-1 | 前述のように定義される正常値。 | -| `gap` | 文字列 - 人間が読める形式の時間 | データが最後にインポートされた時点と現在の時刻の差。 | -| `gap_threshold` | 文字列 - 人間が読める形式の時間 | 正常と見なされる最大ギャップ。 | -| `message` | 文字列 | ゼロ以外のスコアの理由の説明（該当する場合）。 | - -#### 例 - -要求: - -``` -GET /v2/health/nodes_etl?verbose=true -``` - -応答: - -``` -200 OK -{ - "score": 0, - "gap": "1.891s", - "gap_threshold": "2.00m", -} -``` - - - - -# APIの規則 - -## 基本的なデータ型 - -REST APIであるData API v2では[JSON](http://json.org/)のネイティブデータ型を使用してAPIフィールドが表されます（特殊なケースがいくつかあります）。 - -### 数値と精度 -[文字列 - 数値]: #数値と精度 - -{% include '_snippets/string-number-formatting.md' %} - -XRP Ledgerでの**XRP以外の通貨**の額の精度は次のようになります。 - -* 非ゼロの最小絶対値: `1000000000000000e-96` -* 最大値: `9999999999999999e80` -* 最小値: `-9999999999999999e80` -* 10進15桁の精度 - -**XRP**の内部表現は異なり、その精度も異なります。 - -* 最小値: `0` -* 最大値: `100000000000`（`1e11`） -* `0.000001`（`1e-6`）に近い精度。 - -つまりXRPの精度は、64ビット符号なし整数と同等であり、各単位は0.000001 XRPに相当します。 - -### アドレス -[アドレス]: #アドレス - -{% include '_snippets/data_types/address.ja.md' %} - - -### 公開鍵 -[公開鍵]: #公開鍵 - -{% include '_snippets/data_types/public_key.ja.md' %} - - -### ハッシュ -[ハッシュ]: #ハッシュ - -{% include '_snippets/data_types/hash.ja.md' %} - - -### タイムスタンプ -[タイムスタンプ]: #タイムスタンプ - -すべての日付と時刻はISO 8601 Timestamp Formatで記述され、UTCを使用しています。このフォーマットをまとめると次のようになります。 - -`YYYY-MM-DDThh:mm:ssZ` - -* 4桁の年 -* 2桁の月 -* 2桁の日 -* データ部分と時間部分が文字`T`で区切られています。 -* 2桁の時間（24時間制） -* 2桁の分 -* UTCからのゼロオフセットを示す文字`Z` 。 - -（[v2.0.4][]の時点では、オフセット`+00:00`は使用されていません。） - -### レジャーインデックス -[レジャーインデックス]: #レジャーインデックス - -{% include '_snippets/data_types/ledger_index.ja.md' %} - -### アカウントシーケンス -[シーケンス番号]: #アカウントシーケンス - -{% include '_snippets/data_types/account_sequence.ja.md' %} - -### 通貨コード -[通貨コード]: #通貨コード - -{% include '_snippets/data_types/currency_code.ja.md' %} - -## ページネーション - -多くのクエリーは、1つのHTTP応答で返すのに適量を上回る大量のデータを返します。Data APIでは、1つの応答（ページ）で返すデータの量を制御し、追加の内容を照会する「制限とマーカー」システムが採用されています。 - -多くの要求の`limit`クエリーパラメーターは、応答に含まれる結果の数を特定の数に限定します。結果の型とデフォルト値はメソッドに応じて異なります。ほとんどのメソッドでは、`limit`のデフォルト値は**200**で、最大で**1000**まで設定できます。この最大値を超える`limit`値を指定しても、APIはこの最大値を使用します。 - -現在の応答に含まれていない追加オブジェクトがクエリーに含まれている場合、JSON応答には、追加の結果を取得できることを示す最上位フィールド`marker`が含まれます。このためには、`marker`フィールドの前の値を`marker`クエリーパラメーターとして指定した複数の要求を追加で実行します。個々の追加要求では、1番目の要求と同じパラメーター（`marker`を除く）を使用します。応答にて`marker`パラメーターが省略されている場合は、照会可能なデータの最後に達したことを示しています。 - -`marker`が含まれている場合は、応答の[`Link`ヘッダー](https://tools.ietf.org/html/rfc5988#section-5)に`rel="next"`が指定されています。これは、次の結果ページの完全なURLです。応答が`json`ではなく`csv`フォーマットである場合は、これを使用して結果をページネーションできます。_（新規: [v2.0.4][]）_ - -## トランザクションオブジェクト - -トランザクションには、簡潔な「バイナリ」フォーマットと拡張フォーマットの2種類があります。バイナリフォーマットでは、トランザクションを定義するフィールドが16進文字列としてエンコードされており、拡張フォーマットではトランザクションを定義するフィールドが完全なJSONオブジェクトとして入れ子になっています。 - -### 完全なJSONフォーマット - -| フィールド | 値 | 説明 | -|:---------------|:--------------------------|:--------------------------------| -| `hash` | 文字列 - [ハッシュ][] | このトランザクションに固有の識別用ハッシュ値（16進文字列）。 | -| `date` | 文字列 - [タイムスタンプ][] | トランザクションが検証済みレジャーに追加された時刻。 | -| `ledger_index` | 数値 - [レジャーインデックス][] | このレジャーが含まれているレジャーのシーケンス番号。 | -| `tx` | オブジェクト | このトランザクションオブジェクトのフィールド。[トランザクションのフォーマット](transaction-formats.html)により定義されます。 | -| `meta` | オブジェクト | このトランザクションの結果に関するメタデータ。 | - -### バイナリフォーマット - -| フィールド | 値 | 説明 | -|:---------------|:--------------------------|:--------------------------------| -| `hash` | 文字列 - [ハッシュ][] | このトランザクションに固有の識別用ハッシュ値（16進文字列）。 | -| `date` | 文字列 - [タイムスタンプ][] | トランザクションが検証済みレジャーに追加された時刻。 | -| `ledger_index` | 数値 - [レジャーインデックス][] | このレジャーが含まれているレジャーのシーケンス番号。 | -| `tx` | 文字列 | このトランザクションを表すバイナリデータ（16進文字列）。 | -| `meta` | 文字列 | このトランザクションのメタデータを表すバイナリデータ（16進文字列）。 | - -## レジャーオブジェクト - -「レジャー」とは、共有グローバルレジャーの1バージョンです。各レジャーオブジェクトのフィールドを次に示します。 - -| フィールド | 値 | 説明 | -|:--------------------|:--------------------------|:---------------------------| -| `ledger_hash` | 文字列 - [ハッシュ][] | このレジャーに固有の識別用ハッシュ値（16進文字列）。 | -| `ledger_index` | 数値 - [レジャーインデックス][] | このレジャーのシーケンス番号。新しいレジャーのレジャーインデックスは、その直前のレジャーに1を加算した値になります。 | -| `parent_hash` | 文字列 - [ハッシュ][] | 前のレジャーの識別用ハッシュ。 | -| `total_coins` | [文字列 - 数値][] | このレジャーの時点で存在していたXRPのdrops数の合計。（1 XRPは1,000,000 dropに相当します。） | -| `close_time_res` | 数値 | レジャー閉鎖時刻はこの秒数で丸められます。 | -| `accounts_hash` | 文字列 - [ハッシュ][] | このレジャーに含まれているアカウント情報のハッシュ（16進数）。 | -| `transactions_hash` | 文字列 - [ハッシュ][] | このレジャーに含まれているトランザクション情報のハッシュ（16進数）。 | -| `close_time` | 数値 | UNIX時間でのこのレジャーの閉鎖時刻。 | -| `close_time_human` | 文字列 - [タイムスタンプ][] | このレジャーが閉鎖された時刻。 | - -**注記:** レジャーの閉鎖時刻はおおよその時刻であり、通常10秒単位で丸められます。2つのレジャーの実際の閉鎖時刻の差が数秒程度の場合、それらの`close_time`の値が同一となることがあります。レジャーのシーケンス番号（`ledger_index`）により、どのレジャーが最初に閉鎖したのかが明確になります。 - -### ジェネシスレジャー - -XRP Ledgerの運用開始当初に起きた事故により、1～32569番目までのレジャーが失われました。このため、現存する一番最初のレジャーは番号32570のレジャーです。Data API v2の目的上、番号32570のレジャーは _ジェネシスレジャー_ と見なされます。 - -## アカウント作成オブジェクト - -アカウント作成オブジェクトは、XRP Ledgerでのアカウント作成アクションを表します。アカウントがレジャー32570（最も古いレジャー）にすでに含まれていたかどうかに応じて、2種類のバリエーションがあります。レジャー32570にすでに含まれていたアカウントは _ジェネシスアカウント_ と呼ばれます。 - -| フィールド | 値 | 説明 | -|:------------------|:-----------------------------|:--------------------------| -| `address` | 文字列 - [アドレス][] | このアカウントの識別用アドレス（base-58）。 | -| `inception` | 文字列 - [タイムスタンプ][] | このアドレスに資金が供給された時点のUTCタイムスタンプ。ジェネシスアカウントの場合、これはレジャー32570のタイムスタンプです。 | -| `ledger_index` | 数値 - [レジャーインデックス][] | アカウントが作成された時点でのレジャーのシーケンス番号。ジェネシスアカウントの場合は32570です。 | -| `parent` | 文字列 - [アドレス][] | （ジェネシスアカウントの場合は省略）このアドレスに資金供給するためにXRPを提供したアドレス。 | -| `tx_hash` | 文字列 - [ハッシュ][] | （ジェネシスアカウントの場合は省略）このアカウントに資金供給したトランザクションの識別用ハッシュ。 | -| `initial_balance` | [文字列 - 数値][] | （ジェネシスアカウントの場合は省略）このアカウントに供給されたXRPの額。 | -| `genesis_balance` | [文字列 - 数値][] | （ジェネシスアカウントのみ）レジャー番号32570の時点でこのアカウントが保有していたXRPの額。 | -| `genesis_index` | 数値 - [シーケンス番号][] | （ジェネシスアカウントのみ）レジャー番号32570の時点でのこのアカウントのトランザクションシーケンス番号。 | - - -## 取引オブジェクト -[取引オブジェクト]: #取引オブジェクト - -取引オブジェクトは、実際の通貨取引を表します。この取引は、OfferCreateトランザクションまたはPaymentトランザクションを実行した結果として、XRP Ledgerで発生します。通貨が実際に取引されるには、OfferCreateトランザクションを使用してレジャーで以前に発注され、約定しなかったオファーが存在している必要があります。 - -1つのトランザクションで複数の取引を実行できます。この場合、どの取引においてもトランザクションの送信者がTakerとなりますが、プロバイダーと通貨ペアのいずれかまたはその両方は取引ごとに異なります。 - -| フィールド | 値 | 説明 | -|:-----------------------|:-----------------------------|:---------------------| -| `base_amount` | 数値 | 取引されたベース通貨の額。 | -| `counter_amount` | 数値 | 取引されたクオート通貨の額。 | -| `rate` | 数値 | ベース通貨1単位で獲得できるクオート通貨の額。 | -| `autobridged_currency` | 文字列 - [通貨コード][] | （省略される場合があります）オファーがオートブリッジングされていた場合（XRPオーダーブックを使用して2つのXRP以外の通貨がブリッジングされていた場合）、この取引を実行したオファーのもう一方の通貨です。 | -| `autobridged_issuer` | 文字列 - [アドレス][] | （省略される場合があります）オファーがオートブリッジングされていた場合（XRPオーダーブックを使用して2つのXRP以外の通貨がブリッジングされていた場合）、この取引を実行したオファーのもう一方のイシュアーです。 | -| `base_currency` | 文字列 - [通貨コード][] | ベース通貨。 | -| `base_issuer` | 文字列 - [アドレス][] | （XRPの場合は省略）ベース通貨を発行したアカウント。 | -| `buyer` | 文字列 - [アドレス][] | ベース通貨を獲得したアカウント。 | -| `client` | 文字列 | （省略される場合があります）トランザクションに、クライアントアプリケーションが送信したメモが含まれている場合、これはメモの内容です。 | -| `counter_currency` | 文字列 - [通貨コード][] | クオート通貨。 | -| `counter_issuer` | 文字列 - [アドレス][] | （XRPの場合は省略）クオート通貨を発行したアカウント。 | -| `executed_time` | 文字列 - [タイムスタンプ][] | 取引が発生した時刻。 | -| `ledger_index` | 数値 - [レジャーインデックス][] | このトランザクションが含まれているレジャーのシーケンス番号。 | -| `offer_sequence` | 数値 - [シーケンス番号][] | このレジャーに含まれている`provider`の既存のオファーのシーケンス番号。 | -| `provider` | 文字列 - [アドレス][] | レジャーに既存のオファーが含まれているアカウント。 | -| `seller` | 文字列 - [アドレス][] | クオート通貨を獲得したアカウント。 | -| `taker` | 文字列 - [アドレス][] | この取引を実行したトランザクションを送信したアカウント。 | -| `tx_hash` | 文字列 - [ハッシュ][] | この取引を実行したトランザクションの識別用ハッシュ。（**注記:** この取引は、1つのトランザクションで実行された複数の取引の1つである場合があります。） | -| `tx_type` | 文字列 | この取引を実行したトランザクションのタイプ（`Payment`または`OfferCreate`）。 | - - -## レポートオブジェクト -[レポートオブジェクト]: #レポートオブジェクト - -レポートオブジェクトは、特定の間隔（通常は1日）における特定アカウントのアクティビティを示します。レポートには次のフィールドがあります。 - -| フィールド | 値 | 説明 | -|:---------------------------|:-------------------------------------|:---------| -| `account` | 文字列 - [アドレス][] | このレポートに関連するアカウントのアドレス。 | -| `date` | 文字列 - [タイムスタンプ][] | このレポートに関連する間隔の開始時刻。 | -| `high_value_received` | [文字列 - 数値][] | 1回のトランザクションで受領した最大額（XRPに正規化、可能な限り近い値）これにはペイメントと取引が含まれます。 | -| `high_value_sent` | [文字列 - 数値][] | 1回のトランザクションで送金した最大額（XRPに正規化、可能な限り近い値）。 | -| `payments` | [ペイメントサマリーオブジェクト][]の配列 | （省略される場合があります）この間隔でアカウントが送金または受領した各ペイメントに関する情報の配列。 | -| `payments_received` | 数値 | このアカウントに送金されたペイメントの件数。（これには、このアカウントが送金先であるペイメントのみが含まれます。アカウントを通じてRipplingされたペイメントや、アカウントのオファーで消費されたペイメントは含まれません。） | -| `payments_sent` | 数値 | このアカウントが送金したペイメントの件数。 | -| `receiving_counterparties` | 配列または数値 | アカウントリストが要求された場合は、このアカウントからのペイメントを受取ったアドレスの配列。それ以外の場合は、このアカウントからペイメントを受取ったさまざまなアカウントの数。 | -| `sending_counterparties` | 配列または数値 | アカウントリストが要求された場合は、このアカウントにペイメントを送信したアドレスの配列。それ以外の場合は、このアカウントにペイメントを送信したさまざまなアカウントの数。 | -| `total_value` | [文字列 - 数値][] | ペイメントで受領および送金された合計額（XRPに正規化、可能な限り近い値）。 | -| `total_value_received` | [文字列 - 数値][] | このアカウントへのすべてのペイメントの合計額（XRPに正規化、可能な限り近い値）。 | -| `total_value_sent` | [文字列 - 数値][] | このアカウントからのすべてのペイメントの合計額（XRPに正規化、可能な限り近い値）。 | - -## ペイメントサマリーオブジェクト -[ペイメントサマリーオブジェクト]: #ペイメントサマリーオブジェクト - -ペイメントサマリーオブジェクトには、ペイメントの送金元または受取人から見た1つのペイメントに関する限られた量の情報が含まれています。 - -| フィールド | 値 | 説明 | -|:-------------------|:---------------------------|:---------------------------| -| `tx_hash` | 文字列 - [ハッシュ][] | このペイメントを発生させたトランザクションの識別用ハッシュ。 | -| `delivered_amount` | [文字列 - 数値][] | 実際に送金先アカウントが受領した送金先`currency`の額。 | -| `currency` | 文字列 - [通貨コード][] | トランザクションの受取人に送金された通貨。 | -| `issuer` | 文字列 - [アドレス][] | 通貨を発行するゲートウェイ。XRPの場合は空のストリング。 | -| `type` | 文字列 | `sent`または`received`のいずれか。これは、パースペクティブアカウントがトランザクションの送金元または受取人のいずれであるかを示します。 | - - -## ペイメントオブジェクト -[ペイメントオブジェクト]: #ペイメントオブジェクト - -Data APIでは、ペイメントオブジェクトはアカウント間で価値が移動したイベントを表します。これはほとんどの場合、`Payment` [トランザクションタイプ](transaction-types.html)のXRP Ledgerトランザクションに対応します。ただし Data APIでは、送金元`Account` と`Destination`アカウントが同一である場合、またはトランザクションが失敗した場合には、トランザクションはペイメントとして見なされません。 - -ペイメントオブジェクトのフィールドを次に示します。 - -| フィールド | 値 | 説明 | -|:------------------------------|:---------------------------|:----------------| -| `amount` | [文字列 - 数値][] | トランザクションに対し送金指示があった送金先`currency`の額。Partial Paymentsでは、この額は「最大」額です。 | -| `delivered_amount` | [文字列 - 数値][] | 実際に送金先アカウントが受領した送金先`currency`の額。 | -| `destination_balance_changes` | 配列 | [残高変更オブジェクト][]の配列。このオブジェクトは、`destination`アカウントの残高に対して行われたすべての変更を示します。 | -| `source_balance_changes` | 配列 | [残高変更オブジェクト][]の配列。このオブジェクトは、`source`アカウントの残高に対して行われたすべての変更を示します（XRPトランザクションコストを除く）。 | -| `transaction_cost` | [文字列 - 数値][] | トランザクションコストに対して`source`アカウントが支払ったXRPの額。（[v2.0.4][]より前のバージョンでは、このパラメーターは`fee`でした。） | -| `destination_tag` | 整数 | （省略される場合があります）このペイメントに指定された[送金先タグ](become-an-xrp-ledger-gateway.html#source-and-destination-tags)。 | -| `source_tag` | 整数 | （省略される場合があります）このペイメントに指定された[送金元タグ](become-an-xrp-ledger-gateway.html#source-and-destination-tags)。 | -| `currency` | 文字列 - [通貨コード][] | `destination`アカウントが受領した通貨。 | -| `destination` | 文字列 - [アドレス][] | ペイメントを受領したアカウント。 | -| `executed_time` | 文字列 - [タイムスタンプ][] | このペイメントが含まれているレジャーが閉鎖した時刻。 | -| `ledger_index` | 数値 - [レジャーインデックス][] | このペイメントが含まれているレジャーのシーケンス番号。 | -| `source` | 文字列 - [アドレス][] | ペイメントを送金したアカウント。 | -| `source_currency` | 文字列 - [通貨コード][] | `source`アカウントが支払った通貨。 | -| `tx_hash` | 文字列 - [ハッシュ][] | このペイメントを発生させたトランザクションの識別用ハッシュ。 | - - -## 残高オブジェクトと残高変更オブジェクト -[残高変更オブジェクト]: #残高オブジェクトと残高変更オブジェクト -[残高オブジェクト]: #残高オブジェクトと残高変更オブジェクト - -残高オブジェクトは、特定時点での特定の相手側に対する特定通貨でのXRP Ledgerアカウントの残高です。残高変更オブジェクトは、トランザクションの実行時に発生するこのような残高に対する変更を表します。 - -1つのXRP Ledgerトランザクションで、複数の相手側に対する残高の変更と、XRPの変更が行われることがあります。 - -残高オブジェクトと残高変更オブジェクトのフォーマットは同一であり、これらのオブジェクトには次のフィールドが含まれています。 - -| フィールド | 値 | 説明 | -|:---------------|:---------------------------|:-------------------------------| -| `counterparty` | 文字列 - [アドレス][] | `currency`の取引相手またはイシュアー。XRPの場合これは空の文字列です。 | -| `currency` | 文字列 - [通貨コード][] | この残高が変更された通貨。 | -| `value` | [文字列 - 数値][] | 関連付けられているアカウントが獲得または喪失した`currency`の額。残高変更オブジェクトでは、この値がプラスの場合（獲得した額）とマイナスの場合（喪失した額）があります。残高オブジェクトでは、この値がプラスの場合（このアカウントに対して相手側が支払う義務のある額）とマイナスの場合（相手側に対して支払う義務のある額）があります。 | - - -## 残高変更記述 -[残高変更記述]: #残高変更記述 - -残高変更記述は、トランザクションの実行時に発生する1つの残高変更を記述、分析するオブジェクトです。[残高変更オブジェクト][]と同じイベントを表しますが、残高変更オブジェクトよりも詳細です。 - -残高変更記述のフィールドを次に示します。 - -| フィールド | 値 | 説明 | -|:----------------|:---------------------------|:------------------------------| -| `amount_change` | [文字列 - 数値][] | この変更前後での保有通貨額の差。_（[v2.0.6][]より前のバージョンでは、このフィールドは`change`でした。）_ | -| `final_balance` | [文字列 - 数値][] | 変更後の残高。 | -| `node_index` | 数値（または`null`） | この残高変更は、残高変更を実行したトランザクションのメタデータセクション内にて、ModifiedNodes配列のこのインデックスの位置にあるエントリーで表されます。**注記:** トランザクションコストがXRP残高に対する他の変更と結合されている場合、トランザクションコストの`node_index`は**null**になります。 | -| `tx_index` | 数値 | この残高変更を実行したトランザクションは、トランザクションが記録されているレジャーのトランザクション配列のこのインデックスにあります。 | -| `change_type` | 文字列 | この残高変更が発生した原因を示すさまざまな[](#変更タイプ)のうちの1つ。 | -| `currency` | 文字列 - [通貨コード][] | この通貨に影響する変更。 | -| `executed_time` | 文字列 - [タイムスタンプ][] | 変更が発生した時刻。（変更を実行したトランザクションが記録されているレジャーの閉鎖時間に基づいています。） | -| `counterparty` | 文字列 - [アドレス][] | （XRPの場合は省略）`currency`はこのアカウントとの間のトラストラインに保有されています。_（[v2.0.6][]より前のバージョンでは、このフィールドは`issuer`でした。）_ | -| `ledger_index` | 数値 - [レジャーインデックス][] | この残高変更を実行したトランザクションを含むレジャーのシーケンス番号。 | -| `tx_hash` | 文字列 - [ハッシュ][] | この残高変更を実行したトランザクションの識別用ハッシュ。 | - -### 変更タイプ - -残高変更記述の`change_type`フィールドで有効な値を以下に示します。 - -| 値 | 意味 | -|:----------------------|:-----------------------------------------------------| -| `transaction_cost` | これは、トランザクションの中継時にXRPが消却されたことによる残高変更を表します。_（[v2.0.4][]より前では、これは`network fee`でした。）_ | -| `payment_destination` | これは、ペイメントとして通貨を受領したことによる残高変更を表します。 | -| `payment_source` | これは、ペイメントとして通貨を支払ったことによる残高変更を表します。 | -| `exchange` | これは、他の通貨への取引や、別のイシュア―との同一通貨での取引による残高変更を表します。これは、オファーにより発生するだけでなく、ペイメント実行中にも発生する可能性があります。 | - -## 取引量オブジェクト -[取引量オブジェクト]: #取引量オブジェクト - -取引量オブジェクトは、特定の期間にペイメントや取引により移動した資金の合計取引量を表します。 - -| フィールド | 値 | 説明 | -|:----------------|:-----------------------|:----------------------------------| -| `components` | オブジェクトの配列 | この合計の計算に使用されたデータ。ペイメント取引量の場合、各オブジェクトは特定の通貨およびイシュアーでのペイメントを表します。取引量の場合、各オブジェクトは2通貨間のマーケットを表します。 | -| `count` | 数値 | この期間における取引の合計件数。 | -| `end_time` | 文字列 - [タイムスタンプ][] | この間隔の終了時刻。 | -| `exchange` | オブジェクト | `currency`および（XRPの場合を除く） `issuer`フィールドと同様、使用される表示通貨を示します。すべての額は、最初にXRPに交換され、その後要求で指定されている表示通貨に変換されることで正規化されます。 | -| `exchange_rate` | 数値 | XRPから表示通貨への為替レート。 | -| `start_time` | 文字列 - [タイムスタンプ][] | この期間の開始時刻。 | -| `total` | 数値 | 当該期間に記録されたすべての取引の合計取引量。 | - - -## サーバーオブジェクト -[サーバーオブジェクト]: #サーバーオブジェクト -[サーバーオブジェクト]: #サーバーオブジェクト - -「サーバーオブジェクト」は、XRP Ledgerピアツーピアネットワークの1つの`rippled`サーバーを表します。サーバーオブジェクトは[Get Topology](#get-topology)、[Get Toplogy Nodes](#get-topology-nodes)、および[Get Topology Node](#get-topology-node)メソッドで返されます。Data APIは、[ピアクローラー](peer-crawler.html)を使用して、報告されるネットワークトポロジーを約30秒間隔で収集します。 - -サーバーオブジェクトのフィールドを次に示します。一部のフィールドは、要求で応答がverboseであることが指定されている場合にのみ表示されます。 - -| フィールド | 値 | 説明 | -|:-------------------|:--------------------------------|:----------------------| -| `node_public_key` | 文字列 - Base-58 [公開鍵][] | このサーバーがピアツーピア通信に署名するときに使用する公開鍵（検証は含まれません）。 | -| `version` | 文字列 | 最後に照会された時点でのこのサーバーの`rippled`バージョン。 | -| `uptime` | 整数 | このサーバーがネットワークに接続していた秒数。 | -| `ip` | 文字列 | （省略される場合があります）ノードのIPアドレス。 | -| `port` | 整数 | （省略される場合があります）このサーバーが[`rippled`ピアプロトコル](peer-protocol.html)を使用するポート。 | -| `inbound_count` | 整数 | （省略される場合があります）このサーバーへの着信ピアツーピア接続の数。 | -| `inbound_added` | 文字列 | （省略される場合があります）最終測定以降に追加された新規着信ピアツーピア接続の数。 | -| `inbound_dropped` | 文字列 | （省略される場合があります）最終測定以降に削除された着信ピアツーピア接続の数。 | -| `outbound_count` | 整数 | （省略される場合があります）このサーバーへの発信ピアツーピア接続の数。 | -| `outbound_added` | 文字列 | （省略される場合があります）最終測定以降に削除された新規発信ピアツーピア接続の数。 | -| `outbound_dropped` | 文字列 | （省略される場合があります）最終測定以降に削除された発信ピアツーピア接続の数。 | -| `city` | 文字列 | （verboseが設定されている場合のみ）IP位置情報に基づくこのサーバーの所在地の市町村。 | -| `region` | 文字列 | （verboseが設定されている場合のみ）IP位置情報に基づくこのサーバーの所在地の地域。 | -| `country` | 文字列 | （verboseが設定されている場合のみ）IP位置情報に基づくこのサーバーの所在地の国。 | -| `region_code` | 文字列 | （verboseが設定されている場合のみ）IP位置情報に基づくこのサーバーの所在地の地域のISOコード。 | -| `country_code` | 文字列 | （verboseが設定されている場合のみ）IP位置情報に基づくこのサーバーの所在地の国のISOコード。 | -| `postal_code` | 文字列 | （verboseが設定されている場合のみ）IP位置情報に基づくこのサーバーの所在地の郵便番号。 | -| `timezone` | 文字列 | （verboseが設定されている場合のみ）IP位置情報に基づくこのサーバーの所在地のISOタイムゾーン。 | -| `lat` | 文字列 | （verboseが設定されている場合のみ）IP位置情報に基づくこのサーバーの所在地の緯度。 | -| `long` | 文字列 | （verboseが設定されている場合のみ）IP位置情報に基づくこのサーバーの所在地の経度。 | -| `isp` | 文字列 | （verboseが設定されている場合のみ）このサーバーのパブリックIPアドレスをホストするインターネットサービスプロバイダー。 | -| `org` | 文字列 | （verboseが設定されている場合のみ）このサーバーのパブリックIPアドレスを所有する組織。 | - - -## リンクオブジェクト -[リンクオブジェクト]: #リンクオブジェクト -[リンクオブジェクト]: #リンクオブジェクト - -リンクオブジェクトは、2つの`rippled`サーバー間のピアツーピアネットワーク接続を表します。次のフィールドが含まれています。 - -| フィールド | 値 | 説明 | -|:---------|:--------------------------------|:--------------------------------| -| `source` | 文字列 - Base-58 [公開鍵][] | 発信接続を行う`rippled`のノード公開鍵。 | -| `target` | 文字列 - Base-58 [公開鍵][] | 着信接続を受け取る`rippled`のノード公開鍵。 | - - -## 検証オブジェクト -[検証オブジェクト]: #検証オブジェクト -[検証オブジェクト]: #検証オブジェクト - -検証オブジェクトは、レジャーバージョンを検証済みにするためにバリデータが投じる1票を表します。（レジャーは、同一のレジャーバージョンに対して投票した信頼できるバリデータの数が定数に達した場合に、コンセンサスプロセスによってのみ検証済みになります。） - -**注記:** Data APIは検証投票データを6か月間だけ保持します。 - -検証オブジェクトのフィールドを次に示します。 - -| フィールド | 値 | 説明 | -|:------------------------|:--------------------------------|:-----------------| -| `count` | 整数 | （省略される場合があります）この検証を参照した旨を報告した`rippled`サーバーの数。古いデータでは使用できません。 | -| `ledger_hash` | 文字列 - [ハッシュ][] | この検証投票が適用されるレジャーバージョンのハッシュ。 | -| `reporter_public_key` | 文字列 - Base-58 [公開鍵][] | 最初にこの検証を報告した`rippled`サーバーの公開鍵（base-58）。 | -| `validation_public_key` | 文字列 - Base-58 [公開鍵][] | この検証の署名に使用されたバリデータの公開鍵（base-58）。 | -| `signature` | 文字列 | 検証内容についてのバリデータの署名（16進数）。 | -| `first_datetime` | 文字列 - [タイムスタンプ][] | この検証の最初の報告の日時。 | -| `last_datetime` | 文字列 - [タイムスタンプ][] | この検証の最終報告の日時。 | - - - - - -{% include '_snippets/rippled-api-links.md' %} +廃止されましたRipple Data APIについては[rippled-historical-database レポジトリー](https://github.com/ripple/rippled-historical-database)をご覧下さい. diff --git a/content/references/data-api.md b/content/references/data-api.md index a31fca660b..99230a7b5b 100644 --- a/content/references/data-api.md +++ b/content/references/data-api.md @@ -1,5314 +1,12 @@ --- html: data-api.html parent: references.html -blurb: RESTful interface to XRP Ledger analytics and historical data. -curated_anchors: - - name: Methods - anchor: "#api-method-reference" - - name: API Conventions - anchor: "#api-conventions" +blurb: (DEPRECATED) RESTful interface to XRP Ledger analytics and historical data. +status: removed +nav_omit: true --- # Ripple Data API v2 -**Warning:** The Ripple Data API v2 is deprecated with no ongoing support. Please use the [`rippled` API](https://xrpl.org/rippled-api.html) instead. +**Warning:** The Ripple Data API v2 is deprecated with no ongoing support. Please use the native [XRP Ledger HTTP APIs](rippled-api.html) instead. -The Ripple Data API v2 provides access to information about changes in the XRP Ledger, including transaction history and processed analytical data. This information is stored in a dedicated database, with a REST-like interface to present the data in various formats. - -Ripple provides the Data API as a public service at the following address: - -[**https://data.ripple.com**](https://data.ripple.com) - -**Note:** This API and the data it provides are derived from the public, decentralized XRP Ledger. They are provided for free, but also provided “as is,” without any express, implied, or statutory warranties including but not limited to the implied warranties of merchantability or fitness for a particular purpose, and all warranties are disclaimed. The API and data may be unavailable at times, they may change, or they may have errors, so please use them at your own risk and exercise appropriate caution before incorporating them into your infrastructure. - - -## More Information -The Ripple Data API v2 replaces the Historical Database v1 and the [Charts API](https://github.com/ripple/ripple-data-api/). - -* [API Methods](#api-method-reference) -* [API Conventions](#api-conventions) -* [Source Code on Github](https://github.com/ripple/rippled-historical-database) -* [Release Notes](https://github.com/ripple/rippled-historical-database/releases) - -[v2.0.4]: https://github.com/ripple/rippled-historical-database/releases/tag/v2.0.4 -[v2.0.5]: https://github.com/ripple/rippled-historical-database/releases/tag/v2.0.5 -[v2.0.6]: https://github.com/ripple/rippled-historical-database/releases/tag/v2.0.6 -[v2.0.7]: https://github.com/ripple/rippled-historical-database/releases/tag/v2.0.7 -[v2.0.8]: https://github.com/ripple/rippled-historical-database/releases/tag/v2.0.8 -[v2.1.0]: https://github.com/ripple/rippled-historical-database/releases/tag/v2.1.0 -[v2.2.0]: https://github.com/ripple/rippled-historical-database/releases/tag/v2.2.0 -[v2.3.0]: https://github.com/ripple/rippled-historical-database/releases/tag/v2.3.0 -[v2.3.2]: https://github.com/ripple/rippled-historical-database/releases/tag/v2.3.2 -[v2.3.5]: https://github.com/ripple/rippled-historical-database/releases/tag/v2.3.5 -[v2.3.7]: https://github.com/ripple/rippled-historical-database/releases/tag/v2.3.7 -[v2.4.0]: https://github.com/ripple/rippled-historical-database/releases/tag/v2.4.0 - - -# API Method Reference - -The Data API v2 provides a REST API with the following methods: - -Ledger Contents Methods: - -* [Get Ledger - `GET /v2/ledgers/{ledger_identifier}`](#get-ledger) -* [Get Transaction - `GET /v2/transactions/{hash}`](#get-transaction) -* [Get Transactions - `GET /v2/transactions/`](#get-transactions) -* [Get Payments - `GET /v2/payments/{currency}`](#get-payments) -* [Get Exchanges - `GET /v2/exchanges/{base}/{counter}`](#get-exchanges) -* [Get Exchange Rates - `GET /v2/exchange_rates/{base}/{counter}`](#get-exchange-rates) -* [Normalize - `GET /v2/normalize`](#normalize) -* [Get Daily Reports - `GET /v2/reports/`](#get-daily-reports) -* [Get Stats - `GET /v2/stats/`](#get-stats) -* [Get Active Accounts - `GET /v2/active_accounts/{base}/{counter}`](#get-active-accounts) -* [Get Exchange Volume - `GET /v2/network/exchange_volume`](#get-exchange-volume) -* [Get Payment Volume - `GET /v2/network/payment_volume`](#get-payment-volume) -* [Get External Markets - `GET /v2/network/external_markets`](#get-external-markets) -* [Get XRP Distribution - `GET /v2/network/xrp_distribution`](#get-xrp-distribution) -* [Get Top Currencies - `GET /v2/network/top_currencies`](#get-top-currencies) -* [Get Top Markets - `GET /v2/network/top_markets`](#get-top-markets) - -Account Methods: - -* [Get Account - `GET /v2/accounts/{address}`](#get-account) -* [Get Accounts - `GET /v2/accounts`](#get-accounts) -* [Get Account Balances - `GET /v2/accounts/{address}/balances`](#get-account-balances) -* [Get Account Orders - `GET /v2/accounts/{address}/orders`](#get-account-orders) -* [Get Account Transaction History - `GET /v2/accounts/{address}/transactions`](#get-account-transaction-history) -* [Get Transaction By Account and Sequence - `GET /v2/accounts/{address}/transactions/{sequence}`](#get-transaction-by-account-and-sequence) -* [Get Account Payments - `GET /v2/accounts/{address}/payments`](#get-account-payments) -* [Get Account Exchanges - `GET /v2/accounts/{address}/exchanges`](#get-account-exchanges) -* [Get Account Balance Changes - `GET /v2/accounts/{address}/balance_changes`](#get-account-balance-changes) -* [Get Account Reports - `GET /v2/accounts/{address}/reports`](#get-account-reports) -* [Get Account Transaction Stats - `GET /v2/accounts/{address}/stats/transactions`](#get-account-transaction-stats) -* [Get Account Value Stats - `GET /v2/accounts/{address}/stats/value`](#get-account-value-stats) - -External Information Methods: - -* [Get All Gateways - `GET /v2/gateways`](#get-all-gateways) -* [Get Gateway - `GET /v2/gateways/{gateway}`](#get-gateway) -* [Get Currency Image - `GET /v2/currencies/{currencyimage}`](#get-currency-image) - -Validation Network Methods: - -* [Get Transaction Costs - `GET /v2/network/fees`](#get-transaction-costs) -* [Get Fee Stats - `GET /v2/network/fee_stats`](#get-fee-stats) -* [Get Ledger Validations - `GET /v2/ledger/{hash}/validations`](#get-ledger-validations) -* [Get Ledger Validation - `GET /v2/ledger/{hash}/validations/{pubkey}`](#get-ledger-validation) -* [Get Topology - `GET /v2/network/topology`](#get-topology) -* [Get Topology Nodes - `GET /v2/network/topology/nodes`](#get-topology-nodes) -* [Get Topology Node - `GET /v2/network/topology/nodes/{pubkey}`](#get-topology-node) -* [Get Topology Links - `GET /v2/network/topology/links`](#get-topology-links) -* [Get Validator - `GET /v2/network/validators/{pubkey}`](#get-validator) -* [Get Validators - `GET /v2/network/validators`](#get-validators) -* [Get Validator Manifests - `GET /v2/network/validators/{pubkey}/manifests`](#get-validator-manifests) -* [Get Single Validator Reports - `GET /v2/network/validators/{pubkey}/reports`](#get-single-validator-reports) -* [Get Daily Validator Reports - `GET /v2/network/validator_reports`](#get-daily-validator-reports) -* [Get `rippled` Versions - `GET /v2/network/rippled_versions`](#get-rippled-versions) - -Health Checks: - -* [API Health Check - `GET /v2/health/api`](#health-check-api) -* [Importer Health Check - `GET /v2/health/importer`](#health-check-ledger-importer) -* [Nodes ETL Health Check - `GET /v2/health/nodes_etl`](#health-check-nodes-etl) -* [Validations ETL Health Check - `GET /v2/health/validations_etl`](#health-check-validations-etl) - - -## Get Ledger -[[Source]](https://github.com/ripple/rippled-historical-database/blob/master/api/routes/getLedger.js "Source") - -Retrieve a specific Ledger by hash, index, date, or latest validated. - -#### Request Format - - - -*REST* - -``` -GET /v2/ledgers/{identifier} -``` - - - -[Try it! >](data-api-v2-tool.html#get-ledger) - -This method requires the following URL parameters: - -| Field | Value | Description | -|:--------------------|:----------------------------------------------------|:--| -| `ledger_identifier` | Ledger [Hash][], [Ledger Index][], or [Timestamp][] | _(Optional)_ An identifier for the ledger to retrieve: either the full hash in hex, an integer ledger index, or a date-time. If a date-time is provided, retrieve the ledger that was most recently closed at that time. If omitted, retrieve the latest validated ledger. | - -Optionally, you can provide the following query parameters: - -| Field | Value | Description | -|:---------------|:--------|:--------------------------------------------------| -| `transactions` | Boolean | If `true`, include the identifying hashes of all transactions that are part of this ledger. | -| `binary` | Boolean | If `true`, include all transactions from this ledger as hex-formatted binary data. (If provided, overrides `transactions`.) | -| `expand` | Boolean | If `true`, include all transactions from this ledger as nested JSON objects. (If provided, overrides `binary` and `transactions`.) | - -#### Response Format - -A successful response uses the HTTP code **200 OK** and has a JSON body with the following: - -| Field | Value | Description | -|:---------|:---------------------------------|:-------------------------------| -| `result` | String | The value `success` indicates that this is a successful response. | -| `ledger` | [Ledger object](#ledger-objects) | The requested ledger. | - -#### Example - -Request: - -``` -GET /v2/ledgers/3170DA37CE2B7F045F889594CBC323D88686D2E90E8FFD2BBCD9BAD12E416DB5 -``` - -Response: - -``` -200 OK -{ - "result": "success", - "ledger": { - "ledger_hash": "3170da37ce2b7f045f889594cbc323d88686d2e90e8ffd2bbcd9bad12e416db5", - "ledger_index": 8317037, - "parent_hash": "aff6e04f07f441abc6b4133f8c50c65935b817a85b895f06dba098b3fbc1be90", - "total_coins": 99999980165594400, - "close_time_res": 10, - "accounts_hash": "8ad73e49a34d8b9c31bc13b8a97c56981e45ee70225ef4892e8b198fec5a1f7d", - "transaction_hash": "33e0b9c5fd7766343e67854aed4222f5ed9c9507e0ec0d7ae7d54d0f17adb98e", - "close_time": 1408047740, - "close_time_human": "2014-08-14T20:22:20+00:00" - } -} -``` - - - -## Get Ledger Validations -[[Source]](https://github.com/ripple/rippled-historical-database/blob/master/api/routes/getLedger.js "Source") - -Retrieve a any validations recorded for a specific ledger hash. This dataset includes ledger versions that are outside the validated ledger chain. _(New in [v2.2.0][])_ - -**Note:** The Data API does not have a comprehensive record of all validations. The response only includes data that the Data API has recorded. Some ledger versions, especially older ledgers, may have no validations even if they were validated by consensus. - -#### Request Format - - - -*REST* - -``` -GET /v2/ledgers/{ledger_hash}/validations -``` - - - -[Try it! >](data-api-v2-tool.html#get-ledger-validations) - -This method requires the following URL parameters: - -| Field | Value | Description | -|:--------------|:---------|:-----------------------------------------| -| `ledger_hash` | [Hash][] | Ledger hash to retrieve validations for. | - -Optionally, you can provide the following query parameters: - -| Field | Value | Description | -|:---------|:--------|:--------------------------------------------------------| -| `limit` | Integer | Maximum results per page. The default is 200. Cannot be more than 1000. | -| `marker` | String | [Pagination](#pagination) key from previously returned response. | -| `format` | String | Format of returned results: `csv` or `json`. The default is `json`. | - -#### Response Format - -A successful response uses the HTTP code **200 OK** and has a JSON body with the following: - -| Field | Value | Description | -|:--------------|:--------------------------------|:---------------------------| -| `result` | String - `success` | Indicates that the body represents a successful response. | -| `ledger_hash` | String - [Hash][] | The identifying hash of the ledger version requested. | -| `count` | Integer | Number of validations returned. | -| `marker` | String | (May be omitted) [Pagination](#pagination) marker. | -| `validations` | Array of [Validation Objects][] | All known validation votes for the ledger version. | - - -#### Example - -Request: - -``` -GET /v2/ledgers/A10E9E338BA365D2B768814EC8B0A9A2D8322C0040735E20624AF711C5A593E7/validations?limit=2 -``` - -Response: - -``` -200 OK -{ - "result": "success", - "ledger_hash": "A10E9E338BA365D2B768814EC8B0A9A2D8322C0040735E20624AF711C5A593E7", - "count": 2, - "marker": "A10E9E338BA365D2B768814EC8B0A9A2D8322C0040735E20624AF711C5A593E7|n9KDJnMxfjH5Ez8DeWzWoE9ath3PnsmkUy3GAHiVjE7tn7Q7KhQ2|20160608001732", - "validations": [ - { - "count": 27, - "first_datetime": "2016-06-08T00:17:32.352Z", - "last_datetime": "2016-06-08T00:17:32.463Z", - "ledger_hash": "A10E9E338BA365D2B768814EC8B0A9A2D8322C0040735E20624AF711C5A593E7", - "reporter_public_key": "n9KJb7NMxGySRcjCqh69xEPMUhwJx22qntYYXsnUqYgjsJhNoW7g", - "signature": "304402204C751D0033070EBC008786F0ECCA8E29195FD7DD8D22498EB6E4E732905FC7090220091F458976904E7AE4633A1EC405175E6A126798E4896DD452853B887B1E6359", - "validation_public_key": "n949f75evCHwgyP4fPVgaHqNHxUVN15PsJEZ3B3HnXPcPjcZAoy7" - }, - { - "count": 3, - "first_datetime": "2016-06-08T00:17:32.653Z", - "last_datetime": "2016-06-08T00:17:32.673Z", - "ledger_hash": "A10E9E338BA365D2B768814EC8B0A9A2D8322C0040735E20624AF711C5A593E7", - "reporter_public_key": "n9JCK5AML7Ejv3TcJmnvJk5qeYhf7Q9YwScjz5PhtUbtWCKH3NAm", - "signature": "3045022100A48E5AF6EA9D0ACA6FDE18536081A7D2182535579EA580C3D0B0F18C2556C5D30220521615A3D677376069F8F3E608B59F14482DDE4CD2A304DE578B6CCE2F5E8D54", - "validation_public_key": "n9K6YbD1y9dWSAG2tbdFwVCtcuvUeNkBwoy9Z6BmeMra9ZxsMTuo" - } - ] -} -``` - - - -## Get Ledger Validation -[[Source]](https://github.com/ripple/rippled-historical-database/blob/master/api/routes/getLedger.js "Source") - -Retrieve a validation vote recorded for a specific ledger hash by a specific validator. This dataset includes ledger versions that are outside the validated ledger chain. _(New in [v2.2.0][])_ - -**Note:** The Data API does not have a comprehensive record of all validations. The response only includes data that the Data API has recorded. Some ledger versions, especially older ledgers, may have no validations even if they were validated by consensus. - -#### Request Format - - - -*REST* - -``` -GET /v2/ledgers/{ledger_hash}/validations/{pubkey} -``` - - - -[Try it! >](data-api-v2-tool.html#get-ledger-validation) - -This method requires the following URL parameters: - -| Field | Value | Description | -|:--------------|:--------------------------------|:---------------------------| -| `ledger_hash` | [Hash][] | Ledger hash to retrieve validations for. | -| `pubkey` | String - Base-58 [Public Key][] | Validator public key. | - -This request takes no query parameters. - -#### Response Format - -A successful response uses the HTTP code **200 OK** and has a JSON body containing a **[Validation Object][]** with the following additional field: - -| Field | Value | Description | -|:---------|:-------|:---------------------------------------------------------| -| `result` | String | The value `success` indicates that this is a successful response. | - -#### Example - -Request: - -``` -GET /v2/ledgers/A10E9E338BA365D2B768814EC8B0A9A2D8322C0040735E20624AF711C5A593E7/validations/n949f75evCHwgyP4fPVgaHqNHxUVN15PsJEZ3B3HnXPcPjcZAoy7 -``` - -Response: - -``` -200 OK -{ - "count": 27, - "first_datetime": "2016-06-08T00:17:32.352Z", - "last_datetime": "2016-06-08T00:17:32.463Z", - "ledger_hash": "A10E9E338BA365D2B768814EC8B0A9A2D8322C0040735E20624AF711C5A593E7", - "reporter_public_key": "n9KJb7NMxGySRcjCqh69xEPMUhwJx22qntYYXsnUqYgjsJhNoW7g", - "signature": "304402204C751D0033070EBC008786F0ECCA8E29195FD7DD8D22498EB6E4E732905FC7090220091F458976904E7AE4633A1EC405175E6A126798E4896DD452853B887B1E6359", - "validation_public_key": "n949f75evCHwgyP4fPVgaHqNHxUVN15PsJEZ3B3HnXPcPjcZAoy7", - "result": "success" -} -``` - - - -## Get Transaction -[[Source]](https://github.com/ripple/rippled-historical-database/blob/master/api/routes/getTransactions.js "Source") - -Retrieve a specific transaction by its identifying hash. - -#### Request Format - - - -*REST* - -``` -GET /v2/transactions/{hash} -``` - - - -[Try it! >](data-api-v2-tool.html#get-transaction) - -This method requires the following URL parameters: - -| Field | Value | Description | -|:-------|:------------------|:-----------------------------------------| -| `hash` | String - [Hash][] | The identifying hash of the transaction. | - -Optionally, you can provide the following query parameters: - -| Field | Value | Description | -|:---------|:--------|:--------------------------------------------------------| -| `binary` | Boolean | If `true`, return transaction data in binary format, as a hex string. Otherwise, return transaction data as nested JSON. The default is `false`. | - -#### Response Format - -A successful response uses the HTTP code **200 OK** and has a JSON body with the following: - -| Field | Value | Description | -|:--------------|:-----------------------|:------------------------------------| -| `result` | String | The value `success` indicates that this is a successful response. | -| `transaction` | [Transaction object][] | The requested transaction. | - -[Transaction object]: #transaction-objects - -#### Example - -Request: - -``` -GET /v2/transactions/03EDF724397D2DEE70E49D512AECD619E9EA536BE6CFD48ED167AE2596055C9A -``` - -Response (trimmed for size): - -```js -200 OK -{ - "result": "success", - "transaction": { - "ledger_index": 8317037, - "date": "2014-08-14T20:22:20+00:00", - "hash": "03EDF724397D2DEE70E49D512AECD619E9EA536BE6CFD48ED167AE2596055C9A", - "tx": { - "TransactionType": "OfferCreate", - "Flags": 131072, - "Sequence": 159244, - "TakerPays": { - "value": "0.001567373", - "currency": "BTC", - "issuer": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B" - }, - "TakerGets": "146348921", - "Fee": "64", - "SigningPubKey": "02279DDA900BC53575FC5DFA217113A5B21C1ACB2BB2AEFDD60EA478A074E9E264", - "TxnSignature": "3045022100D81FFECC36A3DEF0922EB5D16F1AA5AA0804C30A18ED3B512093A75E87C81AD602206B221E22A4E3158785C109E7508624AD3DE5C0E06108D34FA709FCC9575C9441", - "Account": "r2d2iZiCcJmNL6vhUGFjs8U8BuUq6BnmT" - }, - "meta": { - "TransactionIndex": 0, - "AffectedNodes": [ - { - "ModifiedNode": { - "LedgerEntryType": "AccountRoot", - "PreviousTxnLgrSeq": 8317036, - "PreviousTxnID": "A56793D47925BED682BFF754806121E3C0281E63C24B62ADF7078EF86CC2AA53", - "LedgerIndex": "2880A9B4FB90A306B576C2D532BFE390AB3904642647DCF739492AA244EF46D1", - "PreviousFields": { - "Balance": "275716601760" - }, - "FinalFields": { - "Flags": 0, - "Sequence": 326323, - "OwnerCount": 27, - "Balance": "275862935331", - "Account": "rfCFLzNJYvvnoGHWQYACmJpTgkLUaugLEw", - "RegularKey": "rfYqosNivHQFJ6KpArouxoci3QE3huKNYe" - } - } - }, - - ... - ], - "TransactionResult": "tesSUCCESS" - } - } -} -``` - - - - - -## Get Transactions -[[Source]](https://github.com/ripple/rippled-historical-database/blob/master/api/routes/getTransactions.js "Source") - -Retrieve transactions by time - -#### Request Format - - - -*REST* - -``` -GET /v2/transactions/ -``` - - - -[Try it! >](data-api-v2-tool.html#get-transactions) - -Optionally, you can provide 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 | If `true`, return results in reverse chronological order. The default is `false`. | -| `type` | String | Filter transactions to a specific [transaction type](transaction-types.html). | -| `result` | String | Filter transactions for a specific [transaction result](transaction-results.html). | -| `binary` | Boolean | If `true`, return transactions in binary form. The default is `false`. | -| `limit` | Integer | Maximum results per page. The default is 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: - -| Field | Value | Description | -|:---------------|:---------------------------------|:-------------------------| -| `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 objects][] | The requested transactions. | - -[Transaction objects]: #transaction-objects - -#### Example - -Request: - -``` -GET /v2/transactions/?result=tecPATH_DRY&limit=2&type=Payment -``` - -Response: - -``` -200 OK -{ - "result": "success", - "count": 2, - "marker": "20130106022000|000000053869|00000", - "transactions": [ - { - "hash": "B8E4335A94438EC8209135A4E861A4C88F988C651B819DDAF2E8C55F9B41E589", - "date": "2013-01-02T20:13:40+00:00", - "ledger_index": 40752, - "ledger_hash": "55A900C2BA9483DC83F8FC065DE7789570662365BDE98EB75C5F4CE4F9B43214", - "tx": { - "TransactionType": "Payment", - "Flags": 0, - "Sequence": 61, - "Amount": { - "value": "96", - "currency": "USD", - "issuer": "rJ6VE6L87yaVmdyxa9jZFXSAdEFSoTGPbE" - }, - "Fee": "10", - "SigningPubKey": "02082622E4DA1DC6EA6B38A48956D816881E000ACF0C5F5B52863B9F698799D474", - "TxnSignature": "304402200A0746192EBC7BC3C1B9D657F42B6345A49D75FE23EF340CB6F0427254C139D00220446BF9169C94AEDC87F56D01DB011866E2A67E2AADDCC45C4D11422550D044CB", - "Account": "rB5TihdPbKgMrkFqrqUC3yLdE8hhv4BdeY", - "Destination": "rJ6VE6L87yaVmdyxa9jZFXSAdEFSoTGPbE" - }, - "meta": { - "TransactionIndex": 0, - "AffectedNodes": [ - { - "ModifiedNode": { - "LedgerEntryType": "AccountRoot", - "PreviousTxnLgrSeq": 40212, - "PreviousTxnID": "F491DC8B5E51045D4420297293199039D5AE1EA0C6D62CAD9A973E3C89E40CD6", - "LedgerIndex": "9B242A0D59328CE964FFFBFF7D3BBF8B024F9CB1A212923727B42F24ADC93930", - "PreviousFields": { - "Sequence": 61, - "Balance": "8178999999999400" - }, - "FinalFields": { - "Flags": 0, - "Sequence": 62, - "OwnerCount": 6, - "Balance": "8178999999999390", - "Account": "rB5TihdPbKgMrkFqrqUC3yLdE8hhv4BdeY" - } - } - } - ], - "TransactionResult": "tecPATH_DRY" - } - }, - { - "hash": "1E1C14BF5E61682F3DC9D035D9908816497B8E8843E05C0EE98E06DFDDDAE920", - "date": "2013-01-05T08:43:10+00:00", - "ledger_index": 51819, - "ledger_hash": "88ED10E4E31FC7580285CF173B264690B0E8688A3FC9F5F9C62F1A295B96269D", - "tx": { - "TransactionType": "Payment", - "Flags": 0, - "Sequence": 10, - "Amount": { - "value": "2", - "currency": "EUR", - "issuer": "rfitr7nL7MX85LLKJce7E3ATQjSiyUPDfj" - }, - "Fee": "10", - "SigningPubKey": "03FDDCD97668B686100E60653FD1E5210A8310616669AACB3A1FCC6D2C090CCB32", - "TxnSignature": "304402204F9BB7E37C14A3A3762E2A7DADB9A28D1AFFB3797521229B6FB98BA666B5491B02204F69AAEAFAC8FA473E52042FF06035AB3618A54E0B76C9852766D55184E98598", - "Account": "rhdAw3LiEfWWmSrbnZG3udsN7PoWKT56Qo", - "Destination": "rfitr7nL7MX85LLKJce7E3ATQjSiyUPDfj" - }, - "meta": { - "TransactionIndex": 0, - "AffectedNodes": [ - { - "ModifiedNode": { - "LedgerEntryType": "AccountRoot", - "PreviousTxnLgrSeq": 51814, - "PreviousTxnID": "5EC1C179996BD87E2EB11FE60A37ADD0FB2229ADC7D13B204FAB04FABED8A38D", - "LedgerIndex": "AC1B67084F84839A3158A4E38618218BF9016047B1EE435AECD4B02226AB2105", - "PreviousFields": { - "Sequence": 10, - "Balance": "10000999910" - }, - "FinalFields": { - "Flags": 0, - "Sequence": 11, - "OwnerCount": 2, - "Balance": "10000999900", - "Account": "rhdAw3LiEfWWmSrbnZG3udsN7PoWKT56Qo" - } - } - } - ], - "TransactionResult": "tecPATH_DRY" - } - } - ] -} -``` - - - -## Get Payments -[[Source]](https://github.com/ripple/rippled-historical-database/blob/master/api/routes/getPayments.js "Source") - -Retrieve Payments over time, where Payments are defined as `Payment` type transactions where the sender of the transaction is not also the destination. _(New in [v2.0.4][])_ - -Results can be returned as individual payments, or aggregated to a specific list of intervals if currency and issuer are provided. - -#### Request Format - - - -*REST - All Currencies* - -``` -GET /v2/payments/ -``` - -*REST - Specific Currency* - -``` -GET /v2/payments/{currency} -``` - - - -[Try it! >](data-api-v2-tool.html#get-payments) - -This method uses the following URL parameters: - -| Field | Value | Description | -|:-----------|:-------|:-------------------------------------------------------| -| `currency` | String | _(Optional)_ Currency code, followed by `+` and a counterparty address. (Or `XRP` with no counterparty.) If omitted, return payments for all currencies. | - -Optionally, you can provide 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 | If `true`, return results in reverse chronological order. The default is `false`. | -| `limit` | Integer | Maximum results per page. The default is 200. Cannot be more than 1000. | -| `marker` | String | [Pagination](#pagination) key from previously returned response. | -| `format` | String | Format of returned results: `csv` or `json`. The default is `json`. | - -The `interval` parameter for aggregated results has been removed as of [v2.3.5][]. - -#### Response Format - -A successful response uses the HTTP code **200 OK** and has a JSON body with the following: - -| Field | Value | Description | -|:-----------|:-----------------------------|:---------------------------------| -| `result` | String | The value `success` indicates that this is a successful response. | -| `count` | Integer | Number of payments returned. | -| `marker` | String | (May be omitted) [Pagination](#pagination) marker. | -| `payments` | Array of [Payment Objects][] | The requested payments. | - - -#### Example - -Request: - -``` -GET /v2/payments/BTC+rMwjYedjc7qqtKYVLiAccJSmCwih4LnE2q?limit=2 -``` - -Response: - -``` -200 OK -{ - "result": "success", - "count": 2, - "marker": "20131124004240|000003504935|00002", - "payments": [ - { - "amount": "100.0", - "delivered_amount": "100.0", - "destination_balance_changes": [ - { - "counterparty": "rMwjYedjc7qqtKYVLiAccJSmCwih4LnE2q", - "currency": "BTC", - "value": "100" - } - ], - "transaction_cost": "1.0E-5", - "source_balance_changes": [ - { - "counterparty": "rwm98fCBS8tV1YB8CGho8zUPW5J7N41th2", - "currency": "BTC", - "value": "-100" - } - ], - "tx_index": 3, - "currency": "BTC", - "destination": "rwm98fCBS8tV1YB8CGho8zUPW5J7N41th2", - "executed_time": "2013-09-27T04:03:00Z", - "issuer": "rMwjYedjc7qqtKYVLiAccJSmCwih4LnE2q", - "ledger_index": 2424349, - "source": "rMwjYedjc7qqtKYVLiAccJSmCwih4LnE2q", - "source_currency": "BTC", - "tx_hash": "EDDE2601C38F886E1183B5E7E1BFD936105C76E3648E3FAD2A6C55E90BABDB47" - }, - { - "amount": "0.2", - "delivered_amount": "0.2", - "destination_balance_changes": [ - { - "counterparty": "rMwjYedjc7qqtKYVLiAccJSmCwih4LnE2q", - "currency": "BTC", - "value": "0.2" - } - ], - "transaction_cost": "1.5E-5", - "max_amount": "0.202", - "source_balance_changes": [ - { - "counterparty": "rMwjYedjc7qqtKYVLiAccJSmCwih4LnE2q", - "currency": "BTC", - "value": "-0.2" - } - ], - "tx_index": 1, - "currency": "BTC", - "destination": "rHfcNvcg8pBqBxtSvD9Ma8gF17uxauB31o", - "executed_time": "2013-11-20T23:52:30Z", - "issuer": "rMwjYedjc7qqtKYVLiAccJSmCwih4LnE2q", - "ledger_index": 3445885, - "source": "rwm98fCBS8tV1YB8CGho8zUPW5J7N41th2", - "source_currency": "BTC", - "tx_hash": "F30D6CED4B0C37660F6DD741C9CA49F0BCB2D2648CDB8FC8AD6CFD86A86384E2" - } - ] -} -``` - - - - - -## Get Exchanges -[[Source]](https://github.com/ripple/rippled-historical-database/blob/master/api/routes/getExchanges.js "Source") - -Retrieve Exchanges for a given currency pair over time. Results can be returned as individual exchanges or aggregated to a specific list of intervals - -#### Request Format - - - -*REST* - -``` -GET /v2/exchanges/{base}/{counter} -``` - - - -[Try it! >](data-api-v2-tool.html#get-exchanges) - -This method requires the following URL parameters: - -| Field | Value | Description | -|:----------|:-------|:--------------------------------------------------------| -| `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. | - -Optionally, you can provide 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`. The default is non-aggregated results. | -| `descending` | Boolean | If `true`, return results in reverse chronological order. | -| `reduce` | Boolean | If `true`, aggregate all individual results. The default is `false`. | -| `limit` | Integer | Maximum results per page. The default is 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 return only exchanges made through [auto-bridging](autobridging.html). | -| `format` | String | Format of returned results: `csv` or `json`. The default is `json`. | - -#### Response Format -A successful response uses the HTTP code **200 OK** and has a JSON body with the following: - -| Field | Value | Description | -|:------------|:------------------------------|:-------------------------------| -| `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. | - -#### Example - -Request: - -``` -GET /v2/exchanges/USD+rMwjYedjc7qqtKYVLiAccJSmCwih4LnE2q/XRP?descending=true&limit=3&result=tesSUCCESS&type=OfferCreate -``` - -Response: - -``` -200 OK -{ - "result": "success", - "count": 3, - "marker": "USD|rMwjYedjc7qqtKYVLiAccJSmCwih4LnE2q|XRP||20151021222220|000016612683|00017|00000", - "exchanges": [ - { - "base_amount": 4.98954834453577, - "counter_amount": 1047.806201, - "node_index": 9, - "rate": 210.00021000021, - "tx_index": 0, - "buyer": "rpP2JgiMyTF5jR5hLG3xHCPi1knBb1v9cM", - "executed_time": "2015-10-21T23:09:50", - "ledger_index": 16613308, - "offer_sequence": 1010056, - "provider": "rpP2JgiMyTF5jR5hLG3xHCPi1knBb1v9cM", - "seller": "rK2o63evRPdRoMT2ZaW72wsHsFzcjnRLLq", - "taker": "rK2o63evRPdRoMT2ZaW72wsHsFzcjnRLLq", - "tx_hash": "25600A10E5395D45A9D514E1EC3D98C341C5451FD21C48FA9D104C310EC29D6B", - "tx_type": "Payment", - "base_currency": "USD", - "base_issuer": "rMwjYedjc7qqtKYVLiAccJSmCwih4LnE2q", - "counter_currency": "XRP" - }, - { - "base_amount": 0.0004716155440678037, - "counter_amount": 0.1, - "node_index": 3, - "rate": 212.03711637126, - "tx_index": 0, - "buyer": "rfh3pFHkCXv3TgzsEJgyCzF1CduZHCLi9o", - "executed_time": "2015-10-21T23:09:50", - "ledger_index": 16613308, - "offer_sequence": 158081, - "provider": "rfh3pFHkCXv3TgzsEJgyCzF1CduZHCLi9o", - "seller": "rK2o63evRPdRoMT2ZaW72wsHsFzcjnRLLq", - "taker": "rK2o63evRPdRoMT2ZaW72wsHsFzcjnRLLq", - "tx_hash": "25600A10E5395D45A9D514E1EC3D98C341C5451FD21C48FA9D104C310EC29D6B", - "tx_type": "Payment", - "base_currency": "USD", - "base_issuer": "rMwjYedjc7qqtKYVLiAccJSmCwih4LnE2q", - "counter_currency": "XRP" - }, - { - "base_amount": 0.0004714169229390923, - "counter_amount": 0.1, - "node_index": 3, - "rate": 212.1264535361624, - "tx_index": 17, - "autobridged_currency": "USD", - "autobridged_issuer": "rMwjYedjc7qqtKYVLiAccJSmCwih4LnE2q", - "buyer": "rfh3pFHkCXv3TgzsEJgyCzF1CduZHCLi9o", - "executed_time": "2015-10-21T22:22:20", - "ledger_index": 16612683, - "offer_sequence": 158059, - "provider": "rfh3pFHkCXv3TgzsEJgyCzF1CduZHCLi9o", - "seller": "rpP2JgiMyTF5jR5hLG3xHCPi1knBb1v9cM", - "taker": "rpP2JgiMyTF5jR5hLG3xHCPi1knBb1v9cM", - "tx_hash": "F05F670B06D641D7F6FE18E450DDB2C7A4DDF76D580C34C820939DC22AD9F582", - "tx_type": "OfferCreate", - "base_currency": "USD", - "base_issuer": "rMwjYedjc7qqtKYVLiAccJSmCwih4LnE2q", - "counter_currency": "XRP" - } - ] -} -``` - - - -## Get Exchange Rates -[[Source]](https://github.com/ripple/rippled-historical-database/blob/master/api/routes/getExchangeRate.js "Source") - -Retrieve an exchange rate for a given currency pair at a specific time. - -#### Request Format - - - -*REST* - -``` -GET /v2/exchange_rates/{base}/{counter} -``` - - - -[Try it! >](data-api-v2-tool.html#get-exchange-rates) - -This method requires the following URL parameters: - -| Field | Value | Description | -|:----------|:-------|:--------------------------------------------------------| -| `base` | String | Base currency of the pair, as a [Currency Code][], followed by `+` and the issuer [Address][]. Omit the `+` and the issuer for XRP. | -| `counter` | String | Counter currency of the pair, as a [Currency Code][], followed by `+` and the issuer [Address][]. Omit the `+` and the issuer for XRP. | - - -Optionally, you can provide the following query parameters: - -| Field | Value | Description | -|:---------|:-----------------------|:-----------------------------------------| -| `date` | String - [Timestamp][] | Return an exchange rate for the specified time. The default is the current time. | -| `strict` | Boolean | If `false`, allow rates derived from less than 10 exchanges. The default is `true`. | - - -#### Response Format -A successful response uses the HTTP code **200 OK** and has a JSON body with the following: - -| Field | Value | Description | -|:---------|:-------|:---------------------------------------------------------| -| `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 calculated by converting the base currency and counter currency to XRP. - -The rate is derived from the volume weighted average over the calendar day specified, averaged with the volume weighted average of the last 50 trades within the last 14 days. - -#### Example - -Request: - -``` -GET /v2/exchange_rates/USD+rMwjYedjc7qqtKYVLiAccJSmCwih4LnE2q/XRP?date=2015-11-13T00:00:00Z -``` - -Response: - -``` -200 OK -{ - "result": "success", - "rate": "224.65709" -} -``` - - - - -## Normalize -[[Source]](https://github.com/ripple/rippled-historical-database/blob/master/api/routes/normalize.js "Source") - -Convert an amount from one currency and issuer to another, using the network exchange rates. - -#### Request Format - - - -*REST* - -``` -GET /v2/normalize -``` - - - -[Try it! >](data-api-v2-tool.html#normalize) - -You must provide at least some of the following query parameters: - -| Field | Value | Description | -|:--------------------|:---------------------------|:--------------------------| -| `amount` | Number | (Required) Amount of currency to normalize. | -| `currency` | String - [Currency Code][] | The currency code of the `amount` to convert from. The default is XRP. | -| `issuer` | String - [Address][] | The issuer of the currency to convert from. (Required if `currency` is not XRP.) | -| `exchange_currency` | String - [Currency Code][] | The currency to convert to. The default is XRP. | -| `exchange_issuer` | String - [Address][] | The issuer of the currency to convert to. (Required if `exchange_currency` is not XRP.) | -| `date` | String - [Timestamp][] | Convert according to the exchange rate at this time. The default is the current time. | -| `strict` | Boolean | If `true`, do not use exchange rates that are determined by less than 10 exchanges. The default is `true`. | - - -#### Response Format -A successful response uses the HTTP code **200 OK** and has a JSON body with the following: - -| Field | Value | Description | -|:------------|:-------|:------------------------------------------------------| -| `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. | - -All exchange rates are calculating by converting both currencies to XRP. - -#### Example - -Request: - -``` -GET /v2/normalize?amount=100¤cy=XRP&exchange_currency=USD&exchange_issuer=rMwjYedjc7qqtKYVLiAccJSmCwih4LnE2q -``` - -Response: - -``` -200 OK -{ - "result": "success", - "amount": "100", - "converted": "0.4267798022744489", - "rate": "0.0042677980" -} -``` - - - - -## Get Daily Reports -[[Source]](https://github.com/ripple/rippled-historical-database/blob/master/api/routes/reports.js "Source") - -Retrieve per account per day aggregated payment summaries - -#### Request Format - - - -*REST* - -``` -GET /v2/reports/{date} -``` - - - -[Try it! >](data-api-v2-tool.html#get-daily-reports) - -This method uses the following URL parameter: - -| Field | Value | Description | -|:-------|:-------|:--------------------------------------------------------------| -| `date` | String | _(Optional)_ UTC query date. If omitted, use the current day. | - -Optionally, you can provide the following query parameters: - -| Field | Value | Description | -|:-----------|:--------|:------------------------------------------------------| -| `accounts` | Boolean | If `true`, include lists of counterparty accounts. The default is `false`. | -| `payments` | Boolean | If `true`, include lists of individual payments. The default is `false`. | -| `format` | String | Format of returned results: `csv` or `json`. The default is `json`. | -| `limit` | Integer | Maximum results per page. The default is 200. Cannot be more than 1000. | -| `marker` | String | [Pagination](#pagination) key from previously returned response. | - -#### Response Format - -A successful response uses the HTTP code **200 OK** and has a JSON body with the following: - -| Field | Value | Description | -|:----------|:-----------------------------|:----------------------------------| -| `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. | -| `reports` | Array of [Reports Objects][] | The requested reports. Each report pertains to a single account. | - -**Caution:** This method may return a very large amount of data (more than 1 megabyte), which may cause poor performance in your client application. - -#### Example - -Request: - -``` -GET /v2/reports/2015-08-19T00:00:00Z?accounts=true&payments=true -``` - -Response (trimmed for size): - -``` -{ - "result": "success", - "date": "2015-08-19T00:00:00Z", - "count": 2, - "marker": "20150819000000|r2nt4zXDP6Be5FNrLsiuuTEBETbGR9RFw", - "reports": [ - { - "account": "r2LXq2rZWSgQ1thhKiEytzi1smg6oEn8A", - "date": "2015-08-19T00:00:00Z", - "high_value_received": "7000", - "high_value_sent": "3400", - "payments": [ - { - "tx_hash": "A032EFBB219B1102BBD9BCCB91EDC6EAA8185509574FA476A2D3FE6BA79B04EF", - "amount": "1700", - "type": "received" - }, - { - "tx_hash": "8B059360DC83777CDCABA84824C169651AFD6A7AB44E8742A3B8C6BC2AAF7384", - "amount": "40", - "type": "received" - }, - - ...(additional results trimmed)... - - { - "tx_hash": "76041BD6546389B5EC2CDBAA543200CF7B8D300F34F908BA5CA8523B0CA158C8", - "amount": "1400", - "type": "sent" - } - ], - "payments_received": 155, - "payments_sent": 49, - "receiving_counterparties": [ - "rDMFJrKg2jyoNG6WDWJknXDEKZ6ywNFGwD", - "r4XXHxraHLuCiLmLMw96FTPXXywZSnWSyR", - - ...(additional results trimmed)... - - - "rp1C4Ld6uGjurFpempUJ8q5hPSWhak5EQf" - ], - "sending_counterparties": [ - "rwxcJVWZSEgN2DmLZYYjyagHjMx5jQ7BAa", - - ...(additional results trimmed)... - - - "rBK1rLjbWsSU9EuST1cAz9RsiYdJPVGXXA" - ], - "total_value": "210940", - "total_value_received": "100540", - "total_value_sent": "110400" - }, - { - "account": "r2adXWaWFJt9mHeoWN77iHJozDz2FDAPA", - "date": "2015-08-19T00:00:00Z", - "high_value_received": "7400", - "high_value_sent": "15900", - "payments": [ - { - "tx_hash": "9C7EA76D467AE58E6AEFAAC7994D42FB4E7FA72BFA22F90260937386D76BDB64", - "amount": "900", - "type": "sent" - }, - - ...(additional results trimmed)... - - - { - "tx_hash": "EC25427964419394BB5D06343BC74235C33655C1F70523C688F9A201957D65BA", - "amount": "100", - "type": "sent" - } - ], - "payments_received": 43, - "payments_sent": 62, - "receiving_counterparties": [ - "rB4cyZxrBrTmJcWZSBc8YoW2t3bafiKRp", - - ...(additional results trimmed)... - - - "rKybkw3Pu74VfJfrWr7QJbVPJNarnKP2EJ" - ], - "sending_counterparties": [ - "rNRCXw8PQRjvTwMDDLZVvuLHSKqqXUXQHv", - "r7CLMVEuNvK2yXTPLPnkWMqzkkXuopWeL", - - ...(additional results trimmed)... - - - "ranyeoYRhvwiFABzDvxSVyqQKp1bMkFsaX" - ], - "total_value": "117600", - "total_value_received": "54700", - "total_value_sent": "62900" - } - ] -} -``` - - - -## Get Stats -[[Source]](https://github.com/ripple/rippled-historical-database/blob/master/api/routes/stats.js "Source") - -Retrieve statistics about transaction activity in the XRP Ledger, divided into intervals of time. - -#### Request Format - - - -*REST* - -``` -GET /v2/stats -``` - - - -[Try it! >](data-api-v2-tool.html#get-stats) - -Optionally, you can provide the following query parameters: - -| Field | Value | Description | -|:-------------|:-----------------------|:-------------------------------------| -| `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. | -| `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`, or `week`). The default is `day`. | -| `limit` | Integer | Maximum results per page. The default is 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. The default is `false`. | -| `format` | String | Format of returned results: `csv` or `json`. The default is `json`. | - -##### Families and Metrics - -The `family` and `metrics` query parameters provide a way to filter results to a specific subset of all metrics available for transactions in any given interval. Each metric is tied to a specific family, as follows: - -| Family | Included Metrics | Meaning | -|:---------|:-----------------|:--------| -| `type` | All XRP Ledger [transaction types](transaction-formats.html), including `Payment`, `AccountSet`, `OfferCreate`, and others. | Number of transactions of the given type that occurred during the interval. | -| `result` | All [transaction result codes](transaction-results.html) (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) | - -##### Special Transaction Metrics - -The Data API derives the following values for every interval. These metrics are part of the `metric` family. - -| Field | Value | Description | -|:-------------------|:-------|:-----------------------------------------------| -| `accounts_created` | Number | The number of new accounts funded during this interval. | -| `exchanges_count` | Number | The number of currency exchanges that occurred during this interval. | -| `ledger_count` | Number | The number of ledgers closed during this interval. | -| `ledger_interval` | Number | The average number of seconds between ledgers closing during this interval. | -| `payments_count` | Number | The number of payments from one account to another during this interval. | -| `transaction_count`| Number | The number of transactions that executed during this interval. | -| `tx_per_ledger` | Number | The average number of transactions per ledger in this interval. | - -If any of the metrics have a value of 0, they are omitted from the results. - -#### Response Format -A successful response uses the HTTP code **200 OK** and has a JSON body with the following: - -| Field | Value | Description | -|:---------|:-----------------------|:-----------------------------------------| -| `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. | - -#### Example - -Request: - -``` -GET /v2/stats/?start=2015-08-30&end=2015-08-31&interval=day&family=metric&metrics=accounts_created,exchanges_count,ledger_count,payments_count -``` - -Response: - -``` -200 OK -{ - "result": "success", - "count": 2, - "stats": [ - { - "accounts_created": 15, - "exchanges_count": 19368, - "ledger_count": 20307, - "payments_count": 24763, - "date": "2015-08-30T00:00:00Z" - }, - { - "accounts_created": 18, - "exchanges_count": 17192, - "ledger_count": 19971, - "payments_count": 30894, - "date": "2015-08-31T00:00:00Z" - } - ] -} -``` - - - -## Get Active Accounts -[[Source]](https://github.com/ripple/rippled-historical-database/blob/master/api/routes/activeAccounts.js "Source") - -Get information on which accounts are actively trading in a specific currency pair. _(New in [v2.0.4][])_ - -#### Request Format - - - -*REST* - -``` -GET /v2/active_accounts/{base}/{counter} -``` - - - -[Try it! >](data-api-v2-tool.html#get-active-accounts) - -This method requires the following URL parameters: - -| Field | Value | Description | -|:----------|:-------|:--------------------------------------------------------| -| `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. | - -Optionally, you can provide the following query parameters: - -| Field | Value | Description | -|:--------------------|:--------|:---------------------------------------------| -| `period` | String | Get results for trading activity during a chosen time period. Valid periods are `1day`, `3day`, or `7day`. The default is `1day`. | -| `date` | String | Get results for the period starting at this time. The default is the most recent period available. | -| `include_exchanges` | Boolean | Include individual exchanges for each account in the results. | -| `format` | String | Format of returned results: `csv` or `json`. The default is `json`. | - -#### Response Format -A successful response uses the HTTP code **200 OK** and has a JSON body with the following: - -| Field | Value | Description | -|:------------------|:----------------------------------------|:---------------| -| `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. | - -Each **Account Trading Object** describes the activity of a single account during this time period, and has the following fields: - -| Field | Value | Description | -|:----------------------|:---------------------|:------------------------------| -| `buy` | Object | Summary of currency exchanges buying the base currency | -| `buy.base_volume` | Number | Amount of base currency the account bought in this period. | -| `buy.counter_volume` | Number | Amount of counter currency the account sold in this period. | -| `buy.count` | Number | Number of trades that bought the base currency in this period. | -| `sell` | Object | Summary of currency changes selling the base currency. | -| `sell.base_volume` | Number | Amount of the base currency the account sold this period. | -| `sell.counter_volume` | Number | Amount of the counter currency the account bought this period. | -| `sell.count` | Number | Number of trades that sold the base currency. | -| `account` | String - [Address][] | The address whose activity this object describes. | -| `base_volume` | Number | The total volume of the base currency the account bought and sold in this period. | -| `counter_volume` | Number | The total volume of the counter currency the account bought and sold in this period. | -| `count` | Number | The total number of exchanges the account made during this period. | - -#### Example - -Request: - -``` -GET /v2/active_accounts/XRP/USD+rMwjYedjc7qqtKYVLiAccJSmCwih4LnE2q -``` - -Response: - -``` -200 OK -{ - "result": "success", - "count": 12, - "exchanges_count": 11, - "accounts": [ - { - "buy": { - "base_volume": 0, - "counter_volume": 0, - "count": 0 - }, - "sell": { - "base_volume": 13084.822874, - "counter_volume": 54.499328645454604, - "count": 4 - }, - "account": "rGBQhB8EH5DmqMmfKPLchpqr3MR19pv6zN", - "base_volume": 13084.822874, - "counter_volume": 54.499328645454604, - "count": 4 - }, - { - "buy": { - "base_volume": 12597.822874, - "counter_volume": 52.4909286454546, - "count": 1 - }, - "sell": { - "base_volume": 0, - "counter_volume": 0, - "count": 0 - }, - "account": "rQE5Z3FgVnRMbVfS6xiVQFgB4J3X162FVD", - "base_volume": 12597.822874, - "counter_volume": 52.4909286454546, - "count": 1 - }, - - ... (additional results trimmed)... - - { - "buy": { - "base_volume": 1.996007, - "counter_volume": 0.008782427920595, - "count": 1 - }, - "sell": { - "base_volume": 0, - "counter_volume": 0, - "count": 0 - }, - "account": "rD8LigXE7165r3VWhSQ4FwzJy7PNrTMwUq", - "base_volume": 1.996007, - "counter_volume": 0.008782427920595, - "count": 1 - }, - { - "buy": { - "base_volume": 0, - "counter_volume": 0, - "count": 0 - }, - "sell": { - "base_volume": 0.1, - "counter_volume": 0.0004821658905462904, - "count": 1 - }, - "account": "rfh3pFHkCXv3TgzsEJgyCzF1CduZHCLi9o", - "base_volume": 0.1, - "counter_volume": 0.0004821658905462904, - "count": 1 - } - ] -} -``` - - - -## Get Exchange Volume -[[Source]](https://github.com/ripple/rippled-historical-database/blob/master/api/routes/network/getMetric.js "Source") - -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 - - - -*REST* - -``` -GET /v2/network/exchange_volume -``` - - - -[Try it! >](data-api-v2-tool.html#get-exchange-volume) - -Optionally, you can provide the following query parameters: - -| Field | Value | Description | -|:--------------------|:---------------------------|:--------------------------| -| `live` | String | Return a live rolling window of this length of time. Valid values are `day`, `hour`, or `minute`. _(New in [v2.3.0][])_ | -| `exchange_currency` | String - [Currency Code][] | Normalize all amounts to use this as a display currency. If not XRP, `exchange_issuer` is also required. The default is XRP. | -| `exchange_issuer` | String - [Address][] | Normalize results to the specified `currency` issued by this issuer. | -| `format` | String | Format of returned results: `csv` or `json`. The default is `json`. | - -The `start`, `end`, `interval`, `limit`, and `marker` parameters have been removed in [v2.3.5][]. - -#### Response Format -A successful response uses the HTTP code **200 OK** and has a JSON body with the following: - -| Field | Value | Description | -|:---------|:-------------------------------------|:---------------------------| -| `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 array contains only the most recent complete interval. If `live` is specified and `interval` isn't, this array contains the specified rolling window instead.) | - -Each object in the `components` array of the Volume Objects represent the volume of exchanges in a market between two currencies, and has the following fields: - -| Field | Value | Description | -|:-------------------|:-------|:-----------------------------------------------| -| `count` | Number | The number of exchanges in this market during this interval. | -| `rate` | Number | The exchange rate from the base currency to the display currency. | -| `amount` | Number | The amount of volume in the market, in units of the base currency. | -| `base` | Object | The `currency` and `issuer` of the base currency of this market. There is no `issuer` for XRP. | -| `counter` | Object | The `currency` and `issuer` of the counter currency of this market. There is no `issuer` for XRP. | -| `converted_amount` | Number | The total amount of volume in the market, converted to the display currency. _(Before [v2.1.0][], this was `convertedAmount`.)_ | - -#### Example - -Request: - -``` -GET /v2/network/exchange_volume?exchange_currency=USD&exchange_issuer=rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B -``` - - -Response: - -``` -200 OK -{ - "result": "success", - "count": 1, - "rows": [ - { - "components": [ - { - "count": 1711, - "rate": 5.514373809662552e-8, - "amount": 333.7038784107369, - "base": { - "currency": "BTC", - "issuer": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B" - }, - "counter": { - "currency": "XRP" - }, - "converted_amount": 117720.99268355068 - }, - { - "count": 1977, - "rate": 0.000019601413454357618, - "amount": 74567.72531650064, - "base": { - "currency": "USD", - "issuer": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B" - }, - "counter": { - "currency": "XRP" - }, - "converted_amount": 74003.51871932109 - }, - - ... (additional results trimmed) ... - - { - "count": 3, - "rate": 0.022999083584408355, - "amount": 85.40728674708998, - "base": { - "currency": "CNY", - "issuer": "razqQKzJRdB4UxFPWf5NEpEG3WMkmwgcXA" - }, - "counter": { - "currency": "USD", - "issuer": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B" - }, - "converted_amount": 12.72863756671683 - }, - { - "count": 3, - "rate": 1.7749889023209692e-7, - "amount": 570.687912196755, - "base": { - "currency": "JPY", - "issuer": "r94s8px6kSw1uZ1MV98dhSRTvc6VMPoPcN" - }, - "counter": { - "currency": "BTC", - "issuer": "rMwjYedjc7qqtKYVLiAccJSmCwih4LnE2q" - }, - "converted_amount": 4.4137945368632545 - } - ], - "count": 11105, - "endTime": "2015-09-11T19:58:58+00:00", - "exchange": { - "currency": "USD", - "issuer": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B" - }, - "exchangeRate": 0.004410567085248279, - "startTime": "2015-11-10T00:06:04+00:00", - "total": 442442.5974313684 - } - ] -} -``` - - - - - -## Get Payment Volume -[[Source]](https://github.com/ripple/rippled-historical-database/blob/master/api/routes/network/getMetric.js "Source") - -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 - - - -*REST* - -``` -GET /v2/network/payment_volume -``` - - - -[Try it! >](data-api-v2-tool.html#get-payment-volume) - -Optionally, you can provide the following query parameters: - -| Field | Value | Description | -|:--------------------|:---------------------------|:--------------------------| -| `live` | String | Return a live rolling window of this length of time. Valid values are `day`, `hour`, or `minute`. _(New in [v2.3.0][])_ | -| `exchange_currency` | String - [Currency Code][] | Normalize all amounts to use this as a display currency. If not XRP, `exchange_issuer` is also required. The default is XRP. | -| `exchange_issuer` | String - [Address][] | Normalize results to the specified `currency` issued by this issuer. | -| `format` | String | Format of returned results: `csv` or `json`. The default is `json`. | - -The `start`, `end`, `interval`, `limit`, and `marker` parameters have been removed in [v2.3.5][]. - -#### Response Format -A successful response uses the HTTP code **200 OK** and has a JSON body with the following: - -| Field | Value | Description | -|:---------|:------------------------------------|:----------------------------| -| `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 array contains only the most recent interval. If `live` is specified and `interval` isn't, this array contains the specified rolling window instead.) | - -Each object in the `components` array of the Volume Objects represent the volume of payments for one currencies and issuer, and has the following fields: - -| Field | Value | Description | -|:-------------------|:---------------------------|:---------------------------| -| `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. | -| `converted_amount` | Number | Total payment volume for this currency, converted to the display currency. _(Before [v2.1.0][], this was `convertedAmount`.)_ | - -#### Example - -Request: - -``` -GET /v2/network/payment_volume -``` - -Response: - -``` -200 OK -{ - "result": "success", - "count": 1, - "rows": [ - { - "components": [ - { - "currency": "USD", - "issuer": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B", - "amount": 87279.59029136538, - "count": 331, - "rate": 0.004412045860957953, - "converted_amount": 19782113.1153009 - }, - { - "currency": "USD", - "issuer": "rMwjYedjc7qqtKYVLiAccJSmCwih4LnE2q", - "amount": 0, - "count": 0, - "rate": 0.00451165816091143, - "converted_amount": 0 - }, - { - "currency": "BTC", - "issuer": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B", - "amount": 279.03077460240354, - "count": 107, - "rate": 0.000013312520335244644, - "converted_amount": 20960026.169024874 - }, - - ... (additional results trimmed) ... - - { - "currency": "MXN", - "issuer": "rG6FZ31hDHN1K5Dkbma3PSB5uVCuVVRzfn", - "amount": 49263.13280138676, - "count": 19, - "rate": 0.07640584677247926, - "converted_amount": 644756.0609868265 - }, - { - "currency": "XRP", - "amount": 296246369.30089426, - "count": 8691, - "rate": 1, - "converted_amount": 296246369.30089426 - } - ], - "count": 9388, - "endTime": "2015-09-11T19:58:59+00:00", - "exchange": { - "currency": "XRP" - }, - "exchangeRate": 1, - "startTime": "2015-11-10T00:19:04+00:00", - "total": 390754174.7837752 - } - ] -} -``` - - - -## Get External Markets -[[Source]](https://github.com/ripple/rippled-historical-database/blob/master/api/routes/network/externalMarkets.js "Source") - -Get aggregated exchange volume from a list of off ledger exchanges for a specified rolling interval. - -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 #### - - - -*REST* - -``` -GET /v2/network/external_markets -``` - - - -[Try it! >](data-api-v2-tool.html#get-external-markets) - -Optionally, you can provide the following query parameters: - -| Field | Value | Description | -|:--------------------|:---------------------------|:--------------------------| -| `period` | String | Aggregation Period - valid intervals are `1hour`, `1day`, `3day`, `7day`, or `30day`. The default is `1day`. | -| `exchange_currency` | String - [Currency Code][] | Normalize all amounts to use this as a display currency. If not XRP, `exchange_issuer` is also required. The default is XRP. | -| `exchange_issuer` | String - [Address][] | Normalize results to the specified `currency` issued by this issuer. | - - -#### Response Format #### -A successful response uses the HTTP code **200 OK** and has a JSON body with the following: - -| Field | Value | Description | -|:--------------|:-------|:----------------------------------------------------| -| `result` | String | The value `success` indicates that this is a successful response. | -| `data` | Object | Contains data for the specified period. | -| `data.date` | String | Date at which this period was calculated. | -| `data.total` | Number | Total XRP volume exchanged during the period. | -| `data.period` | String | Name of the period queried. | - -Each object in the `components` array of the Volume Objects represent the volume of a single external market. Not all fields will be present for each market, depending on availability. - -| Field | Value | Description | -|:-------------------|:-------|:-----------------------------------------------| -| `source` | String | Domain name of the specific external market. | -| `base_volume` | Number | Exchange volume in terms of the base currency (XRP). | -| `counter_volume` | Number | Exchange volume in terms of the counter currency. | -| `base_currecy` | String | Base currency of the market pair. | -| `counter_currency` | String | Counter currency of the market pair. | -| `rate` | Number | Exchange rate. | - -#### Example #### - -Request: - -``` -GET /v2/network/external_markets -``` - - -Response: - -``` -200 OK - -{ - "result": "success", - "data": { - "components": [ - { - "base_volume": "52847221.256202064", - "counter_volume": "619.8111371100003", - "source": "poloniex.com", - "base_currency": "XRP", - "counter_currency": "BTC", - "rate": "0.0000117284" - }, - { - "base_volume": "389955.29648717004", - "counter_volume": "3212.07137265", - "source": "poloniex.com", - "base_currency": "XRP", - "counter_currency": "USD", - "rate": "0.00823702" - }, - { - "base_volume": "6025268.09143092", - "counter_volume": "70.57870572291264", - "count": 250, - "source": "kraken.com", - "base_currency": "XRP", - "counter_currency": "BTC", - "rate": "0.0000117138" - }, - { - "base_volume": "4141962.161763998", - "source": "btc38.com", - "base_currency": "XRP", - "counter_currency": "CNY" - }, - { - "base_volume": "303505", - "source": "btc38.com", - "base_currency": "XRP", - "counter_currency": "BTC" - }, - { - "base_volume": "1275008.2922999999", - "source": "jubi.com", - "base_currency": "XRP", - "counter_currency": "CNY" - } - ], - "date": "2016-10-31T20:45:20Z", - "period": "1day", - "total": "64982920.098184146" - } -} -``` - - - -## Get XRP Distribution -[[Source]](https://github.com/ripple/rippled-historical-database/blob/master/api/routes/network/xrpDistribution.js "Source") - -Get information on the total amount of XRP in existence and in circulation, by weekly intervals. _(New in [v2.2.0][])_ - -#### Request Format - - - -*REST* - -``` -GET /v2/network/xrp_distribution -``` - - - -[Try it! >](data-api-v2-tool.html#get-xrp-distribution) - -Optionally, you can provide the following query parameters: - -| Field | Value | Description | -|:-------------|:-----------------------|:-------------------------------------| -| `start` | String - [Timestamp][] | Start time of query range. The default is the start of the most recent interval. | -| `end` | String - [Timestamp][] | End time of query range. The default is the end of the most recent interval. | -| `limit` | Integer | Maximum results per page. The default is 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. The default is `false`. | -| `format` | String | Format of returned results: `csv` or `json`. The default is `json`. | - -#### Response Format - -A successful response uses the HTTP code **200 OK** and has a JSON body with the following: - -| Field | Value | Description | -|:---------|:------------------------------|:----------------------------------| -| `result` | String | The value `success` indicates that the body represents a successful response. | -| `count` | Integer | Number of rows returned. | -| `rows` | Array of Distribution Objects | Weekly snapshots of the XRP distribution. | - -Each Distribution Object has the following fields: - -| Field | Value | Description | -|:----------------|:-----------------------|:----------------------------------| -| `date` | String - [Timestamp][] | The time of this snapshot. | -| `total` | String | Total XRP in existence. | -| `undistributed` | String | Aggregate amount of XRP held by Ripple (the company). | -| `distributed` | String | Aggregate amount of XRP held by others. | - -#### Example - -Request: - -``` -GET /v2/network/xrp_distribution -``` - -Response: - -``` -200 OK -{ - "result": "success", - "count": 171, - "rows": [ - { - "date": "2016-04-10T00:00:00Z", - "distributed": "34918644255.77274", - "total": "99997725821.25714", - "undistributed": "65079081565.4844" - }, - ... - ] -} -``` - - - -## Get Top Currencies -[[Source]](https://github.com/ripple/rippled-historical-database/blob/master/api/routes/network/topCurrencies.js "Source") - -Returns the top currencies on the XRP 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 - - - -*Most Recent* - -``` -GET /v2/network/top_currencies -``` - -*By Date* - -``` -GET /v2/network/top_currencies/{date} -``` - - - -[Try it! >](data-api-v2-tool.html#get-top-currencies) - -This method uses the following URL parameter: - -| Field | Value | Description | -|:-------|:-----------------------|:-------------------------------------------| -| `date` | String - ISO 8601 Date | _(Optional)_ Historical date to query. If omitted, use the most recent date available. | - -Optionally, you can provide the following query parameters: - -| Field | Value | Description | -|:---------|:--------|:--------------------------------------------------------| -| `limit` | Integer | Maximum results per page. The default is 1000. Cannot be more than 1000. | -| `format` | String | Format of returned results: `csv` or `json`. The default is `json`. | - -#### Response Format - -A successful response uses the HTTP code **200 OK** and has a JSON body with the following: - -| Field | Value | Description | -|:-------------|:------------------------------|:------------------------------| -| `result` | String | The value `success` indicates that this is a successful response. | -| `date` | String - [Timestamp][] | When this data was measured. | -| `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: - -| Field | Value | Description | -|:----------------------|:---------------------------|:------------------------| -| `currency` | String - [Currency Code][] | The currency this object describes. | -| `issuer` | String - [Address][] | The XRP Ledger address that issues this currency. | -| `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](#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. | - -#### Example - -Request: - -``` -GET /v2/network/top_currencies/2016-04-14?limit=2 -``` - -Response: - -``` -200 OK -{ - "result": "success", - "date": "2016-04-14T00:00:00Z", - "count": 2, - "currencies": [ - { - "avg_exchange_count": "8099.967741935484", - "avg_exchange_volume": "3.5952068085531615E7", - "avg_payment_count": "624.28125", - "avg_payment_volume": "3910190.139488101", - "issued_value": "1.5276205395328993E8", - "currency": "CNY", - "issuer": "rKiCet8SdvWxPXnAgYarFUXMh1zCPz432Y" - }, - { - "avg_exchange_count": "3003.2258064516127", - "avg_exchange_volume": "3.430482029838605E7", - "avg_payment_count": "257.4375", - "avg_payment_volume": "501442.0789529095", - "issued_value": "2.6289124450524995E8", - "currency": "USD", - "issuer": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B" - } - ] -} -``` - - - -## Get Top Markets -[[Source]](https://github.com/ripple/rippled-historical-database/blob/master/api/routes/network/topMarkets.js "Source") - -Returns the top exchange markets on the XRP 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 - - - -*Most Recent* - -``` -GET /v2/network/top_markets -``` - -*By Date* - -``` -GET /v2/network/top_markets/{date} -``` - - - -[Try it! >](data-api-v2-tool.html#get-top-markets) - -This method uses the following URL parameter: - -| Field | Value | Description | -|:-------|:-----------------------|:-------------------------------------------| -| `date` | String - ISO 8601 Date | _(Optional)_ Historical date to query. If omitted, use the most recent date available. | - -Optionally, you can provide the following query parameters: - -| Field | Value | Description | -|:---------|:--------|:--------------------------------------------------------| -| `limit` | Integer | Maximum results per page. The default is 1000. Cannot be more than 1000. | -| `format` | String | Format of returned results: `csv` or `json`. The default is `json`. | - -#### Response Format - -A successful response uses the HTTP code **200 OK** and has a JSON body with the following: - -| Field | Value | Description | -|:----------|:----------------------------|:-----------------------------------| -| `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: - -| Field | Value | Description | -|:---------------------|:---------------------------|:-------------------------| -| `base_currency` | String - [Currency Code][] | The base currency for this market. | -| `base_issuer` | String - [Address][] | (Omitted if `base_currency` is XRP) The XRP Ledger address that issues the base currency. | -| `counter_currency` | String - [Currency Code][] | The counter currency for this market. | -| `counter_issuer` | String - [Address][] | (Omitted if `counter_currency` is XRP) The XRP Ledger 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](#exchange-objects). | -| `avg_volume` | String | Daily average volume, normalized to XRP. | - -#### Example - -Request: - -``` -GET /v2/network/top_markets/2015-12-31 -``` - -Response: - -``` -200 OK -{ - "result": "success", - "date": "2015-12-31T00:00:00Z", - "count": 58, - "markets": [ - { - "avg_base_volume": "116180.98607935428", - "avg_counter_volume": "1.6657039295476614E7", - "avg_exchange_count": "1521.4603174603174", - "avg_volume": "1.6657039295476614E7", - "base_currency": "USD", - "base_issuer": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B", - "counter_currency": "XRP" - }, - { - "avg_base_volume": "410510.0286920887", - "avg_counter_volume": "9117398.719214212", - "avg_exchange_count": "1902.1587301587301", - "avg_volume": "9117398.719214212", - "base_currency": "CNY", - "base_issuer": "rKiCet8SdvWxPXnAgYarFUXMh1zCPz432Y", - "counter_currency": "XRP" - }, - ... - ] -} -``` - - - -## Get Transaction Costs -[[Source]](https://github.com/ripple/rippled-historical-database/blob/master/api/routes/network/getFees.js "Source") - -Returns [transaction cost](transaction-cost.html) stats per ledger, hour, or day. The data shows the average, minimum, maximum, and total transaction costs paid for the given interval or ledger. _(New in [v2.2.0][])_ - -#### Request Format - - - -*REST* - -``` -GET /v2/network/fees -``` - - - -[Try it! >](data-api-v2-tool.html#get-transaction-costs) - -Optionally, you can provide the following query parameters: - -| Field | Value | Description | -|:-------------|:-----------------------|:-------------------------------------| -| `start` | String - [Timestamp][] | Start time of query range. The default is to start from the earliest data available. | -| `end` | String - [Timestamp][] | End time of query range. The default is to start from the latest data available. | -| `interval` | String | Aggregation interval - valid intervals are `ledger`, `hour`, or `day`. The default is `ledger`. | -| `descending` | Boolean | If `true`, sort results with most recent first. By default, sort results with oldest first. | -| `limit` | Integer | Maximum results per page. The default is 200. Cannot be more than 1000. | -| `marker` | String | [Pagination](#pagination) key from previously returned response. | -| `format` | String | Format of returned results: `csv` or `json`. The default is `json`. | - -#### Response Format - -A successful response uses the HTTP code **200 OK** and has a JSON body with the following: - -| Field | Value | Description | -|:---------|:-----------------------------|:-----------------------------------| -| `result` | String | The value `success` indicates that this is a successful response. | -| `marker` | String | (May be omitted) [Pagination](#pagination) marker. | -| `count` | Integer | Number of results in the `markets` field. | -| `rows` | Array of Fee Summary Objects | Transaction cost statistics for each interval. | - -Each Fee Summary object has the following fields: - -| Field | Value | Description | -|:---------------|:---------------------------|:-------------------------------| -| `avg` | Number | Average transaction cost paid in this interval. | -| `min` | Number | Minimum transaction cost paid in this interval. | -| `max` | Number | Maximum transaction cost paid in this interval. | -| `total` | Number | Total XRP destroyed by transaction costs. | -| `tx_count` | Number | Number of transactions in this interval. | -| `date` | String - [Timestamp][] | The start time of this interval (time intervals), or the close time of this ledger (`ledger` interval). | -| `ledger_index` | Integer - [Ledger Index][] | (Only present in `ledger` interval) The ledger this object describes. | - -#### Example - -Request: - -``` -GET /v2/network/fees?interval=day&limit=3&descending=true -``` - -Response: - -``` -200 OK -{ - "result": "success", - "marker": "day|20160603000000", - "count": 3, - "rows": [ - { - "avg": 0.011829, - "max": 15, - "min": 0.01, - "total": 6682.15335, - "tx_count": 564918, - "date": "2016-06-06T00:00:00Z" - }, - { - "avg": 0.011822, - "max": 4.963071, - "min": 0.01, - "total": 5350.832025, - "tx_count": 452609, - "date": "2016-06-05T00:00:00Z" - }, - { - "avg": 0.012128, - "max": 15, - "min": 0.01, - "total": 5405.126404, - "tx_count": 445689, - "date": "2016-06-04T00:00:00Z" - } - ] -} -``` - - - - -## Get Fee Stats -[[Source]](https://github.com/ripple/rippled-historical-database/blob/master/api/routes/network/getFeeStats.js "Source") - -Returns snapshots of the metrics derived from `rippled`'s [`fee` command](fee.html). _(New in [v2.3.2][])_ - -#### Request Format - - - -*REST* - -``` -GET /v2/network/fee_stats -``` - - - -[Try it! >](data-api-v2-tool.html#get-fee-stats) - -Optionally, you can provide the following query parameters: - -| Field | Value | Description | -|:-------------|:-----------------------|:-------------------------------------| -| `start` | String - [Timestamp][] | Start time of query range. The default is to start from the earliest data available. | -| `end` | String - [Timestamp][] | End time of query range.The default is to end at the latest data available. | -| `interval` | String | The interval of the snapshots. Valid intervals are `minute`, `hour`, or `day`. Default interval is 5 seconds. | -| `descending` | Boolean | If `true`, sort results with most recent first. By default, sort results with oldest first. | -| `limit` | Integer | Maximum results per page. The default is 200. Cannot be more than 1000. | -| `marker` | String | [Pagination](#pagination) key from previously returned response. | -| `format` | String | Format of returned results: `csv` or `json`. The default is `json`. | - -#### Response Format - -A successful response uses the HTTP code **200 OK** and has a JSON body with the following: - -| Field | Value | Description | -|:---------|:-----------------------------|:-----------------------------------| -| `result` | String | The value `success` indicates that this is a successful response. | -| `marker` | String | (May be omitted) [Pagination](#pagination) marker. | -| `count` | Integer | Number of results in the `markets` field. | -| `rows` | Array of Fee Summary Objects | Transaction cost statistics for each interval. | - -Each **Fee Summary Object** has the following fields: - -| Field | Value | Description | -|:-----------------------|:-----------------------|:---------------------------| -| `date` | String - [Timestamp][] | The date-time this snapshot was taken. | -| `current_ledger_size` | Number | Number of transactions in the current ledger at the specified time. | -| `expected_ledger_size` | Number | Number of transactions expected in the next ledger at the specified time. | -| `current_queue_size` | Number | Number of transactions queued for inclusion in future ledgers. | -| `pct_max_queue_size` | Number | current queue size in terms of percentage of maximum queue size. | -| `median_fee` | Number | Median fee of transactions in the current ledger. | -| `minimum_fee` | Number | Minimum fee for inclusion in any ledger. | -| `open_ledger_fee` | Number | Cost threshold for inclusion in the ledger open at the time of the snapshot. | - -#### Example - -Request: - -``` -GET /v2/network/fee_stats -``` - -Response: - -``` -200 OK -{ - result: "success", - marker: "raw|20160701032100", - count: 200, - rows: [ - { - current_ledger_size: 39, - current_queue_size: 0, - date: "2016-07-01T00:00:00Z", - expected_ledger_size: 59, - median_fee: 0.005, - minimum_fee: 0.00001, - open_ledger_fee: 0.00001, - pct_max_queue_size: 0 - }, - { - current_ledger_size: 33, - current_queue_size: 0, - date: "2016-07-01T00:01:00Z", - expected_ledger_size: 59, - median_fee: 0.00543, - minimum_fee: 0.00001, - open_ledger_fee: 0.00001, - pct_max_queue_size: 0 - }, - ... - ] -} -``` - - - - -## Get Topology -[[Source]](https://github.com/ripple/rippled-historical-database/blob/master/api/routes/network/getTopology.js "Source") - -Get known `rippled` servers and peer-to-peer connections between them. _(New in [v2.2.0][])_ - - -#### Request Format - - - -*REST* - -``` -GET /v2/network/topology -``` - - - -[Try it! >](data-api-v2-tool.html#get-topology) - -Optionally, you can provide the following query parameters: - -| Field | Value | Description | -|:----------|:-----------------------|:----------------------------------------| -| `date` | String - [Timestamp][] | Date and time for historical query. By default, uses the most recent data available. | -| `verbose` | Boolean | If `true`, include additional details about each server where available. The default is `false`. | - -#### Response Format - -A successful response uses the HTTP code **200 OK** and has a JSON body with the following: - -| Field | Value | Description | -|:-------------|:----------------------------|:--------------------------------| -| `result` | String | The value `success` indicates that the body represents a successful response. | -| `date` | String - [Timestamp][] | The time of this measurement. | -| `node_count` | Integer | Number of `rippled` servers in the topology. | -| `link_count` | Integer | Number of links in the topology. | -| `nodes` | Array of [Server Objects][] | Details of `rippled` servers in the peer-to-peer network. | -| `links` | Array of [Link Objects][] | Network connections between `rippled` servers in the peer-to-peer network. | - -#### Example - -Request: - -``` -GET /v2/network/topology -``` - -Response: - -``` -200 OK -{ - "result": "success", - "date": "2016-06-06T23:51:04Z", - "node_count": 115, - "link_count": 1913, - "nodes": [ - { - "node_public_key": "n94fDXS3ta92gRSi7DKngh47S7Rg4z1FuNsahvbiakFEg51dLeVa", - "version": "rippled-0.31.0-rc1", - "uptime": 266431, - "inbound_count": 24, - "last_updated": "2016-06-03T21:50:57Z" - }, - { - "node_public_key": "n94h5KNspwUGLaGcdHGxruYNmExWHjPkLcMvwsNrivR9czRp6Lor", - "ip": "104.247.221.178", - "port": 51235, - "version": "rippled-0.31.0", - "uptime": 608382, - "inbound_count": 10, - "outbound_count": 11, - "city": "Atlanta", - "country": "United States", - "country_code": "US", - "isp": "QuickPacket, LLC", - "last_updated": "2016-05-28T06:29:43Z", - "lat": "-84.3846", - "long": "33.8379", - "postal_code": "30305", - "region": "Georgia", - "region_code": "GA", - "timezone": "America/New_York" - }, - - ... - ], - "links": [ - { - "source": "n94Extku8HiQVY8fcgxeot4bY7JqK2pNYfmdnhgf6UbcmgucHFY8", - "target": "n9KcFAX2bCuwF4vGF8gZZcpQQ6nyqm44e5TUygb3zvdZEpiJE5As" - }, - { - "source": "n94Extku8HiQVY8fcgxeot4bY7JqK2pNYfmdnhgf6UbcmgucHFY8", - "target": "n9LGAj7PjvfTmEGQ75JaRKba6GQmVwFCnJTSHgX2HDXzxm6d2JpM" - }, - - ... - ] -} -``` - - - -## Get Topology Nodes -[[Source]](https://github.com/ripple/rippled-historical-database/blob/master/api/routes/network/getNodes.js "Source") - -Get known `rippled` nodes. (This is a subset of the data returned by the [Get Topology method](#get-topology).) _(New in [v2.2.0][])_ - -#### Request Format - - - -*REST* - -``` -GET /v2/network/topology/nodes -``` - - - -[Try it! >](data-api-v2-tool.html#get-topology-nodes) - -Optionally, you can provide the following query parameters: - -| Field | Value | Description | -|:----------|:-----------------------|:----------------------------------------| -| `date` | String - [Timestamp][] | Date and time for historical query. The default is most recent data. | -| `verbose` | Boolean | If `true`, return full details for each server. The default is `false`. | -| `format` | String | Format of returned results: `csv` or `json`. The default is `json`. | - -#### Response Format - -A successful response uses the HTTP code **200 OK** and has a JSON body with the following: - -| Field | Value | Description | -|:---------|:----------------------------|:------------------------------------| -| `result` | String | The value `success` indicates that the body represents a successful response. | -| `date` | String - [Timestamp][] | When this the data was measured. | -| `count` | Integer | Number of `rippled` servers described. | -| `nodes` | Array of [Server Objects][] | Details of the `rippled` servers in the topology. | - -#### Example - -Request: - -``` -GET /v2/network/topology/nodes -``` - -Response: - -``` -200 OK -{ - "result": "success", - "date": "2016-06-08T00:36:53Z", - "count": 116, - "nodes": [ - { - "node_public_key": "n94BuARkPiYLrMuAVZqMQFhTAGpo12dqUPiH3yrzEnhaEcXfLAnV", - "version": "rippled-0.30.1", - "uptime": 122424, - "inbound_count": 10, - "last_updated": "2016-06-06T14:36:52Z" - }, - { - "node_public_key": "n94h5KNspwUGLaGcdHGxruYNmExWHjPkLcMvwsNrivR9czRp6Lor", - "ip": "104.247.221.178", - "port": 51235, - "version": "rippled-0.31.2", - "uptime": 38649, - "inbound_count": 10, - "outbound_count": 11, - "city": "Atlanta", - "country": "United States", - "country_code": "US", - "isp": "QuickPacket, LLC", - "last_updated": "2016-06-07T13:53:12Z", - "lat": "-84.3846", - "long": "33.8379", - "postal_code": "30305", - "region": "Georgia", - "region_code": "GA", - "timezone": "America/New_York" - }, - - ... - - ] -} -``` - - - -## Get Topology Node -[[Source]](https://github.com/ripple/rippled-historical-database/blob/master/api/routes/network/getNodes.js "Source") - -Get information about a single `rippled` server by its [node public key](#public-keys) (not validator public key). _(New in [v2.2.0][])_ - -#### Request Format - - - -*REST* - -``` -GET /v2/network/topology/nodes/{pubkey} -``` - - - -[Try it! >](data-api-v2-tool.html#get-topology-node) - -This method requires the following URL parameters: - -| Field | Value | Description | -|:---------|:--------------------------------|:--------------------------------| -| `pubkey` | String - Base-58 [Public Key][] | Node public key of the server to look up. | - -This method takes no query parameters. - -#### Response Format - -A successful response uses the HTTP code **200 OK** and has a JSON body with a **[Server Object][]** in the response with the following additional field: - -| Field | Value | Description | -|:---------|:-------|:---------------------------------------------------------| -| `result` | String | The value `success` indicates that this is a successful response. | - -#### Example - -Request: - -``` -GET /v2/network/topology/nodes/n94h5KNspwUGLaGcdHGxruYNmExWHjPkLcMvwsNrivR9czRp6Lor -``` - -Response: - -``` -200 OK -{ - "node_public_key": "n94h5KNspwUGLaGcdHGxruYNmExWHjPkLcMvwsNrivR9czRp6Lor", - "ip": "104.247.221.178", - "port": 51235, - "version": "rippled-0.31.2", - "uptime": 43342, - "inbound_count": 10, - "outbound_count": 11, - "city": "Atlanta", - "country": "United States", - "country_code": "US", - "isp": "QuickPacket, LLC", - "last_updated": "2016-06-07T13:53:12Z", - "lat": "-84.3846", - "long": "33.8379", - "postal_code": "30305", - "region": "Georgia", - "region_code": "GA", - "timezone": "America/New_York", - "result": "success" -} -``` - - - -## Get Topology Links -[[Source]](https://github.com/ripple/rippled-historical-database/blob/master/api/routes/network/getLinks.js "Source") - -Get information on peer-to-peer connections between `rippled` servers. (This is a subset of the data returned by the [Get Topology method](#get-topology).) _(New in [v2.2.0][])_ - -#### Request Format - - - -*REST* - -``` -GET /v2/network/topology/links -``` - - - -[Try it! >](data-api-v2-tool.html#get-topology-links) - -Optionally, you can provide the following query parameters: - -| Field | Value | Description | -|:---------|:-----------------------|:-----------------------------------------| -| `date` | String - [Timestamp][] | Date and time for historical query. The default is the most recent data available. | -| `format` | String | Format of returned results: `csv` or `json`. The default is `json`. | - -#### Response Format - -A successful response uses the HTTP code **200 OK** and has a JSON body with the following: - -| Field | Value | Description | -|:---------|:--------------------------|:--------------------------------------| -| `result` | String | The value `success` indicates that the body represents a successful response. | -| `date` | String - [Timestamp][] | When this data was measured. | -| `count` | Integer | Number of links returned. | -| `links` | Array of [Link Objects][] | Links between `rippled` servers. | - -#### Example - -Request: - -``` -GET /v2/network/topology/links -``` - -Response: - -``` -200 OK -{ - result: "success", - date: "2016-03-21T16:38:52Z", - count: 1632, - links: [ - { - source: "n94Extku8HiQVY8fcgxeot4bY7JqK2pNYfmdnhgf6UbcmgucHFY8", - target: "n9JccBLfrDJBLBF2X5N7bUW8251riCwSf9e3VQ3P5fK4gYr5LBu4" - }, - ... - ] -} -``` - - - -## Get Validator -[[Source]](https://github.com/ripple/rippled-historical-database/blob/master/api/routes/network/getValidators.js "Source") - -Get details of a single validator in the [consensus network](consensus.html). _(Updated in [v2.4.0][])_ - - -#### Request Format - - - -*REST* - -``` -GET /v2/network/validators/{pubkey} -``` - - - -[Try it! >](data-api-v2-tool.html#get-validator) - -This method requires the following URL parameters: - -| Field | Value | Description | -|:---------|:--------------------------------|:----------------------| -| `pubkey` | String - Base-58 [Public Key][] | Validator public key. | - -Optionally, you can provide the following query parameters: - -| Field | Value | Description | -|:---------|:-------|:---------------------------------------------------------| -| `format` | String | Format of returned results: `csv` or `json`. The default is `json`. | - -#### Response Format - -A successful response uses the HTTP code **200 OK** and has a JSON body with the following: - -| Field | Value | Description | -|:------------------------|:--------------------------------|:-----------------| -| `result` | String | The value `success` indicates that the body represents a successful response. | -| `validation_public_key` | String - Base-58 [Public Key][] | This validator's validator public key. | -| `domain` | String | (May be omitted) The DNS domain associated with this validator. | -| `chain` | String | Ledger hash chain which this validator is currently following. The value `main` indicates the main network and `altnet` indicates the XRP Test Network. Other forks are named `chain.{NUMBER}`, where `{NUMBER}` is a unique number for each fork. | -| `unl` | Boolean | True if the validator is part of the ledger chain's recommended UNL. | -| `current_index` | Number | Ledger index of most recently validated ledger. | -| `partial` | Boolean | True if the most recent validation was a partial one. | -| `agreement_1h` | Agreement Object | Object containing agreement stats for the most recent hour. | -| `agreement_24h` | Agreement Object | Object containing agreement stats for the most recent 24 hour period. | - -#### Agreement Objects - -| Field | Value | Description | -|:------------------------|:--------------------------------|:-----------------| -| `score` | String | Score of agreement with the ledger chain being followed. | -| `missed` | Integer | Number of ledgers not validated during the time period. | -| `total` | Integer | Number of ledgers that could have been validated during the time period. | -| `incomplete` | Boolean | True indicates the data does not cover the entire time period. | - -#### Example - -Request: - -``` -GET /v2/network/validators/nHBidG3pZK11zQD6kpNDoAhDxH6WLGui6ZxSbUx7LSqLHsgzMPec -``` - -Response: - -``` -200 OK -{ - "validation_public_key": "nHBidG3pZK11zQD6kpNDoAhDxH6WLGui6ZxSbUx7LSqLHsgzMPec", - "domain": "bitso.com", - "chain": "main", - "current_index": 42279525, - "agreement_1h": { - "missed": 0, - "total": 981, - "score": "1.0000", - "incomplete": false - }, - "agreement_24h": { - "missed": 0, - "total": 23519, - "score": "1.0000", - "incomplete": false - }, - "partial": false, - "unl": true, - "result": "success" -} -``` - - - -## Get Validators -[[Source]](https://github.com/ripple/rippled-historical-database/blob/master/api/routes/network/getValidators.js "Source") - -Get a list of known validators active in the last 24 hours. _(Updated in [v2.4.0][])_ - - -#### Request Format - - - -*REST* - -``` -GET /v2/network/validators -``` - - - -[Try it! >](data-api-v2-tool.html#get-validators) - -Optionally, you can provide the following query parameters: - -| Field | Value | Description | -|:---------|:-------|:---------------------------------------------------------| -| `format` | String | Format of returned results: `csv` or `json`. The default is `json`. | - -#### Response Format - -A successful response uses the HTTP code **200 OK** and has a JSON body with the following: - -| Field | Value | Description | -|:------------------------|:--------------------------------|:-----------------| -| `result` | String | The value `success` indicates that the body represents a successful response. | -| `count` | Integer | Number of validators returned. | -| `validators` | Array of [Validator Objects][] | List of validators active in the last 24 hours. | - -#### Validator Objects -[Validator Objects]: #validator-objects - -| Field | Value | Description | -|:------------------------|:--------------------------------|:-----------------| -| `validation_public_key` | String - Base-58 [Public Key][] | This validator's validator public key. | -| `domain` | String | (May be omitted) The DNS domain associated with this validator. | -| `chain` | String | Ledger hash chain which this validator is currently following. The value `main` indicates the main network and `altnet` indicates the XRP Test Network. Other forks are named `chain.{NUMBER}`, where `{NUMBER}` is a unique number for each fork. | -| `unl` | Boolean | True if the validator is part of the ledger chain's recommended UNL. | -| `current_index` | Number | Ledger index of most recently validated ledger. | -| `partial` | Boolean | True if the most recent validation was a partial one. | -| `agreement_1h` | Agreement Object | Object containing agreement stats for the most recent hour. | -| `agreement_24h` | Agreement Object | Object containing agreement stats for the most recent 24 hour period. | - -#### Agreement Objects - -| Field | Value | Description | -|:------------------------|:--------------------------------|:-----------------| -| `score` | String | Score of agreement with the ledger chain being followed. | -| `missed` | Integer | Number of ledgers not validated during the time period. | -| `total` | Integer | Number of ledgers that could have been validated during the time period. | -| `incomplete` | Boolean | True indicates the data does not cover the entire time period. | - -#### Example - -Request: - -``` -GET /v2/network/validators/ -``` - -Response: - -``` -200 OK -{ - "result": "success", - "count": 141, - "validators": [ - { - "validation_public_key": "nHBidG3pZK11zQD6kpNDoAhDxH6WLGui6ZxSbUx7LSqLHsgzMPec", - "domain: "bitso.com", - "chain": "main", - "current_index": 42281151, - "agreement_1h": { - "missed": 0, - "total": 1029, - "score": "1.0000", - "incomplete": false - }, - "agreement_24h": { - "missed": 0, - "total": 23585, - "score": "1.0000", - "incomplete": false - }, - "partial": false, - "unl": true - }, - { - "validation_public_key": "nHUStq4qu3NXaL6T42wbtpR8mare8gWMVYrUzek227c6QeUn6QGN", - "domain": "blockchain.korea.ac.kr", - "chain": "main", - "current_index": 42860792, - "agreement_1h": { - "missed": 0, - "total": 995, - "score": "1.0000", - "incomplete": false - }, - "agreement_24h": { - "missed": 0, - "total": 23478, - "score": "1.0000", - "incomplete": false - }, - "partial": false, - "unl": true - }, - - ... - ] -} -``` - - - -## Get Validator Manifests -[[Source]](https://github.com/ripple/rippled-historical-database/blob/master/api/routes/network/getManifests.js "Source") - -Retrieve manifests signed by a specified validator. (Manifests designate the ephemeral key a validator uses to sign proposals and validations.) _(New in [v2.3.7][])_ - -**Note:** The Data API does not have a comprehensive record of all manifests. The response only includes data that the Data API has recorded. - -#### Request Format - - - -*REST* - -``` -GET /v2/network/validators/{pubkey}/manifests -``` - - - -[Try it! >](data-api-v2-tool.html#get-validator-manifests) - -This method requires the following URL parameters: - -| Field | Value | Description | -|:----------|:--------------------------------|:----------------------| -| `pubkey` | String - Base-58 [Public Key][] | Validator public key. | - -Optionally, you can provide the following query parameters: - -| Field | Value | Description | -|:---------|:--------|:--------------------------------------------------------| -| `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`. | - -#### Response Format - -A successful response uses the HTTP code **200 OK** and has a JSON body with the following: - -| Field | Value | Description | -|:------------|:------------------------------|:-------------------------------| -| `result` | String | The value `success` indicates that the body represents a successful response. | -| `count` | Integer | Number of manifests returned. | -| `marker` | String | (May be omitted) [Pagination](#pagination) marker. | -| `manifests` | Array of [Manifest Objects][] | The requested manifests. | - -#### Manifest Objects -[Manifest Objects]: #manifest-objects - -Each manifest object contains the following: - -| Field | Value | Description | -|:-----------------------|:--------------------------------|:------------------| -| `count` | Number | How many times the Data API has seen this manifest. Lower numbers mean the manifest is more recent. | -| `ephemeral_public_key` | String - Base-58 [Public Key][] | The ephemeral public key for this validator encoded in this manifest. | -| `first_datetime` | String - [Timestamp][] | The time the Data API first saw this manifest. | -| `last_datetime` | String - [Timestamp][] | The time the Data API most recently saw this manifest. | -| `master_public_key` | String - Base-58 [Public Key][] | The master public key that identifies this validator. | -| `master_signature` | String - Hexadecimal | Signature from the validator master key authorizing this manifest. | -| `sequence` | Number | The sequence number of this manifest. Higher-sequence manifests replace older manifests, rotating the ephemeral keys. | -| `signature` | String - Hexadecimal | Signature from ephemeral key authorized by this manifest. | - -#### Example - -Request: - -``` -GET /v2/network/validator/nHDEmQKb2nbcewdQ1fqCTGcPTcePhJ2Rh6MRftsCaf6UNRQLv7pB/manifests -``` - -Response: - -``` -200 OK -{ - "result": "success", - "count": 2, - "manifests": [ - { - "count": 1, - "ephemeral_public_key": "nHUvPMeNsrwdJd7d65eaYGkKx6bPEcxJGudjVDqwCybtEfrSUE8w", - "first_datetime": "2018-09-06T20:20:08.353Z", - "last_datetime": "2018-09-06T20:20:08.353Z", - "master_public_key": "nHDEmQKb2nbcewdQ1fqCTGcPTcePhJ2Rh6MRftsCaf6UNRQLv7pB", - "master_signature": - "D8E78AD2C10ADA5A91D673C2EA66045926D3ED3D4C77DE4350AAA076379F69B8D0EC492A626EA9228964F694EED9EC63394D051001BA432EC57F2B6031204806", - "sequence": "1", - "signature": - "C794C3D1159932FF8EE7360074E7D17CB59F6646B227EF35D439892C00832648C46FD1958714E153AF4BD0540A7B27011B7F58D357B68B87DCBF5CA81874480C" - }, - { - "count": 1, - "ephemeral_public_key": "n9M7mktkbZCnKWa41LFkZsfXemBGdYsFT6fqJBXa4xupV8X8px7W", - "first_datetime": "2018-09-06T20:20:08.357Z", - "last_datetime": "2018-09-06T20:20:08.357Z", - "master_public_key": "nHDEmQKb2nbcewdQ1fqCTGcPTcePhJ2Rh6MRftsCaf6UNRQLv7pB", - "master_signature": - "F7ECCB90F84ED3FC5E0DE1A6B0B7E835A8D2A94C8E985A74932DE30CD2EDCB46936FD14C39A5AA1BB3583CF888C869167979FEE068C6C34B9B63AB922850090E", - "sequence": "2", - "signature": - "3044022055ED7EFF1245DE21D3C28C57D19301291F0D617CA3A6D3D4CFDF8692D9E0E68502200276215BA986BA61834E0AC71E8590706C851B8F55F0B80A44EECE868F71415F" - } - ] -} -``` - - -## Get Single Validator Reports -[[Source]](https://github.com/ripple/rippled-historical-database/blob/master/api/routes/network/getValidatorReports.js "Source") - -Get a single validator's validation vote stats for 24-hour intervals. _(Updated in [v2.4.0][])_ - -#### Request Format - - - -*REST* - -``` -GET /v2/network/validators/{pubkey}/reports -``` - - - -[Try it! >](data-api-v2-tool.html#get-single-validator-reports) - -This method requires the following URL parameters: - -| Field | Value | Description | -|:---------|:-------|:----------------------| -| `pubkey` | String | Validator public key. | - -Optionally, you can provide the following query parameters: - -| Field | Value | Description | -|:---------|:-----------------------|:-----------------------------------------| -| `start` | String - [Timestamp][] | Start date and time for historical query. The default is to start 200 days before the current date. | -| `end` | String - [Timestamp][] | End date and time for historical query. The default is to end with the most recent data available. | -| `descending` | Boolean | Return results in reverse order. | -| `format` | String | Format of returned results: `csv` or `json`. The default is `json`. | - -#### Response Format - -A successful response uses the HTTP code **200 OK** and has a JSON body with the following: - -| Field | Value | Description | -|:-------------|:-----------------------------------------|:-------------------| -| `result` | String | The value `success` indicates that the body represents a successful response. | -| `count` | Integer | Number of validator daily reports returned. | -| `reports` | Array of [Single Validator Report Objects][] | Daily reports of each validator's performance on that day. | - -##### Single Validator Report Objects -[Single Validator Report Objects]: #single-validator-report-objects - -Each Single Validator Report Object describes a validator's performance on a given day and has the following fields: - -| Field | Value | Description | -|:---------------------|:--------------------------------|:-----------------------------| -| `validation_public_key` | String - Base-58 [Public Key][] | Validator public key. | -| `date` | String - [Timestamp][] | The start time of the date this object describes. | -| `chain` | String | Ledger hash chain which this validator is currently following. The value `main` indicates the main network and `altnet` indicates the XRP Test Network. Other forks are named `chain.{NUMBER}`, where `{NUMBER}` is a unique number for each fork. | -| `score` | String | Score of agreement with the ledger chain being followed. | -| `missed` | Integer | Number of ledgers not validated during the time period. | -| `total` | Integer | Number of ledgers that could have been validated during the time period. | -| `incomplete` | Boolean | True indicates the data does not cover the entire time period. | - -#### Example - -Request: - -``` -GET /v2/network/validators/n949f75evCHwgyP4fPVgaHqNHxUVN15PsJEZ3B3HnXPcPjcZAoy7/reports -``` - -Response: - -``` -200 OK -{ - "result": "success", - "count": 198, - "reports": [ - { - "date": "2015-11-20T00:00:00Z", - "total_ledgers": 19601, - "main_net_agreement": "1.0", - "main_net_ledgers": 19601, - "alt_net_agreement": "0.0", - "alt_net_ledgers": 0, - "other_ledgers": 0 - }, - { - "date": "2015-11-21T00:00:00Z", - "total_ledgers": 19876, - "main_net_agreement": "1.0", - "main_net_ledgers": 19876, - "alt_net_agreement": "0.0", - "alt_net_ledgers": 0, - "other_ledgers": 0 - }, - - ... - ] -} -``` - - -## Get Daily Validator Reports -[[Source]](https://github.com/ripple/rippled-historical-database/blob/master/api/routes/network/getValidatorReports.js "Source") - -Get validation vote stats and validator information for all known validators in a 24-hour period. - -#### Request Format - - - -*REST* - -``` -GET /v2/network/validator_reports -``` - - - -[Try it! >](data-api-v2-tool.html#get-daily-validator-reports) - -Optionally, you can provide the following query parameters: - -| Field | Value | Description | -|:---------|:-----------------------|:-----------------------------------------| -| `date` | String - [Timestamp][] | Date and time to query. By default, uses the most recent data available. | -| `format` | String | Format of returned results: `csv` or `json`. The default is `json`. | - -#### Response Format - -A successful response uses the HTTP code **200 OK** and has a JSON body with the following: - -| Field | Value | Description | -|:----------|:----------------------------------------|:-----------------------| -| `result` | String | The value `success` indicates that the body represents a successful response. | -| `count` | Integer | Number of reports returned. | -| `reports` | Array of [Daily Validator Report Objects][] | Daily summaries of validator performance for each validator active during this time period. | - -#### Daily Validator Report Objects -[Daily Validator Report Objects]: #daily-validator-report-objects - -Each member in the `reports` array describes one validator's performance on that day and has the following fields: - -| Field | Value | Description | -|:------------------------|:------------------------|:-------------------------| -| `validation_public_key` | String - [Public Key][] | The validator's public key, in [base58][]. | -| `date` | String - [Timestamp][] | The start time of the date this object describes. | -| `chain` | String | Ledger hash chain which this validator is currently following. The value `main` indicates the main network and `altnet` indicates the XRP Test Network. Other forks are named `chain.{NUMBER}`, where `{NUMBER}` is a unique number for each fork. | -| `score` | String | Score of agreement with the ledger chain being followed. | -| `missed` | Integer | Number of ledgers not validated during the time period. | -| `total` | Integer | Number of ledgers that could have been validated during the time period. | -| `incomplete` | Boolean | _(Optional)_ True indicates the data does not cover the entire time period. | - -#### Example - -Request: - -``` -GET /v2/network/validator_reports -``` - -Response: - -``` -200 OK -{ - "result": "success", - "count": 27, - "reports": [ - { - "validation_public_key": "n9J2N3FfiUFC4rBX5UBob8JzgDGsYqUou1cwKdsaymS44mZDfnYe", - "date": "2018-10-15T00:00:00Z", - "chain": "main", - "score": "0.6909", - "total": "16127", - "missed": "7216" - } - ] -} -``` - - -## Get rippled Versions -[[Source]](https://github.com/ripple/rippled-historical-database/blob/master/api/routes/network/getVersions.js "Source") - -Reports the latest versions of `rippled` available from the official Ripple Yum repositories. _(New in [v2.3.0][].)_ - -#### Request Format - - - -*REST* - -``` -GET /v2/network/rippled_versions -``` - - - -[Try it! >](data-api-v2-tool.html#get-rippled-versions) - - -#### Response Format - -A successful response uses the HTTP code **200 OK** and has a JSON body with the following: - -| Field | Value | Description | -|:---------|:-------------------------|:---------------------------------------| -| `result` | String | The value `success` indicates that the body represents a successful response. | -| `count` | Integer | Number of rows returned. | -| `rows` | Array of Version Objects | Description of the latest `rippled` version in each repository. | - -Each Version Object contains the following fields: - -| Field | Value | Description | -|:----------|:-----------------------|:----------------------------------------| -| `date` | String - [Timestamp][] | The date this `rippled` version was released. | -| `repo` | String | The Yum repository where this `rippled` is available. The `stable` repository has the latest production version. Other versions are for development and testing. | -| `version` | String | The version string for this version of `rippled`. | - -#### Example - -Request: - -``` -GET /v2/network/rippled_versions -``` - -Response: - -``` -200 OK -{ - "result": "success", - "count": 3, - "rows": [ - { - "date": "2016-06-24T00:00:00Z", - "repo": "nightly", - "version": "0.32.0-rc2" - }, - { - "date": "2016-06-24T00:00:00Z", - "repo": "stable", - "version": "0.32.0" - }, - { - "date": "2016-06-24T00:00:00Z", - "repo": "unstable", - "version": "0.32.0-rc1" - } - ] -} -``` - - - -## Get All Gateways -[[Source]](https://github.com/ripple/rippled-historical-database/blob/master/api/routes/gateways.js "Source") - -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 - - - -*REST* - -``` -GET /v2/gateways/ -``` - - - -[Try it! >](data-api-v2-tool.html#get-all-gateways) - -This method takes no query parameters. - -#### Response Format - -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 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 address](issuing-and-operational-addresses.html) of this currency. | -| `featured` | Boolean | Whether this gateway is considered a "featured" issuer of the currency. Ripple 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 XRP Charts.) | - -#### Example - -Request: - -``` -GET /v2/gateways/ -``` - -Response: - -``` -200 OK -{ - "AUD": [ - { - "name": "Bitstamp", - "account": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B", - "featured": false, - "assets": [ - "logo.grayscale.svg", - "logo.svg" - ] - }, - { - "name": "Coinex", - "account": "rsP3mgGb2tcYUrxiLFiHJiQXhsziegtwBc", - "featured": false, - "assets": [] - } - ], - -... (additional results trimmed) ... - - "0158415500000000C1F76FF6ECB0BAC600000000": [ - { - "name": "GBI", - "account": "rrh7rf1gV2pXAoqA8oYbpHd8TKv5ZQeo67", - "featured": false, - "label": "XAU (-0.5pa)", - "assets": [] - } - ], - "KRW": [ - { - "name": "EXRP", - "account": "rPxU6acYni7FcXzPCMeaPSwKcuS2GTtNVN", - "featured": true, - "assets": [] - }, - { - "name": "Pax Moneta", - "account": "rUkMKjQitpgAM5WTGk79xpjT38DEJY283d", - "featured": false, - "assets": [] - } - ] -} -``` - - - -## Get Gateway -[[Source]](https://github.com/ripple/rippled-historical-database/blob/master/api/routes/gateways.js "Source") - - -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 - - - -*REST* - -``` -GET /v2/gateways/{gateway} -``` - - - -[Try it! >](data-api-v2-tool.html#get-gateway) - -This method requires the following URL parameters: - -| Field | Value | Description | -|:----------|:-------|:--------------------------------------------------------| -| `gateway` | String | The issuing [Address][], [URL-encoded name](https://en.wikipedia.org/wiki/Percent-encoding), or normalized name of the gateway. | - -This method takes no query parameters. - -#### Response Format - -A successful response uses the HTTP code **200 OK** and has a JSON body with the following: - -| Field | Value | Description | -|:-------------|:-----------------------|:-------------------------------------| -| `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 addresses](issuing-and-operational-addresses.html) used by this gateway. (Gateways may use different issuing accounts for different currencies.) | -| `hotwallets` | Array of [Address][]es | This gateway's [operational addresses](issuing-and-operational-addresses.html). | -| `domain` | String | The domain name where this gateway does business. | -| `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 XRP Charts.) | - -Each object in the `accounts` field array has the following fields: - -| Field | Value | Description | -|:-------------|:-------|:-----------------------------------------------------| -| `address` | String | The [issuing address](issuing-and-operational-addresses.html) 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 decides which currencies and gateways to feature based on responsible business practices, volume, and other measures. | - -#### Example - -Request: - -``` -GET /v2/gateways/Gatehub -``` - -Response: - -``` -200 OK -{ - "name": "Gatehub", - "start_date": "2015-02-15T00:00:00Z", - "accounts": [ - { - "address": "rhub8VRN55s94qWKDv6jmDy1pUykJzF3wq", - "currencies": { - "EUR": { - "featured": true - }, - "USD": { - "featured": true - } - } - } - ], - "hotwallets": [ - "rhotcWYdfn6qxhVMbPKGDF3XCKqwXar5J4" - ], - "domain": "gatehub.net", - "normalized": "gatehub", - "assets": [ - "logo.grayscale.svg", - "logo.svg" - ] -} -``` - - - - -## Get Currency Image - -[[Source]](https://github.com/ripple/rippled-historical-database/blob/master/api/routes/gateways.js#L199 "Source") - -Retrieve vector icons for various currencies. _(New in [v2.0.4][])_ - -#### Request Format - - - -*REST* - -``` -GET /v2/currencies/{currencyimage} -``` - - - -This method requires the following URL parameter: - -| Field | Value | Description | -|:----------------|:-------|:--------------------------------------------------| -| `currencyimage` | String | An image file for a currency, such as `xrp.svg`. See [the source code](https://github.com/ripple/rippled-historical-database/tree/develop/api/gateways/currencyAssets) for a list of available images. | - -#### Response Format -A successful response uses the HTTP code **200 OK** and has a **Content-Type** header of `image/svg+xml` to indicate that the contents are XML representing a file in [SVG format](https://en.wikipedia.org/wiki/Scalable_Vector_Graphics). - -#### Example - -Request: - -``` -GET /v2/currencies/mxn.svg -``` - -Response - -``` -200 OK -Content-Type: image/svg+xml - - - - - - - - - -``` - - - -## Get Accounts -[[Source]](https://github.com/ripple/rippled-historical-database/blob/master/api/routes/accounts.js "Source") - -Retrieve information about the creation of new accounts in the XRP Ledger. - -#### Request Format - - - -*REST* - -``` -GET /v2/accounts -``` - - - -[Try it! >](data-api-v2-tool.html#get-accounts) - -Optionally, you can provide the following query parameters: - -| Field | Value | Description | -|:-------------|:-----------------------|:-------------------------------------| -| `start` | String - [Timestamp][] | Start time of query range. | -| `end` | String - [Timestamp][] | End time of query range. | -| `limit` | Integer | Maximum results per page. The default is 200. Cannot be more than 1,000. | -| `marker` | String | [Pagination](#pagination) key from previously returned response. | -| `descending` | Boolean | If `true`, return results in reverse chronological order. The default is `false`. | -| `parent` | String | Filter results to children of the specified parent account. Not compatible with the `interval` parameter. | -| `format` | String | Format of returned results: `csv` or `json`. The default is `json`. | - -The `interval` and `reduce` parameters have been removed in [v2.3.5][]. - -#### Response Format -A successful response uses the HTTP code **200 OK** and has a JSON body with the following: - -| Field | Value | Description | -|:-----------|:--------|:------------------------------------------------------| -| `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 |An array of [account creation objects](#account-creation-objects). | - -#### Example - -Request: - -``` -GET /v1/accounts?parent=rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn -``` - -Response: - -``` -200 OK -{ - "result": "success", - "count": 3, - "accounts": [ - { - "balance": "20.0", - "account": "raKEEVSGnKSD9Zyvxu4z6Pqpm4ABH8FS6n", - "executed_time": "2015-02-09T23:31:40+00:00", - "ledger_index": 11620700, - "parent": "rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn", - "tx_hash": "1D381C0FCA00E8C34A6D4D3A91DAC9F3697B4E66BC49ED3D9B2D6F57D7F15E2E" - }, - { - "balance": "30", - "account": "rUpy3eEg8rqjqfUoLeBnZkscbKbFsKXC3v", - "executed_time": "2015-06-16T21:15:40+00:00", - "ledger_index": 14090928, - "parent": "rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn", - "tx_hash": "60B614622FC67DFCA8D796D7F6AF0B7AEC5E59BB268EA032F810395407DDF8D5" - }, - { - "balance": "50", - "account": "rLFd1FzHMScFhLsXeaxStzv3UC97QHGAbM", - "executed_time": "2015-09-23T23:05:20+00:00", - "ledger_index": 16061430, - "parent": "rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn", - "tx_hash": "FAE331A6D5CB83BCE832E7EBEDBD807EDEFFAF39AB241683EE81A0326A1A6748" - } - ] -} -``` - - -## Get Account -[[Source]](https://github.com/ripple/rippled-historical-database/blob/master/api/routes/getAccount.js "Source") - -Get creation info for a specific ripple account - -#### Request Format - - - - -*REST* - -``` -GET /v2/accounts/{address} -``` - - - -[Try it! >](data-api-v2-tool.html#get-account) - -This method requires the following URL parameters: - -| Field | Value | Description | -|:----------|:-------|:-----------------------------| -| `address` | String | XRP Ledger address to query. | - -#### Response Format - -A successful response uses the HTTP code **200 OK** and has a JSON body with the following: - -| Field | Value | Description | -|:----------|:-------------------------------------------------------|:--------| -| `result` | String | The value `success` indicates that this is a successful response. | -| `account` | Object - [Account Creation](#account-creation-objects) | The requested account. | - -#### Example - -Request: - -``` -GET /v2/accounts/rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn -``` - -Response: - -``` -200 OK -{ - "result": "success", - "account": { - "address": "rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn", - "parent": "ra5nK24KXen9AHvsdFTKHSANinZseWnPcX", - "initial_balance": "100.0", - "inception": "2014-05-29T17:05:20+00:00", - "ledger_index": 6902264, - "tx_hash": "074415C5DC6DB0029E815EA6FC2629FBC29A2C9D479F5D040AFF94ED58ECC820" - } -} -``` - - - -## Get Account Balances -[[Source]](https://github.com/ripple/rippled-historical-database/blob/master/api/routes/accountBalances.js "Source") - -Get all balances held or owed by a specific XRP Ledger account. - - - -*REST* - -``` -GET /v2/accounts/{address}/balances -``` - - - -[Try it! >](data-api-v2-tool.html#get-account-balances) - -This method requires the following URL parameters: - -| Field | Value | Description | -|:----------|:-------|:-----------------------------| -| `address` | String | XRP Ledger address to query. | - -Optionally, you can provide the following query parameters: - -| Field | Value | Description | -|:---------------|:--------|:--------------------------------------------------| -| `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 | Maximum results per page. The default is 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. For large issuers, there can be several tens of thousands of results.) | -| `format` | String | Format of returned results: `csv` or `json`. The default is `json`. | - -#### Response Format -A successful response uses the HTTP code **200 OK** and has a JSON body with the following: - -| Field | Value | Description | -|:---------------|:-----------------------------|:-----------------------------| -| `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 - -Request: - -``` -GET /v2/accounts/rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn/balances?currency=USD&date=2015-01-01T00:00:00Z&limit=3 -``` - -Response: - -``` -200 OK -{ - "result": "success", - "ledger_index": 10852618, - "close_time": "2015-01-01T00:00:00Z", - "limit": 3, - "balances": [ - { - "currency": "USD", - "counterparty": "ra5nK24KXen9AHvsdFTKHSANinZseWnPcX", - "value": "-11.0301" - }, - { - "currency": "USD", - "counterparty": "rMwjYedjc7qqtKYVLiAccJSmCwih4LnE2q", - "value": "0.0001" - }, - { - "currency": "USD", - "counterparty": "rweYz56rfmQ98cAdRaeTxQS9wVMGnrdsFp", - "value": "0" - } - ] -} -``` - - -## Get Account Orders -[[Source]](https://github.com/ripple/rippled-historical-database/blob/master/api/routes/accountOrders.js "Source") - -Get orders in the order books, placed by a specific account. This does not return orders that have already been filled. - -#### Request Format - - - -*REST* - -``` -GET /v2/accounts/{address}/orders -``` - - - -[Try it! >](data-api-v2-tool.html#get-account-orders) - -This method requires the following URL parameters: - -| Field | Value | Description | -|:----------|:---------------------|:-----------------------------| -| `address` | String - [Address][] | XRP Ledger address to query. | - -Optionally, you can provide the following query parameters: - -| 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 | Maximum results per page. The default is 200. Cannot be greater than 400. | -| `format` | String | Format of returned results: `csv` or `json`. The default is `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: - -| Field | Value | Description | -|:---------------|:-----------------------|:-----------------------------------| -| `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. | - -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.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 the order can spend or gain 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 XRP Ledger account that placed the order. | -| `properties.sequence` | Number | The sequence number of the transaction that placed this order. | -| `properties.makerExchangeRate` | [String - Number][] | The exchange rate from the point of view of the account that submitted the order. | - -#### Example - -Request: - -``` -GET /v2/accounts/rK5j9n8baXfL4gzUoZsfxBvvsv97P5swaV/orders?limit=2&date=2015-11-11T00:00:00Z -``` - -Response: - -``` -200 OK -{ - "result": "success", - "ledger_index": 17007855, - "close_time": "2015-11-11T00:00:00Z", - "limit": 2, - "orders": [ - { - "specification": { - "direction": "buy", - "quantity": { - "currency": "JPY", - "value": "56798.00687665813", - "counterparty": "r94s8px6kSw1uZ1MV98dhSRTvc6VMPoPcN" - }, - "totalPrice": { - "currency": "USD", - "value": "433.792841227449", - "counterparty": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B" - } - }, - "properties": { - "maker": "rK5j9n8baXfL4gzUoZsfxBvvsv97P5swaV", - "sequence": 7418286, - "makerExchangeRate": "130.9334813270407" - } - }, - { - "specification": { - "direction": "buy", - "quantity": { - "currency": "JPY", - "value": "11557.02705273459", - "counterparty": "r94s8px6kSw1uZ1MV98dhSRTvc6VMPoPcN" - }, - "totalPrice": { - "currency": "USD", - "value": "87.570156003591", - "counterparty": "rhub8VRN55s94qWKDv6jmDy1pUykJzF3wq" - } - }, - "properties": { - "maker": "rK5j9n8baXfL4gzUoZsfxBvvsv97P5swaV", - "sequence": 7418322, - "makerExchangeRate": "131.9744942815983" - } - } - ] -} -``` - - - - -## Get Account Transaction History -[[Source]](https://github.com/ripple/rippled-historical-database/blob/master/api/routes/accountTransactions.js "Source") - -Retrieve a history of transactions that affected a specific account. This includes all transactions the account sent, payments the account received, and payments that rippled through the account. - -#### Request Format - - - -*REST* - -``` -GET /v2/accounts/{address}/transactions -``` - - - -[Try it! >](data-api-v2-tool.html#get-account-transaction-history) - -This method requires the following URL parameters: - -| Field | Value | Description | -|:----------|:---------------------|:-----------------------------| -| `address` | String - [Address][] | XRP Ledger address to query. | - - -Optionally, you can provide the following query parameters: - -| Field | Value | Description | -|:---------------|:-----------------------|:-----------------------------------| -| `start` | String - [Timestamp][] | Start time of query range. The default is the earliest date available. | -| `end` | String - [Timestamp][] | End time of query range. The default is 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](transaction-types.html). | -| `result` | String | Restrict results to a specified [transaction result](transaction-results.html). | -| `binary` | Boolean | Return results in binary format. | -| `descending` | Boolean | If `true`, return results in reverse chronological order. The default is `false`. | -| `limit` | Integer | Maximum results per page. The default is 20. Cannot be more than 1,000. | -| `marker` | String | [Pagination](#pagination) key from previously returned response. | - -**Note:** This method cannot return CSV format; only JSON results are supported for raw XRP Ledger transactions. - - -#### Response Format - -A successful response uses the HTTP code **200 OK** and has a JSON body with the following: - -| Field | Value | Description | -|:---------------|:-----------------------------------------------------|:-----| -| `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. | - -#### Example - -Request: - -``` -GET /v2/accounts/rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn/transactions?type=Payment&result=tesSUCCESS&limit=1 -``` - -Response: - -``` -200 OK -{ - "result": "success", - "count": 1, - "marker": "rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn|20140602224750|000006979192|00001", - "transactions": [ - { - "hash": "074415C5DC6DB0029E815EA6FC2629FBC29A2C9D479F5D040AFF94ED58ECC820", - "date": "2014-05-29T17:05:20+00:00", - "ledger_index": 6902264, - "tx": { - "TransactionType": "Payment", - "Flags": 0, - "Sequence": 1, - "LastLedgerSequence": 6902266, - "Amount": "100000000", - "Fee": "12", - "SigningPubKey": "032ECFCC409F02057D8556988B89E17D48ECFC8373965036C6BA294AA2B7972971", - "TxnSignature": "30450221008D8E251DA5EA17A29CC9192717860F3B4047E74DF005127A65D9140CAE870C0902201C8E4548D2D3BA11B3E13CE8A167EBC076920E2B1C38547275CAA75FEC436EB9", - "Account": "ra5nK24KXen9AHvsdFTKHSANinZseWnPcX", - "Destination": "rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn" - }, - "meta": { - "TransactionIndex": 1, - "AffectedNodes": [ - { - "CreatedNode": { - "LedgerEntryType": "AccountRoot", - "LedgerIndex": "13F1A95D7AAB7108D5CE7EEAF504B2894B8C674E6D68499076441C4837282BF8", - "NewFields": { - "Sequence": 1, - "Balance": "100000000", - "Account": "rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn" - } - } - }, - { - "ModifiedNode": { - "LedgerEntryType": "AccountRoot", - "PreviousTxnLgrSeq": 6486567, - "PreviousTxnID": "FF9BFF3C200B475CA7EE54F9A98EAB7E92BBDBD2DBE95AC854405D8A85C9D535", - "LedgerIndex": "43EA78783A089B137D5E87610DF3BD4129F989EDD02EFAF6C265924D3A0EF8CE", - "PreviousFields": { - "Sequence": 1, - "Balance": "1000000000" - }, - "FinalFields": { - "Flags": 0, - "Sequence": 2, - "OwnerCount": 0, - "Balance": "899999988", - "Account": "ra5nK24KXen9AHvsdFTKHSANinZseWnPcX" - } - } - } - ], - "TransactionResult": "tesSUCCESS" - } - } - ] -} -``` - - - - -## Get Transaction By Account And Sequence -[[Source]](https://github.com/ripple/rippled-historical-database/blob/master/api/routes/accountTxSeq.js "Source") - -Retrieve a specific transaction originating from a specified account - -#### Request Format - - - -*REST* - -``` -GET /v2/accounts/{address}/transactions/{sequence} -``` - - - -[Try it! >](data-api-v2-tool.html#get-transaction-by-account-and-sequence) - -This method requires the following URL parameters: - -| Field | Value | Description | -|:-----------|:--------|:-----------------------------| -| `address` | String | XRP Ledger address to query. | -| `sequence` | Integer | Transaction sequence number. | - - -Optionally, you can provide the following query parameters: - -| Field | Value | Description | -|:---------|:--------|:--------------------------------------------------------| -| `binary` | Boolean | If `true`, return transaction in binary format. The default is `false`. | - - -#### Response Format - -A successful response uses the HTTP code **200 OK** and has a JSON body with the following: - -| Field | Value | Description | -|:--------------|:-------------------------------------------|:----------------| -| `result` | String | The value `success` indicates that this is a successful response. | -| `transaction` | [transaction object](#transaction-objects) | The requested transaction. | - -#### Example - -Request: - -``` -GET /v2/accounts/rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn/transactions/10?binary=true -``` - -Response: - -``` -200 OK -{ - "result": "success", - "transaction": { - "hash": "4BFFBB86C12659B6C5BB88F0EB859356DE3433EBACBFD9F50F6E70B2C05CCFE0", - "date": "2014-09-15T19:59:10+00:00", - "ledger_index": 8889812, - "tx": "1200052200000000240000000A68400000000000000A732103AB40A0490F9B7ED8DF29D246BF2D6269820A0EE7742ACDD457BEA7C7D0931EDB74473045022100AA4AF08726FCF0F28AA4A841C45F975C3BF1545648F6907DCB33F6E3DD7E85D6022037365B80AB1972BF8A4280009A0DBCF16A1D562ED0489B155750E48CC939039981144B4E9C06F24296074F7BC48F92A97916C6DC5EA9", - "meta": "201C00000003F8E5110061250087A5C555CBCA96F4C42E0EBC0E75C5AD84B3403FEDF824A7DAFA45ADCA6ECB66AA143C1B5613F1A95D7AAB7108D5CE7EEAF504B2894B8C674E6D68499076441C4837282BF8E6240000000A62400000000DB5852F8814D3484B9ED2556DCE16A3B928B438BA6EE0FF0989E1E72200010000240000000B2D0000000062400000000DB5852572110000000000000000000000070000000300770A6D64756F31332E636F6D81144B4E9C06F24296074F7BC48F92A97916C6DC5EA9E1E1F1031000" - } -} -``` - - - -## Get Account Payments -[[Source]](https://github.com/ripple/rippled-historical-database/blob/master/api/routes/accountPayments.js "Source") - -Retrieve a payments for a specified account - -#### Request Format - - - -*REST* - -``` -GET /v2/accounts/{address}/payments -``` - - - -[Try it! >](data-api-v2-tool.html#get-account-payments) - -This method requires the following URL parameters: - -| Field | Value | Description | -|:----------|:-------|:-----------------------------| -| `address` | String | XRP Ledger address to query. | - - -Optionally, you can provide 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. | -| `type` | String | Type of payment - `sent` or `received`. | -| `currency` | String - [Currency Code][] | Filter results to specified currency. | -| `issuer` | String - [Address][] | Filter results to specified issuer. | -| `source_tag` | Integer | Filter results to specified source tag. | -| `destination_tag` | Integer | Filter results to specified destination tag. | -| `limit` | Integer | Maximum results per page. The default is 200. Cannot be more than 1,000. | -| `marker` | String | [Pagination](#pagination) key from previously returned response. | -| `format` | String | Format of returned results: `csv` or `json`. The default is `json`. | - - -#### Response Format - -A successful response uses the HTTP code **200 OK** and has a JSON body with the following: - -| Field | Value | Description | -|:-----------|:-----------------------------|:---------------------------------| -| `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, sorted with oldest first. | - -#### Example - -Request: - -``` -GET /v2/accounts/rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn/payments?currency=USD&limit=1 -``` - -Response: - -``` -200 OK -{ - "result": "success", - "count": 1, - "marker": "rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn|20140604191650|000007013674|00000", - "payments": [ - { - "amount": "1.0", - "delivered_amount": "1.0", - "destination_balance_changes": [ - { - "counterparty": "rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn", - "currency": "USD", - "value": "1" - } - ], - "source_balance_changes": [ - { - "counterparty": "ra5nK24KXen9AHvsdFTKHSANinZseWnPcX", - "currency": "USD", - "value": "-1" - } - ], - "tx_index": 1, - "currency": "USD", - "destination": "ra5nK24KXen9AHvsdFTKHSANinZseWnPcX", - "executed_time": "2014-06-02T22:47:50Z", - "issuer": "rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn", - "ledger_index": 6979192, - "source": "rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn", - "source_currency": "USD", - "tx_hash": "7BF105CFE4EFE78ADB63FE4E03A851440551FE189FD4B51CAAD9279C9F534F0E", - "transaction_cost": "1.0E-5" - } - ] -} -``` - - - - -## Get Account Exchanges -[[Source]](https://github.com/ripple/rippled-historical-database/blob/master/api/routes/accountExchanges.js "Source") - -Retrieve Exchanges for a given account over time. - -#### Request Format - -There are two variations on this method: - - - -*REST - All Exchanges* - -``` -GET /v2/accounts/{address}/exchanges/ -``` - -*REST - Specific Currency Pair* - -``` -GET /v2/accounts/{address}/exchanges/{base}/{counter} -``` - - - -[Try it! >](data-api-v2-tool.html#get-account-exchanges-all) - -This method requires the following URL parameters: - -| Field | Value | Description | -|:----------|:-------|:--------------------------------------------------------| -| `address` | String | XRP Ledger 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. | - - -Optionally, you can provide 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 | If `true`, return results in reverse chronological order. The default is `false`. | -| `limit` | Integer | Maximum results per page. The default is 200. Cannot be more than 1000. | -| `marker` | String | [Pagination](#pagination) key from previously returned response. | -| `format` | String | Format of returned results: `csv` or `json`. The default is `json`. | - - -#### Response Format -A successful response uses the HTTP code **200 OK** and has a JSON body with the following: - -| Field | Value | Description | -|:------------|:------------------------------|:-------------------------------| -| `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. | - -#### Example - -Request: - -``` -GET /v2/accounts/rsyDrDi9Emy6vPU78qdxovmNpmj5Qh4NKw/exchanges/KRW+rUkMKjQitpgAM5WTGk79xpjT38DEJY283d/XRP?start=2015-08-08T00:00:00Z&end=2015-08-31T00:00:00Z&limit=2 - -``` - -Response: - -``` -200 OK -{ - "result": "success", - "count": 2, - "marker": "rsyDrDi9Emy6vPU78qdxovmNpmj5Qh4NKw|20150810014200|000015162386|00013|00003", - "exchanges": [ - { - "base_amount": 209.3501241148, - "counter_amount": 20.424402, - "rate": 0.097560973925, - "autobridged_currency": "USD", - "autobridged_issuer": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B", - "base_currency": "KRW", - "base_issuer": "rUkMKjQitpgAM5WTGk79xpjT38DEJY283d", - "buyer": "rnAqwsu2BEbCjacoZmsXrpViqd3miZhHbT", - "counter_currency": "XRP", - "executed_time": "2015-08-08T02:57:40", - "ledger_index": 15122851, - "offer_sequence": "1738", - "provider": "rsyDrDi9Emy6vPU78qdxovmNpmj5Qh4NKw", - "seller": "rsyDrDi9Emy6vPU78qdxovmNpmj5Qh4NKw", - "taker": "rnAqwsu2BEbCjacoZmsXrpViqd3miZhHbT", - "tx_hash": "506D109A609A5E0778276CCBB125A4AA7B78428059F069A2CB4F739B861C0C49", - "tx_type": "OfferCreate" - }, - { - "base_amount": 86355.6498758851, - "counter_amount": 8424.941452, - "rate": 0.097560975618, - "base_currency": "KRW", - "base_issuer": "rUkMKjQitpgAM5WTGk79xpjT38DEJY283d", - "buyer": "r9xQi5YT8jqVM3wZhbiV94ZKKvGHaVeSDj", - "client": "rt1.1-26-gbeb68ab", - "counter_currency": "XRP", - "executed_time": "2015-08-08T07:15:00", - "ledger_index": 15126536, - "offer_sequence": "1738", - "provider": "rsyDrDi9Emy6vPU78qdxovmNpmj5Qh4NKw", - "seller": "rsyDrDi9Emy6vPU78qdxovmNpmj5Qh4NKw", - "taker": "r9xQi5YT8jqVM3wZhbiV94ZKKvGHaVeSDj", - "tx_hash": "C897A595DED16ADF5AD52E6FD9CE5DE65C78A93CCAA62A85248DC3015A78F5C4", - "tx_type": "Payment" - } - ] -} -``` - - - - -## Get Account Balance Changes -[[Source]](https://github.com/ripple/rippled-historical-database/blob/master/api/routes/accountBalanceChanges.js "Source") - -Retrieve Balance changes for a given account over time. - -#### Request Format - - - -*REST* - -``` -GET /v2/accounts/{address}/balance_changes/ -``` - - - -[Try it! >](data-api-v2-tool.html#get-account-balance-changes) - -This method requires the following URL parameters: - -| Field | Value | Description | -|:----------|:-------|:-----------------------------| -| `address` | String | XRP Ledger address to query. | - - -Optionally, you can provide the following query parameters: - -| Field | Value | Description | -|:---------------|:-----------------------|:-----------------------------------| -| `currency` | String | Restrict results to specified currency. | -| `counterparty` | 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. The default is `false`. | -| `limit` | Integer | Maximum results per page. The default is 200. Cannot be more than 1000. | -| `marker` | String | [Pagination](#pagination) key from previously returned response. | -| `format` | String | Format of returned results: `csv` or`json`. The default is `json`. | - - -#### Response Format -A successful response uses the HTTP code **200 OK** and has a JSON body with the following: - -| Field | Value | Description | -|:------------|:----------------------------------------|:---------------------| -| `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. | - -#### Example - -Request: - -``` -GET /v2/accounts/rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn/balance_changes?descending=true&limit=3 -``` - -Response: - -``` -200 OK -{ - "result": "success", - "count": 3, - "marker": "rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn|20160122235211|000018425487|00010|00001", - "balance_changes": [ - { - "amount_change": "-0.012", - "final_balance": "75.169663", - "tx_index": 7, - "change_type": "transaction_cost", - "currency": "XRP", - "executed_time": "2016-01-29T22:57:20Z", - "ledger_index": 18555460, - "tx_hash": "2B44EBE00728D04658E597A85EC4F71D20503B31ABBF556764AD8F7A80BA72F6" - }, - { - "amount_change": "-25.0", - "final_balance": "75.181663", - "node_index": 1, - "tx_index": 4, - "change_type": "payment_source", - "currency": "XRP", - "executed_time": "2016-01-26T08:32:20Z", - "ledger_index": 18489336, - "tx_hash": "E5C6DD25B2DCF534056D98A2EFE3B7CFAE4EBC624854DE3FA436F733A56D8BD9" - }, - { - "amount_change": "-0.01", - "final_balance": "100.181663", - "tx_index": 4, - "change_type": "transaction_cost", - "currency": "XRP", - "executed_time": "2016-01-26T08:32:20Z", - "ledger_index": 18489336, - "tx_hash": "E5C6DD25B2DCF534056D98A2EFE3B7CFAE4EBC624854DE3FA436F733A56D8BD9" - } - ] -} -``` - - - - -## Get Account Reports -[[Source]](https://github.com/ripple/rippled-historical-database/blob/master/api/routes/accountReports.js "Source") - -Retrieve daily summaries of payment activity for an account. - - - -*REST - Date Omitted* - -``` -GET /v2/accounts/{address}/reports/ -``` - -*REST - Date Specified* - -``` -GET /v2/accounts/{address}/reports/{date} -``` - - - -[Try it! >](data-api-v2-tool.html#get-account-reports-by-day) - -This method requires the following URL parameters: - -| Field | Value | Description | -|:----------|:-------|:--------------------------------------------------------| -| `address` | String | XRP Ledger address to query. | -| `date` | String | _(Optional)_ UTC date for single report. If omitted, use the `start` and `end` query parameters. | - - -Optionally, you can provide the following query parameters: - -| Field | Value | Description | -|:-------------|:-----------------------|:-------------------------------------| -| `start` | String - [Timestamp][] | Start time of query range. The default is the start of the current date. Ignored if `date` specified. | -| `end` | String - [Timestamp][] | End time of query range. The default is the end of the 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. The default is `false`. | -| `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` or `json`. The default is `json`. | - - -#### Response Format -A successful response uses the HTTP code **200 OK** and has a JSON body with the following: - -| Field | Value | Description | -|:----------|:-----------------------------|:----------------------------------| -| `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 - -Request: - -``` -GET /v2/accounts/rMwjYedjc7qqtKYVLiAccJSmCwih4LnE2q/reports?start=2015-08-28T00:00:00&end=2015-08-28T00:00:00&accounts=true&payments=true&descending=true -``` - -Response: - -``` -200 OK -{ - "result": "success", - "count": 1, - "reports": [ - { - "account": "rMwjYedjc7qqtKYVLiAccJSmCwih4LnE2q", - "date": "2015-08-28T00:00:00+00:00", - "high_value_received": 89500.74142547617, - "high_value_sent": 0, - "payments": [ - { - "tx_hash": "F2323EE7494384E77ABB18F31981FEE8C31767BBD27515B55FC3BD6792C4E408", - "amount": 2.7, - "currency": "BTC", - "issuer": "rMwjYedjc7qqtKYVLiAccJSmCwih4LnE2q", - "type": "received" - }, - { - "tx_hash": "FEAD462738EE430E154FF3122D3EE2DD27DDD8BEFBA080A60FE91B78E8865365", - "amount": 3, - "currency": "BTC", - "issuer": "rMwjYedjc7qqtKYVLiAccJSmCwih4LnE2q", - "type": "received" - }, - { - "tx_hash": "383B1D1EABB646AB2EFBBF9E8967FE279BFE5EF86A3B6BCD5BDA287210053116", - "amount": 0.14, - "currency": "BTC", - "issuer": "rMwjYedjc7qqtKYVLiAccJSmCwih4LnE2q", - "type": "received" - } - ], - "payments_received": 3, - "payments_sent": 0, - "receiving_counterparties": [], - "sending_counterparties": [ - "rhi4zZdCeFdfTokzek8D7p9bUWmtEFCZAe", - "rP1hkW1LCiVos6FpzU7itmm9Tk29yqvyk5" - ], - "total_value": 174019.58324753598, - "total_value_received": 174019.58324753598, - "total_value_sent": 0 - } - ] -} -``` - - - -## Get Account Transaction Stats -[[Source]](https://github.com/ripple/rippled-historical-database/blob/master/api/routes/accountStats.js "Source") - -Retrieve daily summaries of transaction activity for an account. _(New in [v2.1.0][].)_ - - - -*REST* - -``` -GET /v2/accounts/{address}/stats/transactions -``` - - - -[Try it! >](data-api-v2-tool.html#get-account-transaction-stats) - -This method requires the following URL parameters: - -| Field | Value | Description | -|:----------|:-------|:-----------------------------| -| `address` | String | XRP Ledger address to query. | - - -Optionally, you can provide the following query parameters: - -| Field | Value | Description | -|:-------------|:-----------------------|:-------------------------------------| -| `start` | String - [Timestamp][] | Start time of query range. The default is the earliest date available. | -| `end` | String - [Timestamp][] | End time of query range. The default is the current date. | -| `limit` | Integer | Maximum results per page. The default is 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` or `json`. The default is `json`. | - - -#### Response Format -A successful response uses the HTTP code **200 OK** and has a JSON body with the following: - -| Field | Value | Description | -|:---------|:-----------------------------------|:-----------------------------| -| `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][] | 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](transaction-results.html), indicating how many of each result code occurred in the transactions sent by this account on this date. | -| `type` | Object | Map of [transaction types](transaction-formats.html), indicating how many of each transaction type the account sent on this date. | - -#### Example - -Request: - -``` -GET /v2/accounts/rGFuMiw48HdbnrUbkRYuitXTmfrDBNTCnX/stats/transactions?start=2015-01-01&limit=2 -``` - -Response: - -``` -200 OK -{ - "result": "success", - "count": 2, - "marker": "rGFuMiw48HdbnrUbkRYuitXTmfrDBNTCnX|20150116000000", - "rows": [ - { - "date": "2015-01-14T00:00:00Z", - "transaction_count": 44, - "result": { - "tecUNFUNDED_PAYMENT": 1, - "tesSUCCESS": 43 - }, - "type": { - "Payment": 42, - "TrustSet": 2 - } - }, - { - "date": "2015-01-15T00:00:00Z", - "transaction_count": 116, - "result": { - "tesSUCCESS": 116 - }, - "type": { - "Payment": 116 - } - } - ] -} -``` - - - -## Get Account Value Stats -[[Source]](https://github.com/ripple/rippled-historical-database/blob/master/api/routes/accountStats.js "Source") - -Retrieve daily summaries of transaction activity for an account. _(New in [v2.1.0][].)_ - - - -*REST* - -``` -GET /v2/accounts/{address}/stats/value -``` - - - -[Try it! >](data-api-v2-tool.html#get-account-value-stats) - -This method requires the following URL parameters: - -| Field | Value | Description | -|:----------|:-------|:-----------------------------| -| `address` | String | XRP Ledger address to query. | - - -Optionally, you can provide the following query parameters: - -| Field | Value | Description | -|:-------------|:-----------------------|:-------------------------------------| -| `start` | String - [Timestamp][] | Start time of query range. The default is the start of the most recent interval. | -| `end` | String - [Timestamp][] | End time of query range. The default is the end of the most recent interval. | -| `limit` | Integer | Maximum results per page. The default is 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`. The default is `json`. | - - -#### Response Format -A successful response uses the HTTP code **200 OK** and has a JSON body with the following: - -| Field | Value | Description | -|:---------|:-----------------------------|:-----------------------------------| -| `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 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. | - -#### Example - -Request: - -``` -GET /v2/accounts/rGFuMiw48HdbnrUbkRYuitXTmfrDBNTCnX/stats/value?limit=2&descending=true -``` - -Response: - -``` -200 OK -{ - "result": "success", - "count": 2, - "marker": "rGFuMiw48HdbnrUbkRYuitXTmfrDBNTCnX|20160412000000", - "rows": [ - { - "date": "2016-04-14T00:00:00Z", - "account_value": "7.666658705139822E7", - "balance_change_count": 58 - }, - { - "date": "2016-04-13T00:00:00Z", - "account_value": "1.0022208004947332E8", - "balance_change_count": 184 - } - ] -} -``` - - - - -## Health Check - API -[[Source]](https://github.com/ripple/rippled-historical-database/blob/master/api/routes/checkHealth.js "Source") - -Check the health of the API service. - - - -*REST* - -``` -GET /v2/health/api -``` - - - -[Try it! >](data-api-v2-tool.html#api-health-check) - -Optionally, you can provide the following query parameters: - -| Field | Value | Description | -|:------------|:--------|:-----------------------------------------------------| -| `threshold` | Integer | Consider the API unhealthy if the database does not respond within this amount of time, in seconds. The default is 5 seconds. | -| `verbose` | Boolean | If `true`, return a JSON response with data points. By default, return an integer value only. | - -#### Response Format - -A successful response uses the HTTP code **200 OK**. By default, the response body is an **integer health value only**. - -The health value `0` always indicates a healthy status. Other health values are defined as follows: - -| Value | Meaning | -|:------|:---------------------------------------------------------------------| -| `0` | API service is up, and response time to HBase is less than `threshold` value from request. | -| `1` | API service is up, but response time to HBase is greater than `threshold` value from request. | - -If the request specifies `verbose=true` in the query parameters, the response body is a JSON object, with the following fields: - -| Field | Value | Description | -|:--------------------------|:-----------------------------|:------------------| -| `score` | 0-1 | Health value, as defined above. | -| `response_time` | String - Human-readable time | The actual response time of the database. | -| `response_time_threshold` | String - Human-readable time | The maximum response time to be considered healthy. | - -#### Example - -Request: - -``` -GET /v2/health/api?verbose=true -``` - -Response: - -``` -200 OK -{ - "score": 0, - "response_time": "0.014s", - "response_time_threshold": "5s" -} -``` - - -## Health Check - Ledger Importer -[[Source]](https://github.com/ripple/rippled-historical-database/blob/master/api/routes/checkHealth.js "Source") - -Check the health of the Ledger Importer Service. - - - -*REST - Importer Health* - -``` -GET /v2/health/importer -``` - - - -[Try it! >](data-api-v2-tool.html#importer-health-check) - -Optionally, you can provide the following query parameters: - -| Field | Value | Description | -|:-------------|:--------|:----------------------------------------------------| -| `threshold` | Integer | Consider the Importer unhealthy if more than this amount of time, in seconds, has elapsed since the latest validated ledger was imported. The default is 300 seconds. | -| `threshold2` | Integer | Consider the Importer unhealthy if more than this amount of time, in seconds, has elapsed since the latest ledger of any kind was imported. The default is 60 seconds. | -| `verbose` | Boolean | If `true`, return a JSON response with data points. By default, return an integer value only. | - -#### Response Format - -A successful response uses the HTTP code **200 OK**. By default, the response body is an **integer health value only**. - -The health value `0` always indicates a healthy status. Other health values are defined as follows: - -| Value | Meaning | -|:------|:---------------------------------------------------------------------| -| `0` | The most recent imported ledger was less than `threshold2` (Default: 60) seconds ago, and most recent validated ledger was less than `threshold` seconds ago. | -| `1` | The most recent imported ledger was less than `threshold2` (Default: 60) seconds ago, but the most recent validated ledger is older than `threshold` seconds. | -| `2` | The most recent imported ledger was more than `threshold2` seconds ago. | - -If the request specifies `verbose=true` in the query parameters, the response body is a JSON object, with the following fields: - -| Field | Value | Description | -|:---------------------------|:-----------------------------|:-----------------| -| `score` | 0-2 | Health value, as defined above. | -| `response_time` | String | The actual response time of the database. | -| `ledger_gap` | String - Human-readable time | Difference between the close time of the last saved ledger and the current time. | -| `ledger_gap_threshold` | String - Human-readable time | Maximum ledger gap to be considered healthy. | -| `valildation_gap` | String - Human-readable time | Difference between the close time of the last imported validated ledger and the current time. | -| `validation_gap_threshold` | String - Human-readable time | Maximum validation gap to be considered healthy. | - -#### Example - -Request: - -``` -GET /v2/health/importer?verbose=true -``` - -Response: - -``` -200 OK -{ - "score": 0, - "response_time": "0.081s", - "ledger_gap": "1.891s", - "ledger_gap_threshold": "5.00m", - "validation_gap": "29.894s", - "validation_gap_threshold": "15.00m" -} -``` - - - -## Health Check - Nodes ETL -[[Source]](https://github.com/ripple/rippled-historical-database/blob/master/api/routes/checkHealth.js "Source") - -Check the health of the Topology Nodes Extract, Transform, Load (ETL) Service. - - - -*REST - Nodes ETL Health* - -``` -GET /v2/health/nodes_etl -``` - - - -[Try it! >](data-api-v2-tool.html#nodes-etl-health-check) - -Optionally, you can provide the following query parameters: - -| Field | Value | Description | -|:------------|:--------|:-----------------------------------------------------| -| `threshold` | Integer | Consider the service unhealthy if more than this amount of time, in seconds, has elapsed since the latest data was imported. The default is 120 seconds. | -| `verbose` | Boolean | If `true`, return a JSON response with data points. By default, return an integer value only. | - -#### Response Format - -A successful response uses the HTTP code **200 OK**. By default, the response body is an **integer health value only**. - -The health value `0` always indicates a healthy status. Other health values are defined as follows: - -| Value | Meaning | -|:------|:---------------------------------------------------------------------| -| `0` | The most recent imported topology data was less than `threshold` (Default: 120) seconds ago. | -| `1` | The most recent imported topology data was more than `threshold` seconds ago. | - - -If the request specifies `verbose=true` in the query parameters, the response body is a JSON object, with the following fields: - -| Field | Value | Description | -|:----------------|:-----------------------------|:----------------------------| -| `score` | 0-1 | Health value, as defined above. | -| `gap` | String - Human-readable time | Difference between the latest imported data and the current time. | -| `gap_threshold` | String - Human-readable time | Maximum gap to be considered healthy. | -| `message` | String | Description of the reason for a non-zero score, if applicable. | - -#### Example - -Request: - -``` -GET /v2/health/nodes_etl?verbose=true -``` - -Response: - -``` -200 OK -{ - "score": 0, - "gap": "1.891s", - "gap_threshold": "2.00m", -} -``` - - - -## Health Check - Validations ETL -[[Source]](https://github.com/ripple/rippled-historical-database/blob/master/api/routes/checkHealth.js "Source") - -Check the health of the Validations Extract, Transform, Load (ETL) Service. - - - -*REST - Validations ETL Health* - -``` -GET /v2/health/validations_etl -``` - - - -[Try it! >](data-api-v2-tool.html#validations-etl-health-check) - -Optionally, you can provide the following query parameters: - -| Field | Value | Description | -|:------------|:--------|:-----------------------------------------------------| -| `threshold` | Integer | Consider the service unhealthy if more than this amount of time, in seconds, has elapsed since the latest data was imported. The default is 120 seconds. | -| `verbose` | Boolean | If `true`, return a JSON response with data points. By default, return an integer value only. | - -#### Response Format - -A successful response uses the HTTP code **200 OK**. By default, the response body is an **integer health value only**. - -The health value `0` always indicates a healthy status. Other health values are defined as follows: - -| Value | Meaning | -|:------|:---------------------------------------------------------------------| -| `0` | The most recent imported topology data was less than `threshold` (Default: 120) seconds ago. | -| `1` | The most recent imported topology data was more than `threshold` seconds ago. | - -If the request specifies `verbose=true` in the query parameters, the response body is a JSON object, with the following fields: - -| Field | Value | Description | -|:----------------|:-----------------------------|:----------------------------| -| `score` | 0-1 | Health value, as defined above. | -| `gap` | String - Human-readable time | Difference between the latest imported data and the current time. | -| `gap_threshold` | String - Human-readable time | Maximum gap to be considered healthy. | -| `message` | String | Description of the reason for a non-zero score, if applicable. | - -#### Example - -Request: - -``` -GET /v2/health/nodes_etl?verbose=true -``` - -Response: - -``` -200 OK -{ - "score": 0, - "gap": "1.891s", - "gap_threshold": "2.00m", -} -``` - - - - -# API Conventions - -## Basic Types - -As a REST API, the Data API v2 uses [JSON](http://json.org/)'s native data types to represent API fields, with some special cases. - -### Numbers and Precision -[String - Number]: #numbers-and-precision - -{% include '_snippets/string-number-formatting.md' %} - -The precision for amounts of **non-XRP currency** in the XRP Ledger is as follows: - -* Minimum nonzero absolute value: `1000000000000000e-96` -* Maximum value: `9999999999999999e80` -* Minimum value: `-9999999999999999e80` -* 15 decimal digits of precision - -**XRP** has a different internal representation, and its precision is different: - -* Minimum value: `0` -* Maximum value: `100000000000` (`1e11`) -* Precise to the nearest `0.000001` (`1e-6`) - -In other words, XRP has the same precision as a 64-bit unsigned integer where each unit is equivalent to 0.000001 XRP. - -### Addresses -[Address]: #addresses - -{% include '_snippets/data_types/address.md' %} - - -### Public Keys -[Public Key]: #public-keys - -{% include '_snippets/data_types/public_key.md' %} - - -### Hashes -[Hash]: #hashes - -{% include '_snippets/data_types/hash.md' %} - - -### Timestamps -[Timestamp]: #timestamps - -All dates and times are written in ISO 8601 Timestamp Format, using UTC. This format is summarized as: - -`YYYY-MM-DDThh:mm:ssZ` - -* Four-digit year -* Two-digit month -* Two-digit day -* The letter `T` separating the date part and the time part -* Two-digit hour using a 24-hour clock -* Two digit minute -* The letter `Z` indicating zero offset from UTC. - -(As of [v2.0.4][], the offset `+00:00` is no longer used.) - -### Ledger Index -[Ledger Index]: #ledger-index - -{% include '_snippets/data_types/ledger_index.md' %} - -### Account Sequence -[Sequence Number]: #account-sequence - -{% include '_snippets/data_types/account_sequence.md' %} - -### Currency Code -[Currency Code]: #currency-code - -{% include '_snippets/data_types/currency_code.md' %} - -## Pagination - -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 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. To do so, make more requests with the previous value of the `marker` field as the `marker` query parameter. For each additional request, use the same parameters as the first request (except `marker`). When the response omits the `marker` parameter, that indicates that you have reached the end of the data. - -When a `marker` is or would be present, the response contains a [`Link` header](https://tools.ietf.org/html/rfc5988#section-5) with `rel="next"`. This is a full URL to the next page of results. You can use this to paginate over results when the response is in `csv` format instead of `json`. _(New in [v2.0.4][])_ - -## Transaction Objects - -Transactions have two formats - a compact "binary" format where the defining fields of the transaction are encoded as strings of hex, and an expanded format where the defining fields of the transaction are nested as complete JSON objects. - -### Full JSON Format - -| Field | Value | Description | -|:---------------|:--------------------------|:--------------------------------| -| `hash` | String - [Hash][] | An identifying hash value unique to this transaction, as a hex string. | -| `date` | String - [Timestamp][] | The time when this transaction was included in a validated ledger. | -| `ledger_index` | Number - [Ledger Index][] | The ledger index of the ledger that included this transaction. | -| `tx` | Object | The fields of this transaction object, as defined by the [Transaction Format](transaction-formats.html). | -| `meta` | Object | Metadata about the results of this transaction. | - -### Binary Format - -| Field | Value | Description | -|:---------------|:--------------------------|:--------------------------------| -| `hash` | String - [Hash][] | An identifying hash value unique to this transaction, as a hex string. | -| `date` | String - [Timestamp][] | The time when this transaction was included in a validated ledger. | -| `ledger_index` | Number - [Ledger Index][] | The ledger index of the ledger that included this transaction. | -| `tx` | String | The binary data that represents this transaction, as a hexadecimal string. | -| `meta` | String | The binary data that represents this transaction's metadata, as a hex string. | - -## Ledger Objects - -A "ledger" is one version of the shared global ledger. Each ledger object has the following fields: - -| Field | Value | Description | -|:--------------------|:--------------------------|:---------------------------| -| `ledger_hash` | String - [Hash][] | An identifying hash unique to this ledger, as a hex string. | -| `ledger_index` | Number - [Ledger Index][] | The ledger index of the ledger. Each new ledger has a ledger index 1 higher than the ledger that came before it. | -| `parent_hash` | String - [Hash][] | The identifying hash of the previous ledger. | -| `total_coins` | [String - Number][] | The total number of "drops" of XRP still in existence at the time of the ledger. (Each XRP is 1,000,000 drops.) | -| `close_time_res` | Number | The ledger close time is rounded to this many seconds. | -| `accounts_hash` | String - [Hash][] | Hash of the account information contained in this ledger, as hex. | -| `transaction_hash` | String - [Hash][] | Hash of the transaction information contained in this ledger, as hex. | -| `close_time` | Number | When this ledger was closed, in UNIX time. | -| `close_time_human` | String - [Timestamp][] | When this ledger was closed. | - -**Note:** Ledger close times are approximate, typically rounded to about 10 seconds. Two ledgers could have the same `close_time` values, when their actual close times were several seconds apart. The ledger index makes it unambiguous which ledger closed first. - -### Genesis Ledger - -Due to a mishap early in the XRP Ledger's history, ledgers 1 through 32569 were lost. Thus, ledger #32570 is the earliest ledger available anywhere. For purposes of the Data API v2, ledger #32570 is considered the _genesis ledger_. - -## Account Creation Objects - -An account creation object represents the action of creating an account in the XRP Ledger. There are two variations, depending on whether the account was already present in ledger 32570, the earliest ledger available. Accounts that were already present in ledger 32570 are termed _genesis accounts_. - -| Field | Value | Description | -|:------------------|:-----------------------------|:--------------------------| -| `address` | String - [Address][] | The identifying address of this account, in base-58. | -| `inception` | String - [Timestamp][] | The UTC timestamp when the address was funded. For genesis accounts, this is the timestamp of ledger 32570. | -| `ledger_index` | Number - [Ledger Index][] | The ledger index of the ledger when the account was created, or 32570 for genesis accounts. | -| `parent` | String - [Address][] | (Omitted for genesis accounts) The address that provided the XRP to fund this address. | -| `tx_hash` | String - [Hash][] | (Omitted for genesis accounts) The identifying hash of the transaction that funded this account. | -| `initial_balance` | [String - Number][] | (Omitted for genesis accounts) The amount of XRP that funded this account. | -| `genesis_balance` | [String - Number][] | (Genesis accounts only) The amount of XRP this account held as of ledger #32570. | -| `genesis_index` | Number - [Sequence Number][] | (Genesis accounts only) The transaction sequence number of the account as of ledger #32570. | - - -## Exchange Objects -[Exchange Objects]: #exchange-objects - -An exchange object represents an actual exchange of currency, which can occur in the XRP Ledger as the result of executing either an OfferCreate transaction or a Payment transaction. In order for currency to actually change hands, there must be a previously-unfilled Offer previously placed in the ledger with an OfferCreate transaction. - -A single transaction can cause several exchanges to occur. In this case, the sender of the transaction is the taker for all the exchanges, but each exchange has a different provider, currency pair, or both. - -| Field | Value | Description | -|:-----------------------|:-----------------------------|:---------------------| -| `base_amount` | Number | The amount of the base currency that was traded. | -| `counter_amount` | Number | The amount of the counter currency that was traded. | -| `rate` | Number | The amount of the counter currency acquired per 1 unit of the base currency. | -| `autobridged_currency` | String - [Currency Code][] | (May be omitted) If the offer was auto-bridged (XRP order books were used to bridge two non-XRP currencies), this is the other currency from the offer that executed this exchange. | -| `autobridged_issuer` | String - [Address][] | (May be omitted) If the offer was auto-bridged (XRP order books were used to bridge two non-XRP currencies), this is the other currency from the offer that executed this exchange. | -| `base_currency` | String - [Currency Code][] | The base currency. | -| `base_issuer` | String - [Address][] | (Omitted for XRP) The account that issued the base currency. | -| `buyer` | String - [Address][] | The account that acquired the base currency. | -| `client` | String | (May be omitted) If the transaction contains a memo indicating what client application sent it, this is the contents of the memo. | -| `counter_currency` | String - [Currency Code][] | The counter currency. | -| `counter_issuer` | String - [Address][] | (Omitted for XRP) The account that issued the counter currency. | -| `executed_time` | String - [Timestamp][] | The time the exchange occurred. | -| `ledger_index` | Number - [Ledger Index][] | The ledger index of the ledger that included this transaction. | -| `offer_sequence` | Number - [Sequence Number][] | The sequence number of the `provider`'s existing offer in the ledger. | -| `provider` | String - [Address][] | The account that had an existing Offer in the ledger. | -| `seller` | String - [Address][] | The account that acquired the counter currency. | -| `taker` | String - [Address][] | The account that sent the transaction which executed this exchange. | -| `tx_hash` | String - [Hash][] | The identifying hash of the transaction that executed this exchange. (**Note:** This exchange may be one of several executed in a single transaction.) | -| `tx_type` | String | The type of transaction that executed this exchange, either `Payment` or `OfferCreate`. | - - -## Reports Objects -[Reports Objects]: #reports-objects - -Reports objects show the activity of a given account over a specific interval of time, typically a day. Reports have the following fields: - -| Field | Value | Description | -|:---------------------------|:-------------------------------------|:---------| -| `account` | String - [Address][] | The address of the account to which this report pertains. | -| `date` | String - [Timestamp][] | The start of the interval to which this report pertains. | -| `high_value_received` | [String - Number][] | Largest amount received in a single transaction, normalized to XRP (as closely as possible). This includes payments and exchanges. | -| `high_value_sent` | [String - Number][] | The largest amount sent in a single transaction, normalized to XRP (as closely as possible). | -| `payments` | Array of [Payment Summary Objects][] | (May be omitted) Array with information on each payment sent or received by the account during this interval. | -| `payments_received` | Number | The number of payments sent to this account. (This only includes payments for which this account was the destination, not payments that only rippled through the account or consumed the account's offers.) | -| `payments_sent` | Number | The number of payments sent by this account. | -| `receiving_counterparties` | Array or Number | If account lists requested, an array of addresses that received payments from this account. Otherwise, the number of different accounts that received payments from this account. | -| `sending_counterparties` | Array or Number | If account lists requested, an array of addresses that sent payments to this account. Otherwise, the number of different accounts that sent payments to this account. | -| `total_value` | [String - Number][] | Sum of total value received and sent in payments, normalized to XRP (as closely as possible). | -| `total_value_received` | [String - Number][] | Sum value of all payments to this account, normalized to XRP (as closely as possible). | -| `total_value_sent` | [String - Number][] | Sum value of all payments from this account, normalized to XRP (as closely as possible). | - -## Payment Summary Objects -[Payment Summary Objects]: #payment-summary-objects - -A Payment Summary Object contains a reduced amount of information about a single payment from the perspective of either the sender or receiver of that payment. - -| Field | Value | Description | -|:-------------------|:---------------------------|:---------------------------| -| `tx_hash` | String - [Hash][] | The identifying hash of the transaction that caused the payment. | -| `delivered_amount` | [String - Number][] | The amount of the destination `currency` actually received by the destination account. | -| `currency` | String - [Currency Code][] | The currency delivered to the recipient of the transaction. | -| `issuer` | String - [Address][] | The gateway issuing the currency, or an empty string for XRP. | -| `type` | String | Either `sent` or `received`, indicating whether the perspective account is sender or receiver of this transaction. | - - -## 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 XRP Ledger transactions of the `Payment` [transaction type](transaction-types.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: - -| Field | Value | Description | -|:------------------------------|:---------------------------|:----------------| -| `amount` | [String - Number][] | The amount of the destination `currency` that the transaction was instructed to send. In the case of Partial Payments, this is a "maximum" amount. | -| `delivered_amount` | [String - Number][] | The amount of the destination `currency` actually received by the destination account. | -| `destination_balance_changes` | Array | Array of [balance change objects][], indicating all changes made to the `destination` account's balances. | -| `source_balance_changes` | Array | Array of [balance change objects][], indicating all changes to the `source` account's balances (except the XRP transaction cost). | -| `transaction_cost` | [String - Number][] | The amount of XRP spent by the `source` account on the transaction cost. (Prior to [v2.0.4][], this parameter was called `fee`.) | -| `destination_tag` | Integer | (May be omitted) A [destination tag](become-an-xrp-ledger-gateway.html#source-and-destination-tags) specified in this payment. | -| `source_tag` | Integer | (May be omitted) A [source tag](become-an-xrp-ledger-gateway.html#source-and-destination-tags) specified in this payment. | -| `currency` | String - [Currency Code][] | The currency that the `destination` account received. | -| `destination` | String - [Address][] | The account that received the payment. | -| `executed_time` | String - [Timestamp][] | The time the ledger that included this payment closed. | -| `ledger_index` | Number - [Ledger Index][] | The ledger index of the ledger that included this payment. | -| `source` | String - [Address][] | The account that sent the payment. | -| `source_currency` | String - [Currency Code][] | The currency that the `source` account spent. | -| `tx_hash` | String - [Hash][] | The identifying hash of the transaction that caused the payment. | - - -## Balance Objects and Balance Change Objects -[balance change objects]: #balance-objects-and-balance-change-objects -[Balance Object]: #balance-objects-and-balance-change-objects - -Balance objects represent an XRP Ledger account's balance in a specific currency with a specific counterparty at a single point in time. Balance change objects represent a change to such balances that occurs in transaction execution. - -A single XRP Ledger transaction may cause changes to balances with several counterparties, as well as changes to XRP. - -Balance objects and Balance Change objects have the same format, with the following fields: - -| Field | Value | Description | -|:---------------|:---------------------------|:-------------------------------| -| `counterparty` | String - [Address][] | The counterparty, or issuer, of the `currency`. In the case of XRP, this is an empty string. | -| `currency` | String - [Currency Code][] | The currency for which this balance changed. | -| `value` | [String - Number][] | The amount of the `currency` that the associated account gained or lost. In balance change objects, this value can be positive (for amounts gained) or negative (for amounts lost). In balance objects, this value can be positive (for amounts the counterparty owes the account) or negative (for amounts owed to the counterparty). | - - -## Balance Change Descriptors -[Balance Change Descriptors]: #balance-change-descriptors - -Balance Change Descriptors are objects that describe and analyze a single balance change that occurs in transaction execution. They represent the same events as [balance change objects][], but in greater detail. - -Balance Change Descriptors have the following fields: - -| Field | Value | Description | -|:----------------|:---------------------------|:------------------------------| -| `amount_change` | [String - Number][] | The difference in the amount of currency held before and after this change. _(Prior to [v2.0.6][], this field was called `change`.)_ | -| `final_balance` | [String - Number][] | The balance after the change occurred. | -| `node_index` | Number (or `null`) | This balance change is represented by the entry at this index of the `ModifiedNodes` array within the [metadata section](transaction-metadata.html) of the transaction that executed this balance change. **Note:** When the transaction cost is combined with other changes to XRP balance, the transaction cost has a `node_index` of **null** instead. | -| `tx_index` | Number | The transaction that executed this balance change is at this index in the array of transactions for the ledger that included it. | -| `change_type` | String | One of several [](#change-types) describing what caused this balance change to occur. | -| `currency` | String - [Currency Code][] | The change affected this currency. | -| `executed_time` | String - [Timestamp][] | The time the change occurred. (This is based on the close time of the ledger that included the transaction that executed the change. | -| `counterparty` | String - [Address][] | (Omitted for XRP) The `currency` is held in a trust line to or from this account. _(Prior to [v2.0.6][], this field was called `issuer`.)_ | -| `ledger_index` | Number - [Ledger Index][] | The ledger index of the ledger that included the transaction that executed this balance change. | -| `tx_hash` | String - [Hash][] | The identifying hash of the transaction that executed this balance change. | - -### Change Types - -The following values are valid for the `change_type` field of a Balance Change Descriptor: - -| Value | Meaning | -|:----------------------|:-----------------------------------------------------| -| `transaction_cost` | This balance change reflects XRP that was destroyed to relay a transaction. _(Prior to [v2.0.4][], this was `network fee` instead.)_ | -| `payment_destination` | This balance change reflects currency that was received from a payment. | -| `payment_source` | This balance change reflects currency that was spent in a payment. | -| `exchange` | This balance change reflects currency that was traded for other currency, or the same currency from a different issuer. This can occur in the middle of payment execution as well as from offers. | - -## Volume Objects -[Volume Objects]: #volume-objects - -Volume objects represent the total volumes of money moved, in either payments or exchanges, during a given period. - -| Field | Value | Description | -|:----------------|:-----------------------|:----------------------------------| -| `components` | Array of Objects | The data that was used to assemble this total. For payment volume, each object represents payments in a particular currency and issuer. For exchange volume, each object represents a market between two currencies. | -| `count` | Number | The total number of exchanges in this period. | -| `end_time` | String - [Timestamp][] | The end time of this interval. | -| `exchange` | Object | Indicates the display currency used, as with fields `currency` and (except for XRP) `issuer`. All amounts are normalized by first converting to XRP, and then to the display currency specified in the request. | -| `exchange_rate` | Number | The exchange rate to the displayed currency from XRP. | -| `start_time` | String - [Timestamp][] | The start of this period. | -| `total` | Number | Total volume of all recorded exchanges in the period. | - - -## Server Objects -[Server Object]: #server-objects -[Server Objects]: #server-objects - -A "Server Object" describes one `rippled` server in the XRP Ledger peer-to-peer network. Server objects are returned by the [Get Topology](#get-topology), [Get Topology Nodes](#get-topology-nodes), and [Get Topology Node](#get-topology-node) methods. The Data API collects reported network topology approximately every 30 seconds using the [peer crawler](peer-crawler.html). - -Server objects have the following fields, with some only appearing if the request specified a verbose response: - -| Field | Value | Description | -|:-------------------|:--------------------------------|:----------------------| -| `node_public_key` | String - Base-58 [Public Key][] | The public key used by this server to sign its peer-to-peer communications, not including validations. | -| `version` | String | The `rippled` version of this server, when it was last asked. | -| `uptime` | Integer | Number of seconds this server has been connected to the network. | -| `ip` | String | (May be omitted) IP address of the node (may be omitted). | -| `port` | Integer | (May be omitted) Port where this server speaks the [`rippled` Peer Protocol](peer-protocol.html). | -| `inbound_count` | Integer | (May be omitted) Number of inbound peer-to-peer connections to this server. | -| `inbound_added` | String | (May be omitted) Number of new inbound peer-to-peer connections since the last measurement. | -| `inbound_dropped` | String | (May be omitted) Number of inbound peer-to-peer connections dropped since the last measurement. | -| `outbound_count` | Integer | (May be omitted) Number of outbound peer-to-peer connections to this server. | -| `outbound_added` | String | (May be omitted) Number of new outbound peer-to-peer connections since the last measurement. | -| `outbound_dropped` | String | (May be omitted) Number of outbound peer-to-peer connections dropped since the last measurement. | -| `city` | String | (Verbose only) The city where this server is located, according to IP geolocation. | -| `region` | String | (Verbose only) The region where this server is located, according to IP geolocation. | -| `country` | String | (Verbose only) The country where this server is located, according to IP geolocation. | -| `region_code` | String | (Verbose only) The ISO code for the region where this server is located, according to IP geolocation. | -| `country_code` | String | (Verbose only) The ISO code for the country where this server is located, according to IP geolocation. | -| `postal_code` | String | (Verbose only) The postal code where this server is located, according to IP geolocation. | -| `timezone` | String | (Verbose only) The ISO time zone where this server is located, according to IP geolocation. | -| `lat` | String | (Verbose only) The latitude where this server is located, according to IP geolocation. | -| `long` | String | (Verbose only) The longitude where this server is located, according to IP geolocation. | -| `isp` | String | (Verbose only) The Internet Service Provider hosting this server's public IP address. | -| `org` | String | (Verbose only) The organization that owns this server's public IP address. | - - -## Link Objects -[Link Object]: #link-objects -[Link Objects]: #link-objects - -A Link Object represents a peer-to-peer network connection between two `rippled` servers. It has the following fields: - -| Field | Value | Description | -|:---------|:--------------------------------|:--------------------------------| -| `source` | String - Base-58 [Public Key][] | The node public key of the `rippled` making the outgoing connection. | -| `target` | String - Base-58 [Public Key][] | The node public key of the `rippled` receiving the incoming connection. | - - -## Validation Objects -[Validation Object]: #validation-objects -[Validation Objects]: #validation-objects - -A Validation Object represents one vote from a validator to mark a ledger version as validated. (A ledger is only validated by the consensus process if a quorum of trusted validators votes for the same exact ledger version.) - -**Note:** The Data API keeps only about 6 months of validation vote data. - -A Validation Object has the following fields: - -| Field | Value | Description | -|:------------------------|:--------------------------------|:-----------------| -| `count` | Integer | (May be omitted) The number of `rippled` servers that reported seeing this validation. Not available for old data. | -| `ledger_hash` | String - [Hash][] | The hash of the ledger version this validation vote applies to. | -| `reporter_public_key` | String - Base-58 [Public Key][] | The public key of the `rippled` server that first reported this validation, in base-58. | -| `validation_public_key` | String - Base-58 [Public Key][] | The public key of the validator used to sign this validation, in base-58. | -| `signature` | String | The validator's signature of the validation details, in hexadecimal. | -| `first_datetime` | String - [Timestamp][] | Date and time of the first report of this validation. | -| `last_datetime` | String - [Timestamp][] | Date and time of the last report of this validation. | - - - - - -{% include '_snippets/rippled-api-links.md' %} +For information on the old Data API, see the [rippled-historical-database repository](https://github.com/ripple/rippled-historical-database). diff --git a/content/references/rippled-api/api-conventions/base58-encodings.ja.md b/content/references/protocol-reference/base58-encodings.ja.md similarity index 98% rename from content/references/rippled-api/api-conventions/base58-encodings.ja.md rename to content/references/protocol-reference/base58-encodings.ja.md index d8bd5bb9b6..209166e196 100644 --- a/content/references/rippled-api/api-conventions/base58-encodings.ja.md +++ b/content/references/protocol-reference/base58-encodings.ja.md @@ -1,6 +1,6 @@ --- html: base58-encodings.html -parent: api-conventions.html +parent: protocol-reference.html blurb: 暗号鍵と関連データをbase58形式で表すフォーマットです。 --- # base58エンコード diff --git a/content/references/rippled-api/api-conventions/base58-encodings.md b/content/references/protocol-reference/base58-encodings.md similarity index 98% rename from content/references/rippled-api/api-conventions/base58-encodings.md rename to content/references/protocol-reference/base58-encodings.md index 3ba6b433ca..54ddbcb6a4 100644 --- a/content/references/rippled-api/api-conventions/base58-encodings.md +++ b/content/references/protocol-reference/base58-encodings.md @@ -1,6 +1,6 @@ --- html: base58-encodings.html -parent: api-conventions.html +parent: protocol-reference.html blurb: Formats for representing cryptographic keys and related data in base58 format. --- # base58 Encodings diff --git a/content/references/rippled-api/api-conventions/basic-data-types.ja.md b/content/references/protocol-reference/basic-data-types.ja.md similarity index 99% rename from content/references/rippled-api/api-conventions/basic-data-types.ja.md rename to content/references/protocol-reference/basic-data-types.ja.md index cc198145f4..64106d1f5b 100644 --- a/content/references/rippled-api/api-conventions/basic-data-types.ja.md +++ b/content/references/protocol-reference/basic-data-types.ja.md @@ -1,6 +1,6 @@ --- html: basic-data-types.html -parent: api-conventions.html +parent: protocol-reference.html blurb: さまざまなタイプのオブジェクトがそれぞれ異なる方法で一意に識別されます。 --- # 基本的なデータ型 diff --git a/content/references/rippled-api/api-conventions/basic-data-types.md b/content/references/protocol-reference/basic-data-types.md similarity index 99% rename from content/references/rippled-api/api-conventions/basic-data-types.md rename to content/references/protocol-reference/basic-data-types.md index 9dd32aca0f..25ab8cbea4 100644 --- a/content/references/rippled-api/api-conventions/basic-data-types.md +++ b/content/references/protocol-reference/basic-data-types.md @@ -1,6 +1,6 @@ --- html: basic-data-types.html -parent: api-conventions.html +parent: protocol-reference.html blurb: Format and meaning of fundamental data types like addresses, ledger index, and currency codes. --- # Basic Data Types diff --git a/content/references/rippled-api/api-conventions/currency-formats.ja.md b/content/references/protocol-reference/currency-formats.ja.md similarity index 99% rename from content/references/rippled-api/api-conventions/currency-formats.ja.md rename to content/references/protocol-reference/currency-formats.ja.md index 097bbe589b..46438862e7 100644 --- a/content/references/rippled-api/api-conventions/currency-formats.ja.md +++ b/content/references/protocol-reference/currency-formats.ja.md @@ -1,6 +1,6 @@ --- html: currency-formats.html -parent: api-conventions.html +parent: protocol-reference.html blurb: 通貨番号の精度と範囲、カスタム通貨コードのフォーマットです。 --- # 通貨フォーマット diff --git a/content/references/rippled-api/api-conventions/currency-formats.md b/content/references/protocol-reference/currency-formats.md similarity index 99% rename from content/references/rippled-api/api-conventions/currency-formats.md rename to content/references/protocol-reference/currency-formats.md index fb9929d9b6..6e4c8fa960 100644 --- a/content/references/rippled-api/api-conventions/currency-formats.md +++ b/content/references/protocol-reference/currency-formats.md @@ -1,6 +1,6 @@ --- html: currency-formats.html -parent: api-conventions.html +parent: protocol-reference.html blurb: Precision and range for currency numbers, plus formats of custom currency codes. --- # Currency Formats diff --git a/content/references/rippled-api/ledger-data-formats/ledger-data-formats.ja.md b/content/references/protocol-reference/ledger-data/ledger-data-formats.ja.md similarity index 96% rename from content/references/rippled-api/ledger-data-formats/ledger-data-formats.ja.md rename to content/references/protocol-reference/ledger-data/ledger-data-formats.ja.md index 180d001c9d..bd2c905800 100644 --- a/content/references/rippled-api/ledger-data-formats/ledger-data-formats.ja.md +++ b/content/references/protocol-reference/ledger-data/ledger-data-formats.ja.md @@ -1,6 +1,6 @@ --- html: ledger-data-formats.html -parent: rippled-api.html +parent: protocol-reference.html blurb: XRP Ledgerの共有状態を構成する個別のデータオブジェクトについて説明します。 --- # レジャーのデータ型 diff --git a/content/references/rippled-api/ledger-data-formats/ledger-data-formats.md b/content/references/protocol-reference/ledger-data/ledger-data-formats.md similarity index 96% rename from content/references/rippled-api/ledger-data-formats/ledger-data-formats.md rename to content/references/protocol-reference/ledger-data/ledger-data-formats.md index 7f4504696f..fc44e9c167 100644 --- a/content/references/rippled-api/ledger-data-formats/ledger-data-formats.md +++ b/content/references/protocol-reference/ledger-data/ledger-data-formats.md @@ -1,6 +1,6 @@ --- html: ledger-data-formats.html -parent: rippled-api.html +parent: protocol-reference.html blurb: Learn about individual data objects that comprise the XRP Ledger's shared state. --- # Ledger Data Formats diff --git a/content/references/rippled-api/ledger-data-formats/ledger-header.ja.md b/content/references/protocol-reference/ledger-data/ledger-header.ja.md similarity index 100% rename from content/references/rippled-api/ledger-data-formats/ledger-header.ja.md rename to content/references/protocol-reference/ledger-data/ledger-header.ja.md diff --git a/content/references/rippled-api/ledger-data-formats/ledger-header.md b/content/references/protocol-reference/ledger-data/ledger-header.md similarity index 100% rename from content/references/rippled-api/ledger-data-formats/ledger-header.md rename to content/references/protocol-reference/ledger-data/ledger-header.md diff --git a/content/references/rippled-api/ledger-data-formats/ledger-object-ids.ja.md b/content/references/protocol-reference/ledger-data/ledger-object-ids.ja.md similarity index 100% rename from content/references/rippled-api/ledger-data-formats/ledger-object-ids.ja.md rename to content/references/protocol-reference/ledger-data/ledger-object-ids.ja.md diff --git a/content/references/rippled-api/ledger-data-formats/ledger-object-ids.md b/content/references/protocol-reference/ledger-data/ledger-object-ids.md similarity index 100% rename from content/references/rippled-api/ledger-data-formats/ledger-object-ids.md rename to content/references/protocol-reference/ledger-data/ledger-object-ids.md diff --git a/content/references/rippled-api/ledger-data-formats/ledger-object-types/accountroot.ja.md b/content/references/protocol-reference/ledger-data/ledger-object-types/accountroot.ja.md similarity index 100% rename from content/references/rippled-api/ledger-data-formats/ledger-object-types/accountroot.ja.md rename to content/references/protocol-reference/ledger-data/ledger-object-types/accountroot.ja.md diff --git a/content/references/rippled-api/ledger-data-formats/ledger-object-types/accountroot.md b/content/references/protocol-reference/ledger-data/ledger-object-types/accountroot.md similarity index 100% rename from content/references/rippled-api/ledger-data-formats/ledger-object-types/accountroot.md rename to content/references/protocol-reference/ledger-data/ledger-object-types/accountroot.md diff --git a/content/references/rippled-api/ledger-data-formats/ledger-object-types/amendments.ja.md b/content/references/protocol-reference/ledger-data/ledger-object-types/amendments.ja.md similarity index 100% rename from content/references/rippled-api/ledger-data-formats/ledger-object-types/amendments.ja.md rename to content/references/protocol-reference/ledger-data/ledger-object-types/amendments.ja.md diff --git a/content/references/rippled-api/ledger-data-formats/ledger-object-types/amendments.md b/content/references/protocol-reference/ledger-data/ledger-object-types/amendments.md similarity index 100% rename from content/references/rippled-api/ledger-data-formats/ledger-object-types/amendments.md rename to content/references/protocol-reference/ledger-data/ledger-object-types/amendments.md diff --git a/content/references/rippled-api/ledger-data-formats/ledger-object-types/check.ja.md b/content/references/protocol-reference/ledger-data/ledger-object-types/check.ja.md similarity index 100% rename from content/references/rippled-api/ledger-data-formats/ledger-object-types/check.ja.md rename to content/references/protocol-reference/ledger-data/ledger-object-types/check.ja.md diff --git a/content/references/rippled-api/ledger-data-formats/ledger-object-types/check.md b/content/references/protocol-reference/ledger-data/ledger-object-types/check.md similarity index 100% rename from content/references/rippled-api/ledger-data-formats/ledger-object-types/check.md rename to content/references/protocol-reference/ledger-data/ledger-object-types/check.md diff --git a/content/references/rippled-api/ledger-data-formats/ledger-object-types/depositpreauth.ja.md b/content/references/protocol-reference/ledger-data/ledger-object-types/depositpreauth.ja.md similarity index 100% rename from content/references/rippled-api/ledger-data-formats/ledger-object-types/depositpreauth.ja.md rename to content/references/protocol-reference/ledger-data/ledger-object-types/depositpreauth.ja.md diff --git a/content/references/rippled-api/ledger-data-formats/ledger-object-types/depositpreauth.md b/content/references/protocol-reference/ledger-data/ledger-object-types/depositpreauth.md similarity index 100% rename from content/references/rippled-api/ledger-data-formats/ledger-object-types/depositpreauth.md rename to content/references/protocol-reference/ledger-data/ledger-object-types/depositpreauth.md diff --git a/content/references/rippled-api/ledger-data-formats/ledger-object-types/directorynode.ja.md b/content/references/protocol-reference/ledger-data/ledger-object-types/directorynode.ja.md similarity index 100% rename from content/references/rippled-api/ledger-data-formats/ledger-object-types/directorynode.ja.md rename to content/references/protocol-reference/ledger-data/ledger-object-types/directorynode.ja.md diff --git a/content/references/rippled-api/ledger-data-formats/ledger-object-types/directorynode.md b/content/references/protocol-reference/ledger-data/ledger-object-types/directorynode.md similarity index 100% rename from content/references/rippled-api/ledger-data-formats/ledger-object-types/directorynode.md rename to content/references/protocol-reference/ledger-data/ledger-object-types/directorynode.md diff --git a/content/references/rippled-api/ledger-data-formats/ledger-object-types/escrow.ja.md b/content/references/protocol-reference/ledger-data/ledger-object-types/escrow.ja.md similarity index 100% rename from content/references/rippled-api/ledger-data-formats/ledger-object-types/escrow.ja.md rename to content/references/protocol-reference/ledger-data/ledger-object-types/escrow.ja.md diff --git a/content/references/rippled-api/ledger-data-formats/ledger-object-types/escrow.md b/content/references/protocol-reference/ledger-data/ledger-object-types/escrow.md similarity index 100% rename from content/references/rippled-api/ledger-data-formats/ledger-object-types/escrow.md rename to content/references/protocol-reference/ledger-data/ledger-object-types/escrow.md diff --git a/content/references/rippled-api/ledger-data-formats/ledger-object-types/feesettings.ja.md b/content/references/protocol-reference/ledger-data/ledger-object-types/feesettings.ja.md similarity index 100% rename from content/references/rippled-api/ledger-data-formats/ledger-object-types/feesettings.ja.md rename to content/references/protocol-reference/ledger-data/ledger-object-types/feesettings.ja.md diff --git a/content/references/rippled-api/ledger-data-formats/ledger-object-types/feesettings.md b/content/references/protocol-reference/ledger-data/ledger-object-types/feesettings.md similarity index 100% rename from content/references/rippled-api/ledger-data-formats/ledger-object-types/feesettings.md rename to content/references/protocol-reference/ledger-data/ledger-object-types/feesettings.md diff --git a/content/references/rippled-api/ledger-data-formats/ledger-object-types/ledger-object-types.ja.md b/content/references/protocol-reference/ledger-data/ledger-object-types/ledger-object-types.ja.md similarity index 100% rename from content/references/rippled-api/ledger-data-formats/ledger-object-types/ledger-object-types.ja.md rename to content/references/protocol-reference/ledger-data/ledger-object-types/ledger-object-types.ja.md diff --git a/content/references/rippled-api/ledger-data-formats/ledger-object-types/ledger-object-types.md b/content/references/protocol-reference/ledger-data/ledger-object-types/ledger-object-types.md similarity index 100% rename from content/references/rippled-api/ledger-data-formats/ledger-object-types/ledger-object-types.md rename to content/references/protocol-reference/ledger-data/ledger-object-types/ledger-object-types.md diff --git a/content/references/rippled-api/ledger-data-formats/ledger-object-types/ledgerhashes.ja.md b/content/references/protocol-reference/ledger-data/ledger-object-types/ledgerhashes.ja.md similarity index 100% rename from content/references/rippled-api/ledger-data-formats/ledger-object-types/ledgerhashes.ja.md rename to content/references/protocol-reference/ledger-data/ledger-object-types/ledgerhashes.ja.md diff --git a/content/references/rippled-api/ledger-data-formats/ledger-object-types/ledgerhashes.md b/content/references/protocol-reference/ledger-data/ledger-object-types/ledgerhashes.md similarity index 100% rename from content/references/rippled-api/ledger-data-formats/ledger-object-types/ledgerhashes.md rename to content/references/protocol-reference/ledger-data/ledger-object-types/ledgerhashes.md diff --git a/content/references/rippled-api/ledger-data-formats/ledger-object-types/negativeunl.md b/content/references/protocol-reference/ledger-data/ledger-object-types/negativeunl.md similarity index 100% rename from content/references/rippled-api/ledger-data-formats/ledger-object-types/negativeunl.md rename to content/references/protocol-reference/ledger-data/ledger-object-types/negativeunl.md diff --git a/content/references/rippled-api/ledger-data-formats/ledger-object-types/offer.ja.md b/content/references/protocol-reference/ledger-data/ledger-object-types/offer.ja.md similarity index 100% rename from content/references/rippled-api/ledger-data-formats/ledger-object-types/offer.ja.md rename to content/references/protocol-reference/ledger-data/ledger-object-types/offer.ja.md diff --git a/content/references/rippled-api/ledger-data-formats/ledger-object-types/offer.md b/content/references/protocol-reference/ledger-data/ledger-object-types/offer.md similarity index 100% rename from content/references/rippled-api/ledger-data-formats/ledger-object-types/offer.md rename to content/references/protocol-reference/ledger-data/ledger-object-types/offer.md diff --git a/content/references/rippled-api/ledger-data-formats/ledger-object-types/paychannel.ja.md b/content/references/protocol-reference/ledger-data/ledger-object-types/paychannel.ja.md similarity index 100% rename from content/references/rippled-api/ledger-data-formats/ledger-object-types/paychannel.ja.md rename to content/references/protocol-reference/ledger-data/ledger-object-types/paychannel.ja.md diff --git a/content/references/rippled-api/ledger-data-formats/ledger-object-types/paychannel.md b/content/references/protocol-reference/ledger-data/ledger-object-types/paychannel.md similarity index 100% rename from content/references/rippled-api/ledger-data-formats/ledger-object-types/paychannel.md rename to content/references/protocol-reference/ledger-data/ledger-object-types/paychannel.md diff --git a/content/references/rippled-api/ledger-data-formats/ledger-object-types/ripplestate.ja.md b/content/references/protocol-reference/ledger-data/ledger-object-types/ripplestate.ja.md similarity index 100% rename from content/references/rippled-api/ledger-data-formats/ledger-object-types/ripplestate.ja.md rename to content/references/protocol-reference/ledger-data/ledger-object-types/ripplestate.ja.md diff --git a/content/references/rippled-api/ledger-data-formats/ledger-object-types/ripplestate.md b/content/references/protocol-reference/ledger-data/ledger-object-types/ripplestate.md similarity index 100% rename from content/references/rippled-api/ledger-data-formats/ledger-object-types/ripplestate.md rename to content/references/protocol-reference/ledger-data/ledger-object-types/ripplestate.md diff --git a/content/references/rippled-api/ledger-data-formats/ledger-object-types/signerlist.ja.md b/content/references/protocol-reference/ledger-data/ledger-object-types/signerlist.ja.md similarity index 100% rename from content/references/rippled-api/ledger-data-formats/ledger-object-types/signerlist.ja.md rename to content/references/protocol-reference/ledger-data/ledger-object-types/signerlist.ja.md diff --git a/content/references/rippled-api/ledger-data-formats/ledger-object-types/signerlist.md b/content/references/protocol-reference/ledger-data/ledger-object-types/signerlist.md similarity index 100% rename from content/references/rippled-api/ledger-data-formats/ledger-object-types/signerlist.md rename to content/references/protocol-reference/ledger-data/ledger-object-types/signerlist.md diff --git a/content/references/rippled-api/ledger-data-formats/ledger-object-types/ticket.md b/content/references/protocol-reference/ledger-data/ledger-object-types/ticket.md similarity index 100% rename from content/references/rippled-api/ledger-data-formats/ledger-object-types/ticket.md rename to content/references/protocol-reference/ledger-data/ledger-object-types/ticket.md diff --git a/content/references/rippled-api/api-conventions/modifying-the-ledger.ja.md b/content/references/protocol-reference/modifying-the-ledger.ja.md similarity index 97% rename from content/references/rippled-api/api-conventions/modifying-the-ledger.ja.md rename to content/references/protocol-reference/modifying-the-ledger.ja.md index 18d11a3670..328ab2830c 100644 --- a/content/references/rippled-api/api-conventions/modifying-the-ledger.ja.md +++ b/content/references/protocol-reference/modifying-the-ledger.ja.md @@ -1,6 +1,6 @@ --- html: modifying-the-ledger.html -parent: api-conventions.html +parent: protocol-reference.html blurb: トランザクションだけがレジャーを変更できる理由とその方法です。 --- # レジャーの変更 diff --git a/content/references/protocol-reference/modifying-the-ledger.md b/content/references/protocol-reference/modifying-the-ledger.md new file mode 100644 index 0000000000..cb0089254e --- /dev/null +++ b/content/references/protocol-reference/modifying-the-ledger.md @@ -0,0 +1,13 @@ +--- +html: modifying-the-ledger.html +parent: protocol-reference.html +blurb: Why and how only transactions can modify the ledger. +--- +# Modifying the Ledger + +All changes to the XRP Ledger happen as the result of [transactions](transaction-formats.html), and all changes apply permanently _only_ if the transactions are approved by the [consensus process](consensus.html). No matter what interface you use to access the XRP Ledger, no API method ever change the contents of the XRP Ledger, except by submitting a transaction. + + +{% include '_snippets/rippled-api-links.md' %} +{% include '_snippets/tx-type-links.md' %} +{% include '_snippets/rippled_versions.md' %} diff --git a/content/references/rippled-api/api-conventions/serialization.ja.md b/content/references/protocol-reference/serialization.ja.md similarity index 99% rename from content/references/rippled-api/api-conventions/serialization.ja.md rename to content/references/protocol-reference/serialization.ja.md index 41db2a516c..e205d72660 100644 --- a/content/references/rippled-api/api-conventions/serialization.ja.md +++ b/content/references/protocol-reference/serialization.ja.md @@ -1,6 +1,6 @@ --- html: serialization.html -parent: api-conventions.html +parent: protocol-reference.html blurb: XRP Ledgerトランザクションやその他のオブジェクトの場合のJSONフォーマットと正規バイナリーフォーマットとの変換です。 --- # シリアル化フォーマット diff --git a/content/references/rippled-api/api-conventions/serialization.md b/content/references/protocol-reference/serialization.md similarity index 99% rename from content/references/rippled-api/api-conventions/serialization.md rename to content/references/protocol-reference/serialization.md index e6860604c9..20bd019b1c 100644 --- a/content/references/rippled-api/api-conventions/serialization.md +++ b/content/references/protocol-reference/serialization.md @@ -1,6 +1,6 @@ --- html: serialization.html -parent: api-conventions.html +parent: protocol-reference.html blurb: Conversion between JSON and canonical binary format for XRP Ledger transactions and other objects. --- # Serialization Format diff --git a/content/references/rippled-api/transaction-formats/pseudo-transaction-types/enableamendment.ja.md b/content/references/protocol-reference/transactions/pseudo-transaction-types/enableamendment.ja.md similarity index 100% rename from content/references/rippled-api/transaction-formats/pseudo-transaction-types/enableamendment.ja.md rename to content/references/protocol-reference/transactions/pseudo-transaction-types/enableamendment.ja.md diff --git a/content/references/rippled-api/transaction-formats/pseudo-transaction-types/enableamendment.md b/content/references/protocol-reference/transactions/pseudo-transaction-types/enableamendment.md similarity index 100% rename from content/references/rippled-api/transaction-formats/pseudo-transaction-types/enableamendment.md rename to content/references/protocol-reference/transactions/pseudo-transaction-types/enableamendment.md diff --git a/content/references/rippled-api/transaction-formats/pseudo-transaction-types/pseudo-transaction-types.ja.md b/content/references/protocol-reference/transactions/pseudo-transaction-types/pseudo-transaction-types.ja.md similarity index 100% rename from content/references/rippled-api/transaction-formats/pseudo-transaction-types/pseudo-transaction-types.ja.md rename to content/references/protocol-reference/transactions/pseudo-transaction-types/pseudo-transaction-types.ja.md diff --git a/content/references/rippled-api/transaction-formats/pseudo-transaction-types/pseudo-transaction-types.md b/content/references/protocol-reference/transactions/pseudo-transaction-types/pseudo-transaction-types.md similarity index 100% rename from content/references/rippled-api/transaction-formats/pseudo-transaction-types/pseudo-transaction-types.md rename to content/references/protocol-reference/transactions/pseudo-transaction-types/pseudo-transaction-types.md diff --git a/content/references/rippled-api/transaction-formats/pseudo-transaction-types/setfee.ja.md b/content/references/protocol-reference/transactions/pseudo-transaction-types/setfee.ja.md similarity index 100% rename from content/references/rippled-api/transaction-formats/pseudo-transaction-types/setfee.ja.md rename to content/references/protocol-reference/transactions/pseudo-transaction-types/setfee.ja.md diff --git a/content/references/rippled-api/transaction-formats/pseudo-transaction-types/setfee.md b/content/references/protocol-reference/transactions/pseudo-transaction-types/setfee.md similarity index 100% rename from content/references/rippled-api/transaction-formats/pseudo-transaction-types/setfee.md rename to content/references/protocol-reference/transactions/pseudo-transaction-types/setfee.md diff --git a/content/references/rippled-api/transaction-formats/pseudo-transaction-types/unlmodify.md b/content/references/protocol-reference/transactions/pseudo-transaction-types/unlmodify.md similarity index 100% rename from content/references/rippled-api/transaction-formats/pseudo-transaction-types/unlmodify.md rename to content/references/protocol-reference/transactions/pseudo-transaction-types/unlmodify.md diff --git a/content/references/rippled-api/transaction-formats/transaction-common-fields.ja.md b/content/references/protocol-reference/transactions/transaction-common-fields.ja.md similarity index 100% rename from content/references/rippled-api/transaction-formats/transaction-common-fields.ja.md rename to content/references/protocol-reference/transactions/transaction-common-fields.ja.md diff --git a/content/references/rippled-api/transaction-formats/transaction-common-fields.md b/content/references/protocol-reference/transactions/transaction-common-fields.md similarity index 100% rename from content/references/rippled-api/transaction-formats/transaction-common-fields.md rename to content/references/protocol-reference/transactions/transaction-common-fields.md diff --git a/content/references/rippled-api/transaction-formats/transaction-formats.ja.md b/content/references/protocol-reference/transactions/transaction-formats.ja.md similarity index 97% rename from content/references/rippled-api/transaction-formats/transaction-formats.ja.md rename to content/references/protocol-reference/transactions/transaction-formats.ja.md index 7f796d825d..a2df53d128 100644 --- a/content/references/rippled-api/transaction-formats/transaction-formats.ja.md +++ b/content/references/protocol-reference/transactions/transaction-formats.ja.md @@ -1,6 +1,6 @@ --- html: transaction-formats.html -parent: rippled-api.html +parent: protocol-reference.html blurb: トランザクションは、XRP Ledgerを変更する唯一の方法です。 template: template-landing-children.html --- diff --git a/content/references/rippled-api/transaction-formats/transaction-formats.md b/content/references/protocol-reference/transactions/transaction-formats.md similarity index 93% rename from content/references/rippled-api/transaction-formats/transaction-formats.md rename to content/references/protocol-reference/transactions/transaction-formats.md index 7239498ea9..4a7b4b438d 100644 --- a/content/references/rippled-api/transaction-formats/transaction-formats.md +++ b/content/references/protocol-reference/transactions/transaction-formats.md @@ -1,10 +1,10 @@ --- html: transaction-formats.html -parent: rippled-api.html +parent: protocol-reference.html blurb: Transactions are the only way to modify the XRP Ledger. Get details about their required format. template: template-landing-children.html --- -# Transaction Formats +# Transaction Reference A _Transaction_ is the only way to modify the XRP Ledger. Transactions are only final if signed, submitted, and accepted into a validated ledger version following the [consensus process](consensus.html). Some ledger rules also generate _[pseudo-transactions](pseudo-transaction-types.html)_, which aren't signed or submitted, but still must be accepted by consensus. Transactions that fail are also included in ledgers because they modify balances of XRP to pay for the anti-spam [transaction cost][]. diff --git a/content/references/rippled-api/transaction-formats/transaction-metadata.ja.md b/content/references/protocol-reference/transactions/transaction-metadata.ja.md similarity index 100% rename from content/references/rippled-api/transaction-formats/transaction-metadata.ja.md rename to content/references/protocol-reference/transactions/transaction-metadata.ja.md diff --git a/content/references/rippled-api/transaction-formats/transaction-metadata.md b/content/references/protocol-reference/transactions/transaction-metadata.md similarity index 100% rename from content/references/rippled-api/transaction-formats/transaction-metadata.md rename to content/references/protocol-reference/transactions/transaction-metadata.md diff --git a/content/references/rippled-api/transaction-formats/transaction-results/tec-codes.ja.md b/content/references/protocol-reference/transactions/transaction-results/tec-codes.ja.md similarity index 100% rename from content/references/rippled-api/transaction-formats/transaction-results/tec-codes.ja.md rename to content/references/protocol-reference/transactions/transaction-results/tec-codes.ja.md diff --git a/content/references/rippled-api/transaction-formats/transaction-results/tec-codes.md b/content/references/protocol-reference/transactions/transaction-results/tec-codes.md similarity index 100% rename from content/references/rippled-api/transaction-formats/transaction-results/tec-codes.md rename to content/references/protocol-reference/transactions/transaction-results/tec-codes.md diff --git a/content/references/rippled-api/transaction-formats/transaction-results/tef-codes.ja.md b/content/references/protocol-reference/transactions/transaction-results/tef-codes.ja.md similarity index 100% rename from content/references/rippled-api/transaction-formats/transaction-results/tef-codes.ja.md rename to content/references/protocol-reference/transactions/transaction-results/tef-codes.ja.md diff --git a/content/references/rippled-api/transaction-formats/transaction-results/tef-codes.md b/content/references/protocol-reference/transactions/transaction-results/tef-codes.md similarity index 100% rename from content/references/rippled-api/transaction-formats/transaction-results/tef-codes.md rename to content/references/protocol-reference/transactions/transaction-results/tef-codes.md diff --git a/content/references/rippled-api/transaction-formats/transaction-results/tel-codes.ja.md b/content/references/protocol-reference/transactions/transaction-results/tel-codes.ja.md similarity index 100% rename from content/references/rippled-api/transaction-formats/transaction-results/tel-codes.ja.md rename to content/references/protocol-reference/transactions/transaction-results/tel-codes.ja.md diff --git a/content/references/rippled-api/transaction-formats/transaction-results/tel-codes.md b/content/references/protocol-reference/transactions/transaction-results/tel-codes.md similarity index 100% rename from content/references/rippled-api/transaction-formats/transaction-results/tel-codes.md rename to content/references/protocol-reference/transactions/transaction-results/tel-codes.md diff --git a/content/references/rippled-api/transaction-formats/transaction-results/tem-codes.ja.md b/content/references/protocol-reference/transactions/transaction-results/tem-codes.ja.md similarity index 100% rename from content/references/rippled-api/transaction-formats/transaction-results/tem-codes.ja.md rename to content/references/protocol-reference/transactions/transaction-results/tem-codes.ja.md diff --git a/content/references/rippled-api/transaction-formats/transaction-results/tem-codes.md b/content/references/protocol-reference/transactions/transaction-results/tem-codes.md similarity index 100% rename from content/references/rippled-api/transaction-formats/transaction-results/tem-codes.md rename to content/references/protocol-reference/transactions/transaction-results/tem-codes.md diff --git a/content/references/rippled-api/transaction-formats/transaction-results/ter-codes.ja.md b/content/references/protocol-reference/transactions/transaction-results/ter-codes.ja.md similarity index 100% rename from content/references/rippled-api/transaction-formats/transaction-results/ter-codes.ja.md rename to content/references/protocol-reference/transactions/transaction-results/ter-codes.ja.md diff --git a/content/references/rippled-api/transaction-formats/transaction-results/ter-codes.md b/content/references/protocol-reference/transactions/transaction-results/ter-codes.md similarity index 100% rename from content/references/rippled-api/transaction-formats/transaction-results/ter-codes.md rename to content/references/protocol-reference/transactions/transaction-results/ter-codes.md diff --git a/content/references/rippled-api/transaction-formats/transaction-results/tes-success.ja.md b/content/references/protocol-reference/transactions/transaction-results/tes-success.ja.md similarity index 100% rename from content/references/rippled-api/transaction-formats/transaction-results/tes-success.ja.md rename to content/references/protocol-reference/transactions/transaction-results/tes-success.ja.md diff --git a/content/references/rippled-api/transaction-formats/transaction-results/tes-success.md b/content/references/protocol-reference/transactions/transaction-results/tes-success.md similarity index 100% rename from content/references/rippled-api/transaction-formats/transaction-results/tes-success.md rename to content/references/protocol-reference/transactions/transaction-results/tes-success.md diff --git a/content/references/rippled-api/transaction-formats/transaction-results/transaction-results.ja.md b/content/references/protocol-reference/transactions/transaction-results/transaction-results.ja.md similarity index 100% rename from content/references/rippled-api/transaction-formats/transaction-results/transaction-results.ja.md rename to content/references/protocol-reference/transactions/transaction-results/transaction-results.ja.md diff --git a/content/references/rippled-api/transaction-formats/transaction-results/transaction-results.md b/content/references/protocol-reference/transactions/transaction-results/transaction-results.md similarity index 100% rename from content/references/rippled-api/transaction-formats/transaction-results/transaction-results.md rename to content/references/protocol-reference/transactions/transaction-results/transaction-results.md diff --git a/content/references/rippled-api/transaction-formats/transaction-types/accountdelete.ja.md b/content/references/protocol-reference/transactions/transaction-types/accountdelete.ja.md similarity index 100% rename from content/references/rippled-api/transaction-formats/transaction-types/accountdelete.ja.md rename to content/references/protocol-reference/transactions/transaction-types/accountdelete.ja.md diff --git a/content/references/rippled-api/transaction-formats/transaction-types/accountdelete.md b/content/references/protocol-reference/transactions/transaction-types/accountdelete.md similarity index 100% rename from content/references/rippled-api/transaction-formats/transaction-types/accountdelete.md rename to content/references/protocol-reference/transactions/transaction-types/accountdelete.md diff --git a/content/references/rippled-api/transaction-formats/transaction-types/accountset.ja.md b/content/references/protocol-reference/transactions/transaction-types/accountset.ja.md similarity index 100% rename from content/references/rippled-api/transaction-formats/transaction-types/accountset.ja.md rename to content/references/protocol-reference/transactions/transaction-types/accountset.ja.md diff --git a/content/references/rippled-api/transaction-formats/transaction-types/accountset.md b/content/references/protocol-reference/transactions/transaction-types/accountset.md similarity index 100% rename from content/references/rippled-api/transaction-formats/transaction-types/accountset.md rename to content/references/protocol-reference/transactions/transaction-types/accountset.md diff --git a/content/references/rippled-api/transaction-formats/transaction-types/checkcancel.ja.md b/content/references/protocol-reference/transactions/transaction-types/checkcancel.ja.md similarity index 100% rename from content/references/rippled-api/transaction-formats/transaction-types/checkcancel.ja.md rename to content/references/protocol-reference/transactions/transaction-types/checkcancel.ja.md diff --git a/content/references/rippled-api/transaction-formats/transaction-types/checkcancel.md b/content/references/protocol-reference/transactions/transaction-types/checkcancel.md similarity index 100% rename from content/references/rippled-api/transaction-formats/transaction-types/checkcancel.md rename to content/references/protocol-reference/transactions/transaction-types/checkcancel.md diff --git a/content/references/rippled-api/transaction-formats/transaction-types/checkcash.ja.md b/content/references/protocol-reference/transactions/transaction-types/checkcash.ja.md similarity index 100% rename from content/references/rippled-api/transaction-formats/transaction-types/checkcash.ja.md rename to content/references/protocol-reference/transactions/transaction-types/checkcash.ja.md diff --git a/content/references/rippled-api/transaction-formats/transaction-types/checkcash.md b/content/references/protocol-reference/transactions/transaction-types/checkcash.md similarity index 100% rename from content/references/rippled-api/transaction-formats/transaction-types/checkcash.md rename to content/references/protocol-reference/transactions/transaction-types/checkcash.md diff --git a/content/references/rippled-api/transaction-formats/transaction-types/checkcreate.ja.md b/content/references/protocol-reference/transactions/transaction-types/checkcreate.ja.md similarity index 100% rename from content/references/rippled-api/transaction-formats/transaction-types/checkcreate.ja.md rename to content/references/protocol-reference/transactions/transaction-types/checkcreate.ja.md diff --git a/content/references/rippled-api/transaction-formats/transaction-types/checkcreate.md b/content/references/protocol-reference/transactions/transaction-types/checkcreate.md similarity index 100% rename from content/references/rippled-api/transaction-formats/transaction-types/checkcreate.md rename to content/references/protocol-reference/transactions/transaction-types/checkcreate.md diff --git a/content/references/rippled-api/transaction-formats/transaction-types/depositpreauth.ja.md b/content/references/protocol-reference/transactions/transaction-types/depositpreauth.ja.md similarity index 100% rename from content/references/rippled-api/transaction-formats/transaction-types/depositpreauth.ja.md rename to content/references/protocol-reference/transactions/transaction-types/depositpreauth.ja.md diff --git a/content/references/rippled-api/transaction-formats/transaction-types/depositpreauth.md b/content/references/protocol-reference/transactions/transaction-types/depositpreauth.md similarity index 100% rename from content/references/rippled-api/transaction-formats/transaction-types/depositpreauth.md rename to content/references/protocol-reference/transactions/transaction-types/depositpreauth.md diff --git a/content/references/rippled-api/transaction-formats/transaction-types/escrowcancel.ja.md b/content/references/protocol-reference/transactions/transaction-types/escrowcancel.ja.md similarity index 100% rename from content/references/rippled-api/transaction-formats/transaction-types/escrowcancel.ja.md rename to content/references/protocol-reference/transactions/transaction-types/escrowcancel.ja.md diff --git a/content/references/rippled-api/transaction-formats/transaction-types/escrowcancel.md b/content/references/protocol-reference/transactions/transaction-types/escrowcancel.md similarity index 100% rename from content/references/rippled-api/transaction-formats/transaction-types/escrowcancel.md rename to content/references/protocol-reference/transactions/transaction-types/escrowcancel.md diff --git a/content/references/rippled-api/transaction-formats/transaction-types/escrowcreate.ja.md b/content/references/protocol-reference/transactions/transaction-types/escrowcreate.ja.md similarity index 100% rename from content/references/rippled-api/transaction-formats/transaction-types/escrowcreate.ja.md rename to content/references/protocol-reference/transactions/transaction-types/escrowcreate.ja.md diff --git a/content/references/rippled-api/transaction-formats/transaction-types/escrowcreate.md b/content/references/protocol-reference/transactions/transaction-types/escrowcreate.md similarity index 100% rename from content/references/rippled-api/transaction-formats/transaction-types/escrowcreate.md rename to content/references/protocol-reference/transactions/transaction-types/escrowcreate.md diff --git a/content/references/rippled-api/transaction-formats/transaction-types/escrowfinish.ja.md b/content/references/protocol-reference/transactions/transaction-types/escrowfinish.ja.md similarity index 100% rename from content/references/rippled-api/transaction-formats/transaction-types/escrowfinish.ja.md rename to content/references/protocol-reference/transactions/transaction-types/escrowfinish.ja.md diff --git a/content/references/rippled-api/transaction-formats/transaction-types/escrowfinish.md b/content/references/protocol-reference/transactions/transaction-types/escrowfinish.md similarity index 100% rename from content/references/rippled-api/transaction-formats/transaction-types/escrowfinish.md rename to content/references/protocol-reference/transactions/transaction-types/escrowfinish.md diff --git a/content/references/rippled-api/transaction-formats/transaction-types/offercancel.ja.md b/content/references/protocol-reference/transactions/transaction-types/offercancel.ja.md similarity index 100% rename from content/references/rippled-api/transaction-formats/transaction-types/offercancel.ja.md rename to content/references/protocol-reference/transactions/transaction-types/offercancel.ja.md diff --git a/content/references/rippled-api/transaction-formats/transaction-types/offercancel.md b/content/references/protocol-reference/transactions/transaction-types/offercancel.md similarity index 100% rename from content/references/rippled-api/transaction-formats/transaction-types/offercancel.md rename to content/references/protocol-reference/transactions/transaction-types/offercancel.md diff --git a/content/references/rippled-api/transaction-formats/transaction-types/offercreate.ja.md b/content/references/protocol-reference/transactions/transaction-types/offercreate.ja.md similarity index 100% rename from content/references/rippled-api/transaction-formats/transaction-types/offercreate.ja.md rename to content/references/protocol-reference/transactions/transaction-types/offercreate.ja.md diff --git a/content/references/rippled-api/transaction-formats/transaction-types/offercreate.md b/content/references/protocol-reference/transactions/transaction-types/offercreate.md similarity index 100% rename from content/references/rippled-api/transaction-formats/transaction-types/offercreate.md rename to content/references/protocol-reference/transactions/transaction-types/offercreate.md diff --git a/content/references/rippled-api/transaction-formats/transaction-types/payment.ja.md b/content/references/protocol-reference/transactions/transaction-types/payment.ja.md similarity index 100% rename from content/references/rippled-api/transaction-formats/transaction-types/payment.ja.md rename to content/references/protocol-reference/transactions/transaction-types/payment.ja.md diff --git a/content/references/rippled-api/transaction-formats/transaction-types/payment.md b/content/references/protocol-reference/transactions/transaction-types/payment.md similarity index 100% rename from content/references/rippled-api/transaction-formats/transaction-types/payment.md rename to content/references/protocol-reference/transactions/transaction-types/payment.md diff --git a/content/references/rippled-api/transaction-formats/transaction-types/paymentchannelclaim.ja.md b/content/references/protocol-reference/transactions/transaction-types/paymentchannelclaim.ja.md similarity index 100% rename from content/references/rippled-api/transaction-formats/transaction-types/paymentchannelclaim.ja.md rename to content/references/protocol-reference/transactions/transaction-types/paymentchannelclaim.ja.md diff --git a/content/references/rippled-api/transaction-formats/transaction-types/paymentchannelclaim.md b/content/references/protocol-reference/transactions/transaction-types/paymentchannelclaim.md similarity index 100% rename from content/references/rippled-api/transaction-formats/transaction-types/paymentchannelclaim.md rename to content/references/protocol-reference/transactions/transaction-types/paymentchannelclaim.md diff --git a/content/references/rippled-api/transaction-formats/transaction-types/paymentchannelcreate.ja.md b/content/references/protocol-reference/transactions/transaction-types/paymentchannelcreate.ja.md similarity index 100% rename from content/references/rippled-api/transaction-formats/transaction-types/paymentchannelcreate.ja.md rename to content/references/protocol-reference/transactions/transaction-types/paymentchannelcreate.ja.md diff --git a/content/references/rippled-api/transaction-formats/transaction-types/paymentchannelcreate.md b/content/references/protocol-reference/transactions/transaction-types/paymentchannelcreate.md similarity index 100% rename from content/references/rippled-api/transaction-formats/transaction-types/paymentchannelcreate.md rename to content/references/protocol-reference/transactions/transaction-types/paymentchannelcreate.md diff --git a/content/references/rippled-api/transaction-formats/transaction-types/paymentchannelfund.ja.md b/content/references/protocol-reference/transactions/transaction-types/paymentchannelfund.ja.md similarity index 100% rename from content/references/rippled-api/transaction-formats/transaction-types/paymentchannelfund.ja.md rename to content/references/protocol-reference/transactions/transaction-types/paymentchannelfund.ja.md diff --git a/content/references/rippled-api/transaction-formats/transaction-types/paymentchannelfund.md b/content/references/protocol-reference/transactions/transaction-types/paymentchannelfund.md similarity index 100% rename from content/references/rippled-api/transaction-formats/transaction-types/paymentchannelfund.md rename to content/references/protocol-reference/transactions/transaction-types/paymentchannelfund.md diff --git a/content/references/rippled-api/transaction-formats/transaction-types/setregularkey.ja.md b/content/references/protocol-reference/transactions/transaction-types/setregularkey.ja.md similarity index 100% rename from content/references/rippled-api/transaction-formats/transaction-types/setregularkey.ja.md rename to content/references/protocol-reference/transactions/transaction-types/setregularkey.ja.md diff --git a/content/references/rippled-api/transaction-formats/transaction-types/setregularkey.md b/content/references/protocol-reference/transactions/transaction-types/setregularkey.md similarity index 100% rename from content/references/rippled-api/transaction-formats/transaction-types/setregularkey.md rename to content/references/protocol-reference/transactions/transaction-types/setregularkey.md diff --git a/content/references/rippled-api/transaction-formats/transaction-types/signerlistset.ja.md b/content/references/protocol-reference/transactions/transaction-types/signerlistset.ja.md similarity index 100% rename from content/references/rippled-api/transaction-formats/transaction-types/signerlistset.ja.md rename to content/references/protocol-reference/transactions/transaction-types/signerlistset.ja.md diff --git a/content/references/rippled-api/transaction-formats/transaction-types/signerlistset.md b/content/references/protocol-reference/transactions/transaction-types/signerlistset.md similarity index 100% rename from content/references/rippled-api/transaction-formats/transaction-types/signerlistset.md rename to content/references/protocol-reference/transactions/transaction-types/signerlistset.md diff --git a/content/references/rippled-api/transaction-formats/transaction-types/ticketcreate.md b/content/references/protocol-reference/transactions/transaction-types/ticketcreate.md similarity index 100% rename from content/references/rippled-api/transaction-formats/transaction-types/ticketcreate.md rename to content/references/protocol-reference/transactions/transaction-types/ticketcreate.md diff --git a/content/references/rippled-api/transaction-formats/transaction-types/transaction-types.ja.md b/content/references/protocol-reference/transactions/transaction-types/transaction-types.ja.md similarity index 100% rename from content/references/rippled-api/transaction-formats/transaction-types/transaction-types.ja.md rename to content/references/protocol-reference/transactions/transaction-types/transaction-types.ja.md diff --git a/content/references/rippled-api/transaction-formats/transaction-types/transaction-types.md b/content/references/protocol-reference/transactions/transaction-types/transaction-types.md similarity index 100% rename from content/references/rippled-api/transaction-formats/transaction-types/transaction-types.md rename to content/references/protocol-reference/transactions/transaction-types/transaction-types.md diff --git a/content/references/rippled-api/transaction-formats/transaction-types/trustset.ja.md b/content/references/protocol-reference/transactions/transaction-types/trustset.ja.md similarity index 100% rename from content/references/rippled-api/transaction-formats/transaction-types/trustset.ja.md rename to content/references/protocol-reference/transactions/transaction-types/trustset.ja.md diff --git a/content/references/rippled-api/transaction-formats/transaction-types/trustset.md b/content/references/protocol-reference/transactions/transaction-types/trustset.md similarity index 100% rename from content/references/rippled-api/transaction-formats/transaction-types/trustset.md rename to content/references/protocol-reference/transactions/transaction-types/trustset.md diff --git a/content/references/rippled-api/api-conventions/api-conventions.md b/content/references/rippled-api/api-conventions/api-conventions.md index f2a57f83dc..7ee45ee479 100644 --- a/content/references/rippled-api/api-conventions/api-conventions.md +++ b/content/references/rippled-api/api-conventions/api-conventions.md @@ -6,6 +6,6 @@ template: template-landing-children.html --- # API Conventions -This section describes data types and formats of the `rippled` APIs, including JSON-RPC and WebSocket interfaces. +This section describes data types and formats of the HTTP APIs (JSON-RPC and WebSocket) as implemented in [the `rippled` server](the-rippled-server.html). -Some of these data types also appear in higher-level APIs, including the [Data API](data-api.html). +For information regarding the XRP Ledger protocol regardless of interface, see [Protocol Reference](protocol-reference.html). diff --git a/content/references/rippled-api/api-conventions/modifying-the-ledger.md b/content/references/rippled-api/api-conventions/modifying-the-ledger.md deleted file mode 100644 index c23864a468..0000000000 --- a/content/references/rippled-api/api-conventions/modifying-the-ledger.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -html: modifying-the-ledger.html -parent: api-conventions.html -blurb: Why and how only transactions can modify the ledger. ---- -# Modifying the Ledger - -All changes to the XRP Ledger happen as the result of transactions. The only API methods that can change the contents of the XRP Ledger are the commands that submit transactions. Even then, changes only apply permanently if the transactions are approved by the [consensus process](consensus.html). Most other public methods represent different ways to view the data represented in the XRP Ledger, or request information about the state of the server. - -Transaction submission commands: - -- [submit method][] -- [submit_multisigned method][] - -For more information on the various transactions you can submit, see the [Transaction Formats Reference](transaction-formats.html). - - -{% include '_snippets/rippled-api-links.md' %} -{% include '_snippets/tx-type-links.md' %} -{% include '_snippets/rippled_versions.md' %} diff --git a/content/references/xrp-api.md b/content/references/xrp-api.md new file mode 100644 index 0000000000..7f46769b1e --- /dev/null +++ b/content/references/xrp-api.md @@ -0,0 +1,13 @@ +--- +html: xrp-api.html +parent: references.html +blurb: An API server that provides a REST-like interface to the XRP Ledger. +template: template-redirect.html +redirect_url: https://github.com/xpring-eng/xrp-api # Update to GH Pages ref if possible +nav_omit: true +filters: + - xrpapi_readme +--- +# XRP-API + +The XRP-API server provides an alternate REST-like interface to the XRP Ledger, but is not currently considered stable software and is not actively supported. diff --git a/content/tutorials/get-started/set-up-secure-signing.md b/content/tutorials/get-started/set-up-secure-signing.md index 067a7bf992..e3e983629c 100644 --- a/content/tutorials/get-started/set-up-secure-signing.md +++ b/content/tutorials/get-started/set-up-secure-signing.md @@ -67,15 +67,7 @@ As always, follow industry-standard practices for securing your machines, such a {{ include_svg("img/secure-signing-client-library.svg", "Diagram of using a client library with local signing") }} -This configuration uses a client library in the programming language you are using to sign transactions locally. You need a client library for the programming language you use. The following client libraries can sign transactions for the XRP Ledger locally: - -| Language | Library Name | Get Started | API Reference | Source Code | -|----------|--------------|-------------|---------------|-------------| -| **Python** | `xrpl-py` | [Get Started](get-started-using-python.html) | [API Reference](https://xrpl-py.readthedocs.io/) | [Repo](https://github.com/XRPLF/xrpl-py) | -| **JavaScript** / **TypeScript** | `ripple-lib` | [Get Started](get-started-with-rippleapi-for-javascript.html) | [API Reference](rippleapi-reference.html) | [Repo](https://github.com/ripple/ripple-lib) | -| **C++** | `rippled` Signing Library | [Get Started](https://github.com/ripple/rippled/tree/develop/Builds/linux#signing-library) | | (Part of [`rippled`](https://github.com/ripple/rippled/)) | -| **Java** | `xrpl4j` | [README](https://github.com/XRPLF/xrpl4j#readme) | [API Reference](https://github.com/XRPLF/xrpl4j/tree/main/xrpl4j-integration-tests) | [Repo](https://github.com/XRPLF/xrpl4j) | - +This configuration uses a client library with built-in signing, in the programming language you use. For a list of libraries that can perform local signing, see [Client Libraries](client-libraries.html). ### Security Best Practices for Signing Libraries diff --git a/dactyl-config.yml b/dactyl-config.yml index e7b240f64a..cd0f43f1a3 100644 --- a/dactyl-config.yml +++ b/dactyl-config.yml @@ -184,6 +184,13 @@ targets: no_cover: True link_re_subs: "([\\w-]+\\.html)": https://xrpl.org/\1 + - name: data-api-ja + lang: ja + display_name: XRP Ledger Data API + <<: *defaults + no_cover: True + link_re_subs: + "([\\w-]+\\.html)": https://xrpl.org/ja/\1 pages: @@ -1792,9 +1799,513 @@ pages: targets: - ja - # rippled API -------------------------------------------------------------- - - name: rippled API Reference + - name: XRP Ledger Protocol Reference + html: protocol-reference.html + parent: references.html + template: template-landing-children.html + blurb: Features and rules of the XRP Ledger protocol, regardless of how you access it. + targets: + - en + - ja + + - md: references/protocol-reference/basic-data-types.md + targets: + - en + + - md: references/protocol-reference/basic-data-types.ja.md + targets: + - ja + + - md: references/protocol-reference/base58-encodings.md + targets: + - en + + - md: references/protocol-reference/base58-encodings.ja.md + targets: + - ja + + - md: references/protocol-reference/currency-formats.md + targets: + - en + + - md: references/protocol-reference/currency-formats.ja.md + targets: + - ja + + - md: references/protocol-reference/ledger-data/ledger-data-formats.md + targets: + - en + + - md: references/protocol-reference/ledger-data/ledger-data-formats.ja.md + targets: + - ja + + - md: references/protocol-reference/ledger-data/ledger-header.md + targets: + - en + + - md: references/protocol-reference/ledger-data/ledger-header.ja.md + targets: + - ja + + - md: references/protocol-reference/ledger-data/ledger-object-ids.md + targets: + - en + + - md: references/protocol-reference/ledger-data/ledger-object-ids.ja.md + targets: + - ja + + - md: references/protocol-reference/ledger-data/ledger-object-types/ledger-object-types.md + targets: + - en + + - md: references/protocol-reference/ledger-data/ledger-object-types/ledger-object-types.ja.md + targets: + - ja + + - md: references/protocol-reference/ledger-data/ledger-object-types/accountroot.md + targets: + - en + + - md: references/protocol-reference/ledger-data/ledger-object-types/accountroot.ja.md + targets: + - ja + + - md: references/protocol-reference/ledger-data/ledger-object-types/amendments.md + targets: + - en + + - md: references/protocol-reference/ledger-data/ledger-object-types/amendments.ja.md + targets: + - ja + + - md: references/protocol-reference/ledger-data/ledger-object-types/check.md + targets: + - en + + - md: references/protocol-reference/ledger-data/ledger-object-types/check.ja.md + targets: + - ja + + - md: references/protocol-reference/ledger-data/ledger-object-types/depositpreauth.md + targets: + - en + + - md: references/protocol-reference/ledger-data/ledger-object-types/depositpreauth.ja.md + targets: + - ja + + - md: references/protocol-reference/ledger-data/ledger-object-types/directorynode.md + targets: + - en + + - md: references/protocol-reference/ledger-data/ledger-object-types/directorynode.ja.md + targets: + - ja + + - md: references/protocol-reference/ledger-data/ledger-object-types/escrow.md + targets: + - en + + - md: references/protocol-reference/ledger-data/ledger-object-types/escrow.ja.md + targets: + - ja + + - md: references/protocol-reference/ledger-data/ledger-object-types/feesettings.md + targets: + - en + + - md: references/protocol-reference/ledger-data/ledger-object-types/feesettings.ja.md + targets: + - ja + + - md: references/protocol-reference/ledger-data/ledger-object-types/ledgerhashes.md + targets: + - en + + - md: references/protocol-reference/ledger-data/ledger-object-types/ledgerhashes.ja.md + targets: + - ja + + - md: references/protocol-reference/ledger-data/ledger-object-types/negativeunl.md + targets: + - en + - ja + + - md: references/protocol-reference/ledger-data/ledger-object-types/offer.md + targets: + - en + + - md: references/protocol-reference/ledger-data/ledger-object-types/offer.ja.md + targets: + - ja + + - md: references/protocol-reference/ledger-data/ledger-object-types/paychannel.md + targets: + - en + + - md: references/protocol-reference/ledger-data/ledger-object-types/paychannel.ja.md + targets: + - ja + + - md: references/protocol-reference/ledger-data/ledger-object-types/ripplestate.md + targets: + - en + + - md: references/protocol-reference/ledger-data/ledger-object-types/ripplestate.ja.md + targets: + - ja + + - md: references/protocol-reference/ledger-data/ledger-object-types/signerlist.md + targets: + - en + + - md: references/protocol-reference/ledger-data/ledger-object-types/signerlist.ja.md + targets: + - ja + + - md: references/protocol-reference/ledger-data/ledger-object-types/ticket.md + targets: + - en + - ja + + - md: references/protocol-reference/transactions/transaction-formats.md + targets: + - en + + - md: references/protocol-reference/transactions/transaction-formats.ja.md + targets: + - ja + + - md: references/protocol-reference/transactions/transaction-common-fields.md + targets: + - en + + - md: references/protocol-reference/transactions/transaction-common-fields.ja.md + targets: + - ja + + - md: references/protocol-reference/transactions/transaction-types/transaction-types.md + targets: + - en + + - md: references/protocol-reference/transactions/transaction-types/transaction-types.ja.md + targets: + - ja + + # TODO: translate _snippets/tx-fields-intro.md + + - md: references/protocol-reference/transactions/transaction-types/accountset.md + targets: + - en + + - md: references/protocol-reference/transactions/transaction-types/accountset.ja.md + targets: + - ja + + - md: references/protocol-reference/transactions/transaction-types/accountdelete.md + targets: + - en + + - md: references/protocol-reference/transactions/transaction-types/accountdelete.ja.md + targets: + - ja + + - md: references/protocol-reference/transactions/transaction-types/checkcancel.md + targets: + - en + + - md: references/protocol-reference/transactions/transaction-types/checkcancel.ja.md + targets: + - ja + + - md: references/protocol-reference/transactions/transaction-types/checkcash.md + targets: + - en + + - md: references/protocol-reference/transactions/transaction-types/checkcash.ja.md + targets: + - ja + + - md: references/protocol-reference/transactions/transaction-types/checkcreate.md + targets: + - en + + - md: references/protocol-reference/transactions/transaction-types/checkcreate.ja.md + targets: + - ja + + - md: references/protocol-reference/transactions/transaction-types/depositpreauth.md + targets: + - en + + - md: references/protocol-reference/transactions/transaction-types/depositpreauth.ja.md + targets: + - ja + + - md: references/protocol-reference/transactions/transaction-types/escrowcancel.md + targets: + - en + + - md: references/protocol-reference/transactions/transaction-types/escrowcancel.ja.md + targets: + - ja + + - md: references/protocol-reference/transactions/transaction-types/escrowcreate.md + targets: + - en + + - md: references/protocol-reference/transactions/transaction-types/escrowcreate.ja.md + targets: + - ja + + - md: references/protocol-reference/transactions/transaction-types/escrowfinish.md + targets: + - en + + - md: references/protocol-reference/transactions/transaction-types/escrowfinish.ja.md + targets: + - ja + + - md: references/protocol-reference/transactions/transaction-types/offercancel.md + targets: + - en + + - md: references/protocol-reference/transactions/transaction-types/offercancel.ja.md + targets: + - ja + + - md: references/protocol-reference/transactions/transaction-types/offercreate.md + targets: + - en + + - md: references/protocol-reference/transactions/transaction-types/offercreate.ja.md + targets: + - ja + + - md: references/protocol-reference/transactions/transaction-types/payment.md + targets: + - en + + - md: references/protocol-reference/transactions/transaction-types/payment.ja.md + targets: + - ja + + - md: references/protocol-reference/transactions/transaction-types/paymentchannelclaim.md + targets: + - en + + - md: references/protocol-reference/transactions/transaction-types/paymentchannelclaim.ja.md + targets: + - ja + + - md: references/protocol-reference/transactions/transaction-types/paymentchannelcreate.md + targets: + - en + + - md: references/protocol-reference/transactions/transaction-types/paymentchannelcreate.ja.md + targets: + - ja + + - md: references/protocol-reference/transactions/transaction-types/paymentchannelfund.md + targets: + - en + + - md: references/protocol-reference/transactions/transaction-types/paymentchannelfund.ja.md + targets: + - ja + + - md: references/protocol-reference/transactions/transaction-types/setregularkey.md + targets: + - en + + - md: references/protocol-reference/transactions/transaction-types/setregularkey.ja.md + targets: + - ja + + - md: references/protocol-reference/transactions/transaction-types/signerlistset.md + targets: + - en + + - md: references/protocol-reference/transactions/transaction-types/signerlistset.ja.md + targets: + - ja + + # TODO: translate + - md: references/protocol-reference/transactions/transaction-types/ticketcreate.md + targets: + - en + - ja + + - md: references/protocol-reference/transactions/transaction-types/trustset.md + targets: + - en + + - md: references/protocol-reference/transactions/transaction-types/trustset.ja.md + targets: + - ja + + - md: references/protocol-reference/transactions/pseudo-transaction-types/pseudo-transaction-types.md + targets: + - en + + - md: references/protocol-reference/transactions/pseudo-transaction-types/pseudo-transaction-types.ja.md + targets: + - ja + + - md: references/protocol-reference/transactions/pseudo-transaction-types/enableamendment.md + targets: + - en + + - md: references/protocol-reference/transactions/pseudo-transaction-types/enableamendment.ja.md + targets: + - ja + + - md: references/protocol-reference/transactions/pseudo-transaction-types/setfee.md + targets: + - en + + - md: references/protocol-reference/transactions/pseudo-transaction-types/setfee.ja.md + targets: + - ja + + # TODO: translate + - md: references/protocol-reference/transactions/pseudo-transaction-types/unlmodify.md + targets: + - en + - ja + + - md: references/protocol-reference/transactions/transaction-results/transaction-results.md + targets: + - en + + - md: references/protocol-reference/transactions/transaction-results/transaction-results.ja.md + targets: + - ja + + - md: references/protocol-reference/transactions/transaction-results/tec-codes.md + targets: + - en + + - md: references/protocol-reference/transactions/transaction-results/tec-codes.ja.md + targets: + - ja + + - md: references/protocol-reference/transactions/transaction-results/tef-codes.md + targets: + - en + + - md: references/protocol-reference/transactions/transaction-results/tef-codes.ja.md + targets: + - ja + + - md: references/protocol-reference/transactions/transaction-results/tel-codes.md + targets: + - en + + - md: references/protocol-reference/transactions/transaction-results/tel-codes.ja.md + targets: + - ja + + - md: references/protocol-reference/transactions/transaction-results/tem-codes.md + targets: + - en + + - md: references/protocol-reference/transactions/transaction-results/tem-codes.ja.md + targets: + - ja + + - md: references/protocol-reference/transactions/transaction-results/ter-codes.md + targets: + - en + + - md: references/protocol-reference/transactions/transaction-results/ter-codes.ja.md + targets: + - ja + + - md: references/protocol-reference/transactions/transaction-results/tes-success.md + targets: + - en + + - md: references/protocol-reference/transactions/transaction-results/tes-success.ja.md + targets: + - ja + + - md: references/protocol-reference/transactions/transaction-metadata.md + targets: + - en + + - md: references/protocol-reference/transactions/transaction-metadata.ja.md + targets: + - ja + + - md: references/protocol-reference/modifying-the-ledger.md + targets: + - en + + - md: references/protocol-reference/modifying-the-ledger.ja.md + targets: + - ja + + - md: references/protocol-reference/serialization.md + targets: + - en + + - md: references/protocol-reference/serialization.ja.md + targets: + - ja + + # Client Libraries --------------------------------------------------------- + + # TODO: translate page & blurb + - md: references/client-libraries.md + targets: + - en + - ja + + - name: JavaScript / TypeScript Client Library + md: https://raw.githubusercontent.com/ripple/ripple-lib/1.9.4/docs/index.md + html: rippleapi-reference.html + parent: client-libraries.html + blurb: JavaScript/TypeScript client library to the XRP Ledger. + skip_spell_checker: true + # Japanese: XRP Ledgerに対する公式なクライアントライブラリです。JavaScriptのみで使用できます。 + curated_anchors: + - name: Transactions + anchor: "#transaction-overview" + - name: Basic Types + anchor: "#basic-types" + - name: Methods + anchor: "#api-methods" + filters: + - remove_doctoc + - add_version + targets: + - en + - ja + + - name: Python Client Library + html: https://xrpl-py.readthedocs.io/ + parent: client-libraries.html + blurb: Python client library to the XRP Ledger. + targets: + - en + - ja + + - name: Java Client Library + html: https://javadoc.io/doc/org.xrpl/ + parent: client-libraries.html + blurb: Java client library to the XRP Ledger. + targets: + - en + - ja + + + # HTTP / Websocket APIs ---------------------------------------------------- + + - name: HTTP / WebSocket APIs html: rippled-api.html parent: references.html template: template-landing-children.html @@ -1802,7 +2313,7 @@ pages: targets: - en - - name: rippled API リファレンス + - name: HTTP / WebSocket API リファレンス html: rippled-api.html parent: references.html template: template-landing-children.html @@ -1818,27 +2329,19 @@ pages: targets: - ja - - md: references/rippled-api/api-conventions/basic-data-types.md + - md: references/rippled-api/api-conventions/request-formatting.md targets: - en - - md: references/rippled-api/api-conventions/basic-data-types.ja.md + - md: references/rippled-api/api-conventions/request-formatting.ja.md targets: - ja - - md: references/rippled-api/api-conventions/base58-encodings.md + - md: references/rippled-api/api-conventions/response-formatting.md targets: - en - - md: references/rippled-api/api-conventions/base58-encodings.ja.md - targets: - - ja - - - md: references/rippled-api/api-conventions/currency-formats.md - targets: - - en - - - md: references/rippled-api/api-conventions/currency-formats.ja.md + - md: references/rippled-api/api-conventions/response-formatting.ja.md targets: - ja @@ -1858,36 +2361,12 @@ pages: targets: - ja - - md: references/rippled-api/api-conventions/modifying-the-ledger.md - targets: - - en - - - md: references/rippled-api/api-conventions/modifying-the-ledger.ja.md - targets: - - ja - # TODO: translate page & blurb - md: references/rippled-api/api-conventions/rate-limiting.md targets: - en - ja - - md: references/rippled-api/api-conventions/request-formatting.md - targets: - - en - - - md: references/rippled-api/api-conventions/request-formatting.ja.md - targets: - - ja - - - md: references/rippled-api/api-conventions/response-formatting.md - targets: - - en - - - md: references/rippled-api/api-conventions/response-formatting.ja.md - targets: - - ja - - md: references/rippled-api/api-conventions/rippled-server-states.md targets: - en @@ -1896,14 +2375,6 @@ pages: targets: - ja - - md: references/rippled-api/api-conventions/serialization.md - targets: - - en - - - md: references/rippled-api/api-conventions/serialization.ja.md - targets: - - ja - # rippled Public Methods - md: references/rippled-api/public-rippled-methods/public-rippled-methods.md @@ -2596,414 +3067,6 @@ pages: targets: - ja - - md: references/rippled-api/ledger-data-formats/ledger-data-formats.md - targets: - - en - - - md: references/rippled-api/ledger-data-formats/ledger-data-formats.ja.md - targets: - - ja - - - md: references/rippled-api/ledger-data-formats/ledger-header.md - targets: - - en - - - md: references/rippled-api/ledger-data-formats/ledger-header.ja.md - targets: - - ja - - - md: references/rippled-api/ledger-data-formats/ledger-object-ids.md - targets: - - en - - - md: references/rippled-api/ledger-data-formats/ledger-object-ids.ja.md - targets: - - ja - - - md: references/rippled-api/ledger-data-formats/ledger-object-types/ledger-object-types.md - targets: - - en - - - md: references/rippled-api/ledger-data-formats/ledger-object-types/ledger-object-types.ja.md - targets: - - ja - - - md: references/rippled-api/ledger-data-formats/ledger-object-types/accountroot.md - targets: - - en - - - md: references/rippled-api/ledger-data-formats/ledger-object-types/accountroot.ja.md - targets: - - ja - - - md: references/rippled-api/ledger-data-formats/ledger-object-types/amendments.md - targets: - - en - - - md: references/rippled-api/ledger-data-formats/ledger-object-types/amendments.ja.md - targets: - - ja - - - md: references/rippled-api/ledger-data-formats/ledger-object-types/check.md - targets: - - en - - - md: references/rippled-api/ledger-data-formats/ledger-object-types/check.ja.md - targets: - - ja - - - md: references/rippled-api/ledger-data-formats/ledger-object-types/depositpreauth.md - targets: - - en - - - md: references/rippled-api/ledger-data-formats/ledger-object-types/depositpreauth.ja.md - targets: - - ja - - - md: references/rippled-api/ledger-data-formats/ledger-object-types/directorynode.md - targets: - - en - - - md: references/rippled-api/ledger-data-formats/ledger-object-types/directorynode.ja.md - targets: - - ja - - - md: references/rippled-api/ledger-data-formats/ledger-object-types/escrow.md - targets: - - en - - - md: references/rippled-api/ledger-data-formats/ledger-object-types/escrow.ja.md - targets: - - ja - - - md: references/rippled-api/ledger-data-formats/ledger-object-types/feesettings.md - targets: - - en - - - md: references/rippled-api/ledger-data-formats/ledger-object-types/feesettings.ja.md - targets: - - ja - - - md: references/rippled-api/ledger-data-formats/ledger-object-types/ledgerhashes.md - targets: - - en - - - md: references/rippled-api/ledger-data-formats/ledger-object-types/ledgerhashes.ja.md - targets: - - ja - - - md: references/rippled-api/ledger-data-formats/ledger-object-types/negativeunl.md - targets: - - en - - ja - - - md: references/rippled-api/ledger-data-formats/ledger-object-types/offer.md - targets: - - en - - - md: references/rippled-api/ledger-data-formats/ledger-object-types/offer.ja.md - targets: - - ja - - - md: references/rippled-api/ledger-data-formats/ledger-object-types/paychannel.md - targets: - - en - - - md: references/rippled-api/ledger-data-formats/ledger-object-types/paychannel.ja.md - targets: - - ja - - - md: references/rippled-api/ledger-data-formats/ledger-object-types/ripplestate.md - targets: - - en - - - md: references/rippled-api/ledger-data-formats/ledger-object-types/ripplestate.ja.md - targets: - - ja - - - md: references/rippled-api/ledger-data-formats/ledger-object-types/signerlist.md - targets: - - en - - - md: references/rippled-api/ledger-data-formats/ledger-object-types/signerlist.ja.md - targets: - - ja - - - md: references/rippled-api/ledger-data-formats/ledger-object-types/ticket.md - targets: - - en - - ja - - - md: references/rippled-api/transaction-formats/transaction-formats.md - targets: - - en - - - md: references/rippled-api/transaction-formats/transaction-formats.ja.md - targets: - - ja - - - md: references/rippled-api/transaction-formats/transaction-common-fields.md - targets: - - en - - - md: references/rippled-api/transaction-formats/transaction-common-fields.ja.md - targets: - - ja - - - md: references/rippled-api/transaction-formats/transaction-types/transaction-types.md - targets: - - en - - - md: references/rippled-api/transaction-formats/transaction-types/transaction-types.ja.md - targets: - - ja - - # TODO: translate _snippets/tx-fields-intro.md - - - md: references/rippled-api/transaction-formats/transaction-types/accountset.md - targets: - - en - - - md: references/rippled-api/transaction-formats/transaction-types/accountset.ja.md - targets: - - ja - - - md: references/rippled-api/transaction-formats/transaction-types/accountdelete.md - targets: - - en - - - md: references/rippled-api/transaction-formats/transaction-types/accountdelete.ja.md - targets: - - ja - - - md: references/rippled-api/transaction-formats/transaction-types/checkcancel.md - targets: - - en - - - md: references/rippled-api/transaction-formats/transaction-types/checkcancel.ja.md - targets: - - ja - - - md: references/rippled-api/transaction-formats/transaction-types/checkcash.md - targets: - - en - - - md: references/rippled-api/transaction-formats/transaction-types/checkcash.ja.md - targets: - - ja - - - md: references/rippled-api/transaction-formats/transaction-types/checkcreate.md - targets: - - en - - - md: references/rippled-api/transaction-formats/transaction-types/checkcreate.ja.md - targets: - - ja - - - md: references/rippled-api/transaction-formats/transaction-types/depositpreauth.md - targets: - - en - - - md: references/rippled-api/transaction-formats/transaction-types/depositpreauth.ja.md - targets: - - ja - - - md: references/rippled-api/transaction-formats/transaction-types/escrowcancel.md - targets: - - en - - - md: references/rippled-api/transaction-formats/transaction-types/escrowcancel.ja.md - targets: - - ja - - - md: references/rippled-api/transaction-formats/transaction-types/escrowcreate.md - targets: - - en - - - md: references/rippled-api/transaction-formats/transaction-types/escrowcreate.ja.md - targets: - - ja - - - md: references/rippled-api/transaction-formats/transaction-types/escrowfinish.md - targets: - - en - - - md: references/rippled-api/transaction-formats/transaction-types/escrowfinish.ja.md - targets: - - ja - - - md: references/rippled-api/transaction-formats/transaction-types/offercancel.md - targets: - - en - - - md: references/rippled-api/transaction-formats/transaction-types/offercancel.ja.md - targets: - - ja - - - md: references/rippled-api/transaction-formats/transaction-types/offercreate.md - targets: - - en - - - md: references/rippled-api/transaction-formats/transaction-types/offercreate.ja.md - targets: - - ja - - - md: references/rippled-api/transaction-formats/transaction-types/payment.md - targets: - - en - - - md: references/rippled-api/transaction-formats/transaction-types/payment.ja.md - targets: - - ja - - - md: references/rippled-api/transaction-formats/transaction-types/paymentchannelclaim.md - targets: - - en - - - md: references/rippled-api/transaction-formats/transaction-types/paymentchannelclaim.ja.md - targets: - - ja - - - md: references/rippled-api/transaction-formats/transaction-types/paymentchannelcreate.md - targets: - - en - - - md: references/rippled-api/transaction-formats/transaction-types/paymentchannelcreate.ja.md - targets: - - ja - - - md: references/rippled-api/transaction-formats/transaction-types/paymentchannelfund.md - targets: - - en - - - md: references/rippled-api/transaction-formats/transaction-types/paymentchannelfund.ja.md - targets: - - ja - - - md: references/rippled-api/transaction-formats/transaction-types/setregularkey.md - targets: - - en - - - md: references/rippled-api/transaction-formats/transaction-types/setregularkey.ja.md - targets: - - ja - - - md: references/rippled-api/transaction-formats/transaction-types/signerlistset.md - targets: - - en - - - md: references/rippled-api/transaction-formats/transaction-types/signerlistset.ja.md - targets: - - ja - - # TODO: translate - - md: references/rippled-api/transaction-formats/transaction-types/ticketcreate.md - targets: - - en - - ja - - - md: references/rippled-api/transaction-formats/transaction-types/trustset.md - targets: - - en - - - md: references/rippled-api/transaction-formats/transaction-types/trustset.ja.md - targets: - - ja - - - md: references/rippled-api/transaction-formats/pseudo-transaction-types/pseudo-transaction-types.md - targets: - - en - - - md: references/rippled-api/transaction-formats/pseudo-transaction-types/pseudo-transaction-types.ja.md - targets: - - ja - - - md: references/rippled-api/transaction-formats/pseudo-transaction-types/enableamendment.md - targets: - - en - - - md: references/rippled-api/transaction-formats/pseudo-transaction-types/enableamendment.ja.md - targets: - - ja - - - md: references/rippled-api/transaction-formats/pseudo-transaction-types/setfee.md - targets: - - en - - - md: references/rippled-api/transaction-formats/pseudo-transaction-types/setfee.ja.md - targets: - - ja - - # TODO: translate - - md: references/rippled-api/transaction-formats/pseudo-transaction-types/unlmodify.md - targets: - - en - - ja - - - md: references/rippled-api/transaction-formats/transaction-results/transaction-results.md - targets: - - en - - - md: references/rippled-api/transaction-formats/transaction-results/transaction-results.ja.md - targets: - - ja - - - md: references/rippled-api/transaction-formats/transaction-results/tec-codes.md - targets: - - en - - - md: references/rippled-api/transaction-formats/transaction-results/tec-codes.ja.md - targets: - - ja - - - md: references/rippled-api/transaction-formats/transaction-results/tef-codes.md - targets: - - en - - - md: references/rippled-api/transaction-formats/transaction-results/tef-codes.ja.md - targets: - - ja - - - md: references/rippled-api/transaction-formats/transaction-results/tel-codes.md - targets: - - en - - - md: references/rippled-api/transaction-formats/transaction-results/tel-codes.ja.md - targets: - - ja - - - md: references/rippled-api/transaction-formats/transaction-results/tem-codes.md - targets: - - en - - - md: references/rippled-api/transaction-formats/transaction-results/tem-codes.ja.md - targets: - - ja - - - md: references/rippled-api/transaction-formats/transaction-results/ter-codes.md - targets: - - en - - - md: references/rippled-api/transaction-formats/transaction-results/ter-codes.ja.md - targets: - - ja - - - md: references/rippled-api/transaction-formats/transaction-results/tes-success.md - targets: - - en - - - md: references/rippled-api/transaction-formats/transaction-results/tes-success.ja.md - targets: - - ja - - - md: references/rippled-api/transaction-formats/transaction-metadata.md - targets: - - en - - - md: references/rippled-api/transaction-formats/transaction-metadata.ja.md - targets: - - ja - - md: references/rippled-api/commandline-usage.md targets: - en @@ -3045,53 +3108,8 @@ pages: - en - ja - # XRP-API docs (auto-generated)--------------------------------------------- - - - name: XRP-API - md: https://raw.githubusercontent.com/xpring-eng/xrp-api/master/README.md - html: xrp-api.html - parent: references.html - blurb: An API server that provides a REST-like interface to the XRP Ledger. - skip_spell_checker: true - filters: - - xrpapi_readme - targets: - - en - - ja - - xrp-api-only - - # API reference generator makes multiple files here - - openapi_specification: https://raw.githubusercontent.com/xpring-eng/xrp-api/master/api-doc.yml - openapi_md_template_path: tool/openapi_templates_alpha/ - parent: xrp-api.html - blurb: An API server that provides a REST-like interface to the XRP Ledger. #TODO: translate blurb - api_slug: xrp-api - skip_spell_checker: true - targets: - - en - - ja - - xrp-api-only - - - # --------------- end "XRP-API" section -------------------------------- - - - name: RippleAPI Reference # name is required for remote-sourced files - md: https://raw.githubusercontent.com/ripple/ripple-lib/32718d583b882b58f152511e152e9dae1da2d671/docs/index.md #TEMP: use commit instead of release tag since broken link fixes aren't in a release yet - html: rippleapi-reference.html - parent: references.html - blurb: JavaScript/TypeScript client library to the XRP Ledger. - skip_spell_checker: true - # Japanese: XRP Ledgerに対する公式なクライアントライブラリです。JavaScriptのみで使用できます。 - curated_anchors: - - name: Transactions - anchor: "#transaction-overview" - - name: Basic Types - anchor: "#basic-types" - - name: Methods - anchor: "#api-methods" - filters: - - remove_doctoc - - add_version + # Placeholder / redirect for XRP-API docs. + - md: references/xrp-api.md targets: - en - ja @@ -3099,11 +3117,11 @@ pages: - md: references/data-api.md targets: - en - - data-api-only - md: references/data-api.ja.md targets: - ja + - data-api-ja - md: references/xrp-ledger-toml.md targets: diff --git a/tool/template-landing-references.html b/tool/template-landing-references.html index 9946b706f3..e6717687f2 100644 --- a/tool/template-landing-references.html +++ b/tool/template-landing-references.html @@ -11,7 +11,7 @@ {% set flag_n = cycler(* range(1,99)) %}
- {% for page in currentpage.children %} + {% for page in currentpage.children if not page.nav_omit %}

{{page.name}}

diff --git a/tool/tree-nav.html b/tool/tree-nav.html index a1377d7b39..d038d3e362 100644 --- a/tool/tree-nav.html +++ b/tool/tree-nav.html @@ -3,6 +3,7 @@ {% endif %} {% macro page_w_children(pg, n) %} + {% if not (pg.nav_omit and pg != currentpage) %} {% if pg.is_ancestor_of(currentpage.html) %} {% set active_parent=True %} {% else %} @@ -11,11 +12,15 @@
{% if not pg.children %} - {{ pg.name }}{% if pg.status is defined %} {% include 'template-status_'+pg.status+'.html' %}{% endif %} + {% if "//" in pg.html %} + {{ pg.name }}{% if pg.status is defined %} {% include 'template-status_'+pg.status+'.html' %}{% endif %} + {% else %} + {{ pg.name }}{% if pg.status is defined %} {% include 'template-status_'+pg.status+'.html' %}{% endif %} + {% endif %} {% else %} - {{ pg.name }}{% if pg.status is defined %} {% include 'template-status_'~pg.status~'.html' %}{% endif %} + {{ pg.name }}{% if pg.status is defined %} {% include 'template-status_'~pg.status~'.html' %}{% endif %}
+ {% endif %} {% endmacro %}