true, and the MultiSign amendment is enabled, also returns any SignerList objects associated with this account. (New in version 0.31.0)true, and the MultiSign amendment is enabled, also returns any SignerList objects associated with this account. (New in version 0.31.0)signer_lists and at least one SignerList is associated with the account.) Array of SignerList ledger nodes associated with this account for Multi-Signing. Since an account can own at most 1 SignerList, this array should always have exactly 1 member if it is present. (New in version 0.31.0)signer_lists and at least one SignerList is associated with the account.) Array of SignerList ledger nodes associated with this account for Multi-Signing. Since an account can own at most 1 SignerList, this array should always have exactly 1 member if it is present. (New in version 0.31.0)taker_pays divided by the original taker_gets. When executing offers, the offer with the most favorable (lowest) quality is consumed first; offers with the same quality are executed from oldest to newest. (New in version 0.29.0)taker_pays divided by the original taker_gets. When executing offers, the offer with the most favorable (lowest) quality is consumed first; offers with the same quality are executed from oldest to newest. (New in version 0.29.0)account_tx metho
The gateway_balances command calculates the total balances issued by a given account, optionally excluding amounts held by specific "hot wallet" addresses. (New in version 0.28.2.)
The gateway_balances command calculates the total balances issued by a given account, optionally excluding amounts held by specific "hot wallet" addresses. (New in version 0.28.2.)
An example of the request format:
account_tx metho
Use the wallet_propose method to generate a key pair and Ripple address. This command only generates keys, and does not affect the Ripple Consensus Ledger itself in any way. To become a funded account in the Ripple Consensus Ledger, an address must receive a Payment transaction that provides enough XRP to meet the reserve requirement.
Use the wallet_propose method to generate a key pair and Ripple address. This command only generates keys, and does not affect the Ripple Consensus Ledger itself in any way. To become a funded address stored in the ledger, the address must receive a Payment transaction that provides enough XRP to meet the reserve requirement.
The wallet_propose request is an admin command that cannot be run by unpriviledged users! (This command is restricted to protect against people sniffing network traffic for account secrets, since admin commands are not usually transmitted over the outside network.)
(Updated in version 0.31.0)
+(Updated in version 0.31.0)
An example of the request format:
transactions and expand are both true, and this option is also true, return transaction information in binary format instead of JSON format. (New in version 0.28.0)transactions and expand are both true, and this option is also true, return transaction information in binary format instead of JSON format. (New in version 0.28.0)invalidParams - One or more fields are specified incorrectly, or one or more required fields are missing. This error can also occur if you specify a ledger index equal or higher than the current in-progress ledger.lgrNotFound - If the ledger is not yet available. This indicates that the server has started fetching the ledger, although it may fail if none of its connected peers have the requested ledger. (Note: Prior to version 0.30.1, this error used the code ledgerNotFound instead.)lgrNotFound - If the ledger is not yet available. This indicates that the server has started fetching the ledger, although it may fail if none of its connected peers have the requested ledger. (Note: Prior to version 0.30.1, this error used the code ledgerNotFound instead.)"-1" (for XRP) or provide -1 as the contents of the value field (for non-XRP currencies). This requests a path to deliver as much as possible, while spending no more than the amount specified in send_max (if provided)."-1" (for XRP) or provide -1 as the contents of the value field (for non-XRP currencies). This requests a path to deliver as much as possible, while spending no more than the amount specified in send_max (if provided).source_currencies. (New in version 0.30.0)source_currencies. (New in version 0.30.0)false, this is the result of an incomplete search, and a subsequent reply may have a better path. If true, then this is the best path found. (It is still theoretically possible that a better path could exist, but rippled won't find it.) Until you close the pathfinding request, rippled will continue to send updates each time a new ledger closes. (New in version 0.29.0)false, this is the result of an incomplete search, and a subsequent reply may have a better path. If true, then this is the best path found. (It is still theoretically possible that a better path could exist, but rippled won't find it.) Until you close the pathfinding request, rippled will continue to send updates each time a new ledger closes. (New in version 0.29.0)The ripple_path_find method is a simplified version of path_find that provides a single response with a payment path you can use right away. It is available in both the WebSocket and JSON-RPC APIs. However, the results tend to become outdated as time passes. Instead of making many subsequent calls, you should use path_find instead where possible.
Although the rippled server attempts to find the cheapest path or combination of paths for making a payment, it is not guaranteed that the paths returned by this method are, in fact, the best paths. Due to server load, pathfinding may not find the best results. Additionally, you should be careful with the pathfinding results from untrusted servers. A server could be modified to return less-than-optimal paths in order to earn money for its operators. If you do not have your own server that you can trust with pathfinding, you should compare the results of pathfinding from multiple servers operated by different parties, to minimize the risk of a single server returning poor results. (Note: A server returning less-than-optimal results is not necessarily proof of malicious behavior; it could also be a symptom of heavy server load.)
Although the rippled server attempts to find the cheapest path or combination of paths for making a payment, it is not guaranteed that the paths returned by this method are, in fact, the best paths.
Caution: Be careful with the pathfinding results from untrusted servers. A server could be modified to return less-than-optimal paths in order to earn money for its operators. A server may also return poor results when under heavy load. If you do not have your own server that you can trust with pathfinding, you should compare the results of pathfinding from multiple servers operated by different parties, to minimize the risk of a single server returning poor results.
An example of the request format:
"-1" (for XRP) or provide -1 as the contents of the value field (for non-XRP currencies). This requests a path to deliver as much as possible, while spending no more than the amount specified in send_max (if provided)."-1" (for XRP) or provide -1 as the contents of the value field (for non-XRP currencies). This requests a path to deliver as much as possible, while spending no more than the amount specified in send_max (if provided).source_currencies. (New in version 0.30.0)source_currencies. (New in version 0.30.0)fee_mult_max to create a fractional multiplier for the limit. Specifically, the server multiplies its base transaction cost by fee_mult_max, then divides by this value (rounding down to an integer) to get a limit. If the automatically-provided Fee value would be over the limit, signing fails. (New in version 0.30.1)fee_mult_max to create a fractional multiplier for the limit. Specifically, the server multiplies its base transaction cost by fee_mult_max, then divides by this value (rounding down to an integer) to get a limit. If the automatically-provided Fee value would be over the limit, signing fails. (New in version 0.30.1)The sign_for command provides one signature for a multi-signed transaction.
This command requires the MultiSign amendment to be enabled. (New in version 0.31.0)
+This command requires the MultiSign amendment to be enabled. (New in version 0.31.0)
An example of the request format:
This mode is intended for testing. It signs a transaction and immediately submits it. You cannot use this mode for multi-signed transactions.
+This mode signs a transaction and immediately submits it. This mode is intended to be used for testing. You cannot use this mode for multi-signed transactions.
You can provide the secret key used to sign the transaction in the following ways:
secret value and omit the key_type field. This value can be formatted as base-58 seed, RFC-1751, hexadecimal, or as a string passphrase. (secp256k1 keys only)fee_mult_max to create a fractional multiplier for the limit. Specifically, the server multiplies its base transaction cost by fee_mult_max, then divides by this value (rounding down to an integer) to get a limit. If the automatically-provided Fee value would be over the limit, the submit command fails. (New in version 0.30.1)fee_mult_max to create a fractional multiplier for the limit. Specifically, the server multiplies its base transaction cost by fee_mult_max, then divides by this value (rounding down to an integer) to get a limit. If the automatically-provided Fee value would be over the limit, the submit command fails. (New in version 0.30.1)The submit_multisigned command applies a multi-signed transaction and sends it to the network to be included in future ledgers. (You can also submit multi-signed transactions in binary form using the submit command in submit-only mode.)
This command requires the MultiSign amendment to be enabled. (New in version 0.31.0)
+This command requires the MultiSign amendment to be enabled. (New in version 0.31.0)
An example of the request format:
(New in version 0.29.0)
+(New in version 0.29.0)
The validations stream sends messages whenever it receives validation messages, also called validation votes, from validators it trusts. The message looks like the following:
{
"type": "validationReceived",
@@ -8802,7 +8803,7 @@ rippled book_offers 'USD/rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B' 'EUR/rvYAfWj5gh67oV6
ledger_index
String - Integer
-The Ledger Index of the proposed ledger. (New in version 0.31.0)
+The Ledger Index of the proposed ledger. (New in version 0.31.0)
signature
@@ -9639,22 +9640,22 @@ rippled server_info
state_accounting
Object
-A map of various server states with information about the time the server spends in each. This can be useful for tracking the long-term health of your server's connectivity to the network. (New in version 0.30.1)
+A map of various server states with information about the time the server spends in each. This can be useful for tracking the long-term health of your server's connectivity to the network. (New in version 0.30.1)
state_accounting.*.duration_us
String
-The number of microseconds the server has spent in this state. (This is updated whenever the server transitions into another state.) (New in version 0.30.1)
+The number of microseconds the server has spent in this state. (This is updated whenever the server transitions into another state.) (New in version 0.30.1)
state_accounting.*.transitions
Number
-The number of times the server has transitioned into this state. (New in version 0.30.1)
+The number of times the server has transitioned into this state. (New in version 0.30.1)
uptime
Number
-Number of consecutive seconds that the server has been operational. (New in version 0.30.1)
+Number of consecutive seconds that the server has been operational. (New in version 0.30.1)
validated_ledger
@@ -9994,22 +9995,22 @@ rippled server_state
state_accounting
Object
-A map of various server states with information about the time the server spends in each. This can be useful for tracking the long-term health of your server's connectivity to the network. (New in version 0.30.1)
+A map of various server states with information about the time the server spends in each. This can be useful for tracking the long-term health of your server's connectivity to the network. (New in version 0.30.1)
state_accounting.*.duration_us
String
-The number of microseconds the server has spent in this state. (This is updated whenever the server transitions into another state.) (New in version 0.30.1)
+The number of microseconds the server has spent in this state. (This is updated whenever the server transitions into another state.) (New in version 0.30.1)
state_accounting.*.transitions
Number
-The number of times the server has transitioned into this state. (New in version 0.30.1)
+The number of times the server has transitioned into this state. (New in version 0.30.1)
uptime
Number
-Number of consecutive seconds that the server has been operational. (New in version 0.30.1)
+Number of consecutive seconds that the server has been operational. (New in version 0.30.1)
validated_ledger
@@ -10562,7 +10563,7 @@ Connecting to 127.0.0.1:5005
feature
-The feature command returns information about amendments this server knows about, including whether they are enabled and whether the server is voting in favor of those amendments in the amendment process. (New in version 0.31.0)
+The feature command returns information about amendments this server knows about, including whether they are enabled and whether the server is voting in favor of those amendments in the amendment process. (New in version 0.31.0)
You can use the feature command to temporarily configure the server to vote against or in favor of an amendment. This change does not persist if you restart the server. To make lasting changes in amendment voting, use the rippled.cfg file. See Configuring Amendment Voting for more information.
The feature method is an admin command that cannot be run by unpriviledged users.
Request Format
@@ -10752,7 +10753,7 @@ Connecting to 127.0.0.1:5005
fee
-The fee command reports the current state of the open-ledger requirements for the transaction cost. This requires the FeeEscalation amendment to be enabled. (New in version 0.31.0)
+The fee command reports the current state of the open-ledger requirements for the transaction cost. This requires the FeeEscalation amendment to be enabled. (New in version 0.31.0)
The fee method is an admin command that cannot be run by unpriviledged users.
Request Format
An example of the request format:
@@ -11993,7 +11994,7 @@ Connecting to 127.0.0.1:5005
cluster
Object
-Summary of other rippled servers in the same cluster, if configured as a cluster. (New in version 0.30.1)
+Summary of other rippled servers in the same cluster, if configured as a cluster. (New in version 0.30.1)
peers
@@ -12102,7 +12103,7 @@ Connecting to 127.0.0.1:5005
uptime
Number
-The number of seconds that your rippled server has been continuously connected to this peer. (New in version 0.30.1)
+The number of seconds that your rippled server has been continuously connected to this peer. (New in version 0.30.1)
version