Ripple Data API v2

The Ripple Data API v2 provides access to information about changes in the Ripple Consensus Ledger, including transaction history and processed analytical data. 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 data source for applications such as Ripple Charts and ripple.com.

Ripple provides a live instance of the Data API with as complete a transaction record as possible at the following address:

https://data.ripple.com

More Information

The Ripple Data API v2 replaces the Historical Database v1 and the Charts API.

• API Methods
• API Conventions
• Setup (local instance)
• Source Code on Github
• Release Notes

API Method Reference

The Data API v2 provides a REST API with the following methods:

General Methods:

• Get Ledger - GET /v2/ledgers/{:ledger_identifier}
• Get Ledger Validations - GET /v2/ledger/{:hash}/validations
• Get Ledger Validation - GET /v2/ledger/{:hash}/validations/:validation_pubkey
• Get Transaction - GET /v2/transactions/{:hash}
• Get Transactions - GET /v2/transactions/
• Get Payments - GET /v2/payments/{:currency}
• Get Exchanges - GET /v2/exchanges/{:base}/{:counter}
• Get Exchange Rates - GET /v2/exchange_rates/{:base}/{:counter}
• Normalize - GET /v2/normalize
• Get Daily Reports - GET /v2/reports/
• Get Stats - GET /v2/stats/
• Get Capitalization - GET /v2/capitalization/{:currency}
• Get Active Accounts - GET /v2/active_accounts/{:base}/{:counter}
• Get Exchange Volume - GET /v2/network/exchange_volume
• Get Payment Volume - GET /v2/network/payment_volume
• Get Issued Value - GET /v2/network/issued_value
• Get XRP Distribution - GET /v2/network/xrp_distribution
• Get Top Currencies - GET /v2/network/top_currencies
• Get Top Markets - GET /v2/network/top_markets
• Get Network Fees - GET /v2/network/fees
• Get Topology - GET /v2/network/topology
• Get Topology Nodes - GET /v2/network/topology/nodes
• Get Topology Node - GET /v2/network/topology/nodes/{:pubkey}
• Get Topology Links - GET /v2/network/topology/links
• Get Validations - GET /v2/network/validations
• Get Validators - GET /v2/network/validators
• Get Validator - GET /v2/network/validators/{:pubkey}
• Get Validator Validations - GET /v2/network/validators/{:pubkey}/validations
• Get Single Validator Reports - GET /v2/network/validators/{:pubkey}/reports
• Get Daily Validator Reports - GET /v2/network/validator_reports
• Get All Gateways - GET /v2/gateways
• Get Gateway - GET /v2/gateways/{:gateway}
• Get Currency Image - GET /v2/currencies/{:currencyimage}

Account Methods:

• Get Account - GET /v2/accounts/{:address}
• Get Accounts - GET /v2/accounts
• Get Account Balances - GET /v2/accounts/{:address}/balances
• Get Account Orders - GET /v2/accounts/{:address}/orders
• Get Account Transaction History - GET /v2/accounts/{:address}/transactions
• Get Transaction By Account and Sequence - GET /v2/accounts/{:address}/transactions/{:sequence}
• Get Account Payments - GET /v2/accounts/{:address}/payments
• Get Account Exchanges - GET /v2/accounts/{:address}/exchanges
• Get Account Balance Changes - GET /v2/accounts/{:address}/balance_changes
• Get Account Reports - GET /v2/accounts/{:address}/reports
• Get Account Transaction Stats - GET /v2/accounts/{:address}/stats/transactions
• Get Account Value Stats - GET /v2/accounts/{:address}/stats/value

Health Checks:

• API Health Check - GET /v2/health/api
• Importer Health Check - GET /v2/health/importer
• Nodes ETL Health Check - GET /v2/health/nodes_etl
• Validations ETL Health Check - GET /v2/health/validations_etl

Get Ledger

[Source]

Retrieve a specific Ledger by hash, index, date, or latest validated.

Request Format

REST

GET /v2/ledgers/{:identifier}

Try it! >

The following URL parameters are required by this API endpoint:

Optionally, you can also include the following query parameters:

Response Format

A successful response uses the HTTP code 200 OK and has a JSON body with the following:

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 Ledger Validations

[Source]

Retrieve a any validations recorded for a specific ledger hash. This dataset includes ledgers that are outside the main ledger chain, and only includes data that we have recorded. As such, some ledgers may have no validations even though they were validated by consensus.

Request Format

REST

GET /v2/ledgers/{:ledger_hash}/validations

Try it! >

The following URL parameters are required by this API endpoint:

Optionally, you can also include the following query parameters:

Response Format

A successful response uses the HTTP code 200 OK and has a JSON body with the following:

Each object in the validations array represents a validation report received, and has the following fields:

Example

Request:

GET /v2/ledgers/EB26614C5E171C5A141734BAFFA63A080955811BB7AAE00D76D26FDBE9BC07A5/validations

Response:

200 OK
{
  result: "success",
  ledger_hash: "EB26614C5E171C5A141734BAFFA63A080955811BB7AAE00D76D26FDBE9BC07A5",
  count: 18,
  validations: [
    {
      count: 2,
      first_datetime: "2016-03-28T18:24:24.846Z",
      last_datetime: "2016-03-28T18:24:24.945Z",
      ledger_hash: "EB26614C5E171C5A141734BAFFA63A080955811BB7AAE00D76D26FDBE9BC07A5",
      reporter_public_key: "n9LGDURtWWoaayddmJpjKwTC7p4AKde2L7mC8o5kx1CFDSZdQjcd",
      signature: "304402206F77C7688199343FD911B2ABB0232DBEEC6E30A94F4E00CF7B99CEF444E17FC1022018FF6B21A2A6CB2784429CAAB647AF336E383B5E1630C4B6321616050508306F",
      validation_public_key: "n949f75evCHwgyP4fPVgaHqNHxUVN15PsJEZ3B3HnXPcPjcZAoy7"
    },
    ...
  ]
}

Get Ledger Validation

[Source]

Retrieve a validation recorded for a specific ledger hash by a specific validator. This dataset includes ledgers that are outside the main ledger chain, and only includes data that we have recorded. As such, some ledgers may have no validations even though they were validated by consensus.

