From 3fe9a0dd18e02dfda50dce63df581b232dfbe684 Mon Sep 17 00:00:00 2001 From: mDuo13 Date: Mon, 17 Aug 2015 18:47:58 -0700 Subject: [PATCH] Data API v2 initial doc --- charts-api-tool.html | 2 + charts_api.html | 2 + content/data_v2.md | 1220 ++++++++++++++++++++++++++++++++++++ data_api_v2.html | 187 ++++++ gateway_guide.html | 2 + gateway_services.html | 2 + historical_data.html | 2 + historicaldb-api-tool.html | 2 + index.html | 2 + reliable_tx.html | 2 + rest-api-tool.html | 2 + ripple-api-tool.html | 2 + ripple-ledger.html | 2 + ripple-rest.html | 2 + rippled-apis.html | 2 + rippled-setup.html | 2 + tool/pages.json | 5 + transactions.html | 2 + transfer_fees.html | 2 + whitepapers.html | 2 + 20 files changed, 1446 insertions(+) create mode 100644 content/data_v2.md create mode 100644 data_api_v2.html diff --git a/charts-api-tool.html b/charts-api-tool.html index 3b5d016082..2000e43272 100644 --- a/charts-api-tool.html +++ b/charts-api-tool.html @@ -56,6 +56,7 @@
  • Gateway Guide
  • Historical Data API
  • Ripple Charts API
    • +
  • Ripple Data API v2
  • Gateway Services
  • Transfer Fees
  • Whitepapers
    • @@ -147,6 +148,7 @@
  • Gateway Guide
  • Historical Data API
  • Ripple Charts API
    • +
  • Ripple Data API v2
  • Gateway Services
  • Transfer Fees
  • Whitepapers
    • diff --git a/charts_api.html b/charts_api.html index 98e54ee4e8..28243a63df 100644 --- a/charts_api.html +++ b/charts_api.html @@ -83,6 +83,7 @@
  • Gateway Guide
  • Historical Data API
  • Ripple Charts API
    • +
  • Ripple Data API v2
  • Gateway Services
  • Transfer Fees
  • Whitepapers
    • @@ -142,6 +143,7 @@
  • Gateway Guide
  • Historical Data API
  • Ripple Charts API
    • +
  • Ripple Data API v2
  • Gateway Services
  • Transfer Fees
  • Whitepapers
    • diff --git a/content/data_v2.md b/content/data_v2.md new file mode 100644 index 0000000000..caa2318e30 --- /dev/null +++ b/content/data_v2.md @@ -0,0 +1,1220 @@ +Ripple Data API v2 +================== + +The Ripple Data API v2 provides access to raw and processed information about changes in the Ripple Consensus Ledger. This information is stored in a database for easy access, which frees `rippled` servers to maintain fewer historical ledger versions. Additionally, the Data API v2 acts as a source of processed analytic data to applications such as [Ripple Charts](https://www.ripplecharts.com/) and [ripple.com](https://www.ripple.com). + +Ripple Labs provides a live instance of the `rippled` Historical Database API with as complete a transaction record as possible at the following address: + +`https://data.ripple.com` + +The Ripple Data API v2 is an evolution of the [Historical Database v1](historical_data.html) and the [Charts API](charts_api.html). The [rippled Historical Database source code](https://github.com/ripple/rippled-historical-database) is also available under an open-source license, so you can use, install, and contribute back to the project. + +## API Methods ## + +The Data API v2 provides a REST API with the following methods: + +General Methods: + +* [Get Ledger - `GET /v2/ledgers/{:ledger_identifier}`](#get-ledger-v2) +* [Get Transaction - `GET /v2/transactions/{:hash}`](#get-transaction-v2) +* [Get Transactions - `GET /v2/transactions/`](#get-transactions) +* [Get Exchanges - `GET /v2/exchanges/:base/:counter`](#get-exchanges) +* [Get Reports - `GET /v2/reports/`](#get-reports) +* [Get Stats - `GET /v2/stats/`](#get-stats) +* [Get Accounts - `GET /v2/accounts`](#get-accounts) + +Account Methods: + +* [Get Account - `GET /v2/accounts/{:address}`](#get-account) +* [Get Account Balances - `GET /v2/accounts/{:address}/balances`](#get-account-balances) +* [Get Account Transaction History - `GET /v2/accounts/{:address}/transactions`](#get-account-transaction-history-v2) +* [Get Transaction By Account and Sequence - `GET /v2/accounts/{:address}/transactions/{:sequence}`](#get-transaction-by-account-and-sequence-v2) +* [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) + + + +# API Objects # + +## 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 - Transaction Hash | An identifying SHA-512 hash unique to this transaction, as a hex string. | +| date | String - IS0 8601 UTC Timestamp | The time when this transaction was included in a validated ledger. | +| ledger_index | Number - Ledger Index | The sequence number of the ledger that included this ledger. | +| tx | Object | The fields of this transaction object, as defined by the [Transaction Format](https://ripple.com/build/transactions) | +| meta | Object | Metadata about the results of this transaction. | + +### Binary Format ### + +| Field | Value | Description | +|-------|-------|-------------| +| hash | String - Transaction Hash | An identifying SHA-512 hash unique to this transaction, as a hex string. | +| date | String - IS0 8601 UTC Timestamp | The time when this transaction was included in a validated ledger. | +| ledger_index | Number - Ledger Index | The sequence number of the ledger that included this ledger. | +| tx | String | The binary data that represents this transaction, as a hex string. | +| meta | Object | 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 - Transaction Hash | An identifying hash unique to this ledger, as a hex string. | +| ledger_index | Number (Unsigned Integer) - Ledger Index | The sequence number of the ledger. Each new ledger has a ledger index 1 higher than the ledger that came before it. | +| parent_hash | String - Transaction Hash | The identifying hash of the previous ledger. | +| total_coins | Unsigned Integer | The total number of drops of XRP still in existence at the time of the ledger. (Each "drop" is 100,000 XRP.) | +| close\_time\_res | Number | Approximate number of seconds between closing one ledger version and closing the next one. | +| accounts\_hash | String - Hash | Hash of the account information contained in this ledger, as hex. | +| transactions\_hash | String - Hash | Hash of the transaction information contained in this ledger, as hex. | +| close_time | Unsigned Integer - UNIX time | The time at which this ledger was closed. | +| close\_time\_human | String - IS0 8601 UTC Timestamp | The time at which this ledger was closed. | + + + +# API Reference # + +## Get Ledger V2 ## +[[Source]
    ](https://github.com/ripple/rippled-historical-database/blob/develop/api/routesV2/getLedger.js "Source") + +Retrieve a specific Ledger by hash, index, date, or latest validated. + +#### Request Format #### + +
    + +*REST* + +``` +GET /v2/ledgers/{:identifier} +``` + +
    + +The following URL parameters are required by this API endpoint: + +| Field | Value | Description | +|-------|-------|-------------| +| ledger_identifier | Ledger Hash, Sequence Number, or ISO 8601 UTC timestamp (YYYY-MM-DDThh:mmZ) | (Optional) An identifier for the ledger to retrieve: either the full hash in hex, an integer sequence number, 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 also include 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 | `success` | Indicates that the body represents 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", + "transactions_hash": "33e0b9c5fd7766343e67854aed4222f5ed9c9507e0ec0d7ae7d54d0f17adb98e", + "close_time": 1408047740, + "close_time_human": "2014-08-14T20:22:20+00:00" + } +} +``` + + + +## Get Transaction V2 ## +[[Source]
    ](https://github.com/ripple/rippled-historical-database/blob/develop/api/routesV2/getTransactions.js "Source") + +Retrieve a specific transaction by its identifying hash. + +#### Request Format #### + +
    + +*REST* + +``` +GET /v2/transactions/{:hash} +``` + +
    + +The following URL parameters are required by this API endpoint: + +| Field | Value | Description | +|-------|-------|-------------| +| hash | Transaction Hash | The identifying (SHA-512) hash of the transaction, as hex. | + +Optionally, you can also include 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. Defaults to false. | + +#### Response Format #### + +A successful response uses the HTTP code **200 OK** and has a JSON body with the following: + +| Field | Value | Description | +|--------|-------|-------------| +| result | `success` | Indicates that the body represents a successful response. | +| transaction | [Transaction object](#transaction-objects) | The requested transaction | + +#### Example #### + +Request: + +``` +GET /v2/transactions/03EDF724397D2DEE70E49D512AECD619E9EA536BE6CFD48ED167AE2596055C9A +``` + +Response: + +```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" + } + } + }, + { + "ModifiedNode": { + "LedgerEntryType": "AccountRoot", + "PreviousTxnLgrSeq": 8317030, + "PreviousTxnID": "F8E33A40A481F037BA788231421737AF2AD13161928B15A14F6ABC5007D6A2B7", + "LedgerIndex": "4F83A2CF7E70F77F79A307E6A472BFC2585B806A70833CCD1C26105BAE0D6E05", + "PreviousFields": { + "OwnerCount": 18, + "Balance": "213169802117" + }, + "FinalFields": { + "Flags": 0, + "Sequence": 1405, + "OwnerCount": 17, + "Balance": "213169802799", + "Account": "r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59" + } + } + }, + { + "ModifiedNode": { + "LedgerEntryType": "Offer", + "PreviousTxnLgrSeq": 8317036, + "PreviousTxnID": "B7256723E74A38A17C9F4F5CB938BD45581C57767E44BF26DAC8BA9FF2D58021", + "LedgerIndex": "55D0954D7C190006BF905D3B3D269A07016CB9F97B1E37ABE7CC8275DBBDE3DA", + "PreviousFields": { + "TakerPays": "8016312417", + "TakerGets": { + "value": "0.085862", + "currency": "BTC", + "issuer": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B" + } + }, + "FinalFields": { + "Flags": 0, + "Sequence": 326320, + "Expiration": 461364125, + "BookNode": "0000000000000000", + "OwnerNode": "0000000000000003", + "BookDirectory": "7B73A610A009249B0CC0D4311E8BA7927B5A34D86634581C5F212B4AE944DDE4", + "TakerPays": "7869978846", + "TakerGets": { + "value": "0.084294634308", + "currency": "BTC", + "issuer": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B" + }, + "Account": "rfCFLzNJYvvnoGHWQYACmJpTgkLUaugLEw" + } + } + }, + { + "ModifiedNode": { + "LedgerEntryType": "RippleState", + "PreviousTxnLgrSeq": 8317014, + "PreviousTxnID": "AB356934159ECD02D27089C0AA97EF2B3DA4B3A5A3A9EC522474CADDF276B307", + "LedgerIndex": "5DC222A1BAF75AE489F9C78F772AEF6AF00C66660B4C28D93DC05FF4A4124D27", + "PreviousFields": { + "Balance": { + "value": "-2.254933867206176", + "currency": "BTC", + "issuer": "rrrrrrrrrrrrrrrrrrrrBZbvji" + } + }, + "FinalFields": { + "Flags": 2228224, + "LowNode": "0000000000000221", + "HighNode": "0000000000000000", + "Balance": { + "value": "-2.253363366782792", + "currency": "BTC", + "issuer": "rrrrrrrrrrrrrrrrrrrrBZbvji" + }, + "LowLimit": { + "value": "0", + "currency": "BTC", + "issuer": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B" + }, + "HighLimit": { + "value": "1000", + "currency": "BTC", + "issuer": "rfCFLzNJYvvnoGHWQYACmJpTgkLUaugLEw" + } + } + } + }, + { + "ModifiedNode": { + "LedgerEntryType": "RippleState", + "PreviousTxnLgrSeq": 8317030, + "PreviousTxnID": "F8E33A40A481F037BA788231421737AF2AD13161928B15A14F6ABC5007D6A2B7", + "LedgerIndex": "767C12AF647CDF5FEB9019B37018748A79C50EDAF87E8D4C7F39F78AA7CA9765", + "PreviousFields": { + "Balance": { + "value": "-0.000000007322616", + "currency": "BTC", + "issuer": "rrrrrrrrrrrrrrrrrrrrBZbvji" + } + }, + "FinalFields": { + "Flags": 131072, + "LowNode": "0000000000000043", + "HighNode": "0000000000000000", + "Balance": { + "value": "0", + "currency": "BTC", + "issuer": "rrrrrrrrrrrrrrrrrrrrBZbvji" + }, + "LowLimit": { + "value": "0", + "currency": "BTC", + "issuer": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B" + }, + "HighLimit": { + "value": "3", + "currency": "BTC", + "issuer": "r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59" + } + } + } + }, + { + "DeletedNode": { + "LedgerEntryType": "DirectoryNode", + "LedgerIndex": "7B73A610A009249B0CC0D4311E8BA7927B5A34D86634581C5F211CEE1E0697A0", + "FinalFields": { + "Flags": 0, + "ExchangeRate": "5F211CEE1E0697A0", + "RootIndex": "7B73A610A009249B0CC0D4311E8BA7927B5A34D86634581C5F211CEE1E0697A0", + "TakerPaysCurrency": "0000000000000000000000000000000000000000", + "TakerPaysIssuer": "0000000000000000000000000000000000000000", + "TakerGetsCurrency": "0000000000000000000000004254430000000000", + "TakerGetsIssuer": "0A20B3C85F482532A9578DBB3950B85CA06594D1" + } + } + }, + { + "DeletedNode": { + "LedgerEntryType": "Offer", + "LedgerIndex": "AF3C702057C9C47DB9E809FD8C76CD22521012C5CC7AE95D914EC9E226F1D7E5", + "PreviousFields": { + "TakerPays": "182677152", + "TakerGets": { + "value": "0.001959953669835", + "currency": "BTC", + "issuer": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B" + } + }, + "FinalFields": { + "Flags": 131072, + "Sequence": 1404, + "PreviousTxnLgrSeq": 8317030, + "BookNode": "0000000000000000", + "OwnerNode": "0000000000000000", + "PreviousTxnID": "F8E33A40A481F037BA788231421737AF2AD13161928B15A14F6ABC5007D6A2B7", + "BookDirectory": "7B73A610A009249B0CC0D4311E8BA7927B5A34D86634581C5F211CEE1E0697A0", + "TakerPays": "182676470", + "TakerGets": { + "value": "0.001959946361835", + "currency": "BTC", + "issuer": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B" + }, + "Account": "r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59" + } + } + }, + { + "ModifiedNode": { + "LedgerEntryType": "AccountRoot", + "PreviousTxnLgrSeq": 8317036, + "PreviousTxnID": "049D5872010AE9144F8FE6A8A92937B6A21C065C2FA9A0233C9CAB7F5485ADC5", + "LedgerIndex": "B4C12A5134DCFE012CCC035F62D5903179DE5CABE74B228D84C7E4905BECC032", + "PreviousFields": { + "Sequence": 159244, + "Balance": "201007563226" + }, + "FinalFields": { + "Flags": 0, + "Sequence": 159245, + "OwnerCount": 19, + "Balance": "200861228909", + "Account": "r2d2iZiCcJmNL6vhUGFjs8U8BuUq6BnmT" + } + } + }, + { + "ModifiedNode": { + "LedgerEntryType": "RippleState", + "PreviousTxnLgrSeq": 8317036, + "PreviousTxnID": "03229A664FF41A8767818DC8B236E59279078BB33C440996CB0A0093F213C173", + "LedgerIndex": "F16445094C00CD3A38CE7851BD6ECA77CA2F281019BE800AB984CDF57D2F2631", + "PreviousFields": { + "Balance": { + "value": "0", + "currency": "BTC", + "issuer": "rrrrrrrrrrrrrrrrrrrrBZbvji" + } + }, + "FinalFields": { + "Flags": 1114112, + "LowNode": "0000000000000000", + "HighNode": "0000000000000233", + "Balance": { + "value": "0.001567373", + "currency": "BTC", + "issuer": "rrrrrrrrrrrrrrrrrrrrBZbvji" + }, + "LowLimit": { + "value": "0", + "currency": "BTC", + "issuer": "r2d2iZiCcJmNL6vhUGFjs8U8BuUq6BnmT" + }, + "HighLimit": { + "value": "0", + "currency": "BTC", + "issuer": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B" + } + } + } + }, + { + "ModifiedNode": { + "LedgerEntryType": "DirectoryNode", + "LedgerIndex": "F60ADF645E78B69857D2E4AEC8B7742FEABC8431BD8611D099B428C3E816DF93", + "FinalFields": { + "Flags": 0, + "RootIndex": "F60ADF645E78B69857D2E4AEC8B7742FEABC8431BD8611D099B428C3E816DF93", + "Owner": "r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59" + } + } + } + ], + "TransactionResult": "tesSUCCESS" + } + } +} +``` + + + + + +## Get Transactions V2 ## +[[Source]
    ](https://github.com/ripple/rippled-historical-database/blob/develop/api/routesV2/getTransactions.js "Source") + +Retrieve transactions by time + +#### Request Format #### + +
    + +*REST* + +``` +GET /v2/transactions/ +``` + +
    + +Optionally, you can include the following query parameters: + +| Field | Value | Description | +|------------|-------|-------------| +| start | String | UTC start time of query range | +| end | String | UTC end time of query range | +| descending | Boolean | reverse chronological order | +| type | String | filter transactions for a specific transaction type | +| result | String | filter transactions for a specific transaction result | +| binary | Boolean | return transactions in binary form | +| limit | Integer | max results per page (defaults to 20) | +| marker | String | The 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 | `success` | Indicates that the body represents a successful response. | +| count | Integer | Number of Transactions returned. | +| marker | String | Pagination marker | +| transactions | Array of [Transaction object](#transaction-objects) | The requested transactions | + + + + +## Get Exchanges ## +[[Source]
    ](https://github.com/ripple/rippled-historical-database/blob/develop/api/routesV2/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} +``` + +
    + +This method requires the following URL parameters: + +| Field | Value | Description | +|-------|-------|-------------| +| base | String | base currency of the pair in the format currency[+issuer] (required) | +| counter | String | counter currency of the pair in the format currency[+issuer] (required) | + +Optionally, you can also include the following query parameters: + +| Field | Value | Description | +|-------------|-------|-------------| +| start | String | UTC start time of query range | +| end | String | UTC end time of query range | +| interval | String | Aggregation interval: `1minute`, `5minute`, `15minute`, `30minute`, `1hour`, `2hour`, `4hour`, `1day`, `3day`, `7day`, or `1month` | +| descending | Boolean | reverse chronological order | +| reduce | Boolean | aggregate all individual results | +| limit | Integer | max results per page (defaults to 200) | +| marker | String | pagination key from previously returned response | +| autobridged | Boolean | return only results from autobridged exchanges | +| format | String | format of returned results: `csv`,`json` defaults to `json` | + + +#### Response Format #### +A successful response uses the HTTP code **200 OK** and has a JSON body with the following: + +| Field | Value | Description | +|--------|-------|-------------| +| result | `success` | Indicates that the body represents a successful response. | +| count | Integer | Number of Transactions returned. | +| marker | String | Pagination marker | +| exchanges | Array of exchange objects | The requested exchanges | + + + + +## Get Reports ## +[[Source]
    ](https://github.com/ripple/rippled-historical-database/blob/develop/api/routesV2/reports.js "Source") + +Retrieve per account per day aggregated payment summaries + +#### Request Format #### + +
    + +*REST* + +``` +GET /v2/reports/{:date} +``` + +
    + +This method requires the following URL parameters: + +| Field | Value | Description | +|-------|--------|-------------| +| date | String | UTC query date (defaults to today) | + +Optionally, you can also include the following query parameters: + +| Field | Value | Description | +|----------|---------|-------------| +| accounts | Boolean | Include lists of counterparty accounts | +| payments | Boolean | Include lists of individual payments | +| format | String | Format of returned results: `csv` or `json`. Defaults to `json`. | + + +#### Response Format #### + +A successful response uses the HTTP code **200 OK** and has a JSON body with the following: + +| Field | Value | Description | +|--------|-------|-------------| +| result | `success` | Indicates that the body represents a successful response. | +| count | Integer | Number of reports returned. | +| marker | String | Pagination marker | +| reports | Array of report objects | The requested reports | + + + + +## Get Stats ## +[[Source]
    ](https://github.com/ripple/rippled-historical-database/blob/develop/api/routesV2/stats.js "Source") + +Retrieve ripple network transaction stats + +#### Request Format #### + +
    + +*REST* + +``` +GET /v2/stats +GET /v2/stats/{:family} +GET /v2/stats/{:family}/{:metric} +``` + +
    + +This method requires the following URL parameters: + +| Field | Value | Description | +|--------|-------|-------------| +| family | String | Return only specified family (`type`, `result`, or `metric`) | +| metric | String | Return only a specific metric from the family subset | + +Optionally, you can also include the following query parameters: + +| Field | Value | Description | +|------------|---------|-------------| +| start | String | UTC start time of query range | +| end | String | UTC end time of query range | +| interval | String | Aggregation interval (`hour`,`day`,`week`, defaults to `day`) | +| limit | Integer | Max results per page (defaults to 200) | +| marker | String | Pagination key from previously returned response | +| descending | Boolean | Reverse chronological order | +| format | String | Format of returned results: `csv`,`json` defaults to `json` | + +#### Response Format #### +A successful response uses the HTTP code **200 OK** and has a JSON body with the following: + +| Field | Value | Description | +|--------|-------|-------------| +| result | `success` | Indicates that the body represents a successful response. | +| count | Integer | Number of reports returned. | +| marker | String | Pagination marker | +| stats | Array of stats objects | The requested stats | + + + + +## Get Accounts ## +[[Source]
    ](https://github.com/ripple/rippled-historical-database/blob/develop/api/routesV2/accounts.js "Source") + +Get funded ripple network accounts + +#### Request Format #### + +
    + +*REST* + +``` +GET /v2/accounts +``` + +
    + +Optionally, you can include the following query parameters: + +| Field | Value | Description | +|------------|---------|-------------| +| start | String | UTC start time of query range | +| end | String | UTC end time of query range | +| interval | String | Aggregation interval (`hour`,`day`,`week`, defaults to `day`) | +| limit | Integer | Max results per page (defaults to 200) | +| marker | String | Pagination key from previously returned response | +| descending | Boolean | Reverse chronological order | +| parent | String | Limit results to specified parent account | +| reduce | Boolean | Return a count of results only | +| format | String | Format of returned results: `csv`,`json` defaults to `json` | + +#### Response Format #### +A successful response uses the HTTP code **200 OK** and has a JSON body with the following: + +| Field | Value | Description | +|--------|-------|-------------| +| result | `success` | Indicates that the body represents a successful response. | +| count | Integer | Number of reports returned. | +| marker | String | Pagination marker | +| stats | Array of account creation objects | The requested accounts | + + + +## Get Account ## +[[Source]
    ](https://github.com/ripple/rippled-historical-database/blob/develop/api/routesV2/getaccount.js "Source") + +Get creation info for a specific ripple account + +#### Request Format #### + +``` +GET /v2/account/{:address} +``` + + +This method requires the following URL parameters: + +| Field | Value | Description | +|---------|--------|-------------| +| address | String | Ripple 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 | `success` | Indicates that the body represents a successful response. | +| account | account creation object | The requested account | + + + + + +## Get Account Balances ## +[[Source]
    ](https://github.com/ripple/rippled-historical-database/blob/develop/api/routesV2/accountBalances.js "Source") + +Get balances for a specific ripple account + +
    + +*REST* + +``` +GET /v2/account/{:address}/balances +``` + +
    + +This method requires the following URL parameters: + +| Field | Value | Description | +|----------|--------|-------------| +| address | String | Ripple address to query | + +Optionally, you can also include the following query parameters: + +| Field | Value | Description | +|--------------|---------|-------------| +| ledger_index | Integer | Index of ledger for historical balances | +| ledger_hash | String | Ledger hash for historical balances | +| date | String | UTC date for historical balances | +| currency | String | Restrict results to specified currency | +| issuer | String | Restrict results to specified counterparty/issuer | +| limit | Integer | Max results per page (defaults to 200) | +| marker | String | Pagination key from previously returned response | +| format | String | Format of returned results: `csv`,`json` defaults to `json` | + + + +#### Response Format #### +A successful response uses the HTTP code **200 OK** and has a JSON body with the following: + +| Field | Value | Description | +|--------|-------|-------------| +| result | `success` | Indicates that the body represents a successful response. | +| ledger_index | Integer | ledger index for balances query | +| close_time | String | close time of the ledger | +| limit | String | number of results returned, if limit was exceeded | +| marker | String | Pagination marker | +| balances | Array of balance objects | The requested balances | + + + + +## Get Account Transactions V2 ## +[[Source]
    ](https://github.com/ripple/rippled-historical-database/blob/develop/api/routesV2/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 +``` + +
    + +This method requires the following URL parameters: + +| Field | Value | Description | +|----------|--------|-------------| +| :address | String | Ripple address to query | + + +Optionally, you can also include the following query parameters: + +| Field | Value | Description | +|--------------|---------|-------------| +| start | String | UTC start time of query range | +| end | String | UTC end time of query range | +| min_sequence | String | Minimum sequence number to query | +| max_sequence | String | Max sequence number to query | +| type | String | Restrict results to a specified transaction type | +| result | String | Restrict results to specified transaction result | +| binary | Boolean | Return results in binary format | +| descending | Boolean | Reverse chronological order | +| limit | Integer | Max results per page (defaults to 20) | +| marker | String | Pagination key from previously returned response | +| format | String | Format of returned results: `csv`,`json` defaults to `json` | + + +#### Response Format #### + +A successful response uses the HTTP code **200 OK** and has a JSON body with the following: + +| Field | Value | Description | +|--------|-------|-------------| +| result | `success` | Indicates that the body represents a successful response. | +| count | Integer | The number of objects contained in the `transactions` field. | +| marker | String | Pagination marker | +| transactions | Array of [transaction objects](#transaction-objects) | All transactions matching the request. | + + + + +## Get Transactions By Account And Sequence V2 ## +[[Source]
    ](https://github.com/ripple/rippled-historical-database/blob/develop/api/routesV2/accountTxSeq.js "Source") + +Retrieve a specifc transaction originating from a specified account + +#### Request Format #### + +
    + +*REST* + +``` +GET /v2/accounts/{:address}/transactions/{:sequence} +``` + +
    + +This method requires the following URL parameters: + +| Field | Value | Description | +|-----------|---------|-------------| +| :address | String | Ripple address to query | +| :sequence | Integer | Transaction sequence | + + +Optionally, you can also include the following query parameters: + +| Field | Value | Description | +|--------|---------|-------------| +| binary | Boolean | Return transaction in binary format | + + +#### Response Format #### + +A successful response uses the HTTP code **200 OK** and has a JSON body with the following: + +| Field | Value | Description | +|--------|-------|-------------| +| result | `success` | Indicates that the body represents a successful response. | +| transaction | [transaction object](#transaction-objects) | requested transaction | + + + + +## Get Account Payments ## +[[Source]
    ](https://github.com/ripple/rippled-historical-database/blob/develop/api/routesV2/accountPayments.js "Source") + +Retrieve a payments for a specified account + +#### Request Format #### + +
    + +*REST* + +``` +GET /v2/accounts/{:address}/payments +``` + +
    + +This method requires the following URL parameters: + +| Field | Value | Description | +|----------|--------|-------------| +| :address | String | Ripple address to query | + + +Optionally, you can also include the following query parameters: + +| Field | Value | Description | +|------------|---------|-------------| +| start | String | UTC start time of query range | +| end | String | UTC end time of query range | +| type | String | Type of payment - `sent` or `received` | +| currency | String | Restrict results to specified currency | +| issuer | String | Restrict results to specified issuer | +| descending | Boolean | Reverse chronological order | +| limit | Integer | Max results per page (defaults to 20) | +| marker | String | Pagination key from previously returned response | +| format | String | Format of returned results: `csv`,`json` defaults to `json` | + + +#### Response Format #### + +A successful response uses the HTTP code **200 OK** and has a JSON body with the following: + +| Field | Value | Description | +|--------|-------|-------------| +| result | `success` | Indicates that the body represents a successful response. | +| count | Integer | The number of objects contained in the `payments` field. | +| marker | String | Pagination marker | +| payments | Array of payment objects | All payments matching the request. | + + + + +## Get Account Exchanges ## +[[Source]
    ](https://github.com/ripple/rippled-historical-database/blob/develop/api/routesV2/accountExchanges.js "Source") + +Retrieve Exchanges for a given account over time. + +#### Request Format #### + +
    + +*REST* + +``` +GET /v2/account/{:address}/exchanges/ +GET /v2/account/{:address}/exchanges/{:base}/{:counter} +``` + +
    + +This method requires the following URL parameters: + +| Field | Value | Description | +|----------|--------|-------------| +| :address | String | Ripple address to query | +| :base | String | Base currency of the pair in the format currency[+issuer] | +| :counter | String | Counter currency of the pair in the format currency[+issuer] | + + +Optionally, you can also include the following query parameters: + +| Field | Value | Description | +|------------|---------|-------------| +| start | String | UTC start time of query range | +| end | String | UTC end time of query range | +| descending | Boolean | Reverse chronological order | +| limit | Integer | Max results per page (defaults to 200) | +| marker | String | Pagination key from previously returned response | +| format | String | Format of returned results: `csv`,`json` defaults to `json` | + + +#### Response Format #### +A successful response uses the HTTP code **200 OK** and has a JSON body with the following: + +| Field | Value | Description | +|--------|-------|-------------| +| result | `success` | Indicates that the body represents a successful response. | +| count | Integer | Number of exchanges returned. | +| marker | String | Pagination marker | +| exchanges | Array of exchange objects | The requested exchanges | + + + +## Get Account Balance Changes ## +[[Source]
    ](https://github.com/ripple/rippled-historical-database/blob/develop/api/routesV2/accountBalanceChanges.js "Source") + +Retrieve Balance changes for a given account over time. + +#### Request Format #### + +
    + +*REST* + +``` +GET /v2/account/{:address}/balance_changes/ +``` + +
    + +This method requires the following URL parameters: + +| Field | Value | Description | +|----------|--------|-------------| +| :address | String | Ripple address to query | + + +Optionally, you can also include the following query parameters: + +| Field | Value | Description | +|------------|---------|-------------| +| currency | String | Restrict results to specified currency | +| issuer | String | Restrict results to specified counterparty/issuer | +| start | String | UTC start time of query range | +| end | String | UTC end time of query range | +| descending | Boolean | Reverse chronological order | +| limit | Integer | Max results per page (defaults to 200) | +| marker | String | Pagination key from previously returned response | +| format | String | Format of returned results: `csv`,`json` defaults to `json` | + + +#### Response Format #### +A successful response uses the HTTP code **200 OK** and has a JSON body with the following: + +| Field | Value | Description | +|--------|-------|-------------| +| result | `success` | Indicates that the body represents a successful response. | +| count | Integer | Number of balance changes returned. | +| marker | String | Pagination marker | +| exchanges | Array of balance change objects | The requested balance changes | + + + + +## Get Account Reports ## +[[Source]
    ](https://github.com/ripple/rippled-historical-database/blob/develop/api/routesV2/accountReports.js "Source") + +Retrieve daily summaries of payment activity for an account. + +
    + +*REST* + +``` +GET /v2/account/{:address}/reports/ +GET /v2/account/{:address}/reports/{:date} +``` + +
    + +This method requires the following URL parameters: + +| Field | Value | Description | +|----------|--------|-------------| +| :address | String | Ripple address to query | +| :date | String | UTC date for single report | + + +Optionally, you can also include the following query parameters: + +| Field | Value | Description | +|------------|---------|-------------| +| start | String | UTC start time of query range | +| end | String | UTC end time of query range | +| accounts | Boolean | Include lists of counterparty accounts | +| payments | Boolean | Include lists of individual payments | +| descending | Boolean | Reverse chronological order | +| format | String | Format of returned results: `csv`,`json` defaults to `json` | + + +#### Response Format #### +A successful response uses the HTTP code **200 OK** and has a JSON body with the following: + +| Field | Value | Description | +|--------|-------|-------------| +| result | `success` | Indicates that the body represents a successful response. | +| count | Integer | Number of reports returned. | +| reports | Array of report objects | The requested reports | + + + + + +# Running the Historical Database # + +You can also run your own instance of the Historical Database software, and populate it with transactions from your own `rippled` instance. This is useful if you do not want to depend on Ripple Labs to operate the historical database indefinitely, or you want access to historical transactions from within your own intranet. + +## Installation ## + +### Dependencies ### + +The Historical Database requires the following software installed first: +* [PostgreSQL](http://www.postgresql.org/) (required for v1), +* [HBase](http://hbase.apache.org/) (required for v2), +* [Node.js](http://nodejs.org/) +* [npm](https://www.npmjs.org/) +* [git](http://git-scm.com/) (optional) for installation and updating. + +### Installation Process ### + +For v1 (postgres): + + 1. Create a new postgres database: + `createdb ripple_historical` in PostgreSQL + 2. Clone the rippled Historical Database Git Repository: + `git clone https://github.com/ripple/rippled-historical-database.git` + (You can also download and extract a zipped release instead.) + 3. Use npm to install additional modules: + `cd rippled-historical-database` + `npm install` + The install script will also create the required config files: `config/api.config.json` and `config/import.config.json` + 4. Modify the API and import config files as needed. If you only wish to run the v1 endpoints, remove the `hbase` section from the api config. + 5. Load the latest database schema for the rippled Historical Database: + `./node_modules/knex/lib/bin/cli.js migrate:latest` + +For v2 (hbase): + + 1. Set up an hbase cluster + 2. Clone the rippled Historical Database Git Repository: + `git clone https://github.com/ripple/rippled-historical-database.git` + (You can also download and extract a zipped release instead.) + 3. Use npm to install additional modules: + `cd rippled-historical-database` + `npm install` + The install script will also create the required config files: `config/api.config.json` and `config/import.config.json` + 4. Modify the API and import config files as needed. If you only wish to run the v2 endpoints, remove the `postgres` section from the api config file. + +At this point, the rippled Historical Database is installed. See [Services](#services) for the different components that you can run. + +### Services ### + +The `rippled` Historical Database consists of several processes that can be run separately. + +* [Live Ledger Importer](#live-ledger-importer) - Monitors `rippled` for newly-validated ledgers. + Command: `node import/live` +* [Backfiller](#backfiller) - Populates the database with older ledgers from a `rippled` instance. + Command: `node import/postgres/backfill` +* API Server - Provides [REST API access](#usage) to the data. + Command: `npm start` (restarts the server automatically when source files change), + or `node api/server.js` (simple start) + +# Importing Data # + +In order to retrieve data from the `rippled` Historical Database, you must first populate it with data. Broadly speaking, there are two ways this can happen: + +* Connect to a `rippled` server that has the historical ledgers, and retrieve them. (Later, you can reconfigure the `rippled` server not to maintain history older than what you have in your Historical Database.) + * You can choose to retrieve only new ledgers as they are validated, or you can retrieve old ledgers, too. +* Or, you can load a dump from a database that already has the historical ledger data. (At this time, there are no publicly-available database dumps of historical data.) Use the standard process for your database. + +In all cases, keep in mind that the integrity of the data is only as good as the original source. If you retrieve data from a public server, you are assuming that the operator of that server is trustworthy. If you load from a database dump, you are assuming that the provider of the dump has not corrupted or tampered with the data. + +## Live Ledger Importer ## + +The Live Ledger Importer is a service that connects to a `rippled` server using the WebSocket API, and listens for ledger close events. Each time a new ledger is closed, the Importer requests the latest validated ledger. Although this process has some fault tolerance built in to prevent ledgers from being skipped, it is still possible that the Importer may miss ledgers. + +The Live Ledger Importer includes a secondary process that runs periodically to validate the data already imported and check for gaps in the ledger history. + +The Live Ledger Importer can import to one or more different data stores concurrently. If you have configured the historical database to use another storage scheme, you can use the `--type` parameter to specify the database type or types to use. If not specified, the `rippled` Historical Database defaults to PostgreSQL. + +Here are some examples: + +``` +// defaults to Hbase: +$ node import/live + +// Use Postgres instead: +$ node import/live --type postgres + +// Use PostgreSQL and Hbase simultaneously: +$ node import/live --type postgres,hbase +``` + +## Backfiller ## + +The Backfiller retrieves old ledgers from a `rippled` instance by moving backwards in time. You can optionally provide start and stop indexes to retrieve a specific range of ledgers, by their sequence number. + +The `--startIndex` parameter defines the most-recent ledger to retrieve. The Backfiller retrieves this ledger first and then continues retrieving progressively older ledgers. If this parameter is omitted, the Backfiller begins with the newest validated ledger. + +The `--stopIndex` parameter defines the oldest ledger to retrieve. The Backfiller stops after it retrieves this ledger. If omitted, the Backfiller continues as far back as possible. Because backfilling goes from most recent to least recent, the stop index should be a smaller than the start index. + +**Warning:** The Backfiller is best for filling in relatively short histories of transactions. Importing a complete history of all Ripple transactions using the Backfiller could take weeks. If you want a full history, we recommend acquiring a database dump with early transctions, and importing it directly. Ripple Labs used the internal SQLite database from an offline `rippled` to populate its historical databases with the early transactions, then used the Backfiller to catch up to date after the import finished. + +Here are some examples: + +``` +// retrieve everything to PostgreSQL +node import/postgres/backfill + +// get ledgers #1,000,000 to #2,000,000 (inclusive) and store in hbase +node import/hbase/backfill --startIndex 2000000 --stopIndex 1000000 +``` + + + diff --git a/data_api_v2.html b/data_api_v2.html new file mode 100644 index 0000000000..bf088cbbfd --- /dev/null +++ b/data_api_v2.html @@ -0,0 +1,187 @@ + + + + + + + + Ripple Data API v2 - Ripple Developer Portal + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    +
    +
    +
    +
    +
    +
    + + + diff --git a/gateway_guide.html b/gateway_guide.html index aedd00bef6..1d58bd3f55 100644 --- a/gateway_guide.html +++ b/gateway_guide.html @@ -83,6 +83,7 @@
  • Gateway Guide
  • Historical Data API
  • Ripple Charts API
    • +
  • Ripple Data API v2
  • Gateway Services
  • Transfer Fees
  • Whitepapers
    • @@ -142,6 +143,7 @@
  • Gateway Guide
  • Historical Data API
  • Ripple Charts API
    • +
  • Ripple Data API v2
  • Gateway Services
  • Transfer Fees
  • Whitepapers
    • diff --git a/gateway_services.html b/gateway_services.html index ab07adc4a6..4ae4937082 100644 --- a/gateway_services.html +++ b/gateway_services.html @@ -83,6 +83,7 @@
  • Gateway Guide
  • Historical Data API
  • Ripple Charts API
    • +
  • Ripple Data API v2
  • Gateway Services
  • Transfer Fees
  • Whitepapers
    • @@ -142,6 +143,7 @@
  • Gateway Guide
  • Historical Data API
  • Ripple Charts API
    • +
  • Ripple Data API v2
  • Gateway Services
  • Transfer Fees
  • Whitepapers
    • diff --git a/historical_data.html b/historical_data.html index c2edf6d256..5701c24aa8 100644 --- a/historical_data.html +++ b/historical_data.html @@ -83,6 +83,7 @@
  • Gateway Guide
  • Historical Data API
  • Ripple Charts API
    • +
  • Ripple Data API v2
  • Gateway Services
  • Transfer Fees
  • Whitepapers
    • @@ -142,6 +143,7 @@
  • Gateway Guide
  • Historical Data API
  • Ripple Charts API
    • +
  • Ripple Data API v2
  • Gateway Services
  • Transfer Fees
  • Whitepapers
    • diff --git a/historicaldb-api-tool.html b/historicaldb-api-tool.html index 51a0b8e71f..3fd970ab16 100644 --- a/historicaldb-api-tool.html +++ b/historicaldb-api-tool.html @@ -56,6 +56,7 @@
  • Gateway Guide
  • Historical Data API
  • Ripple Charts API
    • +
  • Ripple Data API v2
  • Gateway Services
  • Transfer Fees
  • Whitepapers
    • @@ -147,6 +148,7 @@
  • Gateway Guide
  • Historical Data API
  • Ripple Charts API
    • +
  • Ripple Data API v2
  • Gateway Services
  • Transfer Fees
  • Whitepapers
    • diff --git a/index.html b/index.html index 78cf49d58d..cdc3e8b945 100644 --- a/index.html +++ b/index.html @@ -69,6 +69,7 @@
  • Gateway Guide
  • Historical Data API
  • Ripple Charts API
    • +
  • Ripple Data API v2
  • Gateway Services
  • Transfer Fees
  • Whitepapers
    • @@ -237,6 +238,7 @@
  • Gateway Guide
  • Historical Data API
  • Ripple Charts API
    • +
  • Ripple Data API v2
  • Gateway Services
  • Transfer Fees
  • Whitepapers
    • diff --git a/reliable_tx.html b/reliable_tx.html index 51fcd5f6dd..3437440757 100644 --- a/reliable_tx.html +++ b/reliable_tx.html @@ -83,6 +83,7 @@
  • Gateway Guide
  • Historical Data API
  • Ripple Charts API
    • +
  • Ripple Data API v2
  • Gateway Services
  • Transfer Fees
  • Whitepapers
    • @@ -142,6 +143,7 @@
  • Gateway Guide
  • Historical Data API
  • Ripple Charts API
    • +
  • Ripple Data API v2
  • Gateway Services
  • Transfer Fees
  • Whitepapers
    • diff --git a/rest-api-tool.html b/rest-api-tool.html index 603d6ea857..f028f59431 100644 --- a/rest-api-tool.html +++ b/rest-api-tool.html @@ -56,6 +56,7 @@
  • Gateway Guide
  • Historical Data API
  • Ripple Charts API
    • +
  • Ripple Data API v2
  • Gateway Services
  • Transfer Fees
  • Whitepapers
    • @@ -147,6 +148,7 @@
  • Gateway Guide
  • Historical Data API
  • Ripple Charts API
    • +
  • Ripple Data API v2
  • Gateway Services
  • Transfer Fees
  • Whitepapers
    • diff --git a/ripple-api-tool.html b/ripple-api-tool.html index 16e2815097..751d18e4b6 100644 --- a/ripple-api-tool.html +++ b/ripple-api-tool.html @@ -56,6 +56,7 @@
  • Gateway Guide
  • Historical Data API
  • Ripple Charts API
    • +
  • Ripple Data API v2
  • Gateway Services
  • Transfer Fees
  • Whitepapers
    • @@ -180,6 +181,7 @@
  • Gateway Guide
  • Historical Data API
  • Ripple Charts API
    • +
  • Ripple Data API v2
  • Gateway Services
  • Transfer Fees
  • Whitepapers
    • diff --git a/ripple-ledger.html b/ripple-ledger.html index 7af8ea141f..0461f7ea45 100644 --- a/ripple-ledger.html +++ b/ripple-ledger.html @@ -83,6 +83,7 @@
  • Gateway Guide
  • Historical Data API
  • Ripple Charts API
    • +
  • Ripple Data API v2
  • Gateway Services
  • Transfer Fees
  • Whitepapers
    • @@ -142,6 +143,7 @@
  • Gateway Guide
  • Historical Data API
  • Ripple Charts API
    • +
  • Ripple Data API v2
  • Gateway Services
  • Transfer Fees
  • Whitepapers
    • diff --git a/ripple-rest.html b/ripple-rest.html index 0f8b16a6b1..6fda167dc0 100644 --- a/ripple-rest.html +++ b/ripple-rest.html @@ -83,6 +83,7 @@
  • Gateway Guide
  • Historical Data API
  • Ripple Charts API
    • +
  • Ripple Data API v2
  • Gateway Services
  • Transfer Fees
  • Whitepapers
    • @@ -142,6 +143,7 @@
  • Gateway Guide
  • Historical Data API
  • Ripple Charts API
    • +
  • Ripple Data API v2
  • Gateway Services
  • Transfer Fees
  • Whitepapers
    • diff --git a/rippled-apis.html b/rippled-apis.html index 28029c0e77..d8aa1cb8d0 100644 --- a/rippled-apis.html +++ b/rippled-apis.html @@ -83,6 +83,7 @@
  • Gateway Guide
  • Historical Data API
  • Ripple Charts API
    • +
  • Ripple Data API v2
  • Gateway Services
  • Transfer Fees
  • Whitepapers
    • @@ -142,6 +143,7 @@
  • Gateway Guide
  • Historical Data API
  • Ripple Charts API
    • +
  • Ripple Data API v2
  • Gateway Services
  • Transfer Fees
  • Whitepapers
    • diff --git a/rippled-setup.html b/rippled-setup.html index d6cba5efe8..5381514429 100644 --- a/rippled-setup.html +++ b/rippled-setup.html @@ -83,6 +83,7 @@
  • Gateway Guide
  • Historical Data API
  • Ripple Charts API
    • +
  • Ripple Data API v2
  • Gateway Services
  • Transfer Fees
  • Whitepapers
    • @@ -142,6 +143,7 @@
  • Gateway Guide
  • Historical Data API
  • Ripple Charts API
    • +
  • Ripple Data API v2
  • Gateway Services
  • Transfer Fees
  • Whitepapers
    • diff --git a/tool/pages.json b/tool/pages.json index 42d1aafd70..b3021f9c67 100644 --- a/tool/pages.json +++ b/tool/pages.json @@ -44,6 +44,11 @@ "md": "charts_api.md", "html": "charts_api.html" }, + { + "name": "Ripple Data API v2", + "md": "data_v2.md", + "html": "data_api_v2.html" + }, { "name": "Gateway Services", "md":"gateway_services_spec.md", diff --git a/transactions.html b/transactions.html index cd46c96037..1bd6360275 100644 --- a/transactions.html +++ b/transactions.html @@ -83,6 +83,7 @@
  • Gateway Guide
  • Historical Data API
  • Ripple Charts API
    • +
  • Ripple Data API v2
  • Gateway Services
  • Transfer Fees
  • Whitepapers
    • @@ -142,6 +143,7 @@
  • Gateway Guide
  • Historical Data API
  • Ripple Charts API
    • +
  • Ripple Data API v2
  • Gateway Services
  • Transfer Fees
  • Whitepapers
    • diff --git a/transfer_fees.html b/transfer_fees.html index d2b18b83f2..c308190e16 100644 --- a/transfer_fees.html +++ b/transfer_fees.html @@ -83,6 +83,7 @@
  • Gateway Guide
  • Historical Data API
  • Ripple Charts API
    • +
  • Ripple Data API v2
  • Gateway Services
  • Transfer Fees
  • Whitepapers
    • @@ -142,6 +143,7 @@
  • Gateway Guide
  • Historical Data API
  • Ripple Charts API
    • +
  • Ripple Data API v2
  • Gateway Services
  • Transfer Fees
  • Whitepapers
    • diff --git a/whitepapers.html b/whitepapers.html index 2e5906bc88..a6cb1dd91b 100644 --- a/whitepapers.html +++ b/whitepapers.html @@ -83,6 +83,7 @@
  • Gateway Guide
  • Historical Data API
  • Ripple Charts API
    • +
  • Ripple Data API v2
  • Gateway Services
  • Transfer Fees
  • Whitepapers
    • @@ -142,6 +143,7 @@
  • Gateway Guide
  • Historical Data API
  • Ripple Charts API
    • +
  • Ripple Data API v2
  • Gateway Services
  • Transfer Fees
  • Whitepapers