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 dedicated database, which frees rippled servers to keep fewer historical ledger versions. The Data API v2 also 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:
The Ripple Data API v2 replaces the Historical Database v1 and the Charts API.
The Data API v2 provides a REST API with the following methods:
Ledger Contents Methods:
- Get Ledger -
GET /v2/ledgers/{:ledger_identifier} - 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 External Markets -
GET /v2/network/external_markets - Get XRP Distribution -
GET /v2/network/xrp_distribution - Get Top Currencies -
GET /v2/network/top_currencies - Get Top Markets -
GET /v2/network/top_markets
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
Gateway Information Methods:
- Get All Gateways -
GET /v2/gateways - Get Gateway -
GET /v2/gateways/{:gateway} - Get Currency Image -
GET /v2/currencies/{:currencyimage}
Validation Network Methods:
- Get Transaction Costs -
GET /v2/network/fees - Get Fee Stats -
GET /v2/network/fee_stats - Get Ledger Validations -
GET /v2/ledger/{:hash}/validations - Get Ledger Validation -
GET /v2/ledger/{:hash}/validations/{:pubkey} - 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 Validator -
GET /v2/network/validators/{:pubkey} - Get Validators -
GET /v2/network/validators - 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 Rippled Versions -
GET /v2/network/rippled_versions
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
Retrieve a specific Ledger by hash, index, date, or latest validated.
REST
GET /v2/ledgers/{:identifier}
This method requires the following URL parameters:
| Field | Value | Description |
|---|---|---|
ledger_identifier |
Ledger Hash, Ledger Index, or Timestamp | (Optional) An identifier for the ledger to retrieve: either the full hash in hex, an integer sequence number, or a date-time. If a date-time is provided, retrieve the ledger that was most recently closed at that time. If omitted, retrieve the latest validated ledger. |
Optionally, you can provide the following query parameters:
| Field | Value | Description |
|---|---|---|
transactions |
Boolean | If true, include the identifying hashes of all transactions that are part of this ledger. |
binary |
Boolean | If true, include all transactions from this ledger as hex-formatted binary data. (If provided, overrides transactions.) |
expand |
Boolean | If true, include all transactions from this ledger as nested JSON objects. (If provided, overrides binary and transactions.) |
A successful response uses the HTTP code 200 OK and has a JSON body with the following:
| Field | Value | Description |
|---|---|---|
result |
String | The value success indicates that this is a successful response. |
ledger |
Ledger object | The requested ledger. |
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"
}
}
Retrieve a any validations recorded for a specific ledger hash. This dataset includes ledger versions that are outside the validated ledger chain. (New in v2.2.0)
Note: The Data API does not have a comprehensive record of all validations. The response only includes data that the Data API has recorded. Some ledger versions, especially older ledgers, may have no validations even if they were validated by consensus.
REST
GET /v2/ledgers/{:ledger_hash}/validations
This method requires the following URL parameters:
| Field | Value | Description |
|---|---|---|
ledger_hash |
Hash | Ledger hash to retrieve validations for. |
Optionally, you can provide the following query parameters:
| Field | Value | Description |
|---|---|---|
limit |
Integer | Maximum results per page. Defaults to 200. Cannot be more than 1000. |
marker |
String | Pagination key from previously returned response. |
format |
String | Format of returned results: csv or json. Defaults to json. |
A successful response uses the HTTP code 200 OK and has a JSON body with the following:
| Field | Value | Description |
|---|---|---|
result |
String - success |
Indicates that the body represents a successful response. |
ledger_hash |
String - Hash | The identifying hash of the ledger version requested. |
count |
Integer | Number of validations returned. |
marker |
String | (May be omitted) Pagination marker. |
validations |
Array of Validation Objects | All known validation votes for the ledger version. |
Request:
GET /v2/ledgers/A10E9E338BA365D2B768814EC8B0A9A2D8322C0040735E20624AF711C5A593E7/validations?limit=2
Response:
200 OK
{
"result": "success",
"ledger_hash": "A10E9E338BA365D2B768814EC8B0A9A2D8322C0040735E20624AF711C5A593E7",
"count": 2,
"marker": "A10E9E338BA365D2B768814EC8B0A9A2D8322C0040735E20624AF711C5A593E7|n9KDJnMxfjH5Ez8DeWzWoE9ath3PnsmkUy3GAHiVjE7tn7Q7KhQ2|20160608001732",
"validations": [
{
"count": 27,
"first_datetime": "2016-06-08T00:17:32.352Z",
"last_datetime": "2016-06-08T00:17:32.463Z",
"ledger_hash": "A10E9E338BA365D2B768814EC8B0A9A2D8322C0040735E20624AF711C5A593E7",
"reporter_public_key": "n9KJb7NMxGySRcjCqh69xEPMUhwJx22qntYYXsnUqYgjsJhNoW7g",
"signature": "304402204C751D0033070EBC008786F0ECCA8E29195FD7DD8D22498EB6E4E732905FC7090220091F458976904E7AE4633A1EC405175E6A126798E4896DD452853B887B1E6359",
"validation_public_key": "n949f75evCHwgyP4fPVgaHqNHxUVN15PsJEZ3B3HnXPcPjcZAoy7"
},
{
"count": 3,
"first_datetime": "2016-06-08T00:17:32.653Z",
"last_datetime": "2016-06-08T00:17:32.673Z",
"ledger_hash": "A10E9E338BA365D2B768814EC8B0A9A2D8322C0040735E20624AF711C5A593E7",
"reporter_public_key": "n9JCK5AML7Ejv3TcJmnvJk5qeYhf7Q9YwScjz5PhtUbtWCKH3NAm",
"signature": "3045022100A48E5AF6EA9D0ACA6FDE18536081A7D2182535579EA580C3D0B0F18C2556C5D30220521615A3D677376069F8F3E608B59F14482DDE4CD2A304DE578B6CCE2F5E8D54",
"validation_public_key": "n9K6YbD1y9dWSAG2tbdFwVCtcuvUeNkBwoy9Z6BmeMra9ZxsMTuo"
}
]
}
Retrieve a validation vote recorded for a specific ledger hash by a specific validator. This dataset includes ledger versions that are outside the validated ledger chain. (New in v2.2.0)
Note: The Data API does not have a comprehensive record of all validations. The response only includes data that the Data API has recorded. Some ledger versions, especially older ledgers, may have no validations even if they were validated by consensus.
REST
GET /v2/ledgers/{:ledger_hash}/validations/{:pubkey}
This method requires the following URL parameters:
| Field | Value | Description |
|---|---|---|
ledger_hash |
Hash | Ledger hash to retrieve validations for. |
pubkey |
String - Base-58 Public Key | Validator public key. |
This request takes no query parameters.
A successful response uses the HTTP code 200 OK and has a JSON body containing a Validation Object with the following additional field:
| Field | Value | Description |
|---|---|---|
result |
String | The value success indicates that this is a successful response. |
Request:
GET /v2/ledgers/A10E9E338BA365D2B768814EC8B0A9A2D8322C0040735E20624AF711C5A593E7/validations/n949f75evCHwgyP4fPVgaHqNHxUVN15PsJEZ3B3HnXPcPjcZAoy7
Response:
200 OK
{
"count": 27,
"first_datetime": "2016-06-08T00:17:32.352Z",
"last_datetime": "2016-06-08T00:17:32.463Z",
"ledger_hash": "A10E9E338BA365D2B768814EC8B0A9A2D8322C0040735E20624AF711C5A593E7",
"reporter_public_key": "n9KJb7NMxGySRcjCqh69xEPMUhwJx22qntYYXsnUqYgjsJhNoW7g",
"signature": "304402204C751D0033070EBC008786F0ECCA8E29195FD7DD8D22498EB6E4E732905FC7090220091F458976904E7AE4633A1EC405175E6A126798E4896DD452853B887B1E6359",
"validation_public_key": "n949f75evCHwgyP4fPVgaHqNHxUVN15PsJEZ3B3HnXPcPjcZAoy7",
"result": "success"
}
Retrieve a specific transaction by its identifying hash.
REST
GET /v2/transactions/{:hash}
This method requires the following URL parameters:
| Field | Value | Description |
|---|---|---|
hash |
String - Hash | The identifying hash of the transaction. |
Optionally, you can provide the following query parameters:
| Field | Value | Description |
|---|---|---|
binary |
Boolean | If true, return transaction data in binary format, as a hex string. Otherwise, return transaction data as nested JSON. Defaults to false. |
A successful response uses the HTTP code 200 OK and has a JSON body with the following:
| Field | Value | Description |
|---|---|---|
result |
String | The value success indicates that this is a successful response. |
transaction |
Transaction object | The requested transaction. |
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"
}
}
}Retrieve transactions by time
REST
GET /v2/transactions/
Optionally, you can provide the following query parameters:
| Field | Value | Description |
|---|---|---|
start |
String - Timestamp | Filter results to this time and later. |
end |
String - Timestamp | Filter results to this time and earlier. |
descending |
Boolean | If true, return results in reverse chronological order. Defaults to false. |
type |
String | Filter transactions to a specific transaction type. |
result |
String | Filter transactions for a specific transaction result. |
binary |
Boolean | If true, return transactions in binary form. Defaults to false. |
limit |
Integer | Maximum results per page. Defaults to 20. Cannot be more than 100. |
marker |
String | Pagination marker from a previous response. |
A successful response uses the HTTP code 200 OK and has a JSON body with the following:
| Field | Value | Description |
|---|---|---|
result |
String | The value success indicates that this is a successful response. |
count |
Integer | Number of Transactions returned. |
marker |
String | (May be omitted) Pagination marker. |
transactions |
Array of Transaction object | The requested transactions. |
Request:
GET /v2/transactions/?result=tecPATH_DRY&limit=2&type=Payment
Response:
200 OK
{
"result": "success",
"count": 2,
"marker": "20130106022000|000000053869|00000",
"transactions": [
{
"hash": "B8E4335A94438EC8209135A4E861A4C88F988C651B819DDAF2E8C55F9B41E589",
"date": "2013-01-02T20:13:40+00:00",
"ledger_index": 40752,
"ledger_hash": "55A900C2BA9483DC83F8FC065DE7789570662365BDE98EB75C5F4CE4F9B43214",
"tx": {
"TransactionType": "Payment",
"Flags": 0,
"Sequence": 61,
"Amount": {
"value": "96",
"currency": "USD",
"issuer": "rJ6VE6L87yaVmdyxa9jZFXSAdEFSoTGPbE"
},
"Fee": "10",
"SigningPubKey": "02082622E4DA1DC6EA6B38A48956D816881E000ACF0C5F5B52863B9F698799D474",
"TxnSignature": "304402200A0746192EBC7BC3C1B9D657F42B6345A49D75FE23EF340CB6F0427254C139D00220446BF9169C94AEDC87F56D01DB011866E2A67E2AADDCC45C4D11422550D044CB",
"Account": "rB5TihdPbKgMrkFqrqUC3yLdE8hhv4BdeY",
"Destination": "rJ6VE6L87yaVmdyxa9jZFXSAdEFSoTGPbE"
},
"meta": {
"TransactionIndex": 0,
"AffectedNodes": [
{
"ModifiedNode": {
"LedgerEntryType": "AccountRoot",
"PreviousTxnLgrSeq": 40212,
"PreviousTxnID": "F491DC8B5E51045D4420297293199039D5AE1EA0C6D62CAD9A973E3C89E40CD6",
"LedgerIndex": "9B242A0D59328CE964FFFBFF7D3BBF8B024F9CB1A212923727B42F24ADC93930",
"PreviousFields": {
"Sequence": 61,
"Balance": "8178999999999400"
},
"FinalFields": {
"Flags": 0,
"Sequence": 62,
"OwnerCount": 6,
"Balance": "8178999999999390",
"Account": "rB5TihdPbKgMrkFqrqUC3yLdE8hhv4BdeY"
}
}
}
],
"TransactionResult": "tecPATH_DRY"
}
},
{
"hash": "1E1C14BF5E61682F3DC9D035D9908816497B8E8843E05C0EE98E06DFDDDAE920",
"date": "2013-01-05T08:43:10+00:00",
"ledger_index": 51819,
"ledger_hash": "88ED10E4E31FC7580285CF173B264690B0E8688A3FC9F5F9C62F1A295B96269D",
"tx": {
"TransactionType": "Payment",
"Flags": 0,
"Sequence": 10,
"Amount": {
"value": "2",
"currency": "EUR",
"issuer": "rfitr7nL7MX85LLKJce7E3ATQjSiyUPDfj"
},
"Fee": "10",
"SigningPubKey": "03FDDCD97668B686100E60653FD1E5210A8310616669AACB3A1FCC6D2C090CCB32",
"TxnSignature": "304402204F9BB7E37C14A3A3762E2A7DADB9A28D1AFFB3797521229B6FB98BA666B5491B02204F69AAEAFAC8FA473E52042FF06035AB3618A54E0B76C9852766D55184E98598",
"Account": "rhdAw3LiEfWWmSrbnZG3udsN7PoWKT56Qo",
"Destination": "rfitr7nL7MX85LLKJce7E3ATQjSiyUPDfj"
},
"meta": {
"TransactionIndex": 0,
"AffectedNodes": [
{
"ModifiedNode": {
"LedgerEntryType": "AccountRoot",
"PreviousTxnLgrSeq": 51814,
"PreviousTxnID": "5EC1C179996BD87E2EB11FE60A37ADD0FB2229ADC7D13B204FAB04FABED8A38D",
"LedgerIndex": "AC1B67084F84839A3158A4E38618218BF9016047B1EE435AECD4B02226AB2105",
"PreviousFields": {
"Sequence": 10,
"Balance": "10000999910"
},
"FinalFields": {
"Flags": 0,
"Sequence": 11,
"OwnerCount": 2,
"Balance": "10000999900",
"Account": "rhdAw3LiEfWWmSrbnZG3udsN7PoWKT56Qo"
}
}
}
],
"TransactionResult": "tecPATH_DRY"
}
}
]
}
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.
REST - All Currencies
GET /v2/payments/
REST - Specific Currency
GET /v2/payments/{:currency}
This method uses the following URL parameters:
| Field | Value | Description |
|---|---|---|
| :currency | String | (Optional) Currency code, followed by + and a counterparty address. (Or XRP with no counterparty.) If omitted, return payments for all currencies. |
Optionally, you can provide the following query parameters:
| Field | Value | Description |
|---|---|---|
start |
String - Timestamp | Filter results to this time and later. |
end |
String - Timestamp | Filter results to this time and earlier. |
interval |
String | If provided and currency is also specified, return results aggregated into intervals of the specified length instead of individual payments. Valid intervals are day, week, or month. |
descending |
Boolean | If true, return results in reverse chronological order. Defaults to false. |
limit |
Integer | Maximum results per page. Defaults to 200. Cannot be more than 1000. |
marker |
String | Pagination key from previously returned response. |
format |
String | Format of returned results: csv or json. Defaults to json. |
A successful response uses the HTTP code 200 OK and has a JSON body with the following:
| Field | Value | Description |
|---|---|---|
result |
String | The value success indicates that this is a successful response. |
count |
Integer | Number of payments returned. |
marker |
String | (May be omitted) Pagination marker. |
payments |
Array of Payment Objects, or array of aggregate objects. | The requested payments. |
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:
| Field | Value | Description |
|---|---|---|
count |
Number | The number of payments that occurred during this interval. |
currency |
String - Currency Code | This summary describes payments that delivered the specified currency. |
issuer |
String - Address | (Omitted for XRP) This summary describes payments that delivered the currency issued by this address. |
start |
String - Timestamp | The start time of this interval. |
total_amount |
Number | The amount of the currency delivered during this interval. |
average_amount |
Number | The average amount of currency delivered by a single payment during this interval. |
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"
}
]
}
Retrieve Exchanges for a given currency pair over time. Results can be returned as individual exchanges or aggregated to a specific list of intervals
REST
GET /v2/exchanges/{:base}/{:counter}
This method requires the following URL parameters:
| Field | Value | Description |
|---|---|---|
base |
String | Base currency of the pair, as a Currency Code, followed by + and the issuer Address unless it's XRP. |
counter |
String | Counter currency of the pair, as a Currency Code, followed by + and the issuer Address unless it's XRP. |
Optionally, you can provide the following query parameters:
| Field | Value | Description |
|---|---|---|
start |
String - Timestamp | Filter results to this time and later. |
end |
String - Timestamp | Filter results to this time and earlier. |
interval |
String | Aggregation interval: 1minute, 5minute, 15minute, 30minute, 1hour, 2hour, 4hour, 1day, 3day, 7day, or 1month. Defaults to non-aggregated results. |
descending |
Boolean | If true, return results in reverse chronological order. |
reduce |
Boolean | Aggregate all individual results. Defaults to false. |
limit |
Integer | Maximum results per page. Defaults to 200. Cannot be more than 1,000. |
marker |
String | Pagination key from previously returned response. |
autobridged |
Boolean | If true, filter results to autobridged exchanges only. |
format |
String | Format of returned results: csv or json. Defaults to json |
A successful response uses the HTTP code 200 OK and has a JSON body with the following:
| Field | Value | Description |
|---|---|---|
result |
String | The value success indicates that this is a successful response. |
count |
Integer | Number of Transactions returned. |
marker |
String | (May be omitted) Pagination marker. |
exchanges |
Array of Exchange Objects | The requested exchanges. |
Request:
GET /v2/exchanges/USD+rMwjYedjc7qqtKYVLiAccJSmCwih4LnE2q/XRP?descending=true&limit=3&result=tesSUCCESS&type=OfferCreate
Response:
200 OK
{
"result": "success",
"count": 3,
"marker": "USD|rMwjYedjc7qqtKYVLiAccJSmCwih4LnE2q|XRP||20151021222220|000016612683|00017|00000",
"exchanges": [
{
"base_amount": 4.98954834453577,
"counter_amount": 1047.806201,
"node_index": 9,
"rate": 210.00021000021,
"tx_index": 0,
"buyer": "rpP2JgiMyTF5jR5hLG3xHCPi1knBb1v9cM",
"executed_time": "2015-10-21T23:09:50",
"ledger_index": 16613308,
"offer_sequence": 1010056,
"provider": "rpP2JgiMyTF5jR5hLG3xHCPi1knBb1v9cM",
"seller": "rK2o63evRPdRoMT2ZaW72wsHsFzcjnRLLq",
"taker": "rK2o63evRPdRoMT2ZaW72wsHsFzcjnRLLq",
"tx_hash": "25600A10E5395D45A9D514E1EC3D98C341C5451FD21C48FA9D104C310EC29D6B",
"tx_type": "Payment",
"base_currency": "USD",
"base_issuer": "rMwjYedjc7qqtKYVLiAccJSmCwih4LnE2q",
"counter_currency": "XRP"
},
{
"base_amount": 0.0004716155440678037,
"counter_amount": 0.1,
"node_index": 3,
"rate": 212.03711637126,
"tx_index": 0,
"buyer": "rfh3pFHkCXv3TgzsEJgyCzF1CduZHCLi9o",
"executed_time": "2015-10-21T23:09:50",
"ledger_index": 16613308,
"offer_sequence": 158081,
"provider": "rfh3pFHkCXv3TgzsEJgyCzF1CduZHCLi9o",
"seller": "rK2o63evRPdRoMT2ZaW72wsHsFzcjnRLLq",
"taker": "rK2o63evRPdRoMT2ZaW72wsHsFzcjnRLLq",
"tx_hash": "25600A10E5395D45A9D514E1EC3D98C341C5451FD21C48FA9D104C310EC29D6B",
"tx_type": "Payment",
"base_currency": "USD",
"base_issuer": "rMwjYedjc7qqtKYVLiAccJSmCwih4LnE2q",
"counter_currency": "XRP"
},
{
"base_amount": 0.0004714169229390923,
"counter_amount": 0.1,
"node_index": 3,
"rate": 212.1264535361624,
"tx_index": 17,
"autobridged_currency": "USD",
"autobridged_issuer": "rMwjYedjc7qqtKYVLiAccJSmCwih4LnE2q",
"buyer": "rfh3pFHkCXv3TgzsEJgyCzF1CduZHCLi9o",
"executed_time": "2015-10-21T22:22:20",
"ledger_index": 16612683,
"offer_sequence": 158059,
"provider": "rfh3pFHkCXv3TgzsEJgyCzF1CduZHCLi9o",
"seller": "rpP2JgiMyTF5jR5hLG3xHCPi1knBb1v9cM",
"taker": "rpP2JgiMyTF5jR5hLG3xHCPi1knBb1v9cM",
"tx_hash": "F05F670B06D641D7F6FE18E450DDB2C7A4DDF76D580C34C820939DC22AD9F582",
"tx_type": "OfferCreate",
"base_currency": "USD",
"base_issuer": "rMwjYedjc7qqtKYVLiAccJSmCwih4LnE2q",
"counter_currency": "XRP"
}
]
}
Retrieve an exchange rate for a given currency pair at a specific time.
REST
GET /v2/exchange_rates/{:base}/{:counter}
This method requires the following URL parameters:
| Field | Value | Description |
|---|---|---|
base |
String | Base currency of the pair, as a Currency Code, followed by + and the issuer Address. Omit the + and the issuer for XRP. |
counter |
String | Counter currency of the pair, as a Currency Code, followed by + and the issuer Address. Omit the + and the issuer for XRP. |
Optionally, you can provide the following query parameters:
| Field | Value | Description |
|---|---|---|
date |
String - Timestamp | Return an exchange rate for the specified time. Defaults to the current time. |
strict |
Boolean | If false, allow rates derived from less than 10 exchanges. Defaults to true. |
A successful response uses the HTTP code 200 OK and has a JSON body with the following:
| Field | Value | Description |
|---|---|---|
result |
String | The value success indicates that this is a successful response. |
rate |
Number | The requested exchange rate, or 0 if the exchange rate could not be determined. |
All exchange rates are 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.
Request:
GET /v2/exchange_rates/USD+rMwjYedjc7qqtKYVLiAccJSmCwih4LnE2q/XRP?date=2015-11-13T00:00:00Z
Response:
200 OK
{
"result": "success",
"rate": "224.65709"
}
Convert an amount from one currency and issuer to another, using the network exchange rates.
REST
GET /v2/normalize
You must provide at least some of the following query parameters:
| Field | Value | Description |
|---|---|---|
amount |
Number | (Required) Amount of currency to normalize. |
currency |
String - Currency Code | The currency code of the amount to convert from. Defaults to XRP. |
issuer |
String - Address | The issuer of the currency to convert from. (Required if currency is not XRP.) |
exchange_currency |
String - Currency Code | The currency to convert to. Defaults to XRP. |
exchange_issuer |
String - Address | The issuer of the currency to convert to. (Required if exchange_currency is not XRP.) |
date |
String - Timestamp | Convert according to the exchange rate at this time. Defaults to the current time. |
strict |
Boolean | If true, do not use exchange rates that are determined by less than 10 exchanges. Defaults to true. |
A successful response uses the HTTP code 200 OK and has a JSON body with the following:
| Field | Value | Description |
|---|---|---|
result |
String | The value success indicates that this is a successful response. |
amount |
Number | Pre-conversion amount specified in the request. |
converted |
Number | Post-conversion amount of the exchange_currency, or 0 if the exchange rate could not be determined. |
rate |
Number | Exchange rate used to calculate the conversion, or 0 if the exchange rate could not be determined. |
All exchange rates are calculating by converting both currencies to XRP.
Request:
GET /v2/normalize?amount=100¤cy=XRP&exchange_currency=USD&exchange_issuer=rMwjYedjc7qqtKYVLiAccJSmCwih4LnE2q
Response:
200 OK
{
"result": "success",
"amount": "100",
"converted": "0.4267798022744489",
"rate": "0.0042677980"
}
Retrieve per account per day aggregated payment summaries
REST
GET /v2/reports/{:date}
This method uses the following URL parameter:
| Field | Value | Description |
|---|---|---|
date |
String | (Optional) UTC query date. If omitted, use the current day. |
Optionally, you can provide the following query parameters:
| Field | Value | Description |
|---|---|---|
accounts |
Boolean | If true, include lists of counterparty accounts. Defaults to false. |
payments |
Boolean | If true, include lists of individual payments. Defaults to false. |
format |
String | Format of returned results: csv or json. Defaults to json. |
limit |
Integer | Maximum results per page. Defaults to 200. Cannot be more than 1000. |
marker |
String | Pagination key from previously returned response. |
A successful response uses the HTTP code 200 OK and has a JSON body with the following:
| Field | Value | Description |
|---|---|---|
result |
String | The value success indicates that this is a successful response. |
date |
String - Timestamp | The date for which this report applies. |
count |
Integer | Number of reports returned. |
marker |
String | (May be omitted) Pagination marker. |
reports |
Array of Reports Objects | The requested reports. Each report pertains to a single account. |
Caution: This method may return a very large amount of data (more than 1 megabyte), which may cause poor performance in your client application.
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"
}
]
}
Retrieve statistics about transaction activity in the Ripple Consensus Ledger, divided into intervals of time.
REST
GET /v2/stats
Optionally, you can provide the following query parameters:
| Field | Value | Description |
|---|---|---|
family |
String | If provided, filter results to a single family of stats: type, result, or metric. By default, provides all stats from all families. |
metrics |
String | Filter results to one or more metrics (in a comma-separated list). Requires the family of the metrics to be specified. By default, provides all metrics in the family. |
start |
String - Timestamp | Filter results to this time and later. |
end |
String - Timestamp | Filter results to this time and earlier. |
interval |
String | Aggregation interval (hour,day,week, defaults to day) |
limit |
Integer | Maximum results per page. Defaults to 200. Cannot be more than 1000. |
marker |
String | Pagination key from previously returned response. |
descending |
Boolean | If true, return results in reverse chronological order. Defaults to false. |
format |
String | Format of returned results: csv or json. Defaults to json. |
The family and metrics query parameters provide a way to filter results to a specific subset of all metrics available for transactions in any given interval. Each metric is tied to a specific family, as follows:
| Family | Included Metrics | Meaning |
|---|---|---|
type |
All Ripple transaction types, including Payment, AccountSet, OfferCreate, and others. |
Number of transactions of the given type that occurred during the interval. |
result |
All transaction result codes (string codes, not the numeric codes), including tesSUCCESS, tecPATH_DRY, and many others. |
Number of transactions that resulted in the given code during the interval. |
metric |
Data-API defined Special Transaction Metrics. | (Varies) |
The Data API derives the following values for every interval. These metrics are part of the metric family.
| Field | Value | Description |
|---|---|---|
accounts_created |
Number | The number of new accounts funded during this interval. |
exchanges_count |
Number | The number of currency exchanges that occurred during this interval. |
ledger_count |
Number | The number of ledgers closed during this interval. |
ledger_interval |
Number | The average number of seconds between ledgers closing during this interval. |
payments_count |
Number | The number of payments from one account to another during this interval. |
tx_per_ledger |
Number | The average number of transactions per ledger in this interval. |
If any of the metrics have a value of 0, they are omitted from the results.
A successful response uses the HTTP code 200 OK and has a JSON body with the following:
| Field | Value | Description |
|---|---|---|
result |
String | The value success indicates that this is a successful response. |
count |
Integer | Number of reports returned. |
marker |
String | (May be omitted) Pagination marker. |
stats |
Array of stats objects | The requested stats. Omits metrics with a value of 0, and intervals that have no nonzero metrics. |
Request:
GET /v2/stats/?start=2015-08-30&end=2015-08-31&interval=day&family=metric&metrics=accounts_created,exchanges_count,ledger_count,payments_count
Response:
200 OK
{
"result": "success",
"count": 2,
"stats": [
{
"accounts_created": 15,
"exchanges_count": 19368,
"ledger_count": 20307,
"payments_count": 24763,
"date": "2015-08-30T00:00:00Z"
},
{
"accounts_created": 18,
"exchanges_count": 17192,
"ledger_count": 19971,
"payments_count": 30894,
"date": "2015-08-31T00:00:00Z"
}
]
}
Get the total amount of a single currency issued by a single issuer, also known as the market capitalization. (New in v2.0.4)
REST
GET /v2/capitaliztion/{:currency}
This method requires the following URL parameters:
| Field | Value | Description |
|---|---|---|
| :currency | String | Currency to look up, in the form of currency+issuer. XRP is disallowed. |
Optionally, you can provide the following query parameters:
| Field | Value | Description |
|---|---|---|
start |
String - Timestamp | Start time of query range. Defaults to 2013-01-01T00:00:00Z. |
end |
String - Timestamp | End time of query range. Defaults to the current time. |
interval |
String | Aggregation interval - day, week, or month. Defaults to day. |
limit |
Integer | Maximum results per page. Defaults to 200. Cannot be more than 1000. |
marker |
String | Pagination key from previously returned response. |
descending |
Boolean | If true, return results in reverse chronological order. Defaults to false. |
adjusted |
Boolean | If true, do not count known issuer-owned addresses towards market capitalization. Defaults to true. |
format |
String | Format of returned results: csv or json. Defaults to json. |
If the request omits both start and end, the API returns only the most recent sample.
A successful response uses the HTTP code 200 OK and has a JSON body with the following:
| Field | Value | Description |
|---|---|---|
result |
String | The value success indicates that this is a successful response. |
count |
Integer | Number of reports returned. |
currency |
String | Currency requested. |
issuer |
String | Issuer requested. |
marker |
String | (May be omitted) Pagination marker. |
rows |
Array of issuer capitalization objects | The requested capitalization data. |
Each issuer capitalization object has the following fields:
| Field | Value | Description |
|---|---|---|
date |
String - Timestamp | The start time of the interval this object represents. |
amount |
String - Number | The total amount of currency issued by the issuer as of the start of this interval. |
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 information on which accounts are actively trading in a specific currency pair. (New in v2.0.4)
REST
GET /v2/active_accounts/{:base}/{:counter}
This method requires the following URL parameters:
| Field | Value | Description |
|---|---|---|
| :base | String | Base currency of the pair, as a Currency Code, followed by + and the issuer Address unless it's XRP. |
| :counter | String | Counter currency of the pair, as a Currency Code, followed by + and the issuer Address unless it's XRP. |
Optionally, you can provide the following query parameters:
| Field | Value | Description |
|---|---|---|
period |
String | Get results for trading activity during a chosen time period. Valid periods are 1day, 3day, or 7day. Defaults to 1day. |
date |
String | Get results for the period starting at this time. Defaults to the most recent period available. |
include_exchanges |
Boolean | Include individual exchanges for each account in the results. |
format |
String | Format of returned results: csv or json. Defaults to json. |
A successful response uses the HTTP code 200 OK and has a JSON body with the following:
| Field | Value | Description |
|---|---|---|
result |
String | The value success indicates that this is a successful response. |
count |
Integer | Number of accounts returned. |
exchanges_count |
Integer | Total number of exchanges in the period. |
accounts |
Array of active Account Trading Objects | Active trading accounts for the period. |
Each "Account Trading Object" describes the activity of a single account during this time period, and has the following fields:
| Field | Value | Description |
|---|---|---|
buy |
Object | Summary of currency exchanges buying the base currency |
buy.base_volume |
Number | Amount of base currency the account bought in this period. |
buy.counter_volume |
Number | Amount of counter currency the account sold in this period. |
buy.count |
Number | Number of trades that bought the base currency in this period. |
sell |
Object | Summary of currency changes selling the base currency. |
sell.base_volume |
Number | Amount of the base currency the account sold this period. |
sell.counter_volume |
Number | Amount of the counter currency the account bought this period. |
sell.count |
Number | Number of trades that sold the base currency. |
account |
String - Address | The address whose activity this object describes. |
base_volume |
Number | The total volume of the base currency the account bought and sold in this period. |
counter_volume |
Number | The total volume of the counter currency the account bought and sold in this period. |
count |
Number | The total number of exchanges the account made during this period. |
Request:
GET /v2/active_accounts/XRP/USD+rMwjYedjc7qqtKYVLiAccJSmCwih4LnE2q
Response:
200 OK
{
"result": "success",
"count": 12,
"exchanges_count": 11,
"accounts": [
{
"buy": {
"base_volume": 0,
"counter_volume": 0,
"count": 0
},
"sell": {
"base_volume": 13084.822874,
"counter_volume": 54.499328645454604,
"count": 4
},
"account": "rGBQhB8EH5DmqMmfKPLchpqr3MR19pv6zN",
"base_volume": 13084.822874,
"counter_volume": 54.499328645454604,
"count": 4
},
{
"buy": {
"base_volume": 12597.822874,
"counter_volume": 52.4909286454546,
"count": 1
},
"sell": {
"base_volume": 0,
"counter_volume": 0,
"count": 0
},
"account": "rQE5Z3FgVnRMbVfS6xiVQFgB4J3X162FVD",
"base_volume": 12597.822874,
"counter_volume": 52.4909286454546,
"count": 1
},
... (additional results trimmed)...
{
"buy": {
"base_volume": 1.996007,
"counter_volume": 0.008782427920595,
"count": 1
},
"sell": {
"base_volume": 0,
"counter_volume": 0,
"count": 0
},
"account": "rD8LigXE7165r3VWhSQ4FwzJy7PNrTMwUq",
"base_volume": 1.996007,
"counter_volume": 0.008782427920595,
"count": 1
},
{
"buy": {
"base_volume": 0,
"counter_volume": 0,
"count": 0
},
"sell": {
"base_volume": 0.1,
"counter_volume": 0.0004821658905462904,
"count": 1
},
"account": "rfh3pFHkCXv3TgzsEJgyCzF1CduZHCLi9o",
"base_volume": 0.1,
"counter_volume": 0.0004821658905462904,
"count": 1
}
]
}
Get 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.
REST
GET /v2/network/exchange_volume
Optionally, you can provide the following query parameters:
| Field | Value | Description |
|---|---|---|
start |
String - Timestamp | Start time of query range. Defaults to the start of the most recent interval. |
end |
String - Timestamp | End time of query range. Defaults to the end of the most recent interval. |
interval |
String | Aggregation interval - valid intervals are day, week, or month. Defaults to day. |
live |
String - 'day', 'hour', 'minute' | Period for live updating spot data. Defaults to 'day', ignored if interval is specified |
exchange_currency |
String - Currency Code | Normalize all amounts to use this as a display currency. If not XRP, exchange_issuer is also required. Defaults to XRP. |
exchange_issuer |
String - Address | Normalize results to the specified currency issued by this issuer. |
limit |
Integer | Maximum results per page. Defaults to 200. Cannot be more than 1000. |
marker |
String | Pagination key from previously returned response. |
format |
String | Format of returned results: csv or json. Defaults to json. |
A successful response uses the HTTP code 200 OK and has a JSON body with the following:
| Field | Value | Description |
|---|---|---|
result |
String | The value success indicates that this is a successful response. |
count |
Integer | Number of results returned. |
rows |
Array of exchange Volume Objects | Exchange volumes for each interval in the requested time period. (By default, this method only returns the most recent interval.) |
Each object in the components array of the Volume Objects represent the volume of exchanges in a market between two currencies, and has the following fields:
| Field | Value | Description |
|---|---|---|
count |
Number | The number of exchanges in this market during this interval. |
rate |
Number | The exchange rate from the base currency to the display currency. |
amount |
Number | The amount of volume in the market, in units of the base currency. |
base |
Object | The currency and issuer of the base currency of this market. There is no issuer for XRP. |
counter |
Object | The currency and issuer of the counter currency of this market. There is no issuer for XRP. |
converted_amount |
Number | The total amount of volume in the market, converted to the display currency. (Before v2.1.0, this was convertedAmount.) |
Request:
GET /v2/network/exchange_volume?exchange_currency=USD&exchange_issuer=rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B
Response:
200 OK
{
"result": "success",
"count": 1,
"rows": [
{
"components": [
{
"count": 1711,
"rate": 5.514373809662552e-8,
"amount": 333.7038784107369,
"base": {
"currency": "BTC",
"issuer": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B"
},
"counter": {
"currency": "XRP"
},
"converted_amount": 117720.99268355068
},
{
"count": 1977,
"rate": 0.000019601413454357618,
"amount": 74567.72531650064,
"base": {
"currency": "USD",
"issuer": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B"
},
"counter": {
"currency": "XRP"
},
"converted_amount": 74003.51871932109
},
... (additional results trimmed) ...
{
"count": 3,
"rate": 0.022999083584408355,
"amount": 85.40728674708998,
"base": {
"currency": "CNY",
"issuer": "razqQKzJRdB4UxFPWf5NEpEG3WMkmwgcXA"
},
"counter": {
"currency": "USD",
"issuer": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B"
},
"converted_amount": 12.72863756671683
},
{
"count": 3,
"rate": 1.7749889023209692e-7,
"amount": 570.687912196755,
"base": {
"currency": "JPY",
"issuer": "r94s8px6kSw1uZ1MV98dhSRTvc6VMPoPcN"
},
"counter": {
"currency": "BTC",
"issuer": "rMwjYedjc7qqtKYVLiAccJSmCwih4LnE2q"
},
"converted_amount": 4.4137945368632545
}
],
"count": 11105,
"endTime": "2015-09-11T19:58:58+00:00",
"exchange": {
"currency": "USD",
"issuer": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B"
},
"exchangeRate": 0.004410567085248279,
"startTime": "2015-11-10T00:06:04+00:00",
"total": 442442.5974313684
}
]
}
Get 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.
REST
GET /v2/network/payment_volume
Optionally, you can provide the following query parameters:
| Field | Value | Description |
|---|---|---|
start |
String - Timestamp | Start time of query range. Defaults to the start of the most recent interval. |
end |
String - Timestamp | End time of query range. Defaults to the end of the most recent interval. |
interval |
String | Aggregation interval - valid intervals are day, week, or month. Defaults to day. |
live |
String - 'day', 'hour', 'minute' | Period for live updating spot data. Defaults to 'day', ignored if interval is specified |
exchange_currency |
String - Currency Code | Normalize all amounts to use this as a display currency. If not XRP, exchange_issuer is also required. Defaults to XRP. |
exchange_issuer |
String - Address | Normalize results to the specified currency issued by this issuer. |
limit |
Integer | Maximum results per page. Defaults to 200. Cannot be more than 1000. |
marker |
String | Pagination key from previously returned response. |
format |
String | Format of returned results: csv or json. Defaults to json. |
A successful response uses the HTTP code 200 OK and has a JSON body with the following:
| Field | Value | Description |
|---|---|---|
result |
String | The value success indicates that this is a successful response. |
count |
Integer | Number of results returned. |
rows |
Array of payment Volume Objects | Payment volumes for each interval in the requested time period. (By default, this method only returns the most recent interval.) |
Each object in the components array of the Volume Objects represent the volume of payments for one currencies and issuer, and has the following fields:
| Field | Value | Description |
|---|---|---|
currency |
String - Currency Code | The currency of this payment volume object. |
issuer |
String - Address | (Omitted for XRP) The issuer of this payment volume object. |
amount |
Number | Total payment volume for this currency during the interval, in units of the currency itself. |
count |
Number | The total number of payments in this currency. |
rate |
Number | The exchange rate between this currency and the display currency. |
converted_amount |
Number | Total payment volume for this currency, converted to the display currency. (Before v2.1.0, this was convertedAmount.) |
Request:
GET /v2/network/payment_volume
Response:
200 OK
{
"result": "success",
"count": 1,
"rows": [
{
"components": [
{
"currency": "USD",
"issuer": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B",
"amount": 87279.59029136538,
"count": 331,
"rate": 0.004412045860957953,
"converted_amount": 19782113.1153009
},
{
"currency": "USD",
"issuer": "rMwjYedjc7qqtKYVLiAccJSmCwih4LnE2q",
"amount": 0,
"count": 0,
"rate": 0.00451165816091143,
"converted_amount": 0
},
{
"currency": "BTC",
"issuer": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B",
"amount": 279.03077460240354,
"count": 107,
"rate": 0.000013312520335244644,
"converted_amount": 20960026.169024874
},
... (additional results trimmed) ...
{
"currency": "MXN",
"issuer": "rG6FZ31hDHN1K5Dkbma3PSB5uVCuVVRzfn",
"amount": 49263.13280138676,
"count": 19,
"rate": 0.07640584677247926,
"converted_amount": 644756.0609868265
},
{
"currency": "XRP",
"amount": 296246369.30089426,
"count": 8691,
"rate": 1,
"converted_amount": 296246369.30089426
}
],
"count": 9388,
"endTime": "2015-09-11T19:58:59+00:00",
"exchange": {
"currency": "XRP"
},
"exchangeRate": 1,
"startTime": "2015-11-10T00:19:04+00:00",
"total": 390754174.7837752
}
]
}
Get the total value of all currencies issued by 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.
REST
GET /v2/network/issued_value
Optionally, you can provide the following query parameters:
| Field | Value | Description |
|---|---|---|
start |
String - Timestamp | Start time of query range. Defaults to the start of the most recent interval. |
end |
String - Timestamp | End time of query range. Defaults to the end of the most recent interval. |
exchange_currency |
String - Currency Code | Normalize all amounts to use this as a display currency. If not XRP, exchange_issuer is also required. Defaults to XRP. |
exchange_issuer |
String - Address | Normalize results to the specified currency issued by this issuer. |
limit |
Integer | Maximum results per page. Defaults to 200. Cannot be more than 1000. |
marker |
String | Pagination key from previously returned response. |
format |
String | Format of returned results: csv or json. Defaults to json. |
A successful response uses the HTTP code 200 OK and has a JSON body with the following:
| Field | Value | Description |
|---|---|---|
result |
String | The value success indicates that this is a successful response. |
count |
Integer | Number of results returned. |
rows |
Array of Issued Value Objects | Aggregated capitalization at the requested point(s) in time. |
Each Issued Value Object represents the total value issued at one point in time, and has the following fields:
| Field | Value | Description |
|---|---|---|
components |
Array of Objects | The data on individual issuers that was used to assemble this total. |
exchange |
Object | Indicates the display currency used, as with fields currency and (except for XRP) issuer. All amounts are normalized by first converting to XRP, and then to the display currency specified in the request. |
exchangeRate |
Number | The exchange rate to the displayed currency from XRP. |
time |
String - Timestamp | When this data was measured. |
total |
Number | Total value of all issued assets at this time, in units of the display currency. |
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:
200 OK
{
"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 aggregated exchange volume from a list of off ledger exchanges for a specified rolling interval.
The API returns results in units of a single display currency rather than many different currencies. The conversion uses standard rates to and from XRP.
REST
GET /v2/network/external_markets
Optionally, you can provide the following query parameters:
| Field | Value | Description |
|---|---|---|
period |
String | Aggregation Period - valid intervals are 1hour, 1day, 3day, 7day, or 30day. Defaults to 1day. |
exchange_currency |
String - Currency Code | Normalize all amounts to use this as a display currency. If not XRP, exchange_issuer is also required. Defaults to XRP. |
exchange_issuer |
String - Address | Normalize results to the specified currency issued by this issuer. |
A successful response uses the HTTP code 200 OK and has a JSON body with the following:
| Field | Value | Description |
|---|---|---|
result |
String | The value success indicates that this is a successful response. |
data |
Object | Contains data for the specified period |
data.date |
String | Date at which this period was calculated. |
data.total |
Number | Total XRP volume exchanged during the period. |
data.period |
String | Name of the period queried. |
Each object in the components array of the Volume Objects represent the volume of a single external market. Not all fields will be present for each market, depending on availability.
| Field | Value | Description |
|---|---|---|
source |
String | Domain name of the specific external market. |
base_volume |
Number | Exchange volume in terms of the base currency (XRP) |
counter_volume |
Number | Exchange volume in terms of the counter currency. |
base_currecy |
String | Base currency of the market pair. |
counter_currency |
String | Counter currency of the market pair. |
rate |
Number | Exchange rate. |
Request:
GET /v2/network/external_markets
Response:
200 OK
{
"result": "success",
"data": {
"components": [
{
"base_volume": "52847221.256202064",
"counter_volume": "619.8111371100003",
"source": "poloniex.com",
"base_currency": "XRP",
"counter_currency": "BTC",
"rate": "0.0000117284"
},
{
"base_volume": "389955.29648717004",
"counter_volume": "3212.07137265",
"source": "poloniex.com",
"base_currency": "XRP",
"counter_currency": "USD",
"rate": "0.00823702"
},
{
"base_volume": "6025268.09143092",
"counter_volume": "70.57870572291264",
"count": 250,
"source": "kraken.com",
"base_currency": "XRP",
"counter_currency": "BTC",
"rate": "0.0000117138"
},
{
"base_volume": "4141962.161763998",
"source": "btc38.com",
"base_currency": "XRP",
"counter_currency": "CNY"
},
{
"base_volume": "303505",
"source": "btc38.com",
"base_currency": "XRP",
"counter_currency": "BTC"
},
{
"base_volume": "1275008.2922999999",
"source": "jubi.com",
"base_currency": "XRP",
"counter_currency": "CNY"
}
],
"date": "2016-10-31T20:45:20Z",
"period": "1day",
"total": "64982920.098184146"
}
}
Get information on the total amount of XRP in existence and in circulation, by weekly intervals. (New in v2.2.0)
REST
GET /v2/network/xrp_distribution
Optionally, you can provide the following query parameters:
| Field | Value | Description |
|---|---|---|
start |
String - Timestamp | Start time of query range. Defaults to the start of the most recent interval. |
end |
String - Timestamp | End time of query range. Defaults to the end of the most recent interval. |
limit |
Integer | Maximum results per page. Defaults to 200. Cannot be more than 1000. |
marker |
String | Pagination key from previously returned response. |
descending |
Boolean | If true, return results in reverse chronological order. Defaults to false. |
format |
String | Format of returned results: csv or json. Defaults to json. |
A successful response uses the HTTP code 200 OK and has a JSON body with the following:
| Field | Value | Description |
|---|---|---|
result |
String | The value success indicates that the body represents a successful response. |
count |
Integer | Number of rows returned. |
rows |
Array of Distribution Objects | Weekly snapshots of the XRP distribution. |
Each Distribution Object has the following fields:
| Field | Value | Description |
|---|---|---|
date |
String - Timestamp | The time of this snapshot. |
total |
String | Total XRP in existence. |
undistributed |
String | Aggregate amount of XRP held by Ripple (the company). |
distributed |
String | Aggregate amount of XRP held by others. |
Request:
GET /v2/network/xrp_distribution
Response:
200 OK
{
"result": "success",
"count": 171,
"rows": [
{
"date": "2016-04-10T00:00:00Z",
"distributed": "34918644255.77274",
"total": "99997725821.25714",
"undistributed": "65079081565.4844"
},
...
]
}
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)
Most Recent
GET /v2/network/top_currencies
By Date
GET /v2/network/top_currencies/{:date}
This method uses the following URL parameter:
| Field | Value | Description |
|---|---|---|
date |
String - ISO 8601 Date | (Optional) Historical date to query. If omitted, use the most recent date available. |
Optionally, you can provide the following query parameters:
| Field | Value | Description |
|---|---|---|
limit |
Integer | Maximum results per page. Defaults to 1000. Cannot be more than 1000. |
format |
String | Format of returned results: csv or json. Defaults to json. |
A successful response uses the HTTP code 200 OK and has a JSON body with the following:
| Field | Value | Description |
|---|---|---|
result |
String | The value success indicates that this is a successful response. |
date |
String - Timestamp | When this data was measured. |
count |
Integer | Number of objects in the currencies field. |
currencies |
Array of Top Currency Objects | The top currencies for this data sample. Each member represents one currency, by currency code and issuer. |
Each Top Currency Object has the following fields:
| Field | Value | Description |
|---|---|---|
currency |
String - Currency Code | The currency this object describes. |
issuer |
String - Address | The Ripple address that issues this currency. |
avg_exchange_count |
String - Number | Daily average number of exchanges |
avg_exchange_volume |
String - Number | Daily average volume of exchanges, normalized to XRP |
avg_payment_count |
String - Number | Daily average number of payments |
avg_payment_volume |
String - Number | Daily average volume of payments, normalized to XRP |
issued_value |
String - Number | Total amount of this currency issued by this issuer, normalized to XRP |
Request:
GET /v2/network/top_currencies/2016-04-14?limit=2
Response:
200 OK
{
"result": "success",
"date": "2016-04-14T00:00:00Z",
"count": 2,
"currencies": [
{
"avg_exchange_count": "8099.967741935484",
"avg_exchange_volume": "3.5952068085531615E7",
"avg_payment_count": "624.28125",
"avg_payment_volume": "3910190.139488101",
"issued_value": "1.5276205395328993E8",
"currency": "CNY",
"issuer": "rKiCet8SdvWxPXnAgYarFUXMh1zCPz432Y"
},
{
"avg_exchange_count": "3003.2258064516127",
"avg_exchange_volume": "3.430482029838605E7",
"avg_payment_count": "257.4375",
"avg_payment_volume": "501442.0789529095",
"issued_value": "2.6289124450524995E8",
"currency": "USD",
"issuer": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B"
}
]
}
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)
Most Recent
GET /v2/network/top_markets
By Date
GET /v2/network/top_markets/{:date}
This method uses the following URL parameter:
| Field | Value | Description |
|---|---|---|
date |
String - ISO 8601 Date | (Optional) Historical date to query. If omitted, use the most recent date available. |
Optionally, you can provide the following query parameters:
| Field | Value | Description |
|---|---|---|
limit |
Integer | Maximum results per page. Defaults to 1000. Cannot be more than 1000. |
format |
String | Format of returned results: csv or json. Defaults to json. |
A successful response uses the HTTP code 200 OK and has a JSON body with the following:
| Field | Value | Description |
|---|---|---|
result |
String | The value success indicates that this is a successful response. |
date |
String - Timestamp | The end of the rolling window over which this data was calculated. |
count |
Integer | Number of results in the markets field. |
markets |
Array of Top Market Objects | The top markets for this data sample. Each member represents a currency pair. |
Each Top Market object has the following fields:
| Field | Value | Description |
|---|---|---|
base_currency |
String - Currency Code | The base currency for this market. |
base_issuer |
String - Address | (Omitted if base_currency is XRP) The Ripple address that issues the base currency. |
counter_currency |
String - Currency Code | The counter currency for this market. |
counter_issuer |
String - Address | (Omitted if counter_currency is XRP) The Ripple address that issues the counter currency. |
avg_base_volume |
String | Daily average volume in terms of the base currency. |
avg_counter_volume |
String | Daily average volume in terms of the counter currency. |
avg_exchange_count |
String | Daily average number of exchanges |
avg_volume |
String | Daily average volume, normalized to XRP |
Request:
GET /v2/network/top_markets/2015-12-31
Response:
200 OK
{
"result": "success",
"date": "2015-12-31T00:00:00Z",
"count": 58,
"markets": [
{
"avg_base_volume": "116180.98607935428",
"avg_counter_volume": "1.6657039295476614E7",
"avg_exchange_count": "1521.4603174603174",
"avg_volume": "1.6657039295476614E7",
"base_currency": "USD",
"base_issuer": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B",
"counter_currency": "XRP"
},
{
"avg_base_volume": "410510.0286920887",
"avg_counter_volume": "9117398.719214212",
"avg_exchange_count": "1902.1587301587301",
"avg_volume": "9117398.719214212",
"base_currency": "CNY",
"base_issuer": "rKiCet8SdvWxPXnAgYarFUXMh1zCPz432Y",
"counter_currency": "XRP"
},
...
]
}
Returns transaction cost stats per ledger, hour, or day. The data shows the average, minimum, maximum, and total transaction costs paid for the given interval or ledger. (New in v2.2.0)
REST
GET /v2/network/fees
Optionally, you can provide the following query parameters:
| Field | Value | Description |
|---|---|---|
start |
String - Timestamp | Start time of query range. Defaults to the earliest data available. |
end |
String - Timestamp | End time of query range. Defaults to the latest data available. |
interval |
String | Aggregation interval - valid intervals are ledger, hour, or day. Defaults to ledger. |
descending |
Boolean | If true, sort results with most recent first. By default, sort results with oldest first. |
limit |
Integer | Maximum results per page. Defaults to 200. Cannot be more than 1000. |
marker |
String | Pagination key from previously returned response. |
format |
String | Format of returned results: csv or json. Defaults to json. |
A successful response uses the HTTP code 200 OK and has a JSON body with the following:
| Field | Value | Description |
|---|---|---|
result |
String | The value success indicates that this is a successful response. |
marker |
String | (May be omitted) Pagination marker. |
count |
Integer | Number of results in the markets field. |
rows |
Array of Fee Summary Objects | Transaction cost statistics for each interval. |
Each Fee Summary object has the following fields:
| Field | Value | Description |
|---|---|---|
avg |
Number | Average transaction cost paid in this interval. |
min |
Number | Minimum transaction cost paid in this interval. |
max |
Number | Maximum transaction cost paid in this interval. |
total |
Number | Total XRP destroyed by transaction costs. |
tx_count |
Number | Number of transactions in this interval. |
date |
String - Timestamp | The start time of this interval (time intervals), or the close time of this ledger (ledger interval). |
ledger_index |
Integer - Ledger Index | (Only present in ledger interval) The ledger this object describes. |
Request:
GET /v2/network/fees?interval=day&limit=3&descending=true
Response:
200 OK
{
"result": "success",
"marker": "day|20160603000000",
"count": 3,
"rows": [
{
"avg": 0.011829,
"max": 15,
"min": 0.01,
"total": 6682.15335,
"tx_count": 564918,
"date": "2016-06-06T00:00:00Z"
},
{
"avg": 0.011822,
"max": 4.963071,
"min": 0.01,
"total": 5350.832025,
"tx_count": 452609,
"date": "2016-06-05T00:00:00Z"
},
{
"avg": 0.012128,
"max": 15,
"min": 0.01,
"total": 5405.126404,
"tx_count": 445689,
"date": "2016-06-04T00:00:00Z"
}
]
}
Returns snapshots of the metrics derived from rippled's fee command. (New in [v2.4.0][])
REST
GET /v2/network/fee_stats
Optionally, you can provide the following query parameters:
| Field | Value | Description |
|---|---|---|
start |
String - Timestamp | Start time of query range. Defaults to the earliest data available. |
end |
String - Timestamp | End time of query range. Defaults to the latest data available. |
interval |
String | Snapshot Interval - valid intervals are minute, hour, or day. Default interval is 5 seconds. |
descending |
Boolean | If true, sort results with most recent first. By default, sort results with oldest first. |
limit |
Integer | Maximum results per page. Defaults to 200. Cannot be more than 1000. |
marker |
String | Pagination key from previously returned response. |
format |
String | Format of returned results: csv or json. Defaults to json. |
A successful response uses the HTTP code 200 OK and has a JSON body with the following:
| Field | Value | Description |
|---|---|---|
result |
String | The value success indicates that this is a successful response. |
marker |
String | (May be omitted) Pagination marker. |
count |
Integer | Number of results in the markets field. |
rows |
Array of Fee Summary Objects | Transaction cost statistics for each interval. |
Each Fee Summary object has the following fields:
| Field | Value | Description |
|---|---|---|
date |
String - Timestamp | The date-time this snapshot was taken. |
current_ledger_size |
Number | Number of transactions in the current ledger at the specified time. |
expected_ledger_size |
Number | Number of transactions expected in the next ledger at the specified time. |
current_queue_size |
Number | Number of transactions queued for inclusion in future ledgers. |
pct_max_queue_size |
Number | current queue size in terms of percentage of maximum queue size. |
median_fee |
Number | Median fee of transactions in the current ledger. |
minimum_fee |
Number | Minimum fee for inclusion in any ledger. |
open_ledger_fee |
Cost threshold for inclusion in the ledger open at the time of the snapshot |
Request:
GET /v2/network/fee_stats
Response:
200 OK
{
result: "success",
marker: "raw|20160701032100",
count: 200,
rows: [
{
current_ledger_size: 39,
current_queue_size: 0,
date: "2016-07-01T00:00:00Z",
expected_ledger_size: 59,
median_fee: 0.005,
minimum_fee: 0.00001,
open_ledger_fee: 0.00001,
pct_max_queue_size: 0
},
{
current_ledger_size: 33,
current_queue_size: 0,
date: "2016-07-01T00:01:00Z",
expected_ledger_size: 59,
median_fee: 0.00543,
minimum_fee: 0.00001,
open_ledger_fee: 0.00001,
pct_max_queue_size: 0
},
...
]
}
Get known rippled servers and peer-to-peer connections between them. (New in v2.2.0)
REST
GET /v2/network/topology
Optionally, you can provide the following query parameters:
| Field | Value | Description |
|---|---|---|
date |
String - Timestamp | Date and time for historical query. By default, uses the most recent data available. |
verbose |
Boolean | If true, include additional details about each server where available. Defaults to false. |
A successful response uses the HTTP code 200 OK and has a JSON body with the following:
| Field | Value | Description |
|---|---|---|
result |
String | The value success indicates that the body represents a successful response. |
date |
String - Timestamp | The time of this measurement. |
node_count |
Integer | Number of rippled servers in the topology. |
link_count |
Integer | Number of links in the topology. |
nodes |
Array of Server Objects | Details of rippled servers in the peer-to-peer network. |
links |
Array of Link Objects | Network connections between rippled servers in the peer-to-peer network. |
Request:
GET /v2/network/topology
Response:
200 OK
{
"result": "success",
"date": "2016-06-06T23:51:04Z",
"node_count": 115,
"link_count": 1913,
"nodes": [
{
"node_public_key": "n94fDXS3ta92gRSi7DKngh47S7Rg4z1FuNsahvbiakFEg51dLeVa",
"version": "rippled-0.31.0-rc1",
"uptime": 266431,
"inbound_count": 24,
"last_updated": "2016-06-03T21:50:57Z"
},
{
"node_public_key": "n94h5KNspwUGLaGcdHGxruYNmExWHjPkLcMvwsNrivR9czRp6Lor",
"ip": "104.247.221.178",
"port": 51235,
"version": "rippled-0.31.0",
"uptime": 608382,
"inbound_count": 10,
"outbound_count": 11,
"city": "Atlanta",
"country": "United States",
"country_code": "US",
"isp": "QuickPacket, LLC",
"last_updated": "2016-05-28T06:29:43Z",
"lat": "-84.3846",
"long": "33.8379",
"postal_code": "30305",
"region": "Georgia",
"region_code": "GA",
"timezone": "America/New_York"
},
...
],
"links": [
{
"source": "n94Extku8HiQVY8fcgxeot4bY7JqK2pNYfmdnhgf6UbcmgucHFY8",
"target": "n9KcFAX2bCuwF4vGF8gZZcpQQ6nyqm44e5TUygb3zvdZEpiJE5As"
},
{
"source": "n94Extku8HiQVY8fcgxeot4bY7JqK2pNYfmdnhgf6UbcmgucHFY8",
"target": "n9LGAj7PjvfTmEGQ75JaRKba6GQmVwFCnJTSHgX2HDXzxm6d2JpM"
},
...
]
}
Get known rippled nodes. (This is a subset of the data returned by the Get Topology method.) (New in v2.2.0)
REST
GET /v2/network/topology/nodes
Optionally, you can provide the following query parameters:
| Field | Value | Description |
|---|---|---|
date |
String - Timestamp | Date and time for historical query. Defaults to most recent data. |
verbose |
Boolean | If true, return full details for each server. Defaults to false. |
format |
String | Format of returned results: csv or json. Defaults to json. |
A successful response uses the HTTP code 200 OK and has a JSON body with the following:
| Field | Value | Description |
|---|---|---|
result |
String | The value success indicates that the body represents a successful response. |
date |
String - Timestamp | When this the data was measured. |
count |
Integer | Number of rippled servers described. |
nodes |
Array of Server Objects | Details of the rippled servers in the topology. |
Request:
GET /v2/network/topology/nodes
Response:
200 OK
{
"result": "success",
"date": "2016-06-08T00:36:53Z",
"count": 116,
"nodes": [
{
"node_public_key": "n94BuARkPiYLrMuAVZqMQFhTAGpo12dqUPiH3yrzEnhaEcXfLAnV",
"version": "rippled-0.30.1",
"uptime": 122424,
"inbound_count": 10,
"last_updated": "2016-06-06T14:36:52Z"
},
{
"node_public_key": "n94h5KNspwUGLaGcdHGxruYNmExWHjPkLcMvwsNrivR9czRp6Lor",
"ip": "104.247.221.178",
"port": 51235,
"version": "rippled-0.31.2",
"uptime": 38649,
"inbound_count": 10,
"outbound_count": 11,
"city": "Atlanta",
"country": "United States",
"country_code": "US",
"isp": "QuickPacket, LLC",
"last_updated": "2016-06-07T13:53:12Z",
"lat": "-84.3846",
"long": "33.8379",
"postal_code": "30305",
"region": "Georgia",
"region_code": "GA",
"timezone": "America/New_York"
},
...
]
}
Get information about a single rippled server by its node public key (not validator public key). (New in v2.2.0)
REST
GET /v2/network/topology/nodes/{:pubkey}
This method requires the following URL parameters:
| Field | Value | Description |
|---|---|---|
pubkey |
String - Base-58 Public Key | Node public key of the server to look up. |
This method takes no query parameters.
A successful response uses the HTTP code 200 OK and has a JSON body with a Server Object in the response with the following additional field:
| Field | Value | Description |
|---|---|---|
result |
String | The value success indicates that this is a successful response. |
Request:
GET /v2/network/topology/nodes/n94h5KNspwUGLaGcdHGxruYNmExWHjPkLcMvwsNrivR9czRp6Lor
Response:
200 OK
{
"node_public_key": "n94h5KNspwUGLaGcdHGxruYNmExWHjPkLcMvwsNrivR9czRp6Lor",
"ip": "104.247.221.178",
"port": 51235,
"version": "rippled-0.31.2",
"uptime": 43342,
"inbound_count": 10,
"outbound_count": 11,
"city": "Atlanta",
"country": "United States",
"country_code": "US",
"isp": "QuickPacket, LLC",
"last_updated": "2016-06-07T13:53:12Z",
"lat": "-84.3846",
"long": "33.8379",
"postal_code": "30305",
"region": "Georgia",
"region_code": "GA",
"timezone": "America/New_York",
"result": "success"
}
Get information on peer-to-peer connections between rippled servers. (This is a subset of the data returned by the Get Topology method.) (New in v2.2.0)
REST
GET /v2/network/topology/links
Optionally, you can provide the following query parameters:
| Field | Value | Description |
|---|---|---|
date |
String - Timestamp | Date and time for historical query. Defaults to most recent data available. |
format |
String | Format of returned results: csv or json. Defaults to json. |
A successful response uses the HTTP code 200 OK and has a JSON body with the following:
| Field | Value | Description |
|---|---|---|
result |
String | The value success indicates that the body represents a successful response. |
date |
String - Timestamp | When this data was measured. |
count |
Integer | Number of links returned. |
links |
Array of Link Objects | Links between rippled servers. |
Request:
GET /v2/network/topology/links
Response:
200 OK
{
result: "success",
date: "2016-03-21T16:38:52Z",
count: 1632,
links: [
{
source: "n94Extku8HiQVY8fcgxeot4bY7JqK2pNYfmdnhgf6UbcmgucHFY8",
target: "n9JccBLfrDJBLBF2X5N7bUW8251riCwSf9e3VQ3P5fK4gYr5LBu4"
},
...
]
}
Get details of a single validator in the consensus network. (New in v2.2.0)
REST
GET /v2/network/validators/{:pubkey}
This method requires the following URL parameters:
| Field | Value | Description |
|---|---|---|
pubkey |
String - Base-58 Public Key | Validator public key. |
Optionally, you can provide the following query parameters:
| Field | Value | Description |
|---|---|---|
format |
String | Format of returned results: csv or json. Defaults to json. |
A successful response uses the HTTP code 200 OK and has a JSON body with the following:
| Field | Value | Description |
|---|---|---|
result |
String | The value success indicates that the body represents a successful response. |
last_datetime |
Integer | The last reported validation vote signed by this validator. |
validation_public_key |
String - Base-58 Public Key | This validator's validator public key. |
domain |
String | (May be omitted) The DNS domain associated with this validator. |
domain_state |
String | The value verified indicates that this validator has a verified domain controlled by the same operator as the validator. The value AccountDomainNotFound indicates that the "Account Domain" part of Domain Verification is not set up properly. The value RippleTxtNotFound indicates that the ripple.txt step of Domain Verification is not set up properly. |
Request:
GET /v2/network/validators/n949f75evCHwgyP4fPVgaHqNHxUVN15PsJEZ3B3HnXPcPjcZAoy7
Response:
200 OK
{
"domain": "ripple.com",
"domain_state": "verified",
"last_datetime": "2016-06-07T01:22:59.929Z",
"validation_public_key": "n949f75evCHwgyP4fPVgaHqNHxUVN15PsJEZ3B3HnXPcPjcZAoy7",
"result": "success"
}
Get a list of known validators. (New in v2.2.0)
REST
GET /v2/network/validators
Optionally, you can provide the following query parameters:
| Field | Value | Description |
|---|---|---|
format |
String | Format of returned results: csv or json. Defaults to json. |
A successful response uses the HTTP code 200 OK and has a JSON body with the following:
| Field | Value | Description |
|---|---|---|
result |
String | The value success indicates that the body represents a successful response. |
last_datetime |
Integer | Number of links returned. |
validation_public_key |
String - Base-58 Public Key | Validator public key of this validator. |
Request:
GET /v2/network/validators/n949f75evCHwgyP4fPVgaHqNHxUVN15PsJEZ3B3HnXPcPjcZAoy7
Response:
200 OK
{
result: "success",
last_datetime: "2016-02-11T23:20:41.319Z",
validation_public_key: "n949f75evCHwgyP4fPVgaHqNHxUVN15PsJEZ3B3HnXPcPjcZAoy7"
}
Retrieve validation votes signed by a specified validator, including votes for ledger versions that are outside the main ledger chain. (New in v2.2.0)
Note: The Data API does not have a comprehensive record of all validations. The response only includes data that the Data API has recorded. Some ledger versions, especially older ledgers, may have no validations even if they were validated by consensus.
REST
GET /v2/network/validators/{:pubkey}/validations
This method requires the following URL parameters:
| Field | Value | Description |
|---|---|---|
pubkey |
String - Base-58 Public Key | Validator public key. |
Optionally, you can provide the following query parameters:
| Field | Value | Description |
|---|---|---|
start |
String - Timestamp | Filter results to this time and later. |
end |
String - Timestamp | Filter results to this time and earlier. |
limit |
Integer | Maximum results per page. Defaults to 200. Cannot be more than 1000. |
marker |
String | Pagination key from previously returned response. |
format |
String | Format of returned results: csv or json. Defaults to json. |
A successful response uses the HTTP code 200 OK and has a JSON body with the following:
| Field | Value | Description |
|---|---|---|
result |
String | The value success indicates that the body represents a successful response. |
count |
Integer | Number of validations returned. |
marker |
String | (May be omitted) Pagination marker. |
validations |
Array of Validation Objects | The requested validations. |
Request:
GET /v2/network/validator/n949f75evCHwgyP4fPVgaHqNHxUVN15PsJEZ3B3HnXPcPjcZAoy7/validations?limit=3&descending=true
Response:
200 OK
{
"result": "success",
"count": 3,
"marker": "n949f75evCHwgyP4fPVgaHqNHxUVN15PsJEZ3B3HnXPcPjcZAoy7|20160608020910|4499E5D60FD4F3F239C5B274E65B9CAE033398BE976E4FB49E9B30508D95F5A5",
"validations": [
{
"count": 27,
"first_datetime": "2016-06-08T02:09:21.280Z",
"last_datetime": "2016-06-08T02:09:21.390Z",
"ledger_hash": "246C5142A108C7B64F5D700936D31360B7790FA6349A98A2A1F7A14671D70B48",
"reporter_public_key": "n9KKTtooV4h2UsmNEhBqPvMRNj6RAHLPS6Baktf4u1AhgKNbyJAF",
"signature": "304402204506DD69B831886C4738F97CEED43AAFDBA67254D3EAF4FB5B3BF167A15B1B690220147E366CA53A3EC8B513978F2BA3A0905DC412CCE553E8ECE544236B097F2C8A",
"validation_public_key": "n949f75evCHwgyP4fPVgaHqNHxUVN15PsJEZ3B3HnXPcPjcZAoy7"
},
{
"count": 27,
"first_datetime": "2016-06-08T02:09:17.275Z",
"last_datetime": "2016-06-08T02:09:17.383Z",
"ledger_hash": "1DC9245CDBFE2C640ACD766DB4AF1DE66F6E92A8EE78F628281A6568760DBAB2",
"reporter_public_key": "n9JySgyBVcQKvyDoeRKg7s2Mm6ZcFHk22vUZb3o1HSosWxcj9xPt",
"signature": "3045022100E07D8CB801EC7AC98DB1DED813D49AE1FFE3C4CB027314EB6ED1BA7796653DE902204E65E96B0961AC09D8D7542EC59B3CE2ECAE6BC02557A4D1C0385DED00445329",
"validation_public_key": "n949f75evCHwgyP4fPVgaHqNHxUVN15PsJEZ3B3HnXPcPjcZAoy7"
},
{
"count": 27,
"first_datetime": "2016-06-08T02:09:13.277Z",
"last_datetime": "2016-06-08T02:09:13.387Z",
"ledger_hash": "0E11FA2052E8D345069CF09F13D76A8EF618C32F2B25A948FF104D59F53371BE",
"reporter_public_key": "n9KKTtooV4h2UsmNEhBqPvMRNj6RAHLPS6Baktf4u1AhgKNbyJAF",
"signature": "3045022100C1252F3FE8D0683F7FE5261D36876650EE185EEFE558150DEEF67F86E928463F022017237E1D89D5DBD8C4C2CC041C2EA73D96260D44A283D6CFF95359E86008E765",
"validation_public_key": "n949f75evCHwgyP4fPVgaHqNHxUVN15PsJEZ3B3HnXPcPjcZAoy7"
}
]
}
Retrieve validation votes, including votes for ledger versions that are outside the main ledger chain. (New in v2.2.0)
Note: The Data API does not have a comprehensive record of all validations. The response only includes data that the Data API has recorded. Some ledger versions, especially older ledgers, may have no validations even if they were validated by consensus.
REST
GET /v2/network/validations
Optionally, you can provide the following query parameters:
| Field | Value | Description |
|---|---|---|
start |
String - Timestamp | Filter results to this time and later. |
end |
String - Timestamp | Filter results to this time and earlier. |
limit |
Integer | Maximum results per page. Defaults to 200. Cannot be more than 1000. |
marker |
String | Pagination key from previously returned response. |
format |
String | Format of returned results: csv or json. Defaults to json. |
descending |
Boolean | If true, return results sorted with earliest first. Otherwise, return oldest results first. Defaults to false. |
A successful response uses the HTTP code 200 OK and has a JSON body with the following:
| Field | Value | Description |
|---|---|---|
result |
String | The value success indicates that the body represents a successful response. |
count |
Integer | Number of validation votes returned. |
marker |
String | (May be omitted) Pagination marker. |
validations |
Array of Validation Objects | The requested validation votes. |
Request:
GET /v2/network/validations?limit=3&descending=true
Response:
200 OK
{
"result": "success",
"count": 3,
"marker": "20160608005421561|nHUBJUyiW7ePZdjoLYrRvLB6JEytaAiX2NFqcmgNqW3CCFgBV7LZ|ADB496DFDBF27382E4D49F79D7EC5DD15229AF21E664934217A82D404748C994",
"validations": [
{
"count": 7,
"first_datetime": "2016-06-08T00:54:21.583Z",
"last_datetime": "2016-06-08T00:54:21.583Z",
"ledger_hash": "ADB496DFDBF27382E4D49F79D7EC5DD15229AF21E664934217A82D404748C994",
"reporter_public_key": "n9MVezjxa3Wk1vsZ8omj7Hga3tEcFiNH3gjWwx2SsQxkiamBwFw5",
"signature": "3044022027DCB43438A27F4F51DFD436FC078933524C6D675DBD7E0033C5A33DA3683699022029A5143EE172CA94AAD706454192CC2EC3CC93182697F0B2C00818C1C43ECE27",
"validation_public_key": "n949f75evCHwgyP4fPVgaHqNHxUVN15PsJEZ3B3HnXPcPjcZAoy7"
},
{
"count": 1,
"first_datetime": "2016-06-08T00:54:21.574Z",
"last_datetime": "2016-06-08T00:54:21.574Z",
"ledger_hash": "ADB496DFDBF27382E4D49F79D7EC5DD15229AF21E664934217A82D404748C994",
"reporter_public_key": "n9MqZ95ENFuf9yCWjZFsvCuvjNv9K3NpYgE9NYLAgzmCkkFpNs9W",
"signature": "3044022054FC074D6AFA022316C24EAEAC70644F3646151C164B72FB3B5A509A692ECAA7022038C93B3E282B5475FC9DC962CA4AD15A28796A1C10A978F66B0C8BBFF42A5782",
"validation_public_key": "n9MM9o8j5HmjNF2YFcvNWdKxAsMsMf58Ke6WQvcnn7oHLsuvkAtf"
},
{
"count": 1,
"first_datetime": "2016-06-08T00:54:21.574Z",
"last_datetime": "2016-06-08T00:54:21.574Z",
"ledger_hash": "ADB496DFDBF27382E4D49F79D7EC5DD15229AF21E664934217A82D404748C994",
"reporter_public_key": "n9MexcuoJg7KsVnJkvyPuLCtJNx5DSWnZbuWpcdsZ2jeqbU1ghEA",
"signature": "3045022100B6CD4FAFF0B699689885D48AB4CA449FA9E4E51832737E36BE5AA6642F88C52C02202297D2F4EFE41F512A4985A571E4D64F8161651DF3FA94561B2F583769305E27",
"validation_public_key": "n9KeL6TaqiQoUGndmyYKFDE868bFSAQQJ6XT1LmsuCDCebBdF5BV"
}
]
}
Get a single validator's validation vote stats for 24-hour intervals.
REST
GET /v2/network/validators/{:pubkey}/reports
This method requires the following URL parameters:
| Field | Value | Description |
|---|---|---|
pubkey |
String | Validator public key. |
Optionally, you can provide the following query parameters:
| Field | Value | Description |
|---|---|---|
start |
String - Timestamp | Start date and time for historical query. Defaults to 200 days before the current date. |
end |
String - Timestamp | End date and time for historical query. Defaults to most recent data available. |
format |
String | Format of returned results: csv or json. Defaults to json. |
A successful response uses the HTTP code 200 OK and has a JSON body with the following:
| Field | Value | Description |
|---|---|---|
result |
String | The value success indicates that the body represents a successful response. |
count |
Integer | Number of validators returned. |
validators |
Array of Single Validator Report Objects | Daily reports of this validator's validation votes. |
Each member in the validators array is a Single Validator Report Object with data on that validator's performance on that day. Each has the following fields:
| Field | Value | Description |
|---|---|---|
date |
String - Timestamp | The start time of the date this object describes. |
total_ledgers |
Integer | Number of ledger hashes for which this validator submitted validation votes. If this number is much lower than other validators in the same time period, that could mean the validator had downtime. |
main_net_agreement |
String - Number | The fraction of consensus-validated production network ledger versions for which this validator voted in this interval. "1.0" indicates 100% agreement. |
main_net_ledgers |
Integer | Number of consensus-validated production network ledger versions this validator voted for. |
alt_net_agreement |
String - Number | The fraction of the consensus-validated Test Network ledger versions this validator voted for. "1.0" indicates 100% agreement. |
alt_net_ledgers |
Integer | Number of consensus-validated Test Network ledger versions this validator voted for. |
other_ledgers |
Integer | Number of other ledger versions this validator voted for. If this number is high, that could indicate that this validator was running non-standard or out-of-date software. |
Request:
GET /v2/network/validators/n949f75evCHwgyP4fPVgaHqNHxUVN15PsJEZ3B3HnXPcPjcZAoy7/reports
Response:
200 OK
{
"result": "success",
"count": 198,
"reports": [
{
"date": "2015-11-20T00:00:00Z",
"total_ledgers": 19601,
"main_net_agreement": "1.0",
"main_net_ledgers": 19601,
"alt_net_agreement": "0.0",
"alt_net_ledgers": 0,
"other_ledgers": 0
},
{
"date": "2015-11-21T00:00:00Z",
"total_ledgers": 19876,
"main_net_agreement": "1.0",
"main_net_ledgers": 19876,
"alt_net_agreement": "0.0",
"alt_net_ledgers": 0,
"other_ledgers": 0
},
...
]
}
Get a validation vote stats and validator information for all known validators in a 24-hour period.
REST
GET /v2/network/validator_reports
Optionally, you can provide the following query parameters:
| Field | Value | Description |
|---|---|---|
date |
String - Timestamp | Date and time to query. By default, uses the most recent data available. |
format |
String | Format of returned results: csv or json. Defaults to json. |
A successful response uses the HTTP code 200 OK and has a JSON body with the following:
| Field | Value | Description |
|---|---|---|
result |
String | The value success indicates that the body represents a successful response. |
count |
Integer | Number of reports returned. |
reports |
Array of Daily Validator Report Objects | Summaries of activity for each validator active during this time period. |
Daily Validator Report Object fields:
| Field | Value | Description |
|---|---|---|
validation_public_key |
String - Base-58 Public Key | This validator's validator public key. |
date |
String - Timestamp | The start time of the date this object describes. |
total_ledgers |
Integer | Number of ledger indexes for which this validator submitted validation votes. If this number is much lower than other validators in the same time period, that could mean the validator had downtime. |
main_net_agreement |
String - Number | The fraction of consensus-validated production network ledger versions for which this validator voted in this interval. "1.0" indicates 100% agreement. |
main_net_ledgers |
Integer | Number of consensus-validated production network ledger versions this validator voted for. |
alt_net_agreement |
String - Number | The fraction of the consensus-validated Test Network ledger versions this validator voted for. "1.0" indicates 100% agreement. |
alt_net_ledgers |
Integer | Number of consensus-validated Test Network ledger versions this validator voted for. |
other_ledgers |
Integer | Number of other ledger versions this validator voted for. If this number is high, that could indicate that this validator was running non-standard or out-of-date software. |
last_datetime |
Integer | The last reported validation vote signed by this validator. |
domain |
String | (May be omitted) The DNS domain associated with this validator. |
domain_state |
String | The value verified indicates that this validator has a verified domain controlled by the same operator as the validator. The value AccountDomainNotFound indicates that the "Account Domain" part of Domain Verification is not set up properly. The value RippleTxtNotFound indicates that the ripple.txt step of Domain Verification is not set up properly. |
Request:
GET /v2/network/validator_reports
Response:
200 OK
{
"result": "success",
"count": 27,
"reports": [
{
"validation_public_key": "n9KvSsyJiheyFnivzFqChZ58pQgjwWWuc7Tp28WPzXbkdwqL6P5y",
"date": "2016-06-07T00:00:00Z",
"total_ledgers": 1289,
"main_net_agreement": "1.00000",
"main_net_ledgers": 1289,
"alt_net_agreement": "0.00000",
"alt_net_ledgers": 0,
"other_ledgers": 0,
"domain": "rippled.media.mit.edu",
"domain_state": "verified",
"last_datetime": "2016-06-07T01:20:20.753Z"
},
{
"validation_public_key": "n949f75evCHwgyP4fPVgaHqNHxUVN15PsJEZ3B3HnXPcPjcZAoy7",
"date": "2016-06-07T00:00:00Z",
"total_ledgers": 1289,
"main_net_agreement": "1.00000",
"main_net_ledgers": 1289,
"alt_net_agreement": "0.00000",
"alt_net_ledgers": 0,
"other_ledgers": 0,
"domain": "ripple.com",
"domain_state": "verified",
"last_datetime": "2016-06-07T01:20:20.717Z"
},
...
]
}
Get current Rippled versions
REST
GET /v2/network/rippled_versions
A successful response uses the HTTP code 200 OK and has a JSON body with the following:
| Field | Value | Description |
|---|---|---|
result |
String | The value success indicates that the body represents a successful response. |
count |
Integer | Number of reports returned. |
rows |
Array of Rippled Versions Objects | Date, Repo, and corresponding version number. |
Rippled Versions Object fields:
| Field | Value | Description |
|---|---|---|
date |
String - Timestamp | Date of record for the specific repo. |
repo |
String | Name of the repo. |
version |
String | Version string of the repo. |
Request:
GET /v2/network/rippled_versions
Response:
200 OK
{
result: "success",
count: 3,
rows: [
{
date: "2016-06-24T00:00:00Z",
repo: "nightly",
version: "0.32.0-rc2"
},
{
date: "2016-06-24T00:00:00Z",
repo: "stable",
version: "0.32.0"
},
{
date: "2016-06-24T00:00:00Z",
repo: "unstable",
version: "0.32.0-rc1"
}
]
}
Get information about known gateways. (New in v2.0.4)
REST
GET /v2/gateways/
This method takes no query parameters.
A successful response uses the HTTP code 200 OK and has a JSON body.
Each field in the top level JSON object is a Currency Code. The content of each field is an array of objects, representing gateways that issue that currency. Each object has the following fields:
| Field | Value | Description |
|---|---|---|
name |
String | A human-readable proper name for the gateway. |
account |
String - Address | The issuing address of this currency. |
featured |
Boolean | Whether this gateway is considered a "featured" issuer of the currency. Ripple decides which gateways to feature based on responsible business practices, volume, and other measures. |
label |
String | (May be omitted) Only provided when the Currency Code is a 40-character hexadecimal value. This is an alternate human-readable name for the currency issued by this gateway. |
assets |
Array of Strings | Graphics filenames available for this gateway, if any. (Mostly, these are logos used by Ripple Charts.) |
Request:
GET /v2/gateways/
Response:
200 OK
{
"AUD": [
{
"name": "Bitstamp",
"account": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B",
"featured": false,
"assets": [
"logo.grayscale.svg",
"logo.svg"
]
},
{
"name": "Coinex",
"account": "rsP3mgGb2tcYUrxiLFiHJiQXhsziegtwBc",
"featured": false,
"assets": []
}
],
... (additional results trimmed) ...
"0158415500000000C1F76FF6ECB0BAC600000000": [
{
"name": "GBI",
"account": "rrh7rf1gV2pXAoqA8oYbpHd8TKv5ZQeo67",
"featured": false,
"label": "XAU (-0.5pa)",
"assets": []
}
],
"KRW": [
{
"name": "EXRP",
"account": "rPxU6acYni7FcXzPCMeaPSwKcuS2GTtNVN",
"featured": true,
"assets": []
},
{
"name": "Pax Moneta",
"account": "rUkMKjQitpgAM5WTGk79xpjT38DEJY283d",
"featured": false,
"assets": []
}
]
}
Get information about a specific gateway from the Data API's list of known gateways. (New in v2.0.4)
REST
GET /v2/gateways/{:gateway}
This method requires the following URL parameters:
| Field | Value | Description |
|---|---|---|
gateway |
String | The issuing Address, URL-encoded name, or normalized name of the gateway. |
This method takes no query parameters.
A successful response uses the HTTP code 200 OK and has a JSON body with the following:
| Field | Value | Description |
|---|---|---|
name |
String | Human-readable name of the gateway. |
start_date |
String - Timestamp | The approximate date of the first time exchanges for this gateway's currencies appeared in the ledger. |
accounts |
Array | A list of issuing addresses used by this gateway. (Gateways may use different issuing accounts for different currencies.) |
hotwallets |
Array of Addresses | This gateway's operational addresses. |
domain |
String | The domain name where this gateway does business. Typically the gateway hosts a ripple.txt there. |
normalized |
String | A normalized version of the name field suitable for including in URLs. |
assets |
Array of Strings | Graphics filenames available for this gateway, if any. (Mostly, these are logos used by Ripple Charts.) |
Each object in the accounts field array has the following fields:
| Field | Value | Description |
|---|---|---|
address |
String | The issuing address used by this gateway. |
currencies |
Object | Each field in this object is a Currency Code corresponding to a currency issued from this address. Each value is an object with a featured boolean indicating whether that currency is featured. Ripple decides which currencies and gateways to feature based on responsible business practices, volume, and other measures. |
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"
]
}
Retrieve vector icons for various currencies. (New in v2.0.4)
REST
GET /v2/currencies/{:currencyimage}
This method requires the following URL parameter:
| Field | Value | Description |
|---|---|---|
currencyimage |
String | An image file for a currency, such as xrp.svg. See the source code for a list of available images. |
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.
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>
Retrieve information about the creation of new accounts in the Ripple Consensus Ledger.
REST
GET /v2/accounts
Optionally, you can provide the following query parameters:
| Field | Value | Description |
|---|---|---|
start |
String - Timestamp | Start time of query range. |
end |
String - Timestamp | End time of query range. |
interval |
String | Aggregation interval (hour,day,week). If omitted, return individual accounts. Not compatible with the parent parameter. |
limit |
Integer | Maximum results per page. Defaults to 200. Cannot be more than 1,000. |
marker |
String | Pagination key from previously returned response. |
descending |
Boolean | If true, return results in reverse chronological order. Defaults to false. |
parent |
String | Filter results to children of the specified parent account. Not compatible with the interval parameter. |
reduce |
Boolean | Return a count of results only. |
format |
String | Format of returned results: csv or json. Defaults to json. |
A successful response uses the HTTP code 200 OK and has a JSON body with the following:
| Field | Value | Description |
|---|---|---|
result |
String | The value success indicates that this is a successful response. |
count |
Integer | Number of accounts returned. |
marker |
String | (May be omitted) Pagination marker. |
accounts |
Array | If the request used the interval query parameter, each member of the array is an interval object. Otherwise, this field is an array of account creation objects. |
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:
| Field | Value | Description |
|---|---|---|
date |
String - Timestamp | When this interval starts. (The length of the interval is determined by the request.) |
count |
Number | How many accounts were created in this interval. |
Request:
GET /v1/accounts?parent=rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn
Response:
200 OK
{
"result": "success",
"count": 3,
"accounts": [
{
"balance": "20.0",
"account": "raKEEVSGnKSD9Zyvxu4z6Pqpm4ABH8FS6n",
"executed_time": "2015-02-09T23:31:40+00:00",
"ledger_index": 11620700,
"parent": "rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn",
"tx_hash": "1D381C0FCA00E8C34A6D4D3A91DAC9F3697B4E66BC49ED3D9B2D6F57D7F15E2E"
},
{
"balance": "30",
"account": "rUpy3eEg8rqjqfUoLeBnZkscbKbFsKXC3v",
"executed_time": "2015-06-16T21:15:40+00:00",
"ledger_index": 14090928,
"parent": "rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn",
"tx_hash": "60B614622FC67DFCA8D796D7F6AF0B7AEC5E59BB268EA032F810395407DDF8D5"
},
{
"balance": "50",
"account": "rLFd1FzHMScFhLsXeaxStzv3UC97QHGAbM",
"executed_time": "2015-09-23T23:05:20+00:00",
"ledger_index": 16061430,
"parent": "rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn",
"tx_hash": "FAE331A6D5CB83BCE832E7EBEDBD807EDEFFAF39AB241683EE81A0326A1A6748"
}
]
}
Get creation info for a specific ripple account
REST
GET /v2/accounts/{:address}
This method requires the following URL parameters:
| Field | Value | Description |
|---|---|---|
address |
String | Ripple address to query. |
A successful response uses the HTTP code 200 OK and has a JSON body with the following:
| Field | Value | Description |
|---|---|---|
result |
String | The value success indicates that this is a successful response. |
account |
Object - Account Creation | The requested account. |
Request:
GET /v2/accounts/rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn
Response:
200 OK
{
"result": "success",
"account": {
"address": "rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn",
"parent": "ra5nK24KXen9AHvsdFTKHSANinZseWnPcX",
"initial_balance": "100.0",
"inception": "2014-05-29T17:05:20+00:00",
"ledger_index": 6902264,
"tx_hash": "074415C5DC6DB0029E815EA6FC2629FBC29A2C9D479F5D040AFF94ED58ECC820"
}
}
Get all balances held or owed by a specific Ripple account.
REST
GET /v2/accounts/{:address}/balances
This method requires the following URL parameters:
| Field | Value | Description |
|---|---|---|
address |
String | Ripple address to query. |
Optionally, you can provide the following query parameters:
| Field | Value | Description |
|---|---|---|
ledger_index |
Integer | Index of ledger for historical balances. |
ledger_hash |
String | Ledger hash for historical balances. |
date |
String | UTC date for historical balances. |
currency |
String | Restrict results to specified currency. |
counterparty |
String | Restrict results to specified counterparty/issuer. |
limit |
Integer | Maximum results per page. Defaults to 200. Cannot be greater than 400, but you can use the value all to return all results. (Caution: When using limit=all to retrieve very many results, the request may time out. For large issuers, there can be several tens of thousands of results.) |
format |
String | Format of returned results: csv or json. Defaults to json. |
A successful response uses the HTTP code 200 OK and has a JSON body with the following:
| Field | Value | Description |
|---|---|---|
result |
String | The value success indicates that this is a successful response. |
ledger_index |
Integer | ledger index for balances query. |
close_time |
String | close time of the ledger. |
limit |
String | number of results returned, if limit was exceeded. |
marker |
String | (May be omitted) Pagination marker. |
balances |
Array of Balance Objects | The requested balances. |
Request:
GET /v2/accounts/rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn/balances?currency=USD&date=2015-01-01T00:00:00Z&limit=3
Response:
200 OK
{
"result": "success",
"ledger_index": 10852618,
"close_time": "2015-01-01T00:00:00Z",
"limit": 3,
"balances": [
{
"currency": "USD",
"counterparty": "ra5nK24KXen9AHvsdFTKHSANinZseWnPcX",
"value": "-11.0301"
},
{
"currency": "USD",
"counterparty": "rMwjYedjc7qqtKYVLiAccJSmCwih4LnE2q",
"value": "0.0001"
},
{
"currency": "USD",
"counterparty": "rweYz56rfmQ98cAdRaeTxQS9wVMGnrdsFp",
"value": "0"
}
]
}
Get orders in the order books, placed by a specific account. This does not return orders that have already been filled.
REST
GET /v2/account/{:address}/orders
This method requires the following URL parameters:
| Field | Value | Description |
|---|---|---|
address |
String - Address | Ripple address to query. |
Optionally, you can provide the following query parameters:
| Field | Value | Description |
|---|---|---|
ledger_index |
Integer | Get orders as of this ledger. Not compatible with ledger_hash or date. |
ledger_hash |
String | Get orders as of this ledger. Not compatible with ledger_index or date. |
date |
String - Timestamp | Get orders at this time. Not compatible with ledger_index or ledger_hash. |
limit |
Integer | Maximum results per page. Defaults to 200. Cannot be greater than 400. |
format |
String | Format of returned results: csv or json. Defaults to json. |
If none of ledger_index, ledger_hash, or date are specified, the API uses the most current data available.
A successful response uses the HTTP code 200 OK and has a JSON body with the following:
| Field | Value | Description |
|---|---|---|
result |
String | The value success indicates that this is a successful response. |
ledger_index |
Integer | ledger_index of the ledger version used. |
close_time |
String | Close time of the ledger version used. |
limit |
String | The limit from the request. |
orders |
Array of order objects | The requested orders. |
Each order object has the following fields:
| Field | Value | Description |
|---|---|---|
specification |
Object | Details of this order's current state. |
specification.direction |
String | Either buy or sell. |
specification.quantity |
Balance Object | The maximum amount of the base currency this order would buy or sell (depending on the direction). This value decreases as the order gets partially filled. |
specification.totalPrice |
Balance Object | The maximum amount of the counter currency the order can spend or gain to buy or sell the base currency. This value decreases as the order gets partially filled. |
properties |
Object | Details of how the order was placed. |
properties.maker |
String - Address | The Ripple account that placed the order. |
properties.sequence |
Number | The sequence number of the transaction that placed this order. |
properties.makerExchangeRate |
String - Number | The exchange rate from the point of view of the account that submitted the order. |
Request:
GET /v2/accounts/rK5j9n8baXfL4gzUoZsfxBvvsv97P5swaV/orders?limit=2&date=2015-11-11T00:00:00Z
Response:
200 OK
{
"result": "success",
"ledger_index": 17007855,
"close_time": "2015-11-11T00:00:00Z",
"limit": 2,
"orders": [
{
"specification": {
"direction": "buy",
"quantity": {
"currency": "JPY",
"value": "56798.00687665813",
"counterparty": "r94s8px6kSw1uZ1MV98dhSRTvc6VMPoPcN"
},
"totalPrice": {
"currency": "USD",
"value": "433.792841227449",
"counterparty": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B"
}
},
"properties": {
"maker": "rK5j9n8baXfL4gzUoZsfxBvvsv97P5swaV",
"sequence": 7418286,
"makerExchangeRate": "130.9334813270407"
}
},
{
"specification": {
"direction": "buy",
"quantity": {
"currency": "JPY",
"value": "11557.02705273459",
"counterparty": "r94s8px6kSw1uZ1MV98dhSRTvc6VMPoPcN"
},
"totalPrice": {
"currency": "USD",
"value": "87.570156003591",
"counterparty": "rhub8VRN55s94qWKDv6jmDy1pUykJzF3wq"
}
},
"properties": {
"maker": "rK5j9n8baXfL4gzUoZsfxBvvsv97P5swaV",
"sequence": 7418322,
"makerExchangeRate": "131.9744942815983"
}
}
]
}
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.
REST
GET /v2/accounts/{:address}/transactions
This method requires the following URL parameters:
| Field | Value | Description |
|---|---|---|
| :address | String - Address | Ripple address to query. |
Optionally, you can provide the following query parameters:
| Field | Value | Description |
|---|---|---|
start |
String - Timestamp | Start time of query range. Defaults to the earliest date available. |
end |
String - Timestamp | End time of query range. Defaults to the current date. |
min_sequence |
String | Minimum sequence number to query. |
max_sequence |
String | Max sequence number to query. |
type |
String | Restrict results to a specified transaction type |
result |
String | Restrict results to specified transaction result. |
binary |
Boolean | Return results in binary format. |
descending |
Boolean | If true, return results in reverse chronological order. Defaults to false. |
limit |
Integer | Maximum results per page. Defaults to 20. Cannot be more than 1,000. |
marker |
String | Pagination key from previously returned response. |
Note: This method cannot return CSV format; only JSON results are supported for raw RCL transactions.
A successful response uses the HTTP code 200 OK and has a JSON body with the following:
| Field | Value | Description |
|---|---|---|
result |
String | The value success indicates that this is a successful response. |
count |
Integer | The number of objects contained in the transactions field. |
marker |
String | (May be omitted) Pagination marker. |
transactions |
Array of transaction objects | All transactions matching the request. |
Request:
GET /v2/accounts/rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn/transactions?type=Payment&result=tesSUCCESS&limit=1
Response:
200 OK
{
"result": "success",
"count": 1,
"marker": "rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn|20140602224750|000006979192|00001",
"transactions": [
{
"hash": "074415C5DC6DB0029E815EA6FC2629FBC29A2C9D479F5D040AFF94ED58ECC820",
"date": "2014-05-29T17:05:20+00:00",
"ledger_index": 6902264,
"tx": {
"TransactionType": "Payment",
"Flags": 0,
"Sequence": 1,
"LastLedgerSequence": 6902266,
"Amount": "100000000",
"Fee": "12",
"SigningPubKey": "032ECFCC409F02057D8556988B89E17D48ECFC8373965036C6BA294AA2B7972971",
"TxnSignature": "30450221008D8E251DA5EA17A29CC9192717860F3B4047E74DF005127A65D9140CAE870C0902201C8E4548D2D3BA11B3E13CE8A167EBC076920E2B1C38547275CAA75FEC436EB9",
"Account": "ra5nK24KXen9AHvsdFTKHSANinZseWnPcX",
"Destination": "rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn"
},
"meta": {
"TransactionIndex": 1,
"AffectedNodes": [
{
"CreatedNode": {
"LedgerEntryType": "AccountRoot",
"LedgerIndex": "13F1A95D7AAB7108D5CE7EEAF504B2894B8C674E6D68499076441C4837282BF8",
"NewFields": {
"Sequence": 1,
"Balance": "100000000",
"Account": "rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn"
}
}
},
{
"ModifiedNode": {
"LedgerEntryType": "AccountRoot",
"PreviousTxnLgrSeq": 6486567,
"PreviousTxnID": "FF9BFF3C200B475CA7EE54F9A98EAB7E92BBDBD2DBE95AC854405D8A85C9D535",
"LedgerIndex": "43EA78783A089B137D5E87610DF3BD4129F989EDD02EFAF6C265924D3A0EF8CE",
"PreviousFields": {
"Sequence": 1,
"Balance": "1000000000"
},
"FinalFields": {
"Flags": 0,
"Sequence": 2,
"OwnerCount": 0,
"Balance": "899999988",
"Account": "ra5nK24KXen9AHvsdFTKHSANinZseWnPcX"
}
}
}
],
"TransactionResult": "tesSUCCESS"
}
}
]
}
Retrieve a specifc transaction originating from a specified account
REST
GET /v2/accounts/{:address}/transactions/{:sequence}
This method requires the following URL parameters:
| Field | Value | Description |
|---|---|---|
address |
String | Ripple address to query. |
sequence |
Integer | Transaction sequence number. |
Optionally, you can provide the following query parameters:
| Field | Value | Description |
|---|---|---|
binary |
Boolean | If true, return transaction in binary format. Defaults to false. |
A successful response uses the HTTP code 200 OK and has a JSON body with the following:
| Field | Value | Description |
|---|---|---|
result |
String | The value success indicates that this is a successful response. |
transaction |
transaction object | The requested transaction. |
Request:
GET /v2/accounts/rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn/transactions/10?binary=true
Response:
200 OK
{
"result": "success",
"transaction": {
"hash": "4BFFBB86C12659B6C5BB88F0EB859356DE3433EBACBFD9F50F6E70B2C05CCFE0",
"date": "2014-09-15T19:59:10+00:00",
"ledger_index": 8889812,
"tx": "1200052200000000240000000A68400000000000000A732103AB40A0490F9B7ED8DF29D246BF2D6269820A0EE7742ACDD457BEA7C7D0931EDB74473045022100AA4AF08726FCF0F28AA4A841C45F975C3BF1545648F6907DCB33F6E3DD7E85D6022037365B80AB1972BF8A4280009A0DBCF16A1D562ED0489B155750E48CC939039981144B4E9C06F24296074F7BC48F92A97916C6DC5EA9",
"meta": "201C00000003F8E5110061250087A5C555CBCA96F4C42E0EBC0E75C5AD84B3403FEDF824A7DAFA45ADCA6ECB66AA143C1B5613F1A95D7AAB7108D5CE7EEAF504B2894B8C674E6D68499076441C4837282BF8E6240000000A62400000000DB5852F8814D3484B9ED2556DCE16A3B928B438BA6EE0FF0989E1E72200010000240000000B2D0000000062400000000DB5852572110000000000000000000000070000000300770A6D64756F31332E636F6D81144B4E9C06F24296074F7BC48F92A97916C6DC5EA9E1E1F1031000"
}
}
Retrieve a payments for a specified account
REST
GET /v2/accounts/{:address}/payments
This method requires the following URL parameters:
| Field | Value | Description |
|---|---|---|
address |
String | Ripple address to query. |
Optionally, you can provide the following query parameters:
| Field | Value | Description |
|---|---|---|
start |
String - Timestamp | Filter results to this time and later. |
end |
String - Timestamp | Filter results to this time and earlier. |
type |
String | Type of payment - sent or received. |
currency |
String - Currency Code | Filter results to specified currency. |
issuer |
String - Address | Filter results to specified issuer. |
source_tag |
Integer | Filter results to specified source tag. |
destination_tag |
Integer | Filter results to specified destination tag. |
descending |
Boolean | If true, sort results with most recent first. Otherwise, return oldest results first. Defaults to false. |
limit |
Integer | Maximum results per page. Defaults to 200. Cannot be more than 1,000. |
marker |
String | Pagination key from previously returned response. |
format |
String | Format of returned results: csv or json. Defaults to json. |
A successful response uses the HTTP code 200 OK and has a JSON body with the following:
| Field | Value | Description |
|---|---|---|
result |
String | The value success indicates that this is a successful response. |
count |
Integer | The number of objects contained in the payments field. |
marker |
String | (May be omitted) Pagination marker. |
payments |
Array of payment objects | All payments matching the request. |
Request:
GET /v2/accounts/rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn/payments?currency=USD&limit=1
Response:
200 OK
{
"result": "success",
"count": 1,
"marker": "rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn|20140604191650|000007013674|00000",
"payments": [
{
"amount": "1.0",
"delivered_amount": "1.0",
"destination_balance_changes": [
{
"counterparty": "rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn",
"currency": "USD",
"value": "1"
}
],
"source_balance_changes": [
{
"counterparty": "ra5nK24KXen9AHvsdFTKHSANinZseWnPcX",
"currency": "USD",
"value": "-1"
}
],
"tx_index": 1,
"currency": "USD",
"destination": "ra5nK24KXen9AHvsdFTKHSANinZseWnPcX",
"executed_time": "2014-06-02T22:47:50Z",
"issuer": "rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn",
"ledger_index": 6979192,
"source": "rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn",
"source_currency": "USD",
"tx_hash": "7BF105CFE4EFE78ADB63FE4E03A851440551FE189FD4B51CAAD9279C9F534F0E",
"transaction_cost": "1.0E-5"
}
]
}
Retrieve Exchanges for a given account over time.
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}
This method requires the following URL parameters:
| Field | Value | Description |
|---|---|---|
address |
String | Ripple address to query. |
base |
String | Base currency of the pair, as a Currency Code, followed by + and the issuer Address unless it's XRP. |
counter |
String | Counter currency of the pair, as a Currency Code, followed by + and the issuer Address unless it's XRP. |
Optionally, you can provide the following query parameters:
| Field | Value | Description |
|---|---|---|
start |
String - Timestamp | Filter results to this time and later. |
end |
String - Timestamp | Filter results to this time and earlier. |
descending |
Boolean | If true, return results in reverse chronological order. Defaults to false. |
limit |
Integer | Maximum results per page. Defaults to 200. Cannot be more than 1000. |
marker |
String | Pagination key from previously returned response. |
format |
String | Format of returned results: csv or json. Defaults to json. |
A successful response uses the HTTP code 200 OK and has a JSON body with the following:
| Field | Value | Description |
|---|---|---|
result |
String | The value success indicates that this is a successful response. |
count |
Integer | Number of exchanges returned. |
marker |
String | (May be omitted) Pagination marker. |
exchanges |
Array of Exchange Objects | The requested exchanges. |
Request:
GET /v2/accounts/rsyDrDi9Emy6vPU78qdxovmNpmj5Qh4NKw/exchanges/KRW+rUkMKjQitpgAM5WTGk79xpjT38DEJY283d/XRP?start=2015-08-08T00:00:00Z&end=2015-08-31T00:00:00Z&limit=2
Response:
200 OK
{
"result": "success",
"count": 2,
"marker": "rsyDrDi9Emy6vPU78qdxovmNpmj5Qh4NKw|20150810014200|000015162386|00013|00003",
"exchanges": [
{
"base_amount": 209.3501241148,
"counter_amount": 20.424402,
"rate": 0.097560973925,
"autobridged_currency": "USD",
"autobridged_issuer": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B",
"base_currency": "KRW",
"base_issuer": "rUkMKjQitpgAM5WTGk79xpjT38DEJY283d",
"buyer": "rnAqwsu2BEbCjacoZmsXrpViqd3miZhHbT",
"counter_currency": "XRP",
"executed_time": "2015-08-08T02:57:40",
"ledger_index": 15122851,
"offer_sequence": "1738",
"provider": "rsyDrDi9Emy6vPU78qdxovmNpmj5Qh4NKw",
"seller": "rsyDrDi9Emy6vPU78qdxovmNpmj5Qh4NKw",
"taker": "rnAqwsu2BEbCjacoZmsXrpViqd3miZhHbT",
"tx_hash": "506D109A609A5E0778276CCBB125A4AA7B78428059F069A2CB4F739B861C0C49",
"tx_type": "OfferCreate"
},
{
"base_amount": 86355.6498758851,
"counter_amount": 8424.941452,
"rate": 0.097560975618,
"base_currency": "KRW",
"base_issuer": "rUkMKjQitpgAM5WTGk79xpjT38DEJY283d",
"buyer": "r9xQi5YT8jqVM3wZhbiV94ZKKvGHaVeSDj",
"client": "rt1.1-26-gbeb68ab",
"counter_currency": "XRP",
"executed_time": "2015-08-08T07:15:00",
"ledger_index": 15126536,
"offer_sequence": "1738",
"provider": "rsyDrDi9Emy6vPU78qdxovmNpmj5Qh4NKw",
"seller": "rsyDrDi9Emy6vPU78qdxovmNpmj5Qh4NKw",
"taker": "r9xQi5YT8jqVM3wZhbiV94ZKKvGHaVeSDj",
"tx_hash": "C897A595DED16ADF5AD52E6FD9CE5DE65C78A93CCAA62A85248DC3015A78F5C4",
"tx_type": "Payment"
}
]
}
Retrieve Balance changes for a given account over time.
REST
GET /v2/accounts/{:address}/balance_changes/
This method requires the following URL parameters:
| Field | Value | Description |
|---|---|---|
address |
String | Ripple address to query. |
Optionally, you can provide the following query parameters:
| Field | Value | Description |
|---|---|---|
currency |
String | Restrict results to specified currency. |
counterparty |
String | Restrict results to specified counterparty/issuer. |
start |
String - Timestamp | Start time of query range. |
end |
String - Timestamp | End time of query range. |
descending |
Boolean | If true, return results in reverse chronological order. Defaults to false. |
limit |
Integer | Maximum results per page. Defaults to 200. Cannot be more than 1000. |
marker |
String | Pagination key from previously returned response. |
format |
String | Format of returned results: csv orjson. Defaults to json. |
A successful response uses the HTTP code 200 OK and has a JSON body with the following:
| Field | Value | Description |
|---|---|---|
result |
String | The value success indicates that this is a successful response. |
count |
Integer | Number of balance changes returned. |
marker |
String | (May be omitted) Pagination marker. |
exchanges |
Array of balance change descriptors | The requested balance changes. |
Request:
GET /v2/accounts/rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn/balance_changes?descending=true&limit=3
Response:
200 OK
{
"result": "success",
"count": 3,
"marker": "rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn|20160122235211|000018425487|00010|00001",
"balance_changes": [
{
"amount_change": "-0.012",
"final_balance": "75.169663",
"tx_index": 7,
"change_type": "transaction_cost",
"currency": "XRP",
"executed_time": "2016-01-29T22:57:20Z",
"ledger_index": 18555460,
"tx_hash": "2B44EBE00728D04658E597A85EC4F71D20503B31ABBF556764AD8F7A80BA72F6"
},
{
"amount_change": "-25.0",
"final_balance": "75.181663",
"node_index": 1,
"tx_index": 4,
"change_type": "payment_source",
"currency": "XRP",
"executed_time": "2016-01-26T08:32:20Z",
"ledger_index": 18489336,
"tx_hash": "E5C6DD25B2DCF534056D98A2EFE3B7CFAE4EBC624854DE3FA436F733A56D8BD9"
},
{
"amount_change": "-0.01",
"final_balance": "100.181663",
"tx_index": 4,
"change_type": "transaction_cost",
"currency": "XRP",
"executed_time": "2016-01-26T08:32:20Z",
"ledger_index": 18489336,
"tx_hash": "E5C6DD25B2DCF534056D98A2EFE3B7CFAE4EBC624854DE3FA436F733A56D8BD9"
}
]
}
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}
This method requires the following URL parameters:
| Field | Value | Description |
|---|---|---|
address |
String | Ripple address to query. |
date |
String | (Optional) UTC date for single report. If omitted, use the start and end query parameters. |
Optionally, you can provide the following query parameters:
| Field | Value | Description |
|---|---|---|
start |
String - Timestamp | Start time of query range. Defaults to start of current date. Ignored if date specified. |
end |
String - Timestamp | End time of query range. Defaults to current date. Ignored if date specified. |
accounts |
Boolean | If true, provide lists with addresses of all sending_counterparties and receiving_counterparties in results. Otherwise, return only the number of sending and receiving counterparties. |
payments |
Boolean | Include Payment Summary Objects in the payments field for each interval, with the payments that occurred during that interval. |
descending |
Boolean | If true, sort results with most recent first. By default, sort results with oldest first. |
format |
String | Format of returned results: csv or json. Defaults to json. |
A successful response uses the HTTP code 200 OK and has a JSON body with the following:
| Field | Value | Description |
|---|---|---|
result |
String | The value success indicates that this is a successful response. |
count |
Integer | Number of reports in the reports field. |
reports |
Array of Reports Objects | Daily summaries of account activity for the given account and date range. |
Request:
GET /v2/accounts/rMwjYedjc7qqtKYVLiAccJSmCwih4LnE2q/reports?start=2015-08-28T00:00:00&end=2015-08-28T00:00:00&accounts=true&payments=true&descending=true
Response:
200 OK
{
"result": "success",
"count": 1,
"reports": [
{
"account": "rMwjYedjc7qqtKYVLiAccJSmCwih4LnE2q",
"date": "2015-08-28T00:00:00+00:00",
"high_value_received": 89500.74142547617,
"high_value_sent": 0,
"payments": [
{
"tx_hash": "F2323EE7494384E77ABB18F31981FEE8C31767BBD27515B55FC3BD6792C4E408",
"amount": 2.7,
"currency": "BTC",
"issuer": "rMwjYedjc7qqtKYVLiAccJSmCwih4LnE2q",
"type": "received"
},
{
"tx_hash": "FEAD462738EE430E154FF3122D3EE2DD27DDD8BEFBA080A60FE91B78E8865365",
"amount": 3,
"currency": "BTC",
"issuer": "rMwjYedjc7qqtKYVLiAccJSmCwih4LnE2q",
"type": "received"
},
{
"tx_hash": "383B1D1EABB646AB2EFBBF9E8967FE279BFE5EF86A3B6BCD5BDA287210053116",
"amount": 0.14,
"currency": "BTC",
"issuer": "rMwjYedjc7qqtKYVLiAccJSmCwih4LnE2q",
"type": "received"
}
],
"payments_received": 3,
"payments_sent": 0,
"receiving_counterparties": [],
"sending_counterparties": [
"rhi4zZdCeFdfTokzek8D7p9bUWmtEFCZAe",
"rP1hkW1LCiVos6FpzU7itmm9Tk29yqvyk5"
],
"total_value": 174019.58324753598,
"total_value_received": 174019.58324753598,
"total_value_sent": 0
}
]
}
Retrieve daily summaries of transaction activity for an account. (New in v2.1.0.)
REST
GET /v2/accounts/{:address}/stats/transactions
This method requires the following URL parameters:
| Field | Value | Description |
|---|---|---|
address |
String | Ripple address to query. |
Optionally, you can provide the following query parameters:
| Field | Value | Description |
|---|---|---|
start |
String - Timestamp | Start time of query range. Defaults to the earliest date available. |
end |
String - Timestamp | End time of query range. Defaults to the current date. |
limit |
Integer | Maximum results per page. Defaults to 200. Cannot be more than 1000. |
descending |
Boolean | If true, sort results with most recent first. By default, sort results with oldest first. |
marker |
String | Pagination key from previously returned response. |
format |
String | Format of returned results: csv or json. Defaults to json. |
A successful response uses the HTTP code 200 OK and has a JSON body with the following:
| Field | Value | Description |
|---|---|---|
result |
String | The value success indicates that this is a successful response. |
count |
Integer | Number of transaction stats objects in the rows field. |
rows |
Array of Transaction Stats Objects | Daily summaries of account transaction activity for the given account. |
Each Transaction Stats Object has the following fields:
| Field | Value | Description |
|---|---|---|
date |
String - Timestamp | This object describes activity on this date. |
transaction_count |
Integer | The total number of transactions sent by the account on this date. |
result |
Object | Map of transaction result codes, indicating how many of each result code occurred in the transactions sent by this account on this date. |
type |
Object | Map of transaction types, indicating how many of each transaction type the account sent on this date. |
Request:
GET /v2/accounts/rGFuMiw48HdbnrUbkRYuitXTmfrDBNTCnX/stats/transactions?start=2015-01-01&limit=2
Response:
200 OK
{
"result": "success",
"count": 2,
"marker": "rGFuMiw48HdbnrUbkRYuitXTmfrDBNTCnX|20150116000000",
"rows": [
{
"date": "2015-01-14T00:00:00Z",
"transaction_count": 44,
"result": {
"tecUNFUNDED_PAYMENT": 1,
"tesSUCCESS": 43
},
"type": {
"Payment": 42,
"TrustSet": 2
}
},
{
"date": "2015-01-15T00:00:00Z",
"transaction_count": 116,
"result": {
"tesSUCCESS": 116
},
"type": {
"Payment": 116
}
}
]
}
Retrieve daily summaries of transaction activity for an account. (New in v2.1.0.)
REST
GET /v2/accounts/{:address}/stats/value
This method requires the following URL parameters:
| Field | Value | Description |
|---|---|---|
address |
String | Ripple address to query. |
Optionally, you can provide the following query parameters:
| Field | Value | Description |
|---|---|---|
start |
String - Timestamp | Start time of query range. Defaults to the start of the most recent interval. |
end |
String - Timestamp | End time of query range. Defaults to the end of the most recent interval. |
limit |
Integer | Maximum results per page. Defaults to 200. Cannot be more than 1000. |
marker |
String | Pagination key from previously returned response. |
descending |
Boolean | If true, sort results with most recent first. By default, sort results with oldest first. |
format |
String | Format of returned results: csv or json. Defaults to json. |
A successful response uses the HTTP code 200 OK and has a JSON body with the following:
| Field | Value | Description |
|---|---|---|
result |
String | The value success indicates that this is a successful response. |
count |
Integer | Number of value stats objects in the rows field. |
rows |
Array of Value Stats Objects | Daily summaries of account value for the given account. |
Each Value Stats Object has the following fields:
| Field | Value | Description |
|---|---|---|
date |
String - Timestamp | This object describes activity on this date. |
value |
String - Number | The total of all currency held by this account, normalized to XRP. |
balance_change_count |
Number | The number of times the account's balance changed on this date. |
Request:
GET /v2/accounts/rGFuMiw48HdbnrUbkRYuitXTmfrDBNTCnX/stats/value?limit=2&descending=true
Response:
200 OK
{
"result": "success",
"count": 2,
"marker": "rGFuMiw48HdbnrUbkRYuitXTmfrDBNTCnX|20160412000000",
"rows": [
{
"date": "2016-04-14T00:00:00Z",
"account_value": "7.666658705139822E7",
"balance_change_count": 58
},
{
"date": "2016-04-13T00:00:00Z",
"account_value": "1.0022208004947332E8",
"balance_change_count": 184
}
]
}
Check the health of the API service.
REST
GET /v2/health/api
Optionally, you can provide the following query parameters:
| Field | Value | Description |
|---|---|---|
threshold |
Integer | Consider the API unhealthy if the database does not respond within this amount of time, in seconds. Defaults to 5 seconds. |
verbose |
Boolean | If true, return a JSON response with data points. By default, return an integer value only. |
A successful response uses the HTTP code 200 OK. By default, the response body is an integer health value only.
The health value 0 always indicates a healthy status. Other health values are defined as follows:
| Value | Meaning |
|---|---|
0 |
API service is up, and response time to HBase is less than threshold value from request. |
1 |
API service is up, but response time to HBase is greater than threshold value from request. |
If the request specifies verbose=true in the query parameters, the response body is a JSON object, with the following fields:
| Field | Value | Description |
|---|---|---|
score |
0-1 | Health value, as defined above. |
response_time |
String - Human-readable time | The actual response time of the database. |
response_time_threshold |
String - Human-readable time | The maximum response time to be considered healthy. |
Request:
GET /v2/health/api?verbose=true
Response:
200 OK
{
"score": 0,
"response_time": "0.014s",
"response_time_threshold": "5s"
}
Check the health of the Ledger Importer Service.
REST - Importer Health
GET /v2/health/importer
Optionally, you can provide the following query parameters:
| Field | Value | Description |
|---|---|---|
threshold |
Integer | Consider the Importer unhealthy if more than this amount of time, in seconds, has elapsed since the latest validated ledger was imported. Defaults to 300 seconds. |
threshold2 |
Integer | Consider the Importer unhealthy if more than this amount of time, in seconds, has elapsed since the latest ledger of any kind was imported. Defaults to 60 seconds. |
verbose |
Boolean | If true, return a JSON response with data points. By default, return an integer value only. |
A successful response uses the HTTP code 200 OK. By default, the response body is an integer health value only.
The health value 0 always indicates a healthy status. Other health values are defined as follows:
| Value | Meaning |
|---|---|
0 |
The most recent imported ledger was less than threshold2 (Default: 60) seconds ago, and most recent validated ledger was less than threshold seconds ago. |
1 |
The most recent imported ledger was less than threshold2 (Default: 60) seconds ago, but the most recent validated ledger is older than threshold seconds. |
2 |
The most recent imported ledger was more than threshold2 seconds ago. |
If the request specifies verbose=true in the query parameters, the response body is a JSON object, with the following fields:
| Field | Value | Description |
|---|---|---|
score |
0-2 | Health value, as defined above. |
response_time |
String | The actual response time of the database. |
ledger_gap |
String - Human-readable time | Difference between the close time of the last saved ledger and the current time. |
ledger_gap_threshold |
String - Human-readable time | Maximum ledger gap to be considered healthy. |
valildation_gap |
String - Human-readable time | Difference between the close time of the last imported validated ledger and the current time. |
validation_gap_threshold |
String - Human-readable time | Maximum validation gap to be considered healthy. |
Request:
GET /v2/health/importer?verbose=true
Response:
200 OK
{
"score": 0,
"response_time": "0.081s",
"ledger_gap": "1.891s",
"ledger_gap_threshold": "5.00m",
"validation_gap": "29.894s",
"validation_gap_threshold": "15.00m"
}
Check the health of the Topology Nodes Extract, Transform, Load (ETL) Service.
REST - Nodes ETL Health
GET /v2/health/nodes_etl
Optionally, you can provide the following query parameters:
| Field | Value | Description |
|---|---|---|
threshold |
Integer | Consider the service unhealthy if more than this amount of time, in seconds, has elapsed since the latest data was imported. Defaults to 120 seconds. |
verbose |
Boolean | If true, return a JSON response with data points. By default, return an integer value only. |
A successful response uses the HTTP code 200 OK. By default, the response body is an integer health value only.
The health value 0 always indicates a healthy status. Other health values are defined as follows:
| Value | Meaning |
|---|---|
0 |
The most recent imported topology data was less than threshold (Default: 120) seconds ago. |
1 |
The most recent imported topology data was more than threshold seconds ago. |
If the request specifies verbose=true in the query parameters, the response body is a JSON object, with the following fields:
| Field | Value | Description |
|---|---|---|
score |
0-1 | Health value, as defined above. |
gap |
String - Human-readable time | Difference between the latest imported data and the current time. |
gap_threshold |
String - Human-readable time | Maximum gap to be considered healthy. |
message |
String | Description of the reason for a non-zero score, if applicable. |
Request:
GET /v2/health/nodes_etl?verbose=true
Response:
200 OK
{
"score": 0,
"gap": "1.891s",
"gap_threshold": "2.00m",
}
Check the health of the Validations Extract, Transform, Load (ETL) Service.
REST - Validations ETL Health
GET /v2/health/validations_etl
Optionally, you can provide the following query parameters:
| Field | Value | Description |
|---|---|---|
threshold |
Integer | Consider the service unhealthy if more than this amount of time, in seconds, has elapsed since the latest data was imported. Defaults to 120 seconds. |
verbose |
Boolean | If true, return a JSON response with data points. By default, return an integer value only. |
A successful response uses the HTTP code 200 OK. By default, the response body is an integer health value only.
The health value 0 always indicates a healthy status. Other health values are defined as follows:
| Value | Meaning |
|---|---|
0 |
The most recent imported topology data was less than threshold (Default: 120) seconds ago. |
1 |
The most recent imported topology data was more than threshold seconds ago. |
If the request specifies verbose=true in the query parameters, the response body is a JSON object, with the following fields:
| Field | Value | Description |
|---|---|---|
score |
0-1 | Health value, as defined above. |
gap |
String - Human-readable time | Difference between the latest imported data and the current time. |
gap_threshold |
String - Human-readable time | Maximum gap to be considered healthy. |
message |
String | Description of the reason for a non-zero score, if applicable. |
Request:
GET /v2/health/nodes_etl?verbose=true
Response:
200 OK
{
"score": 0,
"gap": "1.891s",
"gap_threshold": "2.00m",
}
As a REST API, the Data API v2 uses JSON's native datatypes to represent API fields, with some special cases.
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 as0.5. (American style, not European) - May contain
Eoreto indicate being raised to a power of 10. For example,1.2E5is equivalent to120000. - 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 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.
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:
rpshnaf39wBUDNEGHJKLM4PQRST7VWXYZ2bcdeCg65jkm8oFqi1tuvAxyzThat'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.
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 only an address, any XRP possessed by those addresses is lost forever.
| Address | Name | Meaning | Black Hole? |
|---|---|---|---|
| rrrrrrrrrrrrrrrrrrrrrhoLvTp | ACCOUNT_ZERO | An address that is the base-58 encoding of the value 0. In peer-to-peer communications, rippled uses this address as the issuer for XRP. |
Yes |
| rrrrrrrrrrrrrrrrrrrrBZbvji | ACCOUNT_ONE | An address that is the base-58 encoding of the value 1. In the ledger, RippleState entries use this address as a placeholder for the issuer of a trust line balance. |
Yes |
| rHb9CJAWyB4rj91VRWn96DkukG4bwdtyTh | The genesis account | When rippled starts a new genesis ledger from scratch (for example, in stand-alone mode), this account holds all the XRP. This address is generated from the seed value "masterpassphrase" which is hard-coded. |
No |
| rrrrrrrrrrrrrrrrrNAMEtxvNvQ | Ripple Name reservation black-hole | In the past, Ripple asked users to send XRP to this account to reserve Ripple Names. | Yes |
| rrrrrrrrrrrrrrrrrrrn5RM1rHd | NaN Address | Previous versions of ripple-lib generated this address when base-58 encoding the value NaN. | Yes |
The Ripple Consensus Ledger (RCL) uses public keys to verify cryptographic signatures in several places:
- To authorize transactions, a public key is attached to the transaction. The public key must be mathematically associated with the sending Ripple address or the sender's regular key address.
- To secure peer-to-peer communications between
rippledservers. This uses a "node public key" that the server generates randomly when it starts with an empty database. - To sign validation votes as part of the consensus process. This uses a "validator public key" that the server operator defines in the config file.
Validator public keys and node public keys use the exact same format.
Public keys can be represented in hexadecimal or in base-58. In hexadecimal, all three types of public keys are 33 bytes (66 characters) long.
In base-58 format, validator public keys and node public keys always start with the character n, commonly followed by the character 9. A validator public key in base-58 format can be up to 53 characters long. Example node public key: n9Mxf6qD4J55XeLSCEpqaePW4GjoCR5U1ZeGZGJUCNe3bQa4yQbG.
Ripple addresses are mathematically associated with a public key. This public key is rarely encoded in base-58, but when it is, it starts with the character a.
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 the same.
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.)
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
Tseparating the date part and the time part - Two-digit hour using a 24-hour clock
- Two digit minute
- The letter
Zindicating zero offset from UTC.
(As of v2.0.4, the offset +00:00 is no longer used.)
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 new 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 the same. 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
rippledservers 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. The hash of a ledger is not calculated until the ledger is closed.
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 the same.
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.
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 codeXRP(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.
Many queries may return more data than is reasonable to return in a single HTTP response. The Data API uses a "limit and marker" system to control how much is returned in a single response ("page") and to query for additional content.
The limit query parameter to many requests restricts the response to a specific number of results in the response. The types of results and default values vary based on the method. For most methods, the limit is 200 by default, and can be set as high as 1000. If you specify a limit larger than the maximum, the API uses the maximum value instead.
When a query has additional objects that are not contained in the current response, the JSON response contains a top-level field marker which indicates that you can retrieve additional results. To do so, make more requests with the previous value of the marker field as the marker query parameter. For each additional request, use the same parameters as the first request (except marker). When the response omits the marker parameter, that indicates that you have reached the end of the 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)
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.
| Field | Value | Description |
|---|---|---|
hash |
String - Hash | An identifying hash value unique to this transaction, as a hex string. |
date |
String - Timestamp | The time when this transaction was included in a validated ledger. |
ledger_index |
Number - Ledger Index | The sequence number of the ledger that included this ledger. |
tx |
Object | The fields of this transaction object, as defined by the Transaction Format |
meta |
Object | Metadata about the results of this transaction. |
| Field | Value | Description |
|---|---|---|
hash |
String - Hash | An identifying hash value unique to this transaction, as a hex string. |
date |
String - Timestamp | The time when this transaction was included in a validated ledger. |
ledger_index |
Number - Ledger Index | The sequence number of the ledger that included this ledger. |
tx |
String | The binary data that represents this transaction, as a hexadecimal string. |
meta |
String | The binary data that represents this transaction's metadata, as a hex string. |
A "ledger" is one version of the shared global ledger. Each ledger object has the following fields:
| Field | Value | Description |
|---|---|---|
ledger_hash |
String - Hash | An identifying hash unique to this ledger, as a hex string. |
ledger_index |
Number - Ledger Index | The sequence number of the ledger. Each new ledger has a ledger index 1 higher than the ledger that came before it. |
parent_hash |
String - Hash | The identifying hash of the previous ledger. |
total_coins |
String - Number | The total number of "drops" of XRP still in existence at the time of the ledger. (Each XRP is 1,000,000 drops.) |
close_time_res |
Number | The ledger close time is rounded to this many seconds. |
accounts_hash |
String - Hash | Hash of the account information contained in this ledger, as hex. |
transactions_hash |
String - Hash | Hash of the transaction information contained in this ledger, as hex. |
close_time |
Number | When this ledger was closed, in UNIX time. |
close_time_human |
String - Timestamp | When this ledger was closed. |
Note: Ledger close times are approximate, typically rounded to about 10 seconds. Two ledgers could have the same close_time values, when their actual close times were several seconds apart. The sequence number (ledger_index) of the ledger makes it unambiguous which ledger closed first.
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.
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.
| Field | Value | Description |
|---|---|---|
address |
String - Address | The identifying address of this account, in base-58. |
inception |
String - Timestamp | The UTC timestamp when the address was funded. For genesis accounts, this is the timestamp of ledger 32570. |
ledger_index |
Number - Ledger Index | The sequence number of the ledger when the account was created, or 32570 for genesis accounts. |
parent |
String - Address | (Omitted for genesis accounts) The address that provided the XRP to fund this address. |
tx_hash |
String - Hash | (Omitted for genesis accounts) The identifying hash of the transaction that funded this account. |
initial_balance |
String - Number | (Omitted for genesis accounts) The amount of XRP that funded this account. |
genesis_balance |
String - Number | (Genesis accounts only) The amount of XRP this account held as of ledger #32570. |
genesis_index |
Number - Sequence Number | (Genesis accounts only) The transaction sequence number of the account as of ledger #32570. |
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 has a different provider, currency pair, or both.
| Field | Value | Description |
|---|---|---|
base_amount |
Number | The amount of the base currency that was traded. |
counter_amount |
Number | The amount of the counter currency that was traded. |
rate |
Number | The amount of the counter currency acquired per 1 unit of the base currency. |
autobridged_currency |
String - Currency Code | (May be omitted) If the offer was autobridged (XRP order books were used to bridge two non-XRP currencies), this is the other currency from the offer that executed this exchange. |
autobridged_issuer |
String - Address | (May be omitted) If the offer was autobridged (XRP order books were used to bridge two non-XRP currencies), this is the other currency from the offer that executed this exchange. |
base_currency |
String - Currency Code | The base currency. |
base_issuer |
String - Address | (Omitted for XRP) The account that issued the base currency. |
buyer |
String - Address | The account that acquired the base currency. |
client |
String | (May be omitted) If the transaction contains a memo indicating what client application sent it, this is the contents of the memo. |
counter_currency |
String - Currency Code | The counter currency. |
counter_issuer |
String - Address | (Omitted for XRP) The account that issued the counter currency. |
executed_time |
String - Timestamp | The time the exchange occurred. |
ledger_index |
Number - Ledger Index | The sequence number of the ledger that included this transaction. |
offer_sequence |
Number - Sequence Number | The sequence number of the provider's existing offer in the ledger. |
provider |
String - Address | The account that had an existing Offer in the ledger. |
seller |
String - Address | The account that acquired the counter currency. |
taker |
String - Address | The account that sent the transaction which executed this exchange. |
tx_hash |
String - Hash | The identifying hash of the transaction that executed this exchange. (Note: This exchange may be one of several executed in a single transaction.) |
tx_type |
String | The type of transaction that executed this exchange, either Payment or OfferCreate. |
Reports objects show the activity of a given account over a specific interval of time, typically a day. Reports have the following fields:
| Field | Value | Description |
|---|---|---|
account |
String - Address | The address of the account to which this report pertains. |
date |
String - Timestamp | The start of the interval to which this report pertains. |
high_value_received |
String - Number | Largest amount received in a single transaction, normalized to XRP (as closely as possible). This includes payments and exchanges. |
high_value_sent |
String - Number | The largest amount sent in a single transaction, normalized to XRP (as closely as possible). |
payments |
Array of Payment Summary Objects | (May be omitted) Array with information on each payment sent or received by the account during this interval. |
payments_received |
Number | The number of payments sent to this account. (This only includes payments for which this account was the destination, not payments that only rippled through the account or consumed the account's offers.) |
payments_sent |
Number | The number of payments sent by this account. |
receiving_counterparties |
Array or Number | If account lists requested, an array of addresses that received payments from this account. Otherwise, the number of different accounts that received payments from this account. |
sending_counterparties |
Array or Number | If account lists requested, an array of addresses that sent payments to this account. Otherwise, the number of different accounts that sent payments to this account. |
total_value |
String - Number | Sum of total value received and sent in payments, normalized to XRP (as closely as possible). |
total_value_received |
String - Number | Sum value of all payments to this account, normalized to XRP (as closely as possible). |
total_value_sent |
String - Number | Sum value of all payments from this account, normalized to XRP (as closely as possible). |
A Payment Summary Object contains a reduced amount of information about a single payment from the perspective of either the sender or receiver of that payment.
| Field | Value | Description |
|---|---|---|
tx_hash |
String - Hash | The identifying hash of the transaction that caused the payment. |
delivered_amount |
String - Number | The amount of the destination currency actually received by the destination account. |
currency |
String - Currency Code | The currency delivered to the recipient of the transaction. |
issuer |
String - Address | The gateway issuing the currency, or an empty string for XRP. |
type |
String | Either sent or received, indicating whether the perspective account is sender or receiver of this transaction. |
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:
| Field | Value | Description |
|---|---|---|
amount |
String - Number | The amount of the destination currency that the transaction was instructed to send. In the case of Partial Payments, this is a "maximum" amount. |
delivered_amount |
String - Number | The amount of the destination currency actually received by the destination account. |
destination_balance_changes |
Array | Array of balance change objects, indicating all changes made to the destination account's balances. |
source_balance_changes |
Array | Array of balance change objects, indicating all changes to the source account's balances (except the XRP transaction cost). |
transaction_cost |
String - Number | The amount of XRP spent by the source account on the transaction cost. (Prior to v2.0.4, this parameter was called fee.) |
destination_tag |
Integer | (May be omitted) A destination tag specified in this payment. |
source_tag |
Integer | (May be omitted) A source tag specified in this payment. |
currency |
String - Currency Code | The currency that the destination account received. |
destination |
String - Address | The account that received the payment. |
executed_time |
String - Timestamp | The time the ledger that included this payment closed. |
ledger_index |
Number - Ledger Index | The sequence number of the ledger that included this payment. |
source |
String - Address | The account that sent the payment. |
source_currency |
String - Currency Code | The currency that the source account spent. |
tx_hash |
String - Hash | The identifying hash of the transaction that caused the payment. |
Balance objects 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:
| Field | Value | Description |
|---|---|---|
counterparty |
String - Address | The counterparty, or issuer, of the currency. In the case of XRP, this is an empty string. |
currency |
String - Currency Code | The currency for which this balance changed. |
value |
String - Number | The amount of the currency that the associated account gained or lost. In balance change objects, this value can be positive (for amounts gained) or negative (for amounts lost). In balance objects, this value can be positive (for amounts the counterparty owes the account) or negative (for amounts owed to the counterparty). |
Balance Change Descriptors are objects that describe and analyze a single balance change that occurs in transaction execution. They represent the same events as balance change objects, but in greater detail.
Balance Change Descriptors have the following fields:
| Field | Value | Description |
|---|---|---|
amount_change |
String - Number | The difference in the amount of currency held before and after this change. (Prior to v2.0.6, this field was called change.) |
final_balance |
String - Number | The balance after the change occurred. |
node_index |
Number (or null) |
This balance change is represented by the entry at this index of the ModifiedNodes array within the metadata section of the transaction that executed this balance change. Note: When the transaction cost is combined with other changes to XRP balance, the transaction cost has a node_index of null instead. |
tx_index |
Number | The transaction that executed this balance change is at this index in the array of transactions for the ledger that included it. |
change_type |
String | One of several describing what caused this balance change to occur. |
currency |
String - Currency Code | The change affected this currency. |
executed_time |
String - Timestamp | The time the change occurred. (This is based on the close time of the ledger that included the transaction that executed the change. |
counterparty |
String - Address | (Omitted for XRP) The currency is held in a trust line to or from this account. (Prior to v2.0.6, this field was called issuer.) |
ledger_index |
Number - Ledger Index | The sequence number of the ledger that included the transaction that executed this balance change. |
tx_hash |
String - Hash | The identifying hash of the transaction that executed this balance change. |
The following values are valid for the change_type field of a Balance Change Descriptor:
| Value | Meaning |
|---|---|
transaction_cost |
This balance change reflects XRP that was destroyed to relay a transaction. (Prior to v2.0.4, this was network fee instead.) |
payment_destination |
This balance change reflects currency that was received from a payment. |
payment_source |
This balance change reflects currency that was spent in a payment. |
exchange |
This balance change reflects currency that was traded for other currency, or the same currency from a different issuer. This can occur in the middle of payment execution as well as from offers. |
Volume objects represent the total volumes of money moved, in either payments or exchanges, during a given period.
| Field | Value | Description |
|---|---|---|
components |
Array of Objects | The data that was used to assemble this total. For payment volume, each object represents payments in a particular currency and issuer. For exchange volume, each object represents a market between two currencies. |
count |
Number | The total number of exchanges in this period. |
endTime |
String - Timestamp | The end time of this interval. |
exchange |
Object | Indicates the display currency used, as with fields currency and (except for XRP) issuer. All amounts are normalized by first converting to XRP, and then to the display currency specified in the request. |
exchangeRate |
Number | The exchange rate to the displayed currency from XRP. |
startTime |
String - Timestamp | The start of this period. |
total |
Number | Total volume of all recorded exchanges in the period. |
A "Server Object" describes one rippled server in the Ripple peer-to-peer network. Server objects are returned by the Get Topology, Get Toplogy Nodes, and Get Topology Node methods. The Data API collects reported network topology approximately every 30 seconds using the peer crawler.
Server objects have the following fields, with some only appearing if the request specified a verbose response:
| Field | Value | Description |
|---|---|---|
node_public_key |
String - Base-58 Public Key | The public key used by this server to sign its peer-to-peer communications, not including validations. |
version |
String | The rippled version of this server, when it was last asked. |
uptime |
Integer | Number of seconds this server has been connected to the network. |
ip |
String | (May be omitted) IP address of the node (may be omitted) |
port |
Integer | (May be omitted) Port where this server speaks the rippled Peer Protocol. |
inbound_count |
Integer | (May be omitted) Number of inbound peer-to-peer connections to this server. |
inbound_added |
String | (May be omitted) Number of new inbound peer-to-peer connections since the last measurement. |
inbound_dropped |
String | (May be omitted) Number of inbound peer-to-peer connections dropped since the last measurement. |
outbound_count |
Integer | (May be omitted) Number of outbound peer-to-peer connections to this server. |
outbound_added |
String | (May be omitted) Number of new outbound peer-to-peer connections since the last measurement. |
outbound_dropped |
String | (May be omitted) Number of outbound peer-to-peer connections dropped since the last measurement. |
city |
String | (Verbose only) The city where this server is located, according to IP geolocation. |
region |
String | (Verbose only) The region where this server is located, according to IP geolocation. |
country |
String | (Verbose only) The country where this server is located, according to IP geolocation. |
region_code |
String | (Verbose only) The ISO code for the region where this server is located, according to IP geolocation. |
country_code |
String | (Verbose only) The ISO code for the country where this server is located, according to IP geolocation. |
postal_code |
String | (Verbose only) The postal code where this server is located, according to IP geolocation. |
timezone |
String | (Verbose only) The ISO timezone where this server is located, according to IP geolocation. |
lat |
String | (Verbose only) The latitude where this server is located, according to IP geolocation. |
long |
String | (Verbose only) The longitude where this server is located, according to IP geolocation. |
isp |
String | (Verbose only) The Internet Service Provider hosting this server's public IP address. |
org |
String | (Verbose only) The organization that owns this server's public IP address. |
A Link Object represents a peer-to-peer network connection between two rippled servers. It has the following fields:
| Field | Value | Description |
|---|---|---|
source |
String - Base-58 Public Key | The node public key of the rippled making the outgoing connection. |
target |
String - Base-58 Public Key | The node public key of the rippled receiving the incoming connection. |
A Validation Object represents one vote from a validator to mark a ledger version as validated. (A ledger is only validated by the consensus process if a quorum of trusted validators votes for the same exact ledger version.)
Note: The Data API retain only about 6 months of validation vote data.
A Validation Object has the following fields:
| Field | Value | Description |
|---|---|---|
count |
Integer | (May be omitted) The number of rippled servers that reported seeing this validation. Not available for old data. |
ledger_hash |
String - Hash | The hash of the ledger version this validation vote applies to. |
reporter_public_key |
String - Base-58 Public Key | The public key of the rippled server that first reported this validation, in base-58. |
validation_public_key |
String - Base-58 Public Key | The public key of the validator used to sign this validation, in base-58. |
signature |
String | The validator's signature of the validation details, in hexadecimal. |
first_datetime |
String - Timestamp | Date and time of the first report of this validation. |
last_datetime |
String - Timestamp | Date and time of the last report of this validation. |
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 run the historical database indefinitely, or you want access to historical transactions from within your own intranet.
The Historical Database requires the following software installed first:
Version 2 of the Historical Database requires HBase instead of PostgreSQL. Postgres support is deprecated.
To install the Data API v2:
-
Install HBase. For production use, configure it in distributed mode.
-
Clone the Historical Database Git Repository:
git clone https://github.com/ripple/rippled-historical-database.git(You can also download and extract a zipped release instead.)
-
Use npm to install additional modules:
cd rippled-historical-database npm installThe install script creates the required config files:
config/api.config.jsonandconfig/import.config.json -
Change the config files as needed. Remove the
postgressection fromapi.config.json.
Reports, stats, and aggregated exchange data needs more 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 Data API is installed. See Services for the different components that you can run.
Dependencies:
$ docker-compose build
$ docker-compose up -d hbase
$ docker-compose run webapp npm test
The rippled Historical Database consists of several processes that can be run separately.
- Live Ledger Importer - Monitors
rippledfor newly-validated ledgers. Command:node import/live - Backfiller - Populates the database with older ledgers from a
rippledinstance. 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), ornode api/server.js(start once)
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
rippledserver that has the historical ledgers, and retrieve them. (Later, you can reconfigure therippledserver not to keep 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.
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, the Importer may still 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
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.
Caution: 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