Request Format

REST

GET /v2/ledgers/{:ledger_hash}/validations/{:validation_public_key}

Try it! >

The following URL parameters are required by this API endpoint:

Response Format

A successful response uses the HTTP code 200 OK and has a JSON body with the following:

Example

Request:

GET /v2/ledgers/EB26614C5E171C5A141734BAFFA63A080955811BB7AAE00D76D26FDBE9BC07A5/validations/n949f75evCHwgyP4fPVgaHqNHxUVN15PsJEZ3B3HnXPcPjcZAoy7

Response:

200 OK
{
  count: 2,
  first_datetime: "2016-03-28T18:24:24.846Z",
  last_datetime: "2016-03-28T18:24:24.945Z",
  ledger_hash: "EB26614C5E171C5A141734BAFFA63A080955811BB7AAE00D76D26FDBE9BC07A5",
  reporter_public_key: "n9LGDURtWWoaayddmJpjKwTC7p4AKde2L7mC8o5kx1CFDSZdQjcd",
  signature: "304402206F77C7688199343FD911B2ABB0232DBEEC6E30A94F4E00CF7B99CEF444E17FC1022018FF6B21A2A6CB2784429CAAB647AF336E383B5E1630C4B6321616050508306F",
  validation_public_key: "n949f75evCHwgyP4fPVgaHqNHxUVN15PsJEZ3B3HnXPcPjcZAoy7",
  result: "success"
}

Get Transaction

[Source]

Retrieve a specific transaction by its identifying hash.

Request Format

REST

GET /v2/transactions/{:hash}

Try it! >

The following URL parameters are required by this API endpoint:

Optionally, you can also include the following query parameters:

Response Format

A successful response uses the HTTP code 200 OK and has a JSON body with the following:

Example

Request:

GET /v2/transactions/03EDF724397D2DEE70E49D512AECD619E9EA536BE6CFD48ED167AE2596055C9A

Response (trimmed for size):

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]

Retrieve transactions by time

Request Format

REST

GET /v2/transactions/

Try it! >

Optionally, you can include the following query parameters:

Response Format

A successful response uses the HTTP code 200 OK and has a JSON body with the following:

Example

Request:

GET /v2/transactions/?result=tecPATH_DRY&limit=2&type=Payment

Response:

{
  "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]

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! >

This method accepts the following URL parameters:

Optionally, you can also include the following query parameters:

Response Format

A successful response uses the HTTP code 200 OK and has a JSON body with the following:

Aggregate Results

If the request specifies a currency and an interval, the result includes objects summarizing activity over a specific time period instead of listing individual payments. Each interval summary object has the following fields:

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]

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! >

This method requires the following URL parameters:

Optionally, you can also include the following query parameters:

Response Format

A successful response uses the HTTP code 200 OK and has a JSON body with the following:

Example

Request:

GET /v2/exchanges/USD+rMwjYedjc7qqtKYVLiAccJSmCwih4LnE2q/XRP?descending=true&limit=3&result=tesSUCCESS&type=OfferCreate

Response:

{
    "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]

Retrieve an exchange rate for a given currency pair at a specific time.

Request Format

REST

GET /v2/exchange_rates/{:base}/{:counter}

Try it! >

This method requires the following URL parameters:

Optionally, you can also include the following query parameters:

Response Format

A successful response uses the HTTP code 200 OK and has a JSON body with the following:

All exchange rates are calcuated 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:

{
  "result": "success",
  "rate": "224.65709"
}

Normalize

[Source]

Convert an amount from one currency and issuer to another, using the network exchange rates.

Request Format

REST

GET /v2/normalize

Try it! >

This method uses the following query parameters:

Response Format

A successful response uses the HTTP code 200 OK and has a JSON body with the following:

All exchange rates are calculating by converting both currencies to XRP.

Example

Request:

GET /v2/normalize?amount=100&currency=XRP&exchange_currency=USD&exchange_issuer=rMwjYedjc7qqtKYVLiAccJSmCwih4LnE2q

Response:

{
  "result": "success",
  "amount": "100",
  "converted": "0.4267798022744489",
  "rate": "0.0042677980"
}

Get Daily Reports

[Source]

Retrieve per account per day aggregated payment summaries

Request Format

REST

GET /v2/reports/{:date}

Try it! >

This method uses the following URL parameters:

Optionally, you can also include the following query parameters:

Response Format

A successful response uses the HTTP code 200 OK and has a JSON body with the following:

WARNING: 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]

Retrieve statistics about transaction activity in the Ripple Consensus Ledger, divided into intervals of time.

Request Format

REST

GET /v2/stats

Try it! >

Optionally, you can also include the following query parameters:

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:

Special Transaction Metrics

The Data API derives the following values for every interval. These metrics are part of the metric family.

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:

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:

{
  "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 Capitalization

[Source]

Get the total amount of a single currency issued by a single issuer, also known as the market capitalization. (New in v2.0.4)

Request Format

REST

GET /v2/capitaliztion/{:currency}

Try it! >

This method requires the following URL parameters:

Optionally, you can also include the following query parameters:

If the request omits both start and end, the API returns only the most recent sample.

Response Format

A successful response uses the HTTP code 200 OK and has a JSON body with the following:

Each issuer capitalization object has the following fields:

Example

Request:

GET /v2/capitalization/USD+rMwjYedjc7qqtKYVLiAccJSmCwih4LnE2q?start=2015-01-01T00:00:00Z&end=2015-10-31&interval=month

Response:

200 OK
{
  "result": "success",
  "currency": "USD",
  "issuer": "rMwjYedjc7qqtKYVLiAccJSmCwih4LnE2q",
  "count": 10,
  "rows": [
    {
      "date": "2015-01-01T00:00:00Z",
      "amount": "4212940.254176095"
    },
    {
      "date": "2015-02-01T00:00:00Z",
      "amount": "5102817.663782776"
    },
    {
      "date": "2015-03-01T00:00:00Z",
      "amount": "4179270.8503426993"
    },
    {
      "date": "2015-04-01T00:00:00Z",
      "amount": "2609239.954946732"
    },
    {
      "date": "2015-05-01T00:00:00Z",
      "amount": "2262976.3681027396"
    },
    {
      "date": "2015-06-01T00:00:00Z",
      "amount": "2401904.277326213"
    },
    {
      "date": "2015-07-01T00:00:00Z",
      "amount": "2007614.760195671"
    },
    {
      "date": "2015-08-01T00:00:00Z",
      "amount": "2286058.6013003727"
    },
    {
      "date": "2015-09-01T00:00:00Z",
      "amount": "2070512.4729615194"
    },
    {
      "date": "2015-10-01T00:00:00Z",
      "amount": "2140238.7719266433"
    }
  ]
}

Get Active Accounts

[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! >

This method requires the following URL parameters:

Optionally, you can also include the following query parameters:

Response Format

A successful response uses the HTTP code 200 OK and has a JSON body with the following:

Each "Account Trading Object" describes the activity of a single account during the period, and has the following fields:

Example

Request:

GET /v2/active_accounts/XRP/USD+rMwjYedjc7qqtKYVLiAccJSmCwih4LnE2q

Response:

{
    "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]

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! >

Optionally, you can include the following query parameters:

Response Format

A successful response uses the HTTP code 200 OK and has a JSON body with the following:

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:

Example

Request:

GET /v2/network/exchange_volume?exchange_currency=USD&exchange_issuer=rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B

Response:

{
    "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]

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! >

Optionally, you can include the following query parameters:

Response Format

A successful response uses the HTTP code 200 OK and has a JSON body with the following:

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:

Example

Request:

GET /v2/network/payment_volume

Response:

{
    "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 Issued Value

[Source]

Get the total value of all currencies issued by a selection of major gateways over time. By default, returns only the most recent measurement. (New in v2.0.4)

The API returns results in units of a single display currency rather than many different currencies. The conversion uses standard rates to and from XRP.

Request Format

REST

GET /v2/network/issued_value

Try it! >

Optionally, you can include the following query parameters:

Response Format

A successful response uses the HTTP code 200 OK and has a JSON body with the following:

Each Issued Value Object represents the total value issued at one point in time, and has the following fields:

Example

Request:

GET /v2/network/issued_value?start=2015-10-01T00:00:00&end=2015-10-01T00:00:00&exchange_currency=USD&exchange_issuer=rMwjYedjc7qqtKYVLiAccJSmCwih4LnE2q

Response:

{
  "result": "success",
  "count": 1,
  "rows": [
    {
      "components": [
        {
          "currency": "USD",
          "issuer": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B",
          "amount": "2177473.2843876695",
          "rate": "0.000028818194",
          "converted_amount": "2166521.1303508882"
        },
        {
          "currency": "USD",
          "issuer": "rMwjYedjc7qqtKYVLiAccJSmCwih4LnE2q",
          "amount": "1651297.315492664",
          "rate": "0.000028888001",
          "converted_amount": "1639021.4313562333"
        },

        ... (additional results trimmed for size) ...

        {
          "currency": "MXN",
          "issuer": "rG6FZ31hDHN1K5Dkbma3PSB5uVCuVVRzfn",
          "amount": "2288827.2376308907",
          "rate": "0.00050850375",
          "converted_amount": "129061.20018881827"
        }
      ],
      "exchange": {
        "currency": "USD",
        "issuer": "rMwjYedjc7qqtKYVLiAccJSmCwih4LnE2q"
      },
      "total": "8338101.394233938",
      "exchange_rate": "0.0053547404",
      "date": "2015-10-01T00:00:00Z"
    }
  ]
}

Get XRP distribution

[Source]

Get total XRP, aggregate amount held by Ripple, Inc., and aggregate amount held by others.

Request Format

REST

GET /v2/network/xrp_distribution

Try it! >

Optionally, you can include the following query parameters:

Response Format

A successful response uses the HTTP code 200 OK and has a JSON body with the following:

Each Distribution Object has the following fields:

Example

Request:

GET /v2/network/xrp_distribution

Response:

{
  "result": "success",
  "count": 171,
  "rows": [
    {
      "date": "2016-04-10T00:00:00Z",
      "distributed": "34918644255.77274",
      "total": "99997725821.25714",
      "undistributed": "65079081565.4844"
    },
    ...
  ]
}

Get Top Currencies

[Source]

Returns the top currencies on the Ripple Consensus Ledger, ordered from highest rank to lowest. The ranking is determined by the volume and count of transactions and the number of unique counterparties. By default, returns results for the 30-day rolling window ending on the current date. You can specify a date to get results for the 30-day window ending on that date. (New in v2.1.0)

Request Format

Most Recent

GET /v2/network/top_currencies

By Date

GET /v2/network/top_currencies/2016-01-01

Try it! >

This method does not accept any query parameters.

Response Format

A successful response uses the HTTP code 200 OK and has a JSON body with the following:

Each Top Currency Object has the following fields:

Example

Request:

GET /v2/network/top_currencies/2015-12-31

Response:

{
  result: "success",
  date: "2015-12-31T00:00:00Z",
  count: 41,
  currencies: [
    {
      avg_exchange_count: "4652.1612903225805",
      avg_exchange_volume: "5.872515158748898E7",
      avg_payment_count: "406.5625",
      avg_payment_volume: "592537.1043782063",
      issued_value: "3.3304427137620807E8",
      currency: "USD",
      issuer: "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B"
    },
    {
      avg_exchange_count: "6083.193548387097",
      avg_exchange_volume: "3.558897661266646E7",
      avg_payment_count: "520.71875",
      avg_payment_volume: "3507232.307236187",
      issued_value: "1.1695602455168623E8",
      currency: "CNY",
      issuer: "rKiCet8SdvWxPXnAgYarFUXMh1zCPz432Y"
    },
    {
      avg_exchange_count: "3715.0967741935483",
      avg_exchange_volume: "3.7346262589967564E7",
      avg_payment_count: "163.1875",
      avg_payment_volume: "775.0342076125125",
      issued_value: "1.906530130641547E8",
      currency: "BTC",
      issuer: "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B"
    },
    ...
  ]
}

Get Top Markets

[Source]

Returns the top exchange markets on the Ripple Consensus Ledger, ordered from highest rank to lowest. The rank is determined by the number and volume of exchanges and the number of counterparties participating. By default, returns top markets for the 30-day rolling window ending on the current date. You can specify a date to get results for the 30-day window ending on that date. (New in v2.1.0)

Request Format

Most Recent

GET /v2/network/top_markets

By Date

GET /v2/network/top_markets/2016-01-01

This method does not accept any query parameters.

Try it! >

Response Format

A successful response uses the HTTP code 200 OK and has a JSON body with the following:

Each Top Market object has the following fields:

Example

Request:

GET /v2/network/top_markets/2015-12-31

Response:

{
  result: "success",
  date: "2015-12-31T00:00:00Z",
  count: 56,
  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"
    },
    {
      avg_base_volume: "178.06809101586364",
      avg_counter_volume: "1.1343000055456754E7",
      avg_exchange_count: "1224.2857142857142",
      avg_volume: "1.1343000055456754E7",
      base_currency: "BTC",
      base_issuer: "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B",
      counter_currency: "XRP"
    },
    ...
  ]
}

Get Network Fees

[Source]

Returns network fee stats per ledger, hour, or day. The data shows the average, minimum, maximum, and total fees incurred for the given interval/ledger. (New in [v2.2.0][])

Request Format

GET /v2/network/fees

Optionally, you can include the following query parameters:

Try it! >

Response Format

A successful response uses the HTTP code 200 OK and has a JSON body with the following:

Each Fee Summary object has the following fields:

Example

Request:

GET /v2/network/fees?interval=hour

Response:

{
  result: "success",
  marker: "hour|20130124080000",
  count: 200,
  rows: [
    {
      avg: 0.00001,
      max: 0.00001,
      min: 0.00001,
      total: 0.00001,
      tx_count: 1,
      date: "2013-01-02T06:00:00Z"
    },
    ...
  ]
}

Get Topology

[Source]

Get known Rippled nodes and connections between them.

Request Format

REST

GET /v2/network/topology

Optionally, you can include the following query parameters:

Response Format

A successful response uses the HTTP code 200 OK and has a JSON body with the following:

Node Object fields:

Additional Optional Node Object fields (verbose = true)

Link Object fields:

Example

Request:

GET /v2/network/topology

Response:

{
  result: "success",
  date: "2016-03-21T16:38:52Z",
  node_count: 99,
  link_count: 1632,
  nodes: [
    {
      node_public_key: "n94Extku8HiQVY8fcgxeot4bY7JqK2pNYfmdnhgf6UbcmgucHFY8",
      version: "rippled-0.30.1-hf2",
      uptime: 1729008,
      inbound_count: 4,
      outbound_count: 20
    },
    ...
  ],
  links: [
    {
      source: "n94Extku8HiQVY8fcgxeot4bY7JqK2pNYfmdnhgf6UbcmgucHFY8",
      target: "n9JccBLfrDJBLBF2X5N7bUW8251riCwSf9e3VQ3P5fK4gYr5LBu4"
    },
    ...
  ]
}

Get Topology Nodes##

[Source]

Get known Rippled nodes.

Request Format

REST

GET /v2/network/topology/nodes

Response Format

A successful response uses the HTTP code 200 OK and has a JSON body with the following:

Node Object fields:

Additional Optional Node Object fields (verbose = true)

Example

Request:

GET /v2/network/topology/nodes

Response:

{
  result: "success",
  date: "2016-03-21T16:38:52Z",
  count: 99,
  nodes: [
    {
      node_public_key: "n94Extku8HiQVY8fcgxeot4bY7JqK2pNYfmdnhgf6UbcmgucHFY8",
      version: "rippled-0.30.1-hf2",
      uptime: 1729008,
      inbound_count: 4,
      outbound_count: 20
    },
    ...
  ]
}

Get Topology Node

[Source]

Get a single rippled node by node public key

Request Format

REST

GET /v2/network/topology/nodes

Response Format

A successful response uses the HTTP code 200 OK and has a JSON body with the following:

Example

Request:

GET /v2/network/topology/nodes/n94Extku8HiQVY8fcgxeot4bY7JqK2pNYfmdnhgf6UbcmgucHFY8

Response:

{
  result: "success",
  date: "2016-03-21T16:38:52Z",
  node_public_key: "n94Extku8HiQVY8fcgxeot4bY7JqK2pNYfmdnhgf6UbcmgucHFY8",
  version: "rippled-0.30.1-hf2",
  uptime: 1729008,
  inbound_count: 4,
  outbound_count: 20
}

Get Topology Links

[Source]

Get known Rippled nodes and connections between them.

Request Format

REST

GET /v2/network/topology/links

Optionally, you can include the following query parameters:

Response Format

A successful response uses the HTTP code 200 OK and has a JSON body with the following:

Link Object fields:

Example

Request:

GET /v2/network/topology/links

Response:

{
  result: "success",
  date: "2016-03-21T16:38:52Z",
  count: 1632,
  links: [
    {
      source: "n94Extku8HiQVY8fcgxeot4bY7JqK2pNYfmdnhgf6UbcmgucHFY8",
      target: "n9JccBLfrDJBLBF2X5N7bUW8251riCwSf9e3VQ3P5fK4gYr5LBu4"
    },
    ...
  ]
}

Get Validations

[Source]

Retrieve a validations. This dataset includes ledgers that are outside the main ledger chain, and only includes data that we have recorded. As such, some ledgers may have no validations even though they were validated by consensus.

Request Format

REST

GET /v2/network/validations

Try it! >

Optionally, you can also include the following query parameters:

Response Format

A successful response uses the HTTP code 200 OK and has a JSON body with the following:

Each object in the validations array represents a validation report received, and has the following fields:

Example

Request:

GET /v2/network/validations

Response:

200 OK
{
  result: "success",
  count: 18,
  marker: "20160321220050|n9L81uNCaPgtUJfaHh89gmdvXKAmSt5Gdsw2g1iPWaPkAHW5Nm4C|FEDEB98F78265AB3DBAE95C316101CAD583E348144AFC41A410D598BD79DD5C2",
  validations: [
    {
      count: 2,
      first_datetime: "2016-03-28T18:24:24.846Z",
      last_datetime: "2016-03-28T18:24:24.945Z",
      ledger_hash: "EB26614C5E171C5A141734BAFFA63A080955811BB7AAE00D76D26FDBE9BC07A5",
      reporter_public_key: "n9LGDURtWWoaayddmJpjKwTC7p4AKde2L7mC8o5kx1CFDSZdQjcd",
      signature: "304402206F77C7688199343FD911B2ABB0232DBEEC6E30A94F4E00CF7B99CEF444E17FC1022018FF6B21A2A6CB2784429CAAB647AF336E383B5E1630C4B6321616050508306F",
      validation_public_key: "n949f75evCHwgyP4fPVgaHqNHxUVN15PsJEZ3B3HnXPcPjcZAoy7"
    },
    ...
  ]
}

Get Validators

[Source]

Get a list of known validators

Request Format

REST

GET /v2/network/validators

Optionally, you can include the following query parameters:

Response Format

A successful response uses the HTTP code 200 OK and has a JSON body with the following:

Example

Request:

GET /v2/network/validators/n949f75evCHwgyP4fPVgaHqNHxUVN15PsJEZ3B3HnXPcPjcZAoy7

Response:

{
  result: "success",
  last_datetime: "2016-02-11T23:20:41.319Z",
  validation_public_key: "n949f75evCHwgyP4fPVgaHqNHxUVN15PsJEZ3B3HnXPcPjcZAoy7"
}

Get Validator

[Source]

Get details of a single validator by validation public key

Request Format

REST

GET /v2/network/validators/:pubkey

This method requires the following URL parameters:

Optionally, you can include the following query parameters:

Response Format

A successful response uses the HTTP code 200 OK and has a JSON body with the following:

Example

Request:

GET /v2/network/validators/n949f75evCHwgyP4fPVgaHqNHxUVN15PsJEZ3B3HnXPcPjcZAoy7

Response:

{
  result: "success",
  last_datetime: "2016-02-11T23:20:41.319Z",
  validation_public_key: "n949f75evCHwgyP4fPVgaHqNHxUVN15PsJEZ3B3HnXPcPjcZAoy7"
}

Get Validator Validations

[Source]

Retrieve a validations for a specified validator. This dataset includes ledgers that are outside the main ledger chain, and only includes data that we have recorded. As such, some ledgers may have no validations even though they were validated by consensus.

Request Format

REST

GET /v2/network/validators/:pubkey/validations

Try it! >

This method requires the following URL parameters:

Optionally, you can also include the following query parameters:

Response Format

A successful response uses the HTTP code 200 OK and has a JSON body with the following:

Each object in the validations array represents a validation report received, and has the following fields:

Example

Request:

GET /v2/network/validator/n9KDWeLbHfZuXDfdJoe5wVXtHxLwWVTp5QE7PnWL6LctqoaFsVox/validations

Response:

200 OK
{
  result: "success",
  count: 18,
  marker: "n9KDWeLbHfZuXDfdJoe5wVXtHxLwWVTp5QE7PnWL6LctqoaFsVox|20160321222943|8D75A43EF0AA72E6FF5908855F35D88145E042D9AEB6B40B2E66AB3CC5BF5AEF",
  validations: [
    {
      count: 2,
      first_datetime: "2016-03-28T18:24:24.846Z",
      last_datetime: "2016-03-28T18:24:24.945Z",
      ledger_hash: "EB26614C5E171C5A141734BAFFA63A080955811BB7AAE00D76D26FDBE9BC07A5",
      reporter_public_key: "n9LGDURtWWoaayddmJpjKwTC7p4AKde2L7mC8o5kx1CFDSZdQjcd",
      signature: "304402206F77C7688199343FD911B2ABB0232DBEEC6E30A94F4E00CF7B99CEF444E17FC1022018FF6B21A2A6CB2784429CAAB647AF336E383B5E1630C4B6321616050508306F",
      validation_public_key: "n9KDWeLbHfZuXDfdJoe5wVXtHxLwWVTp5QE7PnWL6LctqoaFsVox"
    },
    ...
  ]
}

Get Single Validator Reports

[Source]

Get Daily reports for a single validator by validation public key.

Request Format

REST

GET /v2/network/validators/:pubkey/reports

This method requires the following URL parameters:

Optionally, you can include the following query parameters:

Response Format

A successful response uses the HTTP code 200 OK and has a JSON body with the following:

Validator Report Object fields:

Example

Request:

GET /v2/network/validators/n949f75evCHwgyP4fPVgaHqNHxUVN15PsJEZ3B3HnXPcPjcZAoy7/reports

Response:

{
  result: "success",
  count: 2,
  validators: [
    {
    last_datetime: "2016-02-11T23:20:41.779Z",
    validation_public_key: "n94a8g8RVLQR3jTRJRatdSvWM7JYmeH433jizBHFaezPVWendSoo"
    },
    ...
  ]
}

Get Daily Validator Reports

[Source]

Get Daily reports for known validators.

Request Format

REST

GET /v2/network/validator_reports

Optionally, you can include the following query parameters:

Response Format

A successful response uses the HTTP code 200 OK and has a JSON body with the following:

Validator Report Object fields:

Example

Request:

GET /v2/network/validator_reports

Response:

{
  result: "success",
  count: 25,
  reports: [
    {
      validation_public_key: "n9L81uNCaPgtUJfaHh89gmdvXKAmSt5Gdsw2g1iPWaPkAHW5Nm4C",
      date: "2016-03-25T00:00:00Z",
      total_ledgers: 1035,
      main_net_agreeement: "1.0000",
      main_net_ledgers: 1035,
      alt_net_agreeement: "0.0000",
      alt_net_ledgers: 0,
      other_ledgers: 0
    },
    ...
  ]
}

Get All Gateways

[Source]

Get information about known gateways. (New in v2.0.4)

Request Format

REST

GET /v2/gateways/

Try it! >

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:

Example

Request:

GET /v2/gateways/

Response:

{
    "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]

Get information about a specific gateway from the Data API's list of known gateways. (New in v2.0.4)

Request Format

REST

GET /v2/gateways/{:gateway}

Try it! >

This method requires the following URL parameters:

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:

Each object in the accounts field array has the following fields:

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]

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:

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.

Example

Request:

GET /v2/currencies/mxn.svg

Response

200 OK
Content-Type: image/svg+xml
<?xml version="1.0" encoding="utf-8"?>
<!-- Generator: Adobe Illustrator 18.1.1, SVG Export Plug-In . SVG Version: 6.00 Build 0)  -->
<svg version="1.1" id="Layer_1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" x="0px" y="0px"
   width="200px" height="200px" viewBox="0 0 200 200" enable-background="new 0 0 200 200" xml:space="preserve">
<g>
  <path fill="#FC6E74" d="M105.1,181.5c-12.2,0-24-2.1-35.1-6.2c-11.1-4.1-21.6-10.5-31.1-19.1l-1.3-1.2l18.8-22.3l1.4,1.2
    c7.4,6.4,14.9,11.3,22.4,14.7c7.4,3.4,16,5.1,25.5,5.1c8,0,14.4-1.7,19-5c4.5-3.2,6.7-7.3,6.7-12.7c0-3-0.4-5.2-1.3-7.1
    c-0.8-1.8-2.4-3.6-4.8-5.4c-2.4-1.8-5.9-3.5-10.2-5.1c-4.5-1.6-10.3-3.2-17.5-4.8c-8.3-1.9-15.8-4.1-22.4-6.6
    c-6.6-2.5-12.3-5.6-16.8-9.2C54,94.3,50.4,89.8,48,84.5c-2.4-5.2-3.6-11.6-3.6-18.9c0-7.4,1.4-13.8,4.1-19.5
    c2.7-5.8,6.6-10.7,11.4-14.8c4.8-4.1,10.6-7.3,17.3-9.5c6.7-2.3,14-3.4,21.9-3.4c11.6,0,22.2,1.7,31.4,5.1
    c9.3,3.4,18.1,8.4,26.2,14.8l1.4,1.1l-16.8,23.6l-1.5-1.1c-6.9-5-13.9-9-20.7-11.6c-6.7-2.6-13.6-4-20.4-4
    c-7.5,0-13.4,1.6-17.5,4.9c-4,3.2-6,7-6,11.6c0,3.1,0.5,5.5,1.4,7.5c0.9,2,2.6,3.8,5,5.4c2.6,1.8,6.3,3.4,10.9,5
    c4.8,1.6,10.9,3.3,18.2,5c8.3,2.1,15.7,4.4,22,7c6.5,2.6,12,5.8,16.3,9.5c4.3,3.8,7.7,8.3,9.9,13.3c2.2,5,3.4,10.9,3.4,17.5
    c0,7.9-1.4,14.7-4.2,20.7c-2.8,6-6.8,11.1-11.9,15.3c-5,4.1-11.1,7.3-18.1,9.4C121.2,180.5,113.4,181.5,105.1,181.5z"/>
  <rect x="86.7" y="0" fill="#FC6E74" width="26.5" height="40.1"/>
  <rect x="86.5" y="159.2" fill="#FC6E74" width="27" height="40.8"/>
</g>
</svg>

Get Accounts

[Source]

Retrieve information about the creation of new accounts in the Ripple Consensus Ledger.

Request Format

REST

GET /v2/accounts

Try it! >

Optionally, you can include the following query parameters:

Response Format

A successful response uses the HTTP code 200 OK and has a JSON body with the following:

Interval Objects

If the request uses the interval query parameter, the response has an array of interval objects, each of which represents the number of accounts created during a single interval. Interval objects have the following fields:

Example

Request:

GET /v1/accounts?parent=rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn

Response:

{
  "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]

Get creation info for a specific ripple account

Request Format

REST

GET /v2/accounts/{:address}

Try it! >

This method requires the following URL parameters:

Response Format

A successful response uses the HTTP code 200 OK and has a JSON body with the following:

Example

Request:

GET /v2/accounts/rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn

Response:

{
    "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]

Get all balances held or owed by a specific Ripple account.

REST

GET /v2/accounts/{:address}/balances

Try it! >

This method requires the following URL parameters:

Optionally, you can also include the following query parameters:

Response Format

A successful response uses the HTTP code 200 OK and has a JSON body with the following:

Example

Request:

GET /v2/accounts/rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn/balances?currency=USD&date=2015-01-01T00:00:00Z&limit=3

Response:

{
  "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]

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/account/{:address}/orders

Try it! >

This method requires the following URL parameters:

Optionally, you can also include the following query parameters:

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:

Each order object has the following fields:

Example

Request:

GET /v2/accounts/rK5j9n8baXfL4gzUoZsfxBvvsv97P5swaV/orders?limit=2&date=2015-11-11T00:00:00Z

Response:

{
  "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]

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! >

This method requires the following URL parameters:

Optionally, you can also include the following query parameters:

Response Format

A successful response uses the HTTP code 200 OK and has a JSON body with the following:

Example

Request:

GET /v2/accounts/rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn/transactions?type=Payment&result=tesSUCCESS&limit=1

Response:

{
  "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]

Retrieve a specifc transaction originating from a specified account

Request Format

REST

GET /v2/accounts/{:address}/transactions/{:sequence}

Try it! >

This method requires the following URL parameters:

Optionally, you can also include the following query parameters:

Response Format

A successful response uses the HTTP code 200 OK and has a JSON body with the following:

Example

Request:

GET /v2/accounts/rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn/transactions/10?binary=true

Response:

{
  "result": "success",
  "transaction": {
    "hash": "4BFFBB86C12659B6C5BB88F0EB859356DE3433EBACBFD9F50F6E70B2C05CCFE0",
    "date": "2014-09-15T19:59:10+00:00",
    "ledger_index": 8889812,
    "tx": "1200052200000000240000000A68400000000000000A732103AB40A0490F9B7ED8DF29D246BF2D6269820A0EE7742ACDD457BEA7C7D0931EDB74473045022100AA4AF08726FCF0F28AA4A841C45F975C3BF1545648F6907DCB33F6E3DD7E85D6022037365B80AB1972BF8A4280009A0DBCF16A1D562ED0489B155750E48CC939039981144B4E9C06F24296074F7BC48F92A97916C6DC5EA9",
    "meta": "201C00000003F8E5110061250087A5C555CBCA96F4C42E0EBC0E75C5AD84B3403FEDF824A7DAFA45ADCA6ECB66AA143C1B5613F1A95D7AAB7108D5CE7EEAF504B2894B8C674E6D68499076441C4837282BF8E6240000000A62400000000DB5852F8814D3484B9ED2556DCE16A3B928B438BA6EE0FF0989E1E72200010000240000000B2D0000000062400000000DB5852572110000000000000000000000070000000300770A6D64756F31332E636F6D81144B4E9C06F24296074F7BC48F92A97916C6DC5EA9E1E1F1031000"
  }
}

Get Account Payments

[Source]

Retrieve a payments for a specified account

Request Format

REST

GET /v2/accounts/{:address}/payments

Try it! >

This method requires the following URL parameters:

Optionally, you can also include the following query parameters:

Response Format

A successful response uses the HTTP code 200 OK and has a JSON body with the following:

Example

Request:

GET /v2/accounts/rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn/payments?currency=USD&limit=1

Response:

{
  "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]

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! >

This method requires the following URL parameters:

Optionally, you can also include the following query parameters:

Response Format

A successful response uses the HTTP code 200 OK and has a JSON body with the following:

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:

{
    "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]

Retrieve Balance changes for a given account over time.

Request Format

REST

GET /v2/accounts/{:address}/balance_changes/

Try it! >

This method requires the following URL parameters:

Optionally, you can also include the following query parameters:

Response Format

A successful response uses the HTTP code 200 OK and has a JSON body with the following:

Example

Request:

GET /v2/accounts/rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn/balance_changes?descending=true&limit=3

Response:

{
  "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]

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! >

This method requires the following URL parameters:

Optionally, you can also include the following query parameters:

Response Format

A successful response uses the HTTP code 200 OK and has a JSON body with the following:

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:

{
  "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]

Retrieve daily summaries of transaction activity for an account. (New in v2.1.0.)

REST

GET /v2/accounts/{:address}/stats/transactions

Try it! >

This method requires the following URL parameters:

Optionally, you can also include the following query parameters:

Response Format

A successful response uses the HTTP code 200 OK and has a JSON body with the following:

Each Transaction Stats Object has the following fields:

Example

Request:

GET /v2/accounts/rGFuMiw48HdbnrUbkRYuitXTmfrDBNTCnX/stats/transactions?start=2015-01-01&limit=2

Response:

{
  "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]

Retrieve daily summaries of transaction activity for an account. (New in v2.1.0.)

REST

GET /v2/accounts/{:address}/stats/value

Try it! >

This method requires the following URL parameters:

Optionally, you can also include the following query parameters:

Response Format

A successful response uses the HTTP code 200 OK and has a JSON body with the following:

Each Value Stats Object has the following fields:

Example

Request:

GET /v2/accounts/rGFuMiw48HdbnrUbkRYuitXTmfrDBNTCnX/stats/value?limit=2&descending=true

Response:

{
  "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]

Check the health of the API service.

REST

GET /v2/health/api

Optionally, you can also include the following query parameters:

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:

If the request specifies verbose=true in the query parameters, the response body is a JSON object, with the following fields:

Example

Request:

GET /v2/health/api?verbose=true

Response:

{
  "score": 0,
  "response_time": "0.014s",
  "response_time_threshold": "5s"
}

Health Check - Ledger Importer

[Source]

Check the health of the Ledger Importer Service.

REST - Importer Health

GET /v2/health/importer

Optionally, you can also include the following query parameters:

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:

If the request specifies verbose=true in the query parameters, the response body is a JSON object, with the following fields:

Example

Request:

GET /v2/health/importer?verbose=true

Response:

{
    "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]

Check the health of the Topology Nodes ETL Service.

REST - Nodes ETL Health

GET /v2/health/nodes_etl

Optionally, you can also include the following query parameters:

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:

If the request specifies verbose=true in the query parameters, the response body is a JSON object, with the following fields:

Example

Request:

GET /v2/health/nodes_etl?verbose=true

Response:

{
  "score": 0,
  "gap": "1.891s",
  "gap_threshold": "2.00m",
}

Health Check - Validations ETL

[Source]

Check the health of the Validations ETL Service.

REST - Validations ETL Health

GET /v2/health/validations_etl

Optionally, you can also include the following query parameters:

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:

If the request specifies verbose=true in the query parameters, the response body is a JSON object, with the following fields:

Example

Request:

GET /v2/health/nodes_etl?verbose=true

Response:

{
  "score": 0,
  "gap": "1.891s",
  "gap_threshold": "2.00m",
}

API Conventions

Basic Types

As a REST API, the Data API v2 uses JSON's native datatypes to represent API fields, with some special cases.

Numbers and Precision

Currency amounts in Ripple require more precision than most native number types, so the Data API v2 uses the String type to represent some values.

Within the String value, the numbers are serialized in the same way as native JSON numbers:

• Base-10.
• Non-zero-prefaced.
• May contain . as a decimal point. For example, ½ is represented as 0.5. (American style, not European)
• May contain E or e to indicate being raised to a power of 10. For example, 1.2E5 is equivalent to 120000.
• No comma (,) characters are used.

The precision for amounts of non-XRP currency in Ripple 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 consequently 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

Ripple Accounts are identified by a base-58 Ripple Address, which is derived from the account's master public key. An address is represented as a String in JSON, with the following characteristics:

• Between 25 and 35 characters in length
• Starts with the character r
• Case-sensitive
• Base-58 encoded using only the following characters: rpshnaf39wBUDNEGHJKLM4PQRST7VWXYZ2bcdeCg65jkm8oFqi1tuvAxyz That's alphanumeric characters, excluding zero (0), capital O (O), capital I (I), and lowercase L (l).
• Contains error-checking that makes it unlikely that a randomly-generated string is a valid address.

Special Addresses

Some addresses have special meaning, or historical uses, in the Ripple Consensus Ledger. In many cases, these are "black hole" addresses, meaning the address is not derived from a known secret key. Since it is almost impossible to guess a secret key from just an address, any XRP possessed by those addresses is lost forever.

Hashes

Many objects in Ripple, particularly transactions and ledgers, are uniquely identified by a 256-bit hash value. This value is typically calculated as a "SHA-512Half", which calculates a SHA-512 hash from some contents, then takes the first 64 characters of the hexadecimal representation. Since the hash of an object is derived from the contents in a way that is extremely unlikely to produce collisions, two objects with the same hash can be considered identical.

A Ripple hash value has the following characteristics:

• Exactly 64 characters in length
• Hexadecimal character set: 0-9 and A-F.
• Typically written in upper case.

Note: SHA-512Half has similar security to the officially-defined SHA-512/256 hash function. However, Ripple's usage predates SHA-512/256 and is also easier to implement on top of an existing SHA-512 function. (As of this writing, SHA-512 support in cryptographic libraries is much more common than for SHA-512/256.)

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 indicating the beginning of the time portion
• 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

A ledger index is a 32-bit unsigned integer used to identify a ledger. The ledger index is also known as the ledger's sequence number. The very first ledger was ledger index 1, and each subsequent ledger has a ledger index 1 higher than that of the ledger immediately before it.

The ledger index indicates the order of the ledgers; the Hash value identifies the exact contents of the ledger. Two ledgers with the same hash are always identical. For validated ledgers, hash values and sequence numbers are equally valid and correlate 1:1. However, this is not true for in-progress ledgers:

• Two different rippled servers may have different contents for a current ledger with the same ledger index, due to latency in propagating transactions throughout the network.
• There may be multiple closed ledger versions competing to be validated by consensus. These ledger versions have the same sequence number but different contents (and different hashes). Only one of these closed ledgers can become validated.
• A current ledger's contents change over time, which would cause its hash to change, even though its ledger index number stays the same. Therefore, the hash of a ledger is not calculated until the ledger is closed.

Account Sequence

A Sequence number is a 32-bit unsigned integer used to identify a transaction or Offer relative to a specific account.

Every account object in the Ripple Consensus Ledger has a Sequence number, which starts at 1. For a transaction to be relayed to the network and possibly included in a validated ledger, it must have a Sequence field that matches the sending account's current Sequence number. An account's Sequence field is incremented whenever a transaction from that account is included in a validated ledger (regardless of whether the transaction succeeded or failed). This preserves the order of transactions submitted by an account, and differentiates transactions that would otherwise be identical.

Every Offer node in the Ripple Consensus Ledger is marked with the sending Account Address and the Sequence value of the OfferCreate transaction that created it. These two fields, together, uniquely identify the Offer.

Currency Code

There are two kinds of currency code in the Ripple Consensus Ledger:

• Three-character currency code. We recommend using all-uppercase ISO 4217 Currency Codes. However, any combination of the following characters is permitted: all uppercase and lowercase letters, digits, as well as the symbols ?, !, @, #, $, %, ^, &, *, <, >, (, ), {, }, [, ], and |. The currency code XRP (all-uppercase) is reserved for XRP and cannot be used by issued currencies.
• 160-bit hexadecimal values, such as 0158415500000000C1F76FF6ECB0BAC600000000, according to Ripple's internal Currency Format. This representation is uncommon.

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 by including the contents of the marker field as the marker query parameter of a subsequent request. For the follow-up request, you should use the same parameters as the initial request. When the response omits the marker parameter, that indicates that you have reached the end of the queryable data.

When a marker is or would be present, the response contains a Link header 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

Binary Format

Ledger Objects

A "ledger" is one version of the shared global ledger. Each ledger object has the following fields:

Note: Ledger close times are approximate, typically rounded to about 10 seconds. Consequently, two subsequent ledgers could have the same close time recorded, when actual close times were several seconds apart. The sequence number (ledger_index) of the ledger makes it unambiguous which ledger closed first.

Genesis Ledger

Due to a mishap early in Ripple'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 Ripple Consensus 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.

Exchange Objects

An exchange object represents an actual exchange of currency, which can occur in the Ripple Consensus 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 will have a different provider, currency pair, or both.

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:

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.

Payment Objects

In the Data API, a Payment Object represents an event where one account sent value to another account. This mostly lines up with Ripple transactions of the Payment transaction type, except that the Data API does not consider a transaction to be a payment if the sending Account and the Destination account are the same, or if the transaction failed.

Payment objects have the following fields:

Balance Objects and Balance Change Objects

Balance objects represent an Ripple 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 Ripple 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:

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:

Change Types

The following values are valid for the change_type field of a Balance Change Descriptor:

Volume Objects

Volume objects represent the total volumes of money moved, in either payments or exchanges, during a given time period.

Running the Historical Database

You can also serve the Data API v2 from 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 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:

• HBase (required for v2),
• Node.js
• npm
• git (optional) for installation and updating.

Version 2 of the Historical Database requires HBase instead of PostgreSQL. Postgres support is deprecated.

Installation Process

Starting in

1. Install HBase. For production use, configure it in distributed mode.
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. Remove the postgres section from api.config.json.

Reports, stats, and aggregated exchange data needs additional processing before the API can make it available. This processing uses Apache Storm as well as some custom scripts. See Storm Setup for more information.

At this point, the rippled Historical Database is installed. See Services for the different components that you can run.

Tests

Dependencies:

• Docker Compose

$ docker-compose build
$ docker-compose up -d hbase
$ docker-compose run --rm webapp npm test

Services

The rippled Historical Database consists of several processes that can be run separately.

• Live Ledger Importer - Monitors rippled for newly-validated ledgers. Command: node import/live
• Backfiller - Populates the database with older ledgers from a rippled instance. Command: node import/postgres/backfill
• API Server - Provides REST API access 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.

Example usage:

// start loading records into HBase:
$ node import/live

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. For the public server, Ripple (the company) 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.

Example usage:

// get ledgers #1,000,000 to #2,000,000 (inclusive) and store in HBase
node import/hbase/backfill --startIndex 2000000 --stopIndex 1000000