diff --git a/content/reference-rippled.md b/content/reference-rippled.md index 19845a3179..94b6b2b928 100755 --- a/content/reference-rippled.md +++ b/content/reference-rippled.md @@ -418,6 +418,7 @@ Some API methods require you to specify an amount of currency. Depending on whet #### XRP #### [drops of XRP]: #xrp +[XRP, in drops]: #xrp Amounts of XRP are represented as strings. (XRP has precision equivalent to a 64-bit integer, but JSON integers are limited to 32 bits, so XRP can overflow if represented in a JSON integer.) XRP is formally specified in "drops", which are equivalent to 0.000001 (one 1-millionth) of an XRP each. Thus, to represent 1.0 XRP in a JSON document, you would write: @@ -513,12 +514,15 @@ API methods for the Websocket and JSON-RPC APIs are defined by command names, an ## List of Public Commands ## * [`account_currencies` - Get a list of currencies an account can send or receive](#account-currencies) +* [`account_channels` - Get a list of payment channels where the account is the source of the channel](#account-channels) * [`account_info` - Get basic data about an account](#account-info) * [`account_lines` - Get info about an account's trust lines](#account-lines) * [`account_objects` - Get all ledger objects owned by an account](#account-objects) * [`account_offers` - Get info about an account's currency exchange offers](#account-offers) * [`account_tx` - Get info about an account's transactions](#account-tx) * [`book_offers` - Get info about offers to exchange two currencies](#book-offers) +* [`channel_authorize` - Sign a claim for money from a payment channel](#channel-authorize) +* [`channel_verify` - Check a payment channel claim's signature](#channel-verify) * [`fee` - Get information about transaction cost](#fee) * [`gateway_balances` - Calculate total amounts issued by an account](#gateway-balances) * [`ledger` - Get info about a ledger version](#ledger) @@ -632,9 +636,9 @@ The request includes the following parameters: | `Field` | Type | Description | |:---------------|:---------------------------|:-------------------------------| | `account` | String | A unique identifier for the account, most commonly the account's [Address][]. | -| `strict` | Boolean | (Optional) If true, only accept an address or public key for the account parameter. Defaults to false. | -| `ledger_hash` | String | (Optional) A 20-byte hex string for the ledger version to use. (See [Specifying a Ledger](#specifying-ledgers)) | -| `ledger_index` | String or Unsigned Integer | (Optional) The sequence number of the ledger to use, or a shortcut string to choose a ledger automatically. (See [Specifying a Ledger](#specifying-ledgers)) | +| `strict` | Boolean | _(Optional)_ If true, only accept an address or public key for the account parameter. Defaults to false. | +| `ledger_hash` | String | _(Optional)_ A 20-byte hex string for the ledger version to use. (See [Specifying a Ledger](#specifying-ledgers)) | +| `ledger_index` | String or Unsigned Integer | _(Optional)_ The sequence number of the ledger to use, or a shortcut string to choose a ledger automatically. (See [Specifying a Ledger](#specifying-ledgers)) | The following field is deprecated and should not be provided: `account_index`. @@ -737,6 +741,181 @@ The response follows the [standard format](#response-formatting), with a success +## account_channels +[[Source]
](https://github.com/ripple/rippled/blob/release/src/ripple/rpc/handlers/AccountChannels.cpp "Source") + +_(Requires the [PayChan amendment](concept-amendments.html#paychan) to be enabled. [New in: rippled 0.33.0][])_ + +The `account_channels` method returns information about an account's Payment Channels. This includes only channels where the specified account is the channel's source, not the destination. (A channel's "source" and "owner" are the same.) All information retrieved is relative to a particular version of the ledger. + +#### Request Format +An example of the request format: + + + +*WebSocket* + +```json +{ + "id": 1, + "command": "account_channels", + "account": "rN7n7otQDd6FczFgLdSqtcsAUxDkw6fzRH", + "destination_account": "rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn", + "ledger_index": "validated" +} +``` + +*JSON-RPC* + +```json +{ + "method": "account_channels", + "params": [{ + "account": "rN7n7otQDd6FczFgLdSqtcsAUxDkw6fzRH", + "destination_account": "rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn", + "ledger_index": "validated" + }] +} +``` + +*Commandline* + +```bash +#Syntax: account_channels [] [] +rippled account_channels rN7n7otQDd6FczFgLdSqtcsAUxDkw6fzRH rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn validated +``` + + + +The request includes the following parameters: + +| Field | Type | Description | +|:----------------------|:-------------------------------------------|:--------| +| `account` | String | The unique identifier of an account, typically the account's [Address][]. The request returns channels where this account is the channel's owner/source. | +| `destination_account` | String | _(Optional)_ The unique identifier of an account, typically the account's [Address][]. If provided, filter results to payment channels whose destination is this account. | +| `ledger_hash` | String | _(Optional)_ A 20-byte hex string for the ledger version to use. (See [Specifying a Ledger](#specifying-ledgers)) | +| `ledger_index` | String or Unsigned Integer | _(Optional)_ The sequence number of the ledger to use, or a shortcut string to choose a ledger automatically. (See [Specifying a Ledger](#specifying-ledgers)) | +| `limit` | Integer | _(Optional)_ Limit the number of transactions to retrieve. The server is not required to honor this value. Must be within the inclusive range 10 to 400. Defaults to 200. | +| `marker` | [(Not Specified)](#markers-and-pagination) | _(Optional)_ Value from a previous paginated response. Resume retrieving data where that response left off. | + +#### Response Format + +An example of a successful response: + + + +*WebSocket* + +```json +{ + "id": 2, + "status": "success", + "type": "response", + "result": { + "account": "rN7n7otQDd6FczFgLdSqtcsAUxDkw6fzRH", + "channels": [ + { + "account": "rN7n7otQDd6FczFgLdSqtcsAUxDkw6fzRH", + "amount": "100000000", + "balance": "1000000", + "channel_id": "5DB01B7FFED6B67E6B0414DED11E051D2EE2B7619CE0EAA6286D67A3A4D5BDB3", + "destination_account": "rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn", + "destination_tag": 20170428, + "expiration": 547073182, + "public_key": "aB44YfzW24VDEJQ2UuLPV2PvqcPCSoLnL7y5M1EzhdW4LnK5xMS3", + "public_key_hex": "023693F15967AE357D0327974AD46FE3C127113B1110D6044FD41E723689F81CC6", + "settle_delay": 86400 + } + ] + } +} +``` + +*JSON-RPC* + +```json +200 OK + +{ + "result": { + "account": "rN7n7otQDd6FczFgLdSqtcsAUxDkw6fzRH", + "channels": [{ + "account": "rN7n7otQDd6FczFgLdSqtcsAUxDkw6fzRH", + "amount": "100000000", + "balance": "0", + "channel_id": "5DB01B7FFED6B67E6B0414DED11E051D2EE2B7619CE0EAA6286D67A3A4D5BDB3", + "destination_account": "rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn", + "destination_tag": 20170428, + "public_key": "aB44YfzW24VDEJQ2UuLPV2PvqcPCSoLnL7y5M1EzhdW4LnK5xMS3", + "public_key_hex": "023693F15967AE357D0327974AD46FE3C127113B1110D6044FD41E723689F81CC6", + "settle_delay": 86400 + }], + "status": "success" + } +} +``` + +*Commandline* + +```json +200 OK + +{ + "result": { + "account": "rN7n7otQDd6FczFgLdSqtcsAUxDkw6fzRH", + "channels": [{ + "account": "rN7n7otQDd6FczFgLdSqtcsAUxDkw6fzRH", + "amount": "100000000", + "balance": "0", + "channel_id": "5DB01B7FFED6B67E6B0414DED11E051D2EE2B7619CE0EAA6286D67A3A4D5BDB3", + "destination_account": "rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn", + "destination_tag": 20170428, + "public_key": "aB44YfzW24VDEJQ2UuLPV2PvqcPCSoLnL7y5M1EzhdW4LnK5xMS3", + "public_key_hex": "023693F15967AE357D0327974AD46FE3C127113B1110D6044FD41E723689F81CC6", + "settle_delay": 86400 + }], + "status": "success" + } +} +``` + + + +The response follows the [standard format](#response-formatting), with a successful result containing the following fields: + +| Field | Type | Description | +|:-----------|:-------------------------------------------|:-------------------| +| `account` | String | The address of the source/owner of the payment channels. This corresponds to the `account` field of the request. | +| `channels` | Array of Channel Objects | Payment channels owned by this `account`. | +| `limit` | Number | _(May be omitted)_ The limit to how many channel objects were actually returned by this request. | +| `marker` | [(Not Specified)](#markers-and-pagination) | _(May be omitted)_ Server-defined value for pagination. Pass this to the next call to resume getting results where this call left off. Omitted when there are no additional pages after this one. | + +Each Channel Object has the following fields: + +| Field | Type | Description | +|-------|------|-------------| +| `account` | String | The owner of the channel, as an [Address][]. | +| `amount` | String | The total amount of [XRP, in drops](#specifying-currency-amounts) allocated to this channel. | +| `balance` | String | The total amount of XRP, in drops, paid out from this channel, as of the ledger version used. (You can calculate the amount of XRP remaining in the channel by subtracting `balance` from `amount`.) | +| `channel_id` | String | A unique ID for this channel, as a 64-character hexadecimal string. This is also the [index of the channel](reference-ledger-format.html#paychannel-index-format) in the ledger's state data. | +| `destination_account` | String | the destination account of the channel, as an [Address][]. Only this account can receive the XRP in the channel while it remains open. | +| `public_key` | String | _(May be omitted)_ The public key for the payment channel in base58 format. Signed claims against this channel must be redeemed with the matching key pair. | +| `public_key_hex` | String | _(May be omitted)_ The public key for the payment channel in hexadecimal format, if one was specified at channel creation. Signed claims against this channel must be redeemed with the matching key pair. | +| `settle_delay` | Unsigned Integer | The number of seconds the payment channel must remain open after the owner of the channel requests to close it. | +| `expiration` | Unsigned Integer | _(May be omitted)_ Time, in seconds since the [Ripple Epoch](#specifying-time), when this channel is set to expire. This expiration date is mutable. If this is before the close time of the most recent validated ledger, the channel is expired. | +| `cancel_after` | Unsigned Integer | _(May be omitted)_ Time, in seconds since the [Ripple Epoch](#specifying-time), of this channel's immutable expiration, if one was specified at channel creation. If this is before the close time of the most recent validated ledger, the channel is expired. | +| `source_tag` | Unsigned Integer | _(May be omitted)_ A 32-bit unsigned integer to use as a [source tag](tutorial-gateway-guide.html#source-and-destination-tags) for payments through this payment channel, if one was specified at channel creation. This indicates the payment channel's originator or other purpose at the source account. Conventionally, if you bounce payments from this channel, you should specify this value in the `DestinationTag` of the return payment. | +| `destination_tag` | Unsigned Integer | _(May be omitted)_ A 32-bit unsigned integer to use as a [destination tag](tutorial-gateway-guide.html#source-and-destination-tags) for payments through this channel, if one was specified at channel creation. This indicates the payment channel's beneficiary or other purpose at the destination account. | + +#### Possible Errors + +* Any of the [universal error types](#universal-errors). +* `invalidParams` - One or more fields are specified incorrectly, or one or more required fields are missing. +* `actNotFound` - The address specified in the `account` field of the request does not correspond to an account in the ledger. +* `lgrNotFound` - The ledger specified by the `ledger_hash` or `ledger_index` does not exist, or it does exist but the server does not have it. + + + ## account_info ## [[Source]
](https://github.com/ripple/rippled/blob/master/src/ripple/rpc/handlers/AccountInfo.cpp "Source") @@ -794,10 +973,10 @@ The request contains the following parameters: |:---------------|:---------------------------|:-------------------------------| | `account` | String | A unique identifier for the account, most commonly the account's [Address][]. | | `strict` | Boolean | (Optional, defaults to False) If set to True, then the `account` field only accepts a public key or Ripple address. | -| `ledger_hash` | String | (Optional) A 20-byte hex string for the ledger version to use. (See [Specifying a Ledger](#specifying-ledgers)) | -| `ledger_index` | String or Unsigned Integer | (Optional) The sequence number of the ledger to use, or a shortcut string to choose a ledger automatically. (See [Specifying a Ledger](#specifying-ledgers)) | -| `queue` | Boolean | (Optional) If `true`, and the [FeeEscalation amendment](concept-amendments.html#feeescalation) is enabled, also returns stats about queued transactions associated with this account. Can only be used when querying for the data from the current open ledger. [New in: rippled 0.33.0][] | -| `signer_lists` | Boolean | (Optional) If `true`, and the [MultiSign amendment](concept-amendments.html#multisign) is enabled, also returns any [SignerList objects](reference-ledger-format.html#signerlist) associated with this account. [New in: rippled 0.31.0][] | +| `ledger_hash` | String | _(Optional)_ A 20-byte hex string for the ledger version to use. (See [Specifying a Ledger](#specifying-ledgers)) | +| `ledger_index` | String or Unsigned Integer | _(Optional)_ The sequence number of the ledger to use, or a shortcut string to choose a ledger automatically. (See [Specifying a Ledger](#specifying-ledgers)) | +| `queue` | Boolean | _(Optional)_ If `true`, and the [FeeEscalation amendment](concept-amendments.html#feeescalation) is enabled, also returns stats about queued transactions associated with this account. Can only be used when querying for the data from the current open ledger. [New in: rippled 0.33.0][] | +| `signer_lists` | Boolean | _(Optional)_ If `true`, and the [MultiSign amendment](concept-amendments.html#multisign) is enabled, also returns any [SignerList objects](reference-ledger-format.html#signerlist) associated with this account. [New in: rippled 0.31.0][] | The following fields are deprecated and should not be provided: `ident`, `ledger`. @@ -951,7 +1130,7 @@ Each object in the `transactions` array, if present, may contain any or all of t ## account_lines ## [[Source]
](https://github.com/ripple/rippled/blob/master/src/ripple/rpc/handlers/AccountLines.cpp "Source") -The `account_lines` method returns information about the account's lines of trust, including balances in all non-XRP currencies and assets. All information retrieved is relative to a particular version of the ledger. +The `account_lines` method returns information about an account's trust lines, including balances in all non-XRP currencies and assets. All information retrieved is relative to a particular version of the ledger. #### Request Format #### @@ -993,11 +1172,11 @@ The request accepts the following paramters: | `Field` | Type | Description | |:---------------|:-------------------------------------------|:---------------| | `account` | String | A unique identifier for the account, most commonly the account's [Address][]. | -| `ledger_hash` | String | (Optional) A 20-byte hex string for the ledger version to use. (See [Specifying a Ledger](#specifying-ledgers)) | -| `ledger_index` | String or Unsigned Integer | (Optional) The sequence number of the ledger to use, or a shortcut string to choose a ledger automatically. (See [Specifying a Ledger](#specifying-ledgers)) | -| `peer` | String | (Optional) The [Address][] of a second account. If provided, show only lines of trust connecting the two accounts. | -| `limit` | Integer | (Optional, default varies) Limit the number of transactions to retrieve. The server is not required to honor this value. Cannot be smaller than 10 or larger than 400. [New in: rippled 0.26.4][] | -| `marker` | [(Not Specified)](#markers-and-pagination) | (Optional) Value from a previous response to specify where to resume retrieving data from. [New in: rippled 0.26.4][] | +| `ledger_hash` | String | _(Optional)_ A 20-byte hex string for the ledger version to use. (See [Specifying a Ledger](#specifying-ledgers)) | +| `ledger_index` | String or Unsigned Integer | _(Optional)_ The sequence number of the ledger to use, or a shortcut string to choose a ledger automatically. (See [Specifying a Ledger](#specifying-ledgers)) | +| `peer` | String | _(Optional)_ The [Address][] of a second account. If provided, show only lines of trust connecting the two accounts. | +| `limit` | Integer | (Optional, default varies) Limit the number of transactions to retrieve. The server is not required to honor this value. Must be within the inclusive range 10 to 400. [New in: rippled 0.26.4][] | +| `marker` | [(Not Specified)](#markers-and-pagination) | _(Optional)_ Value from a previous paginated response. Resume retrieving data where that response left off. [New in: rippled 0.26.4][] | The following parameters are deprecated and may be removed without further notice: `ledger` and `peer_index`. @@ -1098,18 +1277,18 @@ An example of a successful response: -The response follows the [standard format](#response-formatting), with a successful result containing the address of the account and an array of trust-line objects. Specifically, the result object contains the following fields: +The response follows the [standard format](#response-formatting), with a successful result containing the address of the account and an array of trust line objects. Specifically, the result object contains the following fields: | `Field` | Type | Description | |:-----------------------|:-------------------------------------------|:-------| | `account` | String | Unique [Address][] of the account this request corresponds to. This is the "perspective account" for purpose of the trust lines. | -| `lines` | Array | Array of trust-line objects, as described below. If the number of trust-lines is large, only returns up to the `limit` at a time. | +| `lines` | Array | Array of trust line objects, as described below. If the number of trust lines is large, only returns up to the `limit` at a time. | | `ledger_current_index` | Integer | (Omitted if `ledger_hash` or `ledger_index` provided) Sequence number of the ledger version used when retrieving this data. [New in: rippled 0.26.4-sp1][] | | `ledger_index` | Integer | (Omitted if `ledger_current_index` provided instead) Sequence number, provided in the request, of the ledger version that was used when retrieving this data. [New in: rippled 0.26.4-sp1][] | | `ledger_hash` | String | (May be omitted) Hex hash, provided in the request, of the ledger version that was used when retrieving this data. [New in: rippled 0.26.4-sp1][] | -| `marker` | [(Not Specified)](#markers-and-pagination) | Server-defined value. Pass this to the next call to resume where this call left off. Omitted when there are no additional pages after this one. [New in: rippled 0.26.4][] | +| `marker` | [(Not Specified)](#markers-and-pagination) | Server-defined value indicating the response is paginated. Pass this to the next call to resume where this call left off. Omitted when there are no additional pages after this one. [New in: rippled 0.26.4][] | -Each trust-line object has some combination of the following fields: +Each trust line object has some combination of the following fields: | `Field` | Type | Description | |:-----------------|:-----------------|:---------------------------------------| @@ -1187,10 +1366,10 @@ A request can include the following parameters: |:---------------|:-------------------------------------------|:---------------| | `account` | String | A unique identifier for the account, most commonly the account's [Address][]. | | `ledger` | Unsigned integer, or String | (Deprecated, Optional) A unique identifier for the ledger version to use, such as a ledger sequence number, a hash, or a shortcut such as "validated". | -| `ledger_hash` | String | (Optional) A 20-byte hex string identifying the ledger version to use. | -| `ledger_index` | (Optional) [Ledger Index][] | (Optional, defaults to `current`) The sequence number of the ledger to use, or "current", "closed", or "validated" to select a ledger dynamically. (See [Specifying Ledgers](#specifying-ledgers)) | -| `limit` | Integer | (Optional, default varies) Limit the number of transactions to retrieve. The server is not required to honor this value. Cannot be lower than 10 or higher than 400. [New in: rippled 0.26.4][] | -| `marker` | [(Not Specified)](#markers-and-pagination) | Value from a previous response value to specify where to resume retrieving data from. [New in: rippled 0.26.4][] | +| `ledger_hash` | String | _(Optional)_ A 20-byte hex string identifying the ledger version to use. | +| `ledger_index` | _(Optional)_ [Ledger Index][] | (Optional, defaults to `current`) The sequence number of the ledger to use, or "current", "closed", or "validated" to select a ledger dynamically. (See [Specifying Ledgers](#specifying-ledgers)) | +| `limit` | Integer | (Optional, default varies) Limit the number of transactions to retrieve. The server is not required to honor this value. Must be within the inclusive range 10 to 400. [New in: rippled 0.26.4][] | +| `marker` | [(Not Specified)](#markers-and-pagination) | Value from a previous paginated response. Resume retrieving data where that response left off. [New in: rippled 0.26.4][] | The following parameter is deprecated and may be removed without further notice: `ledger`. @@ -1300,7 +1479,7 @@ The response follows the [standard format](#response-formatting), with a success | `ledger_current_index` | Integer | (Omitted if `ledger_hash` or `ledger_index` provided) Sequence number of the ledger version used when retrieving this data. [New in: rippled 0.26.4-sp1][] | | `ledger_index` | Integer | (Omitted if `ledger_current_index` provided instead) Sequence number, provided in the request, of the ledger version that was used when retrieving this data. [New in: rippled 0.26.4-sp1][] | | `ledger_hash` | String | (May be omitted) Hex hash, provided in the request, of the ledger version that was used when retrieving this data. [New in: rippled 0.26.4-sp1][] | -| `marker` | [(Not Specified)](#markers-and-pagination) | Server-defined value. Pass this to the next call to resume where this call left off. Omitted when there are no pages of information after this one. [New in: rippled 0.26.4][] | +| `marker` | [(Not Specified)](#markers-and-pagination) | Server-defined value indicating the response is paginated. Pass this to the next call to resume where this call left off. Omitted when there are no pages of information after this one. [New in: rippled 0.26.4][] | Each offer object contains the following fields: @@ -1388,11 +1567,11 @@ The request includes the following parameters: | `Field` | Type | Description | |:---------------|:-------------------------------------------|:---------------| | `account` | String | A unique identifier for the account, most commonly the account's address. | -| `type` | String | (Optional) If included, filter results to include only this type of ledger node. Valid types include `state` (trust lines), `offer` (offers), and `ticket` (part of the forthcoming signing process). | -| `ledger_hash` | String | (Optional) A 20-byte hex string for the ledger version to use. (See [Specifying a Ledger](#specifying-ledgers)) | -| `ledger_index` | String or Unsigned Integer | (Optional) The sequence number of the ledger to use, or a shortcut string to choose a ledger automatically. (See [Specifying a Ledger](#specifying-ledgers)) | -| `limit` | Unsigned Integer | (Optional) The maximum number of objects to include in the results. Cannot be less than 10 or higher than 400 on non-admin connections. Defaults to 200. | -| `marker` | [(Not Specified)](#markers-and-pagination) | (Optional) Value from a previous response value to specify where to resume retrieving data from. | +| `type` | String | _(Optional)_ If included, filter results to include only this type of ledger node. Valid types include `state` (trust lines), `offer` (offers), and `ticket` (part of the forthcoming signing process). | +| `ledger_hash` | String | _(Optional)_ A 20-byte hex string for the ledger version to use. (See [Specifying a Ledger](#specifying-ledgers)) | +| `ledger_index` | String or Unsigned Integer | _(Optional)_ The sequence number of the ledger to use, or a shortcut string to choose a ledger automatically. (See [Specifying a Ledger](#specifying-ledgers)) | +| `limit` | Unsigned Integer | _(Optional)_ The maximum number of objects to include in the results. Must be within the inclusive range 10 to 400 on non-admin connections. Defaults to 200. | +| `marker` | [(Not Specified)](#markers-and-pagination) | _(Optional)_ Value from a previous paginated response. Resume retrieving data where that response left off. | #### Response Format #### @@ -1931,7 +2110,7 @@ The response follows the [standard format](#response-formatting), with a success | `ledger_index` | Number | (May be omitted) The sequence number of the ledger version that was used to generate this response. | | `ledger_current_index` | Number | (May be omitted) The sequence number of the current in-progress ledger version that was used to generate this response. | | `limit` | Number | (May be omitted) The limit that was used in this request, if any. | -| `marker` | [(Not Specified)](#markers-and-pagination) | Server-defined value. Pass this to the next call to resume where this call left off. Omitted when there are no additional pages after this one. | +| `marker` | [(Not Specified)](#markers-and-pagination) | Server-defined value indicating the response is paginated. Pass this to the next call to resume where this call left off. Omitted when there are no additional pages after this one. | | `validated` | Boolean | If `true`, this information comes from ledger version that has been validated by consensus. | #### Possible Errors #### @@ -2009,12 +2188,12 @@ The request includes the following parameters: | `account` | String | A unique identifier for the account, most commonly the account's address. | | `ledger_index_min` | Integer | Use to specify the earliest ledger to include transactions from. A value of `-1` instructs the server to use the earliest validated ledger version available. | | `ledger_index_max` | Integer | Use to specify the most recent ledger to include transactions from. A value of `-1` instructs the server to use the most recent validated ledger version available. | -| `ledger_hash` | String | (Optional) Use instead of ledger\_index\_min and ledger\_index\_max to look for transactions from a single ledger only. (See [Specifying a Ledger](#specifying-ledgers)) | -| `ledger_index` | String or Unsigned Integer | (Optional) Use instead of ledger\_index\_min and ledger\_index\_max to look for transactions from a single ledger only. (See [Specifying a Ledger](#specifying-ledgers)) | +| `ledger_hash` | String | _(Optional)_ Use instead of ledger\_index\_min and ledger\_index\_max to look for transactions from a single ledger only. (See [Specifying a Ledger](#specifying-ledgers)) | +| `ledger_index` | String or Unsigned Integer | _(Optional)_ Use instead of ledger\_index\_min and ledger\_index\_max to look for transactions from a single ledger only. (See [Specifying a Ledger](#specifying-ledgers)) | | `binary` | Boolean | (Optional, defaults to False) If set to True, return transactions as hex strings instead of JSON. | | `forward` | boolean | (Optional, defaults to False) If set to True, return values indexed with the oldest ledger first. Otherwise, the results are indexed with the newest ledger first. (Each page of results may not be internally ordered, but the pages are overall ordered.) | | `limit` | Integer | (Optional, default varies) Limit the number of transactions to retrieve. The server is not required to honor this value. | -| `marker` | [(Not Specified)](#markers-and-pagination) | Value from a previous response value to specify where to resume retrieving data from. This value is stable even if there is a change in the server's range of available ledgers. | +| `marker` | [(Not Specified)](#markers-and-pagination) | Value from a previous paginated response. Resume retrieving data where that response left off. This value is stable even if there is a change in the server's range of available ledgers. | [[Source]
](https://github.com/ripple/rippled/blob/master/src/ripple/rpc/handlers/AccountTxSwitch.cpp "Source") There is also a deprecated legacy variation of the `account_tx` method. For that reason, we recommend *not using any of the following fields*: `offset`, `count`, `descending`, `ledger_max`, `ledger_min`. @@ -2514,7 +2693,7 @@ The response follows the [standard format](#response-formatting), with a success | `ledger_index_min` | Integer | The sequence number of the earliest ledger actually searched for transactions. | | `ledger_index_max` | Integer | The sequence number of the most recent ledger actually searched for transactions. | | `limit` | Integer | The `limit` value used in the request. (This may differ from the actual limit value enforced by the server.) | -| `marker` | [(Not Specified)](#markers-and-pagination) | Server-defined value. Pass this to the next call to resume where this call left off. | +| `marker` | [(Not Specified)](#markers-and-pagination) | Server-defined value indicating the response is paginated. Pass this to the next call to resume where this call left off. | | `offset` | Integer | The `offset` value used in the request. | | `transactions` | Array | Array of transactions matching the request's criteria, as explained below. | | `validated` | Boolean | If included and set to `true`, the information in this request comes from a validated ledger version. Otherwise, the information is subject to change. | @@ -2591,10 +2770,10 @@ The request includes the following parameters: |:---------------|:---------------------------|:-------------------------------| | `account` | String | A unique identifier for the account, most commonly the account's address. | | `role` | String | Whether the address refers to a `gateway` or `user`. Recommendations depend on the role of the account. Issuers must have DefaultRipple enabled and must disable NoRipple on all trust lines. Users should have DefaultRipple disabled, and should enable NoRipple on all trust lines. | -| `transactions` | Boolean | (Optional) If `true`, include an array of suggested [transactions](reference-transaction-format.html), as JSON objects, that you can sign and submit to fix the problems. Defaults to false. | -| `limit` | Unsigned Integer | (Optional) The maximum number of trust line problems to include in the results. Defaults to 300. | -| `ledger_hash` | String | (Optional) A 20-byte hex string for the ledger version to use. (See [Specifying a Ledger](#specifying-ledgers)) | -| `ledger_index` | String or Unsigned Integer | (Optional) The sequence number of the ledger to use, or a shortcut string to choose a ledger automatically. (See [Specifying a Ledger](#specifying-ledgers)) | +| `transactions` | Boolean | _(Optional)_ If `true`, include an array of suggested [transactions](reference-transaction-format.html), as JSON objects, that you can sign and submit to fix the problems. Defaults to false. | +| `limit` | Unsigned Integer | _(Optional)_ The maximum number of trust line problems to include in the results. Defaults to 300. | +| `ledger_hash` | String | _(Optional)_ A 20-byte hex string for the ledger version to use. (See [Specifying a Ledger](#specifying-ledgers)) | +| `ledger_index` | String or Unsigned Integer | _(Optional)_ The sequence number of the ledger to use, or a shortcut string to choose a ledger automatically. (See [Specifying a Ledger](#specifying-ledgers)) | #### Response Format #### @@ -2772,10 +2951,10 @@ The request includes the following parameters: | `Field` | Type | Description | |:---------------|:---------------------------|:-------------------------------| | `account` | String | The [Address][] to check. This should be the [issuing address](concept-issuing-and-operational-addresses.html) | -| `strict` | Boolean | (Optional) If true, only accept an address or public key for the account parameter. Defaults to false. | +| `strict` | Boolean | _(Optional)_ If true, only accept an address or public key for the account parameter. Defaults to false. | | `hotwallet` | String or Array | An [operational address](concept-issuing-and-operational-addresses.html) to exclude from the balances issued, or an array of such addresses. | -| `ledger_hash` | String | (Optional) A 20-byte hex string for the ledger version to use. (See [Specifying a Ledger](#specifying-ledgers)) | -| `ledger_index` | String or Unsigned Integer | (Optional) The sequence number of the ledger version to use, or a shortcut string to choose a ledger automatically. (See [Specifying a Ledger](#specifying-ledgers)) | +| `ledger_hash` | String | _(Optional)_ A 20-byte hex string for the ledger version to use. (See [Specifying a Ledger](#specifying-ledgers)) | +| `ledger_index` | String or Unsigned Integer | _(Optional)_ The sequence number of the ledger version to use, or a shortcut string to choose a ledger automatically. (See [Specifying a Ledger](#specifying-ledgers)) | #### Response Format #### @@ -3018,9 +3197,9 @@ The request can contain the following parameters: | `Field` | Type | Description | |:-------------|:-------|:-----------------------------------------------------| | `key_type` | String | Which elliptic curve to use for this key pair. Valid values are `ed25519` and `secp256k1` (all lower case). Defaults to `secp256k1`. | -| `passphrase` | String | (Optional) Generate a key pair and address from this seed value. This value can be formatted in [hexadecimal][], [base58][], [RFC-1751][], or as an arbitrary string. Cannot be used with `seed` or `seed_hex`. | -| `seed` | String | (Optional) Generate the key pair and address from this [base58][]-encoded seed value. Cannot be used with `passphrase` or `seed_hex`. | -| `seed_hex` | String | (Optional) Generate the key pair and address from this seed value in [hexadecimal][] format. Cannot be used with `passphrase` or `seed`. | +| `passphrase` | String | _(Optional)_ Generate a key pair and address from this seed value. This value can be formatted in [hexadecimal][], [base58][], [RFC-1751][], or as an arbitrary string. Cannot be used with `seed` or `seed_hex`. | +| `seed` | String | _(Optional)_ Generate the key pair and address from this [base58][]-encoded seed value. Cannot be used with `passphrase` or `seed_hex`. | +| `seed_hex` | String | _(Optional)_ Generate the key pair and address from this seed value in [hexadecimal][] format. Cannot be used with `passphrase` or `seed`. | You must provide **at most one** of the following fields: `passphrase`, `seed`, or `seed_hex`. If you omit all three, `rippled` uses a random seed. @@ -3195,8 +3374,8 @@ The request can contain the following parameters: | `Field` | Type | Description | |:---------------|:---------------------------|:-------------------------------| -| `ledger_hash` | String | (Optional) A 20-byte hex string for the ledger version to use. (See [Specifying a Ledger](#specifying-ledgers)). | -| `ledger_index` | String or Unsigned Integer | (Optional) The sequence number of the ledger to use, or a shortcut string to choose a ledger automatically. (See [Specifying a Ledger](#specifying-ledgers)) | +| `ledger_hash` | String | _(Optional)_ A 20-byte hex string for the ledger version to use. (See [Specifying a Ledger](#specifying-ledgers)). | +| `ledger_index` | String or Unsigned Integer | _(Optional)_ The sequence number of the ledger to use, or a shortcut string to choose a ledger automatically. (See [Specifying a Ledger](#specifying-ledgers)) | | `full` | Boolean | (Optional, defaults to false) **Admin required** If true, return full information on the entire ledger. Ignored if you did not specify a ledger. (Equivalent to enabling `transactions`, `accounts`, and `expand`.) **Caution:** This is a very large amount of data -- on the order of several hundred megabytes! | | `accounts` | Boolean | (Optional, defaults to false) **Admin required.** If true, return information on accounts in the ledger. Ignored if you did not specify a ledger. **Caution:** This returns a very large amount of data! | | `transactions` | Boolean | (Optional, defaults to false) If true, return information on transactions in the specified ledger version. Ignored if you did not specify a ledger. | @@ -3540,11 +3719,11 @@ A request can include the following fields: | `Field` | Type | Description | |:---------------|:-------------------------------------------|:---------------| | `id` | (Arbitrary) | (WebSocket only) Any identifier to separate this request from others in case the responses are delayed or out of order. | -| `ledger_hash` | String | (Optional) A 20-byte hex string for the ledger version to use. (See [Specifying a Ledger](#specifying-ledgers)) | -| `ledger_index` | String or Unsigned Integer | (Optional) The sequence number of the ledger to use, or a shortcut string to choose a ledger automatically. (See [Specifying a Ledger](#specifying-ledgers)) | +| `ledger_hash` | String | _(Optional)_ A 20-byte hex string for the ledger version to use. (See [Specifying a Ledger](#specifying-ledgers)) | +| `ledger_index` | String or Unsigned Integer | _(Optional)_ The sequence number of the ledger to use, or a shortcut string to choose a ledger automatically. (See [Specifying a Ledger](#specifying-ledgers)) | | `binary` | Boolean | (Optional, defaults to False) If set to true, return data nodes as hashed hex strings instead of JSON. | | `limit` | Integer | (Optional, default varies) Limit the number of nodes to retrieve. The server is not required to honor this value. | -| `marker` | [(Not Specified)](#markers-and-pagination) | Value from a previous response value to specify where to resume retrieving data from. | +| `marker` | [(Not Specified)](#markers-and-pagination) | Value from a previous paginated response. Resume retrieving data where that response left off. | The `ledger` field is deprecated and may be removed without further notice. @@ -3735,7 +3914,7 @@ The response follows the [standard format](#response-formatting), with a success | `ledger_index` | Unsigned Integer | Sequence number of this ledger | | `ledger_hash` | String | Unique identifying hash of the entire ledger. | | `state` | Array | Array of JSON objects containing data from the tree, as defined below | -| `marker` | [(Not Specified)](#markers-and-pagination) | Server-defined value. Pass this to the next call to resume where this call left off. | +| `marker` | [(Not Specified)](#markers-and-pagination) | Server-defined value indicating the response is paginated. Pass this to the next call to resume where this call left off. | The format of each object in the `state` array depends on whether `binary` was set to true or not in the request. Each `state` object may include the following fields: @@ -3811,21 +3990,21 @@ The full list of parameters recognized by this method is as follows: | `Field` | Type | Description | |:------------------------|:---------------------------|:----------------------| -| `index` | String | (Optional) Specify the unique identifier of a single ledger entry to retrieve. | -| `account_root` | String - [Address][] | (Optional) Specify an [AccountRoot node](reference-ledger-format.html#accountroot) to retrieve. | -| `directory` | Object or String | (Optional) Specify a [DirectoryNode](reference-ledger-format.html#directorynode). (Directory nodes each contain a list of IDs for things contained in them.) If a string, interpret as the [unique index](reference-ledger-format.html#tree-format) to the directory, in hex. If an object, requires either `dir_root` or `owner` as a sub-field, plus optionally a `sub_index` sub-field. | -| `directory.sub_index` | Unsigned Integer | (Optional) If provided, jumps to a further sub-node in the [DirectoryNode](reference-ledger-format.html#directorynode). | +| `index` | String | _(Optional)_ Specify the unique identifier of a single ledger entry to retrieve. | +| `account_root` | String - [Address][] | _(Optional)_ Specify an [AccountRoot node](reference-ledger-format.html#accountroot) to retrieve. | +| `directory` | Object or String | _(Optional)_ Specify a [DirectoryNode](reference-ledger-format.html#directorynode). (Directory nodes each contain a list of IDs for things contained in them.) If a string, interpret as the [unique index](reference-ledger-format.html#tree-format) to the directory, in hex. If an object, requires either `dir_root` or `owner` as a sub-field, plus optionally a `sub_index` sub-field. | +| `directory.sub_index` | Unsigned Integer | _(Optional)_ If provided, jumps to a further sub-node in the [DirectoryNode](reference-ledger-format.html#directorynode). | | `directory.dir_root` | String | (Required if `directory` is specified as an object and `directory.owner` is not provided) Unique index identifying the directory to retrieve, as a hex string. | | `directory.owner` | String | (Required if `directory` is specified as an object and `directory.dir_root` is not provided) Unique address of the account associated with this directory | -| `offer` | Object or String | (Optional) Specify an [Offer node](reference-ledger-format.html#offer) to retrieve. If a string, interpret as the [unique index](reference-ledger-format.html#tree-format) to the Offer. If an object, requires the sub-fields `account` and `seq` to uniquely identify the offer. | +| `offer` | Object or String | _(Optional)_ Specify an [Offer node](reference-ledger-format.html#offer) to retrieve. If a string, interpret as the [unique index](reference-ledger-format.html#tree-format) to the Offer. If an object, requires the sub-fields `account` and `seq` to uniquely identify the offer. | | `offer.account` | String - [Address][] | (Required if `offer` specified) The account that placed the offer. | | `offer.seq` | Unsigned Integer | (Required if `offer` specified) The sequence number of the transaction that created the Offer node. | -| `ripple_state` | Object | (Optional) Object specifying the RippleState (trust line) node to retrieve. The `accounts` and `currency` sub-fields are required to uniquely specify the RippleState entry to retrieve. | +| `ripple_state` | Object | _(Optional)_ Object specifying the RippleState (trust line) node to retrieve. The `accounts` and `currency` sub-fields are required to uniquely specify the RippleState entry to retrieve. | | `ripple_state.accounts` | Array | (Required if `ripple_state` specified) 2-length array of account [Address][]es, defining the two accounts linked by this [RippleState node](reference-ledger-format.html#ripplestate) | | `ripple_state.currency` | String | (Required if `ripple_state` specified) [Currency Code][] of the [RippleState node](reference-ledger-format.html#ripplestate) to retrieve. | | `binary` | Boolean | (Optional, defaults to false) If true, return the requested ledger node's contents as a hex string. Otherwise, return data in JSON format. | -| `ledger_hash` | String | (Optional) A 20-byte hex string for the ledger version to use. (See [Specifying a Ledger](#specifying-ledgers)) | -| `ledger_index` | String or Unsigned Integer | (Optional) The sequence number of the ledger to use, or a shortcut string to choose a ledger automatically. (See [Specifying a Ledger](#specifying-ledgers)) | +| `ledger_hash` | String | _(Optional)_ A 20-byte hex string for the ledger version to use. (See [Specifying a Ledger](#specifying-ledgers)) | +| `ledger_index` | String or Unsigned Integer | _(Optional)_ The sequence number of the ledger to use, or a shortcut string to choose a ledger automatically. (See [Specifying a Ledger](#specifying-ledgers)) | The `generator` and `ledger` parameters are deprecated and may be removed without further notice. @@ -3936,8 +4115,8 @@ The request includes the following parameters: | `Field` | Type | Description | |:---------------|:-------|:---------------------------------------------------| -| `ledger_index` | Number | (Optional) Retrieve the specified ledger by its [Ledger Index][]. | -| `ledger_hash` | String | (Optional) Retrieve the specified ledger by its identifying [Hash][]. | +| `ledger_index` | Number | _(Optional)_ Retrieve the specified ledger by its [Ledger Index][]. | +| `ledger_hash` | String | _(Optional)_ Retrieve the specified ledger by its identifying [Hash][]. | You must provide either `ledger_index` or `ledger_hash` but not both. @@ -4408,8 +4587,8 @@ The request includes the following parameters: | `Field` | Type | Description | |:---------------|:---------------------------|:-------------------------------| -| `ledger_hash` | String | (Optional) A 20-byte hex string for the ledger version to use. (See [Specifying a Ledger](#specifying-ledgers)) | -| `ledger_index` | String or Unsigned Integer | (Optional) The sequence number of the ledger to use, or a shortcut string to choose a ledger automatically. (See [Specifying a Ledger](#specifying-ledgers)) | +| `ledger_hash` | String | _(Optional)_ A 20-byte hex string for the ledger version to use. (See [Specifying a Ledger](#specifying-ledgers)) | +| `ledger_index` | String or Unsigned Integer | _(Optional)_ The sequence number of the ledger to use, or a shortcut string to choose a ledger automatically. (See [Specifying a Ledger](#specifying-ledgers)) | | `tx_hash` | String | Unique hash of the transaction you are looking up | **Note:** This method does not support retrieving information from the current in-progress ledger. You must specify a ledger version in either `ledger_index` or `ledger_hash`. @@ -5528,8 +5707,8 @@ The request includes the following parameters: | `source_account` | String | Unique address of the account to find a path from. (In other words, the account that would be sending a payment.) | | `destination_account` | String | Unique address of the account to find a path to. (In other words, the account that would receive a payment.) | | `destination_amount` | String or Object | [Currency amount](#specifying-currency-amounts) that the destination account would receive in a transaction. **Special case:** [New in: rippled 0.30.0][] You can specify `"-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). | -| `send_max` | String or Object | (Optional) [Currency amount](#specifying-currency-amounts) that would be spent in the transaction. Not compatible with `source_currencies`. [New in: rippled 0.30.0][] | -| `paths` | Array | (Optional) Array of arrays of objects, representing [payment paths](concept-paths.html) to check. You can use this to keep updated on changes to particular paths you already know about, or to check the overall cost to make a payment along a certain path. | +| `send_max` | String or Object | _(Optional)_ [Currency amount](#specifying-currency-amounts) that would be spent in the transaction. Not compatible with `source_currencies`. [New in: rippled 0.30.0][] | +| `paths` | Array | _(Optional)_ Array of arrays of objects, representing [payment paths](concept-paths.html) to check. You can use this to keep updated on changes to particular paths you already know about, or to check the overall cost to make a payment along a certain path. | The server also recognizes the following fields, but the results of using them are not guaranteed: `source_currencies`, `bridges`. These fields should be considered reserved for future use. @@ -6138,10 +6317,10 @@ The request includes the following parameters: | `source_account` | String | Unique address of the account that would send funds in a transaction | | `destination_account` | String | Unique address of the account that would receive funds in a transaction | | `destination_amount` | String or Object | [Currency amount](#specifying-currency-amounts) that the destination account would receive in a transaction. **Special case:** [New in: rippled 0.30.0][] You can specify `"-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). | -| `send_max` | String or Object | (Optional) [Currency amount](#specifying-currency-amounts) that would be spent in the transaction. Cannot be used with `source_currencies`. [New in: rippled 0.30.0][] | -| `source_currencies` | Array | (Optional) Array of currencies that the source account might want to spend. Each entry in the array should be a JSON object with a mandatory `currency` field and optional `issuer` field, like how [currency amounts](#specifying-currency-amounts) are specified. Cannot contain more than **18** source currencies. By default, uses all source currencies available up to a maximum of **88** different currency/issuer pairs. | -| `ledger_hash` | String | (Optional) A 20-byte hex string for the ledger version to use. (See [Specifying a Ledger](#specifying-ledgers)) | -| `ledger_index` | String or Unsigned Integer | (Optional) The sequence number of the ledger to use, or a shortcut string to choose a ledger automatically. (See [Specifying a Ledger](#specifying-ledgers)) | +| `send_max` | String or Object | _(Optional)_ [Currency amount](#specifying-currency-amounts) that would be spent in the transaction. Cannot be used with `source_currencies`. [New in: rippled 0.30.0][] | +| `source_currencies` | Array | _(Optional)_ Array of currencies that the source account might want to spend. Each entry in the array should be a JSON object with a mandatory `currency` field and optional `issuer` field, like how [currency amounts](#specifying-currency-amounts) are specified. Cannot contain more than **18** source currencies. By default, uses all source currencies available up to a maximum of **88** different currency/issuer pairs. | +| `ledger_hash` | String | _(Optional)_ A 20-byte hex string for the ledger version to use. (See [Specifying a Ledger](#specifying-ledgers)) | +| `ledger_index` | String or Unsigned Integer | _(Optional)_ The sequence number of the ledger to use, or a shortcut string to choose a ledger automatically. (See [Specifying a Ledger](#specifying-ledgers)) | #### Response Format #### @@ -6480,13 +6659,13 @@ The request includes the following parameters: | `Field` | Type | Description | |:---------------|:--------|:--------------------------------------------------| | `tx_json` | Object | [Transaction definition](reference-transaction-format.html) in JSON format | -| `secret` | String | (Optional) Secret key of the account supplying the transaction, used to sign it. Do not send your secret to untrusted servers or through unsecured network connections. Cannot be used with `key_type`, `seed`, `seed_hex`, or `passphrase`. | -| `seed` | String | (Optional) Secret key of the account supplying the transaction, used to sign it. Must be in [base58][] format. If provided, you must also specify the `key_type`. Cannot be used with `secret`, `seed_hex`, or `passphrase`. | -| `seed_hex` | String | (Optional) Secret key of the account supplying the transaction, used to sign it. Must be in hexadecimal format. If provided, you must also specify the `key_type`. Cannot be used with `secret`, `seed`, or `passphrase`. | -| `passphrase` | String | (Optional) Secret key of the account supplying the transaction, used to sign it, as a string passphrase. If provided, you must also specify the `key_type`. Cannot be used with `secret`, `seed`, or `seed_hex`. | -| `key_type` | String | (Optional) Type of cryptographic key provided in this request. Valid types are `secp256k1` or `ed25519`. Defaults to `secp256k1`. Cannot be used with `secret`. **Caution:** Ed25519 support is experimental. | +| `secret` | String | _(Optional)_ Secret key of the account supplying the transaction, used to sign it. Do not send your secret to untrusted servers or through unsecured network connections. Cannot be used with `key_type`, `seed`, `seed_hex`, or `passphrase`. | +| `seed` | String | _(Optional)_ Secret key of the account supplying the transaction, used to sign it. Must be in [base58][] format. If provided, you must also specify the `key_type`. Cannot be used with `secret`, `seed_hex`, or `passphrase`. | +| `seed_hex` | String | _(Optional)_ Secret key of the account supplying the transaction, used to sign it. Must be in hexadecimal format. If provided, you must also specify the `key_type`. Cannot be used with `secret`, `seed`, or `passphrase`. | +| `passphrase` | String | _(Optional)_ Secret key of the account supplying the transaction, used to sign it, as a string passphrase. If provided, you must also specify the `key_type`. Cannot be used with `secret`, `seed`, or `seed_hex`. | +| `key_type` | String | _(Optional)_ Type of cryptographic key provided in this request. Valid types are `secp256k1` or `ed25519`. Defaults to `secp256k1`. Cannot be used with `secret`. **Caution:** Ed25519 support is experimental. | | `offline` | Boolean | (Optional, defaults to false) If true, when constructing the transaction, do not try to automatically fill in or validate values. | -| `build_path` | Boolean | (Optional) If provided for a Payment-type transaction, automatically fill in the `Paths` field before signing. **Caution:** The server looks for the presence or absence of this field, not its value. This behavior may change. | +| `build_path` | Boolean | _(Optional)_ If provided for a Payment-type transaction, automatically fill in the `Paths` field before signing. **Caution:** The server looks for the presence or absence of this field, not its value. This behavior may change. | | `fee_mult_max` | Integer | (Optional, defaults to 10; recommended value 1000) Limits how high the [automatically-provided `Fee` field](reference-transaction-format.html#auto-fillable-fields) can be. Signing fails with the error `rpcHIGH_FEE` if the current [load multiplier on the transaction cost](concept-transaction-cost.html#local-load-cost) is greater than (`fee_mult_max` ÷ `fee_div_max`). Ignored if you specify the `Fee` field of the transaction ([transaction cost](concept-transaction-cost.html)). | | `fee_div_max` | Integer | (Optional, defaults to 1) Signing fails with the error `rpcHIGH_FEE` if the current [load multiplier on the transaction cost](concept-transaction-cost.html#local-load-cost) is greater than (`fee_mult_max` ÷ `fee_div_max`). Ignored if you specify the `Fee` field of the transaction ([transaction cost](concept-transaction-cost.html)). [New in: rippled 0.30.1][] | @@ -6709,11 +6888,11 @@ The request includes the following parameters: |:-------------|:---------------------|:---------------------------------------| | `account` | String - [Address][] | The address which is providing the signature. | | `tx_json` | Object | The [Transaction](reference-transaction-format.html) to sign. Unlike using the [`sign` command](#sign), all fields of the transaction must be provided, including `Fee` and `Sequence`. The transaction must include the field `SigningPubKey` with an empty string as the value. The object may optionally contain a `Signers` array with previously-collected signatures. | -| `secret` | String | (Optional) The secret key to sign with. (Cannot be used with `key_type`.) | -| `passphrase` | String | (Optional) A passphrase to use as the secret key to sign with. | -| `seed` | String | (Optional) A [base58][]-encoded secret key to sign with. | -| `seed_hex` | String | (Optional) A hexadecimal secret key to sign with. | -| `key_type` | String | (Optional) The type of key to use for signing. This can be `secp256k1` or `ed25519`. (Ed25519 support is experimental.) | +| `secret` | String | _(Optional)_ The secret key to sign with. (Cannot be used with `key_type`.) | +| `passphrase` | String | _(Optional)_ A passphrase to use as the secret key to sign with. | +| `seed` | String | _(Optional)_ A [base58][]-encoded secret key to sign with. | +| `seed_hex` | String | _(Optional)_ A hexadecimal secret key to sign with. | +| `key_type` | String | _(Optional)_ The type of key to use for signing. This can be `secp256k1` or `ed25519`. (Ed25519 support is experimental.) | You must provide exactly 1 field with the secret key. You can use any of the following fields: `secret`, `passphrase`, `seed`, or `seed_hex`. @@ -6924,14 +7103,14 @@ The request includes the following parameters: | `Field` | Type | Description | |:---------------|:--------|:--------------------------------------------------| | `tx_json` | Object | [Transaction definition](reference-transaction-format.html) in JSON format, optionally omitting any auto-fillable fields. | -| `secret` | String | (Optional) Secret key of the account supplying the transaction, used to sign it. Do not send your secret to untrusted servers or through unsecured network connections. Cannot be used with `key_type`, `seed`, `seed_hex`, or `passphrase`. | -| `seed` | String | (Optional) Secret key of the account supplying the transaction, used to sign it. Must be in [base58][] format. If provided, you must also specify the `key_type`. Cannot be used with `secret`, `seed_hex`, or `passphrase`. | -| `seed_hex` | String | (Optional) Secret key of the account supplying the transaction, used to sign it. Must be in hexadecimal format. If provided, you must also specify the `key_type`. Cannot be used with `secret`, `seed`, or `passphrase`. | -| `passphrase` | String | (Optional) Secret key of the account supplying the transaction, used to sign it, as a string passphrase. If provided, you must also specify the `key_type`. Cannot be used with `secret`, `seed`, or `seed_hex`. | -| `key_type` | String | (Optional) Type of cryptographic key provided in this request. Valid types are `secp256k1` or `ed25519`. Defaults to `secp256k1`. Cannot be used with `secret`. **Caution:** Ed25519 support is experimental. | +| `secret` | String | _(Optional)_ Secret key of the account supplying the transaction, used to sign it. Do not send your secret to untrusted servers or through unsecured network connections. Cannot be used with `key_type`, `seed`, `seed_hex`, or `passphrase`. | +| `seed` | String | _(Optional)_ Secret key of the account supplying the transaction, used to sign it. Must be in [base58][] format. If provided, you must also specify the `key_type`. Cannot be used with `secret`, `seed_hex`, or `passphrase`. | +| `seed_hex` | String | _(Optional)_ Secret key of the account supplying the transaction, used to sign it. Must be in hexadecimal format. If provided, you must also specify the `key_type`. Cannot be used with `secret`, `seed`, or `passphrase`. | +| `passphrase` | String | _(Optional)_ Secret key of the account supplying the transaction, used to sign it, as a string passphrase. If provided, you must also specify the `key_type`. Cannot be used with `secret`, `seed`, or `seed_hex`. | +| `key_type` | String | _(Optional)_ Type of cryptographic key provided in this request. Valid types are `secp256k1` or `ed25519`. Defaults to `secp256k1`. Cannot be used with `secret`. **Caution:** Ed25519 support is experimental. | | `fail_hard` | Boolean | (Optional, defaults to false) If true, and the transaction fails locally, do not retry or relay the transaction to other servers | | `offline` | Boolean | (Optional, defaults to false) If true, when constructing the transaction, do not try to automatically fill in or validate values. | -| `build_path` | Boolean | (Optional) If provided for a Payment-type transaction, automatically fill in the `Paths` field before signing. You must omit this field if the transaction is a direct XRP-to-XRP transfer. **Caution:** The server looks for the presence or absence of this field, not its value. This behavior may change. | +| `build_path` | Boolean | _(Optional)_ If provided for a Payment-type transaction, automatically fill in the `Paths` field before signing. You must omit this field if the transaction is a direct XRP-to-XRP transfer. **Caution:** The server looks for the presence or absence of this field, not its value. This behavior may change. | | `fee_mult_max` | Integer | (Optional, defaults to 10, recommended value 1000) If the `Fee` parameter is omitted, this field limits the automatically-provided `Fee` value so that it is less than or equal to the long-term base transaction cost times this value. | | `fee_div_max` | Integer | (Optional, defaults to 1) Used with `fee_mult_max` to create a fractional multiplier for the limit. Specifically, the server multiplies its base [transaction cost](concept-transaction-cost.html) 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: rippled 0.30.1][] | @@ -7451,10 +7630,10 @@ The request includes the following parameters: | `Field` | Type | Description | |:---------------|:---------------------------|:-------------------------------| -| `ledger_hash` | String | (Optional) A 20-byte hex string for the ledger version to use. (See [Specifying a Ledger](#specifying-ledgers)) | -| `ledger_index` | String or Unsigned Integer | (Optional) The sequence number of the ledger to use, or a shortcut string to choose a ledger automatically. (See [Specifying a Ledger](#specifying-ledgers)) | -| `limit` | Unsigned Integer | (Optional) If provided, the server does not provide more than this many offers in the results. The total number of results returned may be fewer than the limit, because the server omits unfunded offers. | -| `taker` | String | (Optional) The [Address][] of an account to use as a perspective. [Unfunded offers](reference-transaction-format.html#lifecycle-of-an-offer) placed by this account are always included in the response. (You can use this to look up your own orders to cancel them.) | +| `ledger_hash` | String | _(Optional)_ A 20-byte hex string for the ledger version to use. (See [Specifying a Ledger](#specifying-ledgers)) | +| `ledger_index` | String or Unsigned Integer | _(Optional)_ The sequence number of the ledger to use, or a shortcut string to choose a ledger automatically. (See [Specifying a Ledger](#specifying-ledgers)) | +| `limit` | Unsigned Integer | _(Optional)_ If provided, the server does not provide more than this many offers in the results. The total number of results returned may be fewer than the limit, because the server omits unfunded offers. | +| `taker` | String | _(Optional)_ The [Address][] of an account to use as a perspective. [Unfunded offers](reference-transaction-format.html#lifecycle-of-an-offer) placed by this account are always included in the response. (You can use this to look up your own orders to cancel them.) | | `taker_gets` | Object | Specification of which currency the account taking the offer would receive, as an object with `currency` and `issuer` fields (omit issuer for XRP), like [currency amounts](#specifying-currency-amounts). | | `taker_pays` | Object | Specification of which currency the account taking the offer would pay, as an object with `currency` and `issuer` fields (omit issuer for XRP), like [currency amounts](#specifying-currency-amounts). | @@ -7571,6 +7750,247 @@ In addition to the standard Offer fields, the following fields may be included i +## channel_authorize +[[Source]
](https://github.com/ripple/rippled/blob/d4a56f223a3b80f64ff70b4e90ab6792806929ca/src/ripple/rpc/handlers/PayChanClaim.cpp#L41 "Source") + +_(Requires the [PayChan amendment](concept-amendments.html#paychan) to be enabled. [New in: rippled 0.33.0][])_ + +The `channel_authorize` method creates a signature that can be used to redeem a specific amount of XRP from a payment channel. + +#### Request Format +An example of the request format: + + + +*WebSocket* + +``` +{ + "id": "channel_authorize_example_id1", + "command": "channel_authorize", + "channel_id": "5DB01B7FFED6B67E6B0414DED11E051D2EE2B7619CE0EAA6286D67A3A4D5BDB3", + "secret": "s████████████████████████████", + "amount": "1000000" +} +``` + +*JSON-RPC* + +```json +POST http://localhost:5005/ +Content-Type: application/json + +{ + "method": "channel_authorize", + "params": [{ + "channel_id": "5DB01B7FFED6B67E6B0414DED11E051D2EE2B7619CE0EAA6286D67A3A4D5BDB3", + "secret": "s████████████████████████████", + "amount": "1000000" + }] +} +``` + +*Commandline* + +``` +#Syntax: channel_authorize +rippled channel_authorize s████████████████████████████ 5DB01B7FFED6B67E6B0414DED11E051D2EE2B7619CE0EAA6286D67A3A4D5BDB3 1000000 +``` + + + +The request includes the following parameters: + +| Field | Type | Description | +|-------|------|-------------| +| `channel_id` | String | The unique ID of the payment channel to use. +| `secret` | String | The secret key to use to sign the claim. This must be the same key pair as the public key specified in the channel. | +| `amount` | String | Cumulative amount of XRP, in drops, to authorize. If the destination has already received a lesser amount of XRP from this channel, the signature created by this method can be redeemed for the difference. | + +**Note:** You cannot use Ed25519 keys to sign claims with this method. This is a known bug. + +#### Response Format + +An example of a successful response: + + + +*WebSocket* + +``` +{ + "id": "channel_authorize_example_id1", + "status": "success" + "result": { + "signature": "304402204EF0AFB78AC23ED1C472E74F4299C0C21F1B21D07EFC0A3838A420F76D783A400220154FB11B6F54320666E4C36CA7F686C16A3A0456800BBC43746F34AF50290064", + } +} +``` + +*JSON-RPC* + +```json +200 OK + +{ + "result": { + "signature": "304402204EF0AFB78AC23ED1C472E74F4299C0C21F1B21D07EFC0A3838A420F76D783A400220154FB11B6F54320666E4C36CA7F686C16A3A0456800BBC43746F34AF50290064", + "status": "success" + } +} +``` + +*Commandline* + +``` +{ + "result": { + "signature": "304402204EF0AFB78AC23ED1C472E74F4299C0C21F1B21D07EFC0A3838A420F76D783A400220154FB11B6F54320666E4C36CA7F686C16A3A0456800BBC43746F34AF50290064", + "status": "success" + } +} +``` + + + +The response follows the [standard format](#response-formatting), with a successful result containing the following fields: + +| Field | Type | Description | +|-------|------|-------------| +| `signature` | String | The signature for this claim, as a hexadecimal value. To verify this signature or process the claim, the destination account of the payment channel must send a [PaymentChannelClaim transaction][] with this signature, the exact Channel ID, XRP amount, and public key of the channel. | + +#### Possible Errors + +* Any of the [universal error types](#universal-errors). +* `badSeed` - The value specified in the `secret` field was not a valid secret key. +* `channelAmtMalformed` - The value specified in the `amount` field was not a valid XRP amount. See [Specifying Currency Amounts](#specifying-currency-amounts) for details. +* `channelMalformed` - The value specified in the `channel_id` field of the reqeuest was not a valid Channel ID. The Channel ID should be a 256-bit (64-character) hexadecimal string. + + + +## channel_verify +[[Source]
](https://github.com/ripple/rippled/blob/d4a56f223a3b80f64ff70b4e90ab6792806929ca/src/ripple/rpc/handlers/PayChanClaim.cpp#L89 "Source") + +_(Requires the [PayChan amendment](concept-amendments.html#paychan) to be enabled. [New in: rippled 0.33.0][])_ + +The `channel_verify` method checks the validity of a signature that can be used to redeem a specific amount of XRP from a payment channel. + +#### Request Format #### +An example of the request format: + + + +*WebSocket* + +``` +{ + "id": 1, + "command": "channel_verify", + "channel_id": "5DB01B7FFED6B67E6B0414DED11E051D2EE2B7619CE0EAA6286D67A3A4D5BDB3", + "signature": "304402204EF0AFB78AC23ED1C472E74F4299C0C21F1B21D07EFC0A3838A420F76D783A400220154FB11B6F54320666E4C36CA7F686C16A3A0456800BBC43746F34AF50290064", + "public_key": "aB44YfzW24VDEJQ2UuLPV2PvqcPCSoLnL7y5M1EzhdW4LnK5xMS3", + "amount": "1000000" +} +``` + +*JSON-RPC* + +``` +POST http://localhost:5005/ +Content-Type: application/json + +{ + "method": "channel_verify", + "params": [{ + "channel_id": "5DB01B7FFED6B67E6B0414DED11E051D2EE2B7619CE0EAA6286D67A3A4D5BDB3", + "signature": "304402204EF0AFB78AC23ED1C472E74F4299C0C21F1B21D07EFC0A3838A420F76D783A400220154FB11B6F54320666E4C36CA7F686C16A3A0456800BBC43746F34AF50290064", + "public_key": "aB44YfzW24VDEJQ2UuLPV2PvqcPCSoLnL7y5M1EzhdW4LnK5xMS3", + "amount": "1000000" + }] +} +``` + +*Commandline* + +``` +#Syntax: channel_verify +rippled channel_verify aB44YfzW24VDEJQ2UuLPV2PvqcPCSoLnL7y5M1EzhdW4LnK5xMS3 5DB01B7FFED6B67E6B0414DED11E051D2EE2B7619CE0EAA6286D67A3A4D5BDB3 1000000 304402204EF0AFB78AC23ED1C472E74F4299C0C21F1B21D07EFC0A3838A420F76D783A400220154FB11B6F54320666E4C36CA7F686C16A3A0456800BBC43746F34AF50290064 +``` + + + +The request includes the following parameters: + +| Field | Type | Description | +|-------|------|-------------| +| `amount` | String | The amount of [XRP, in drops][], the provided `signature` authorizes. | +| `channel_id` | String | The Channel ID of the channel that provides the XRP. This is a 64-character hexadecimal string. | +| `public_key` | String | The public key of the channel and the key pair that was used to create the signature, in base58 format. (One way to get the public key in base58 format is to use the [`wallet_propose` command](#wallet-propose).) | +| `signature` | String | The signature to verify, in hexadecimal. | + +#### Response Format #### + +An example of a successful response: + + + +*WebSocket* + +``` +{ + "id": 1, + "status": "success", + "type": "response", + "result": { + "signature_verified":true + } +} +``` + +*JSON-RPC* + +``` +200 OK + +{ + "result": { + "signature_verified":true, + "status":"success" + } +} +``` + +*Commandline* + +``` +{ + "result": { + "signature_verified":true, + "status":"success" + } +} +``` + + + +The response follows the [standard format](#response-formatting), with a successful result containing the following fields: + +| Field | Type | Description | +|-------|------|-------------| +| `signature_verified` | Boolean | If `true`, the signature is valid for the stated amount, channel, and public key. | + +**Caution:** This does not indicate check that the channel has sufficient XRP allocated to it. Before considering a claim valid, you should look up the channel in the latest validated ledger and confirm that the channel is open and its `amount` value is equal or greater than the `amount` of the claim. To do so, use the [`account_channels` method](#account-channels). + +#### Possible Errors #### + +* Any of the [universal error types](#universal-errors). +* `invalidParams` - One or more fields are specified incorrectly, or one or more required fields are missing. +* `publicMalformed` - The `public_key` field of the request is not a valid public key in the correct format. Public keys are 33 bytes and must be represented in base58. The base58 representation of account public keys starts with the letter `a`. +* `channelMalformed` - The `channel_id` field of the request is not a valid Channel ID. The Channel ID must be a 256-bit (64-character) hexadecimal string. +* `channelAmtMalformed` - The value specified in the `amount` field was not a valid [XRP amount](#specifying-currency-amounts). + + + # Subscriptions # @@ -7637,13 +8057,13 @@ The request includes the following parameters: | `Field` | Type | Description | |:--------------------|:-------|:----------------------------------------------| -| `streams` | Array | (Optional) Array of string names of generic streams to subscribe to, as explained below | -| `accounts` | Array | (Optional) Array with the unique [base58][] addresses of accounts to monitor for validated transactions. The server sends a notification for any transaction that affects at least one of these accounts. | -| `accounts_proposed` | Array | (Optional) Like `accounts`, but include transactions that are not yet finalized. | -| `books` | Array | (Optional) Array of objects defining [order books](http://www.investopedia.com/terms/o/order-book.asp) to monitor for updates, as detailed below. | +| `streams` | Array | _(Optional)_ Array of string names of generic streams to subscribe to, as explained below | +| `accounts` | Array | _(Optional)_ Array with the unique [base58][] addresses of accounts to monitor for validated transactions. The server sends a notification for any transaction that affects at least one of these accounts. | +| `accounts_proposed` | Array | _(Optional)_ Like `accounts`, but include transactions that are not yet finalized. | +| `books` | Array | _(Optional)_ Array of objects defining [order books](http://www.investopedia.com/terms/o/order-book.asp) to monitor for updates, as detailed below. | | `url` | String | (Optional for Websocket; Required otherwise) URL where the server sends a JSON-RPC callbacks for each event. *Admin-only.* | -| `url_username` | String | (Optional) Username to provide for basic authentication at the callback URL. | -| `url_password` | String | (Optional) Password to provide for basic authentication at the callback URL. | +| `url_username` | String | _(Optional)_ Username to provide for basic authentication at the callback URL. | +| `url_password` | String | _(Optional)_ Password to provide for basic authentication at the callback URL. | The following parameters are deprecated and may be removed without further notice: `user`, `password`, `rt_accounts`. @@ -7699,8 +8119,8 @@ The response follows the [standard format](#response-formatting). The fields con * Any of the [universal error types](#universal-errors). * `invalidParams` - One or more fields are specified incorrectly, or one or more required fields are missing. * `noPermission` - The request included the `url` field, but you are not connected as an admin. -* `unknownStream` - One or more the members of the `streams` field in the request was not recognized as a valid stream name. -* `malformedStream` - The `streams` field of the request was not formatted properly. +* `unknownStream` - One or more the members of the `streams` field of the request is not a valid stream name. +* `malformedStream` - The `streams` field of the request is not formatted properly. * `malformedAccount` - One of the addresses in the `accounts` or `accounts_proposed` fields of the request is not a properly-formatted Ripple address. (**Note:**: You _can_ subscribe to the stream of an address that does not yet have an entry in the global ledger to get a message when that address becomes funded.) * `srcCurMalformed` - One or more `taker_pays` sub-fields of the `books` field in the request is not formatted properly. * `dstAmtMalformed` - One or more `taker_gets` sub-fields of the `books` field in the request is not formatted properly. @@ -8155,10 +8575,10 @@ The parameters in the request are specified almost exactly like the parameters t | `Field` | Type | Description | |:--------------------|:------|:-----------------------------------------------| -| `streams` | Array | (Optional) Array of string names of generic streams to unsubscribe from, including `ledger`, `server`, `transactions`, and `transactions_proposed`. | -| `accounts` | Array | (Optional) Array of unique [base58][] account addresses to stop receiving updates for. (This only stops those messages if you previously subscribed to those accounts specifically. You cannot use this to filter accounts out of the general transactions stream.) | -| `accounts_proposed` | Array | (Optional) Like `accounts`, but for `accounts_proposed` subscriptions that included not-yet-validated transactions. | -| `books` | Array | (Optional) Array of objects defining order books to unsubscribe from, as explained below. | +| `streams` | Array | _(Optional)_ Array of string names of generic streams to unsubscribe from, including `ledger`, `server`, `transactions`, and `transactions_proposed`. | +| `accounts` | Array | _(Optional)_ Array of unique [base58][] account addresses to stop receiving updates for. (This only stops those messages if you previously subscribed to those accounts specifically. You cannot use this to filter accounts out of the general transactions stream.) | +| `accounts_proposed` | Array | _(Optional)_ Like `accounts`, but for `accounts_proposed` subscriptions that included not-yet-validated transactions. | +| `books` | Array | _(Optional)_ Array of objects defining order books to unsubscribe from, as explained below. | The `rt_accounts` and `url` parameters, and the `rt_transactions` stream name, are deprecated and may be removed without further notice. @@ -8196,7 +8616,7 @@ The response follows the [standard format](#response-formatting), with a success * Any of the [universal error types](#universal-errors). * `invalidParams` - One or more fields are specified incorrectly, or one or more required fields are missing. * `noPermission` - The request included the `url` field, but you are not connected as an admin. -* `malformedStream` - The `streams` field of the request was not formatted properly. +* `malformedStream` - The `streams` field of the request is not formatted properly. * `malformedAccount` - One of the addresses in the `accounts` or `accounts_proposed` fields of the request is not a properly-formatted Ripple address. * **Note:**: You _can_ subscribe to the stream of an address that does not yet have an entry in the global ledger to get a message when that address becomes funded. * `srcCurMalformed` - One or more `taker_pays` sub-fields of the `books` field in the request is not formatted properly. @@ -9343,7 +9763,7 @@ The request includes the following parameters: | `Field` | Type | Description | |:----------|:--------|:-------------------------------------------------------| -| `feature` | String | (Optional) The unique ID of an amendment, as hexadecimal; or the short name of the amendment. If provided, limits the response to one amendment. Otherwise, the response lists all amendments. | +| `feature` | String | _(Optional)_ The unique ID of an amendment, as hexadecimal; or the short name of the amendment. If provided, limits the response to one amendment. Otherwise, the response lists all amendments. | | `vetoed` | Boolean | (Optional; ignored unless `feature` also specified) If true, instructs the server to vote against the amendment specified by `feature`. If false, instructs the server to vote in favor of the amendment. | **Note:** You can configure your server to vote in favor of a new amendment, even if the server does not currently know how to apply that amendment, by specifying the amendment ID in the `feature` field. For example, you might want to do this if you plan to upgrade soon to a new `rippled` version that _does_ support the amendment. @@ -9787,7 +10207,7 @@ For most other entries, the value indicates the number of objects of that type c ## ledger_cleaner ## [[Source]
](https://github.com/ripple/rippled/blob/df54b47cd0957a31837493cd69e4d9aade0b5055/src/ripple/rpc/handlers/LedgerCleaner.cpp "Source") -The `ledger_cleaner` command controls the [Ledger Cleaner](https://github.com/ripple/rippled/blob/f313caaa73b0ac89e793195dcc2a5001786f916f/src/ripple/app/ledger/README.md#the-ledger-cleaner), an asynchronous maintenance process that can find and repair corruption in rippled's database of ledgers. +The `ledger_cleaner` command controls the [Ledger Cleaner](https://github.com/ripple/rippled/blob/f313caaa73b0ac89e793195dcc2a5001786f916f/src/ripple/app/ledger/README.md#the-ledger-cleaner), an asynchronous maintenance process that can find and repair corruption in `rippled`'s database of ledgers. _The `ledger_cleaner` method is an [admin command](#connecting-to-rippled) that cannot be run by unprivileged users._ @@ -9813,13 +10233,13 @@ The request includes the following parameters: | `Field` | Type | Description | |:--------------|:--------------------------------|:---------------------------| -| `ledger` | Number (Ledger Sequence Number) | (Optional) If provided, check and correct this specific ledger only. | -| `max_ledger` | Number (Ledger Sequence Number) | (Optional) Configure the ledger cleaner to check ledgers with sequence numbers equal or lower than this. | -| `min_ledger` | Number (Ledger Sequence Number) | (Optional) Configure the ledger cleaner to check ledgers with sequence numbers equal or higher than this. | -| `full` | Boolean | (Optional) If true, fix ledger state nodes and transations in the specified ledger(s). Defaults to false. Automatically set to `true` if `ledger` is provided. | -| `fix_txns` | Boolean | (Optional) If true, correct transaction in the specified ledger(s). Overrides `full` if provided. | -| `check_nodes` | Boolean | (Optional) If true, correct ledger state nodes in the specified ledger(s). Overrides `full` if provided. | -| `stop` | Boolean | (Optional) If true, disable the ledger cleaner. | +| `ledger` | Number (Ledger Sequence Number) | _(Optional)_ If provided, check and correct this specific ledger only. | +| `max_ledger` | Number (Ledger Sequence Number) | _(Optional)_ Configure the ledger cleaner to check ledgers with sequence numbers equal or lower than this. | +| `min_ledger` | Number (Ledger Sequence Number) | _(Optional)_ Configure the ledger cleaner to check ledgers with sequence numbers equal or higher than this. | +| `full` | Boolean | _(Optional)_ If true, fix ledger state nodes and transations in the specified ledger(s). Defaults to false. Automatically set to `true` if `ledger` is provided. | +| `fix_txns` | Boolean | _(Optional)_ If true, correct transaction in the specified ledger(s). Overrides `full` if provided. | +| `check_nodes` | Boolean | _(Optional)_ If true, correct ledger state nodes in the specified ledger(s). Overrides `full` if provided. | +| `stop` | Boolean | _(Optional)_ If true, disable the ledger cleaner. | #### Response Format #### @@ -9851,7 +10271,7 @@ The response follows the [standard format](#response-formatting), with a success #### Possible Errors #### * Any of the [universal error types](#universal-errors). -* `internal` if one the parameters was specified in a way that the server couldn't interpret. (This is a bug, and it should return `invalidParams` instead.) +* `internal` if one the parameters is specified incorrectly. (This is a bug; the intended error code is `invalidParams`.) ## log_level ## @@ -9890,8 +10310,8 @@ The request includes the following parameters: | `Field` | Type | Description | |:------------|:-------|:------------------------------------------------------| -| `severity` | String | (Optional) What level of verbosity to set logging at. Valid values are, in order from least to most verbose: `fatal`, `error`, `warn`, `info`, `debug`, and `trace`. If omitted, return current log verbosity for all categories. | -| `partition` | String | (Optional) Ignored unless `severity` is provided. Which logging category to modify. If omitted, or if provided with the value `base`, set logging level for all categories. | +| `severity` | String | _(Optional)_ What level of verbosity to set logging at. Valid values are, in order from least to most verbose: `fatal`, `error`, `warn`, `info`, `debug`, and `trace`. If omitted, return current log verbosity for all categories. | +| `partition` | String | _(Optional)_ Ignored unless `severity` is provided. Which logging category to modify. If omitted, or if provided with the value `base`, set logging level for all categories. | #### Response Format #### @@ -10116,7 +10536,7 @@ The request includes the following parameters: | `Field` | Type | Description | |:---------|:-------|:---------------------------------------------------------| -| `secret` | String | (Optional) Use this value as a seed to generate the credentials. The same secret always generates the same credentials. You can provide the seed in [RFC-1751](https://tools.ietf.org/html/rfc1751) format or Ripple's [base58][] format. If omitted, generate a random seed. | +| `secret` | String | _(Optional)_ Use this value as a seed to generate the credentials. The same secret always generates the same credentials. You can provide the seed in [RFC-1751](https://tools.ietf.org/html/rfc1751) format or Ripple's [base58][] format. If omitted, generate a random seed. | **Note:** The security of your validator depends on the entropy of your seed. Do not use a secret value that is not sufficiently randomized for real business purposes. We recommend omitting the `secret` when generating new credentials for the first time. @@ -10205,7 +10625,7 @@ The request includes the following parameters: | `Field` | Type | Description | |:---------|:-------|:---------------------------------------------------------| -| `secret` | String | (Optional) If present, use this value as the secret value for the validating key pair. Valid formats include [base58][], [RFC-1751](https://tools.ietf.org/html/rfc1751), or as a passphrase. If omitted, disables proposing validations to the network. | +| `secret` | String | _(Optional)_ If present, use this value as the secret value for the validating key pair. Valid formats include [base58][], [RFC-1751](https://tools.ietf.org/html/rfc1751), or as a passphrase. If omitted, disables proposing validations to the network. | #### Response Format #### @@ -11165,7 +11585,7 @@ The request includes the following parameters: | `Field` | Type | Description | |:--------|:-------|:----------------------------------------------------------| | `ip` | String | IP address of the server to connect to | -| `port` | Number | (Optional) Port number to use when connecting. Defaults to 6561. | +| `port` | Number | _(Optional)_ Port number to use when connecting. Defaults to 6561. | #### Response Format #### @@ -11473,3 +11893,4 @@ Example: {% include 'snippets/rippled_versions.md' %} +{% include 'snippets/tx-type-links.md' %} diff --git a/reference-rippled.html b/reference-rippled.html index 9929a9a089..37573cf3c9 100644 --- a/reference-rippled.html +++ b/reference-rippled.html @@ -168,6 +168,7 @@
  • Commandline Access
  • Account Information
  • account_currencies
    • +
  • account_channels
  • account_info
  • account_lines
  • account_offers
    • @@ -201,6 +202,8 @@
  • Sign-and-Submit Mode
  • submit_multisigned
  • book_offers
    • +
  • channel_authorize
    • +
  • channel_verify
  • Subscriptions
  • subscribe
  • Ledger Stream
    • @@ -816,12 +819,15 @@ Null method

    List of Public Commands

    +

    account_channels

    +

    [Source]

    +

    (Requires the PayChan amendment to be enabled. New in: rippled 0.33.0)

    +

    The account_channels method returns information about an account's Payment Channels. This includes only channels where the specified account is the channel's source, not the destination. (A channel's "source" and "owner" are the same.) All information retrieved is relative to a particular version of the ledger.

    +

    Request Format

    +

    An example of the request format:

    +
    + +
    {
+  "id": 1,
+  "command": "account_channels",
+  "account": "rN7n7otQDd6FczFgLdSqtcsAUxDkw6fzRH",
+  "destination_account": "rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn",
+  "ledger_index": "validated"
+}
+
    + +
    {
+    "method": "account_channels",
+    "params": [{
+        "account": "rN7n7otQDd6FczFgLdSqtcsAUxDkw6fzRH",
+        "destination_account": "rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn",
+        "ledger_index": "validated"
+    }]
+}
+
    + +
    #Syntax: account_channels <account> [<destination_account>] [<ledger>]
+rippled account_channels rN7n7otQDd6FczFgLdSqtcsAUxDkw6fzRH rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn validated
+
    +
    +

    The request includes the following parameters:

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    FieldTypeDescription
    accountStringThe unique identifier of an account, typically the account's Address. The request returns channels where this account is the channel's owner/source.
    destination_accountString(Optional) The unique identifier of an account, typically the account's Address. If provided, filter results to payment channels whose destination is this account.
    ledger_hashString(Optional) A 20-byte hex string for the ledger version to use. (See Specifying a Ledger)
    ledger_indexString or Unsigned Integer(Optional) The sequence number of the ledger to use, or a shortcut string to choose a ledger automatically. (See Specifying a Ledger)
    limitInteger(Optional) Limit the number of transactions to retrieve. The server is not required to honor this value. Must be within the inclusive range 10 to 400. Defaults to 200.
    marker(Not Specified)(Optional) Value from a previous paginated response. Resume retrieving data where that response left off.
    +

    Response Format

    +

    An example of a successful response:

    +
    + +
    {
+  "id": 2,
+  "status": "success",
+  "type": "response",
+  "result": {
+    "account": "rN7n7otQDd6FczFgLdSqtcsAUxDkw6fzRH",
+    "channels": [
+      {
+        "account": "rN7n7otQDd6FczFgLdSqtcsAUxDkw6fzRH",
+        "amount": "100000000",
+        "balance": "1000000",
+        "channel_id": "5DB01B7FFED6B67E6B0414DED11E051D2EE2B7619CE0EAA6286D67A3A4D5BDB3",
+        "destination_account": "rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn",
+        "destination_tag": 20170428,
+        "expiration": 547073182,
+        "public_key": "aB44YfzW24VDEJQ2UuLPV2PvqcPCSoLnL7y5M1EzhdW4LnK5xMS3",
+        "public_key_hex": "023693F15967AE357D0327974AD46FE3C127113B1110D6044FD41E723689F81CC6",
+        "settle_delay": 86400
+      }
+    ]
+  }
+}
+
    + +
    200 OK
+
+{
+    "result": {
+        "account": "rN7n7otQDd6FczFgLdSqtcsAUxDkw6fzRH",
+        "channels": [{
+            "account": "rN7n7otQDd6FczFgLdSqtcsAUxDkw6fzRH",
+            "amount": "100000000",
+            "balance": "0",
+            "channel_id": "5DB01B7FFED6B67E6B0414DED11E051D2EE2B7619CE0EAA6286D67A3A4D5BDB3",
+            "destination_account": "rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn",
+            "destination_tag": 20170428,
+            "public_key": "aB44YfzW24VDEJQ2UuLPV2PvqcPCSoLnL7y5M1EzhdW4LnK5xMS3",
+            "public_key_hex": "023693F15967AE357D0327974AD46FE3C127113B1110D6044FD41E723689F81CC6",
+            "settle_delay": 86400
+        }],
+        "status": "success"
+    }
+}
+
    + +
    200 OK
+
+{
+    "result": {
+        "account": "rN7n7otQDd6FczFgLdSqtcsAUxDkw6fzRH",
+        "channels": [{
+            "account": "rN7n7otQDd6FczFgLdSqtcsAUxDkw6fzRH",
+            "amount": "100000000",
+            "balance": "0",
+            "channel_id": "5DB01B7FFED6B67E6B0414DED11E051D2EE2B7619CE0EAA6286D67A3A4D5BDB3",
+            "destination_account": "rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn",
+            "destination_tag": 20170428,
+            "public_key": "aB44YfzW24VDEJQ2UuLPV2PvqcPCSoLnL7y5M1EzhdW4LnK5xMS3",
+            "public_key_hex": "023693F15967AE357D0327974AD46FE3C127113B1110D6044FD41E723689F81CC6",
+            "settle_delay": 86400
+        }],
+        "status": "success"
+    }
+}
+
    +
    +

    The response follows the standard format, with a successful result containing the following fields:

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    FieldTypeDescription
    accountStringThe address of the source/owner of the payment channels. This corresponds to the account field of the request.
    channelsArray of Channel ObjectsPayment channels owned by this account.
    limitNumber(May be omitted) The limit to how many channel objects were actually returned by this request.
    marker(Not Specified)(May be omitted) Server-defined value for pagination. Pass this to the next call to resume getting results where this call left off. Omitted when there are no additional pages after this one.
    +

    Each Channel Object has the following fields:

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    FieldTypeDescription
    accountStringThe owner of the channel, as an Address.
    amountStringThe total amount of XRP, in drops allocated to this channel.
    balanceStringThe total amount of XRP, in drops, paid out from this channel, as of the ledger version used. (You can calculate the amount of XRP remaining in the channel by subtracting balance from amount.)
    channel_idStringA unique ID for this channel, as a 64-character hexadecimal string. This is also the index of the channel in the ledger's state data.
    destination_accountStringthe destination account of the channel, as an Address. Only this account can receive the XRP in the channel while it remains open.
    public_keyString(May be omitted) The public key for the payment channel in base58 format. Signed claims against this channel must be redeemed with the matching key pair.
    public_key_hexString(May be omitted) The public key for the payment channel in hexadecimal format, if one was specified at channel creation. Signed claims against this channel must be redeemed with the matching key pair.
    settle_delayUnsigned IntegerThe number of seconds the payment channel must remain open after the owner of the channel requests to close it.
    expirationUnsigned Integer(May be omitted) Time, in seconds since the Ripple Epoch, when this channel is set to expire. This expiration date is mutable. If this is before the close time of the most recent validated ledger, the channel is expired.
    cancel_afterUnsigned Integer(May be omitted) Time, in seconds since the Ripple Epoch, of this channel's immutable expiration, if one was specified at channel creation. If this is before the close time of the most recent validated ledger, the channel is expired.
    source_tagUnsigned Integer(May be omitted) A 32-bit unsigned integer to use as a source tag for payments through this payment channel, if one was specified at channel creation. This indicates the payment channel's originator or other purpose at the source account. Conventionally, if you bounce payments from this channel, you should specify this value in the DestinationTag of the return payment.
    destination_tagUnsigned Integer(May be omitted) A 32-bit unsigned integer to use as a destination tag for payments through this channel, if one was specified at channel creation. This indicates the payment channel's beneficiary or other purpose at the destination account.
    +

    Possible Errors

    +
      +
    • Any of the universal error types.
      • +
    • invalidParams - One or more fields are specified incorrectly, or one or more required fields are missing.
      • +
    • actNotFound - The address specified in the account field of the request does not correspond to an account in the ledger.
      • +
    • lgrNotFound - The ledger specified by the ledger_hash or ledger_index does not exist, or it does exist but the server does not have it.
      • +

    account_info

    [Source]

    The account_info command retrieves information about an account, its activity, and its XRP balance. All information retrieved is relative to a particular version of the ledger.

    -

    Request Format

    +

    Request Format

    An example of an account_info request:

    -
    +
    -
    {
+
    {
   "id": 2,
   "command": "account_info",
   "account": "r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59",
@@ -1073,7 +1333,7 @@ Null method
 }
 
    
 
-
    {
+
    {
     "method": "account_info",
     "params": [
         {
@@ -1086,7 +1346,7 @@ Null method
 }
 
    
 
-
    #Syntax: account_info account [ledger_index|ledger_hash] [strict]
+
    #Syntax: account_info account [ledger_index|ledger_hash] [strict]
 rippled account_info r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59 true
 
    
 
    
@@ -1114,31 +1374,31 @@ rippled account_info r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59 true
 
 ledger_hash
 String
-(Optional) A 20-byte hex string for the ledger version to use. (See Specifying a Ledger)
+(Optional) A 20-byte hex string for the ledger version to use. (See Specifying a Ledger)
 
 
 ledger_index
 String or Unsigned Integer
-(Optional) The sequence number of the ledger to use, or a shortcut string to choose a ledger automatically. (See Specifying a Ledger)
+(Optional) The sequence number of the ledger to use, or a shortcut string to choose a ledger automatically. (See Specifying a Ledger)
 
 
 queue
 Boolean
-(Optional) If true, and the FeeEscalation amendment is enabled, also returns stats about queued transactions associated with this account. Can only be used when querying for the data from the current open ledger. New in: rippled 0.33.0
+(Optional) If true, and the FeeEscalation amendment is enabled, also returns stats about queued transactions associated with this account. Can only be used when querying for the data from the current open ledger. New in: rippled 0.33.0
 
 
 signer_lists
 Boolean
-(Optional) If true, and the MultiSign amendment is enabled, also returns any SignerList objects associated with this account. New in: rippled 0.31.0
+(Optional) If true, and the MultiSign amendment is enabled, also returns any SignerList objects associated with this account. New in: rippled 0.31.0
 
 
 
 
    The following fields are deprecated and should not be provided: ident, ledger.
    
-
    Response Format
    
+
    Response Format
    
 
    An example of a successful response:
    
-
    
+
    
 
-
    {
+
    {
     "id": 5,
     "status": "success",
     "type": "response",
@@ -1185,7 +1445,7 @@ rippled account_info r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59 true
 }
 
    
 
-
    {
+
    {
     "result": {
         "account_data": {
             "Account": "rG1QQv2nh2gr7RCZ1P8YYcBUKCCN633jCn",
@@ -1351,7 +1611,7 @@ rippled account_info r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59 true
 
 
 
-
    Possible Errors
    
+
    Possible Errors
    
 
      
 
    • Any of the universal error types.
      • 
 
    • invalidParams - One or more fields are specified incorrectly, or one or more required fields are missing. For example, the request specified queue as true but specified a ledger_index that is not the current open ledger.
      • 
@@ -1360,12 +1620,12 @@ rippled account_info r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59 true
 
    
 
    account_lines
    
 
    [Source]
    
-
    The account_lines method returns information about the account's lines of trust, including balances in all non-XRP currencies and assets. All information retrieved is relative to a particular version of the ledger.
    
-
    Request Format
    
+
    The account_lines method returns information about an account's trust lines, including balances in all non-XRP currencies and assets. All information retrieved is relative to a particular version of the ledger.
    
+
    Request Format
    
 
    An example of the request format:
    
-
    
+
    
 
-
    {
+
    {
   "id": 1,
   "command": "account_lines",
   "account": "r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59",
@@ -1373,7 +1633,7 @@ rippled account_info r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59 true
 }
 
    
 
-
    {
+
    {
     "method": "account_lines",
     "params": [
         {
@@ -1403,36 +1663,36 @@ rippled account_info r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59 true
 
 ledger_hash
 String
-(Optional) A 20-byte hex string for the ledger version to use. (See Specifying a Ledger)
+(Optional) A 20-byte hex string for the ledger version to use. (See Specifying a Ledger)
 
 
 ledger_index
 String or Unsigned Integer
-(Optional) The sequence number of the ledger to use, or a shortcut string to choose a ledger automatically. (See Specifying a Ledger)
+(Optional) The sequence number of the ledger to use, or a shortcut string to choose a ledger automatically. (See Specifying a Ledger)
 
 
 peer
 String
-(Optional) The Address of a second account. If provided, show only lines of trust connecting the two accounts.
+(Optional) The Address of a second account. If provided, show only lines of trust connecting the two accounts.
 
 
 limit
 Integer
-(Optional, default varies) Limit the number of transactions to retrieve. The server is not required to honor this value. Cannot be smaller than 10 or larger than 400. New in: rippled 0.26.4
+(Optional, default varies) Limit the number of transactions to retrieve. The server is not required to honor this value. Must be within the inclusive range 10 to 400. New in: rippled 0.26.4
 
 
 marker
 (Not Specified)
-(Optional) Value from a previous response to specify where to resume retrieving data from. New in: rippled 0.26.4
+(Optional) Value from a previous paginated response. Resume retrieving data where that response left off. New in: rippled 0.26.4
 
 
 
 
    The following parameters are deprecated and may be removed without further notice: ledger and peer_index.
    
-
    Response Format
    
+
    Response Format
    
 
    An example of a successful response:
    
-
    
+
    
 
-
    {
+
    {
     "id": 1,
     "status": "success",
     "type": "response",
@@ -1474,7 +1734,7 @@ rippled account_info r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59 true
 }
 
    
 
-
    200 OK
+
    200 OK
 {
     "result": {
         "account": "r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59",
@@ -1515,7 +1775,7 @@ rippled account_info r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59 true
 }
 
    
 
    
-
    The response follows the standard format, with a successful result containing the address of the account and an array of trust-line objects. Specifically, the result object contains the following fields:
    
+
    The response follows the standard format, with a successful result containing the address of the account and an array of trust line objects. Specifically, the result object contains the following fields:
    
 
@@ -1533,7 +1793,7 @@ rippled account_info r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59 true
 
-
+
@@ -1553,11 +1813,11 @@ rippled account_info r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59 true
 
-
+
    
 
 
    
 lines
 ArrayArray of trust-line objects, as described below. If the number of trust-lines is large, only returns up to the limit at a time.Array of trust line objects, as described below. If the number of trust lines is large, only returns up to the limit at a time.
 
    
 
    
 ledger_current_index
    
 marker
 (Not Specified)Server-defined value. Pass this to the next call to resume where this call left off. Omitted when there are no additional pages after this one. New in: rippled 0.26.4Server-defined value indicating the response is paginated. Pass this to the next call to resume where this call left off. Omitted when there are no additional pages after this one. New in: rippled 0.26.4
 
    
 
 
    
-
    Each trust-line object has some combination of the following fields:
    
+
    Each trust line object has some combination of the following fields:
    
 
@@ -1624,7 +1884,7 @@ rippled account_info r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59 true
 
    
 
 
    
 
 
    
-
    Possible Errors
    
+
    Possible Errors
    
 
      
 
    • Any of the universal error types.
      • 
 
    • invalidParams - One or more fields are specified incorrectly, or one or more required fields are missing.
      • 
@@ -1635,11 +1895,11 @@ rippled account_info r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59 true
 
      account_offers
      
 
      [Source]
      
 
      The account_offers method retrieves a list of offers made by a given account that are outstanding as of a particular ledger version.
      
-
      Request Format
      
+
      Request Format
      
 
      An example of the request format:
      
-
      
+
      
 
-
      {
+
      {
   "id": 2,
   "command": "account_offers",
   "account": "rpP2JgiMyTF5jR5hLG3xHCPi1knBb1v9cM",
@@ -1647,7 +1907,7 @@ rippled account_info r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59 true
 }
 
      
 
-
      {
+
      {
     "method": "account_offers",
     "params": [
         {
@@ -1658,7 +1918,7 @@ rippled account_info r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59 true
 }
 
      
 
-
      #Syntax: account_offers account [ledger_index]
+
      #Syntax: account_offers account [ledger_index]
 rippled account_offers r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59 current
 
      
 
      
@@ -1686,31 +1946,31 @@ rippled account_offers r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59 current
 
 ledger_hash
 String
-(Optional) A 20-byte hex string identifying the ledger version to use.
+(Optional) A 20-byte hex string identifying the ledger version to use.
 
 
 ledger_index
-(Optional) Ledger Index
+(Optional) Ledger Index
 (Optional, defaults to current) The sequence number of the ledger to use, or "current", "closed", or "validated" to select a ledger dynamically. (See Specifying Ledgers)
 
 
 limit
 Integer
-(Optional, default varies) Limit the number of transactions to retrieve. The server is not required to honor this value. Cannot be lower than 10 or higher than 400. New in: rippled 0.26.4
+(Optional, default varies) Limit the number of transactions to retrieve. The server is not required to honor this value. Must be within the inclusive range 10 to 400. New in: rippled 0.26.4
 
 
 marker
 (Not Specified)
-Value from a previous response value to specify where to resume retrieving data from. New in: rippled 0.26.4
+Value from a previous paginated response. Resume retrieving data where that response left off. New in: rippled 0.26.4
 
 
 
 
      The following parameter is deprecated and may be removed without further notice: ledger.
      
-
      Response Format
      
+
      Response Format
      
 
      An example of a successful response:
      
-
      
+
      
 
-
      {
+
      {
   "id": 9,
   "status": "success",
   "type": "response",
@@ -1747,7 +2007,7 @@ rippled account_offers r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59 current
 }
 
      
 
-
      200 OK
+
      200 OK
 {
     "result": {
         "account": "rpP2JgiMyTF5jR5hLG3xHCPi1knBb1v9cM",
@@ -1831,7 +2091,7 @@ rippled account_offers r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59 current
 
 marker
 (Not Specified)
-Server-defined value. Pass this to the next call to resume where this call left off. Omitted when there are no pages of information after this one. New in: rippled 0.26.4
+Server-defined value indicating the response is paginated. Pass this to the next call to resume where this call left off. Omitted when there are no pages of information after this one. New in: rippled 0.26.4
 
 
 
@@ -1877,7 +2137,7 @@ rippled account_offers r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59 current
 
 
 
-
      Possible Errors
      
+
      Possible Errors
      
 
        
 
      • Any of the universal error types.
        • 
 
      • invalidParams - One or more fields are specified incorrectly, or one or more required fields are missing.
        • 
@@ -1896,11 +2156,11 @@ rippled account_offers r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59 current
 
      • Escrow nodes for held payments that have not yet been executed or canceled.
        • 
 
      • PayChannel nodes for open payment channels.
        • 
 
      
-
      Request Format
      
+
      Request Format
      
 
      An example of the request format:
      
-
      
+
      
 
-
      {
+
      {
   "id": 1,
   "command": "account_objects",
   "account": "r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59",
@@ -1910,7 +2170,7 @@ rippled account_offers r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59 current
 }
 
      
 
-
      {
+
      {
     "method": "account_objects",
     "params": [
         {
@@ -1923,7 +2183,7 @@ rippled account_offers r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59 current
 }
 
      
 
-
      #Syntax: account_objects <account> [<ledger>]
+
      #Syntax: account_objects <account> [<ledger>]
 rippled account_objects r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59 validated
 
      
 
      
@@ -1945,35 +2205,35 @@ rippled account_objects r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59 validated
 
 type
 String
-(Optional) If included, filter results to include only this type of ledger node. Valid types include state (trust lines), offer (offers), and ticket (part of the forthcoming signing process).
+(Optional) If included, filter results to include only this type of ledger node. Valid types include state (trust lines), offer (offers), and ticket (part of the forthcoming signing process).
 
 
 ledger_hash
 String
-(Optional) A 20-byte hex string for the ledger version to use. (See Specifying a Ledger)
+(Optional) A 20-byte hex string for the ledger version to use. (See Specifying a Ledger)
 
 
 ledger_index
 String or Unsigned Integer
-(Optional) The sequence number of the ledger to use, or a shortcut string to choose a ledger automatically. (See Specifying a Ledger)
+(Optional) The sequence number of the ledger to use, or a shortcut string to choose a ledger automatically. (See Specifying a Ledger)
 
 
 limit
 Unsigned Integer
-(Optional) The maximum number of objects to include in the results. Cannot be less than 10 or higher than 400 on non-admin connections. Defaults to 200.
+(Optional) The maximum number of objects to include in the results. Must be within the inclusive range 10 to 400 on non-admin connections. Defaults to 200.
 
 
 marker
 (Not Specified)
-(Optional) Value from a previous response value to specify where to resume retrieving data from.
+(Optional) Value from a previous paginated response. Resume retrieving data where that response left off.
 
 
 
-
      Response Format
      
+
      Response Format
      
 
      An example of a successful response:
      
-
      
+
      
 
-
      {
+
      {
     "id": 8,
     "status": "success",
     "type": "response",
@@ -2230,7 +2490,7 @@ rippled account_objects r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59 validated
 }
 
      
 
-
      200 OK
+
      200 OK
 {
     "result": {
         "account": "r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59",
@@ -2529,7 +2789,7 @@ rippled account_objects r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59 validated
 
 marker
 (Not Specified)
-Server-defined value. Pass this to the next call to resume where this call left off. Omitted when there are no additional pages after this one.
+Server-defined value indicating the response is paginated. Pass this to the next call to resume where this call left off. Omitted when there are no additional pages after this one.
 
 
 validated
@@ -2538,7 +2798,7 @@ rippled account_objects r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59 validated
 
 
 
-
      Possible Errors
      
+
      Possible Errors
      
 
        
 
      • Any of the universal error types.
        • 
 
      • invalidParams - One or more fields are specified incorrectly, or one or more required fields are missing.
        • 
@@ -2548,11 +2808,11 @@ rippled account_objects r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59 validated
 
        account_tx
        
 
        [Source]
        
 
        The account_tx method retrieves a list of transactions that involved the specified account.
        
-
        Request Format
        
+
        Request Format
        
 
        An example of the request format:
        
-
        
+
        
 
-
        {
+
        {
   "id": 2,
   "command": "account_tx",
   "account": "r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59",
@@ -2565,7 +2825,7 @@ rippled account_objects r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59 validated
 }
 
        
 
-
        {
+
        {
     "method": "account_tx",
     "params": [
         {
@@ -2583,7 +2843,7 @@ rippled account_objects r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59 validated
 }
 
        
 
-
        #Syntax account_tx account [ledger_index_min [ledger_index_max [limit]]] [binary] [count] [forward]
+
        #Syntax account_tx account [ledger_index_min [ledger_index_max [limit]]] [binary] [count] [forward]
 rippled account_tx r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59 -1 -1 2 false false false
 
        
 
        
@@ -2616,12 +2876,12 @@ rippled account_tx r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59 -1 -1 2 false false false
 
 ledger_hash
 String
-(Optional) Use instead of ledger_index_min and ledger_index_max to look for transactions from a single ledger only. (See Specifying a Ledger)
+(Optional) Use instead of ledger_index_min and ledger_index_max to look for transactions from a single ledger only. (See Specifying a Ledger)
 
 
 ledger_index
 String or Unsigned Integer
-(Optional) Use instead of ledger_index_min and ledger_index_max to look for transactions from a single ledger only. (See Specifying a Ledger)
+(Optional) Use instead of ledger_index_min and ledger_index_max to look for transactions from a single ledger only. (See Specifying a Ledger)
 
 
 binary
@@ -2641,7 +2901,7 @@ rippled account_tx r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59 -1 -1 2 false false false
 
 marker
 (Not Specified)
-Value from a previous response value to specify where to resume retrieving data from. This value is stable even if there is a change in the server's range of available ledgers.
+Value from a previous paginated response. Resume retrieving data where that response left off. This value is stable even if there is a change in the server's range of available ledgers.
 
 
 
@@ -2650,11 +2910,11 @@ There is also a deprecated legacy variation of the account_tx metho
 
        Iterating over queried data
        
 
        As with other paginated methods, you can use the marker field to return multiple pages of data.
        
 
        In the time between requests, "ledger_index_min": -1 and "ledger_index_max": -1 may change to refer to different ledger versions than they did before. The marker field can safely paginate even if there are changes in the ledger range from the request, so long as the marker does not indicate a point outside the range of ledgers specified in the request.
        
-
        Response Format
        
+
        Response Format
        
 
        An example of a successful response:
        
-
        
+
        
 
-
        {
+
        {
     "id": 2,
     "status": "success",
     "type": "response",
@@ -2888,7 +3148,7 @@ There is also a deprecated legacy variation of the account_tx metho
 }
 
        
 
-
        200 OK
+
        200 OK
 {
     "result": {
         "account": "r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59",
@@ -3154,7 +3414,7 @@ There is also a deprecated legacy variation of the account_tx metho
 
 marker
 (Not Specified)
-Server-defined value. Pass this to the next call to resume where this call left off.
+Server-defined value indicating the response is paginated. Pass this to the next call to resume where this call left off.
 
 
 offset
@@ -3211,7 +3471,7 @@ There is also a deprecated legacy variation of the account_tx metho
 
 
 
-
        Possible Errors
        
+
        Possible Errors
        
 
          
 
        • Any of the universal error types.
          • 
 
        • invalidParams - One or more fields are specified incorrectly, or one or more required fields are missing.
          • 
@@ -3222,11 +3482,11 @@ There is also a deprecated legacy variation of the account_tx metho
 
          noripple_check
          
 
          [Source]
          
 
          The noripple_check command provides a quick way to check the status of the DefaultRipple field for an account and the NoRipple flag of its trust lines, compared with the recommended settings.
          
-
          Request Format
          
+
          Request Format
          
 
          An example of the request format:
          
-
          
+
          
 
-
          {
+
          {
     "id": 0,
     "command": "noripple_check",
     "account": "r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59",
@@ -3237,7 +3497,7 @@ There is also a deprecated legacy variation of the account_tx metho
 }
 
          
 
-
          {
+
          {
     "method": "noripple_check",
     "params": [
         {
@@ -3275,30 +3535,30 @@ There is also a deprecated legacy variation of the account_tx metho
 
 transactions
 Boolean
-(Optional) If true, include an array of suggested transactions, as JSON objects, that you can sign and submit to fix the problems. Defaults to false.
+(Optional) If true, include an array of suggested transactions, as JSON objects, that you can sign and submit to fix the problems. Defaults to false.
 
 
 limit
 Unsigned Integer
-(Optional) The maximum number of trust line problems to include in the results. Defaults to 300.
+(Optional) The maximum number of trust line problems to include in the results. Defaults to 300.
 
 
 ledger_hash
 String
-(Optional) A 20-byte hex string for the ledger version to use. (See Specifying a Ledger)
+(Optional) A 20-byte hex string for the ledger version to use. (See Specifying a Ledger)
 
 
 ledger_index
 String or Unsigned Integer
-(Optional) The sequence number of the ledger to use, or a shortcut string to choose a ledger automatically. (See Specifying a Ledger)
+(Optional) The sequence number of the ledger to use, or a shortcut string to choose a ledger automatically. (See Specifying a Ledger)
 
 
 
-
          Response Format
          
+
          Response Format
          
 
          An example of a successful response:
          
-
          
+
          
 
-
          {
+
          {
   "id": 0,
   "status": "success",
   "type": "response",
@@ -3347,7 +3607,7 @@ There is also a deprecated legacy variation of the account_tx metho
 }
 
          
 
-
          200 OK
+
          200 OK
 {
     "result": {
         "ledger_current_index": 14380381,
@@ -3422,7 +3682,7 @@ There is also a deprecated legacy variation of the account_tx metho
 
 
 
-
          Possible Errors
          
+
          Possible Errors
          
 
            
 
          • Any of the universal error types.
            • 
 
          • invalidParams - One or more fields are specified incorrectly, or one or more required fields are missing.
            • 
@@ -3432,11 +3692,11 @@ There is also a deprecated legacy variation of the account_tx metho
 
            gateway_balances
            
 
            [Source]
            
 
            The gateway_balances command calculates the total balances issued by a given account, optionally excluding amounts held by operational addresses. New in: rippled 0.28.2
            
-
            Request Format
            
+
            Request Format
            
 
            An example of the request format:
            
-
            
+
            
 
-
            {
+
            {
     "id": "example_gateway_balances_1",
     "command": "gateway_balances",
     "account": "rMwjYedjc7qqtKYVLiAccJSmCwih4LnE2q",
@@ -3446,7 +3706,7 @@ There is also a deprecated legacy variation of the account_tx metho
 }
 
            
 
-
            {
+
            {
     "method": "gateway_balances",
     "params": [
         {
@@ -3480,7 +3740,7 @@ There is also a deprecated legacy variation of the account_tx metho
 
 strict
 Boolean
-(Optional) If true, only accept an address or public key for the account parameter. Defaults to false.
+(Optional) If true, only accept an address or public key for the account parameter. Defaults to false.
 
 
 hotwallet
@@ -3490,20 +3750,20 @@ There is also a deprecated legacy variation of the account_tx metho
 
 ledger_hash
 String
-(Optional) A 20-byte hex string for the ledger version to use. (See Specifying a Ledger)
+(Optional) A 20-byte hex string for the ledger version to use. (See Specifying a Ledger)
 
 
 ledger_index
 String or Unsigned Integer
-(Optional) The sequence number of the ledger version to use, or a shortcut string to choose a ledger automatically. (See Specifying a Ledger)
+(Optional) The sequence number of the ledger version to use, or a shortcut string to choose a ledger automatically. (See Specifying a Ledger)
 
 
 
-
            Response Format
            
+
            Response Format
            
 
            An example of a successful response:
            
-
            
+
            
 
-
            {
+
            {
   "id": 3,
   "status": "success",
   "type": "response",
@@ -3568,7 +3828,7 @@ There is also a deprecated legacy variation of the account_tx metho
 }
 
            
 
-
            200 OK
+
            200 OK
 {
     "result": {
         "account": "rMwjYedjc7qqtKYVLiAccJSmCwih4LnE2q",
@@ -3675,7 +3935,7 @@ There is also a deprecated legacy variation of the account_tx metho
 
 
 
-
            Possible Errors
            
+
            Possible Errors
            
 
              
 
            • Any of the universal error types.
              • 
 
            • invalidParams - One or more fields are specified incorrectly, or one or more required fields are missing.
              • 
@@ -3688,24 +3948,24 @@ There is also a deprecated legacy variation of the 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 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 unprivileged 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: rippled 0.31.0
              
-
              Request Format
              
+
              Request Format
              
 
              An example of the request format:
              
-
              
+
              
 
-
              {
+
              {
     "command": "wallet_propose",
     "seed": "snoPBrXtMeMyMHUVTgbuqAfg1SUTb",
     "key_type": "secp256k1"
 }
 
              
 
-
              {
+
              {
     "command": "wallet_propose",
     "passphrase": "masterpassphrase"
 }
 
              
 
-
              {
+
              {
     "method": "wallet_propose",
     "params": [
         {
@@ -3716,7 +3976,7 @@ There is also a deprecated legacy variation of the account_tx metho
 }
 
              
 
-
              {
+
              {
     "method": "wallet_propose",
     "params": [
         {
@@ -3726,7 +3986,7 @@ There is also a deprecated legacy variation of the account_tx metho
 }
 
              
 
-
              #Syntax: wallet_propose [passphrase]
+
              #Syntax: wallet_propose [passphrase]
 rippled wallet_propose masterpassphrase
 
              
 
              
@@ -3748,17 +4008,17 @@ rippled wallet_propose masterpassphrase
 
 passphrase
 String
-(Optional) Generate a key pair and address from this seed value. This value can be formatted in hexadecimal, base58, RFC-1751, or as an arbitrary string. Cannot be used with seed or seed_hex.
+(Optional) Generate a key pair and address from this seed value. This value can be formatted in hexadecimal, base58, RFC-1751, or as an arbitrary string. Cannot be used with seed or seed_hex.
 
 
 seed
 String
-(Optional) Generate the key pair and address from this base58-encoded seed value. Cannot be used with passphrase or seed_hex.
+(Optional) Generate the key pair and address from this base58-encoded seed value. Cannot be used with passphrase or seed_hex.
 
 
 seed_hex
 String
-(Optional) Generate the key pair and address from this seed value in hexadecimal format. Cannot be used with passphrase or seed.
+(Optional) Generate the key pair and address from this seed value in hexadecimal format. Cannot be used with passphrase or seed.
 
 
 
@@ -3778,11 +4038,11 @@ rippled wallet_propose masterpassphrase
 
            • As a 128-bit hexadecimal string. Example: DEDCE9CE67B451D852FD4E846FCDE31C.
              • 
 
            • An arbitrary string to use as a seed value. For example: masterpassphrase.
              • 
 
            
-
            Response Format
            
+
            Response Format
            
 
            An example of a successful response:
            
-
            
+
            
 
-
            {
+
            {
   "id": 2,
   "status": "success",
   "type": "response",
@@ -3798,7 +4058,7 @@ rippled wallet_propose masterpassphrase
 }
 
            
 
-
            {
+
            {
     "result": {
         "account_id": "rHb9CJAWyB4rj91VRWn96DkukG4bwdtyTh",
         "key_type": "secp256k1",
@@ -3812,7 +4072,7 @@ rippled wallet_propose masterpassphrase
 }
 
            
 
-
            Loading: "/etc/rippled.cfg"
+
            Loading: "/etc/rippled.cfg"
 Connecting to 127.0.0.1:5005
 {
    "result" : {
@@ -3876,7 +4136,7 @@ Connecting to 127.0.0.1:5005
 
 
 
            The key generated by this method can also be used as a regular key for an account if you use the SetRegularKey transaction type to do so.
            
-
            Possible Errors
            
+
            Possible Errors
            
 
              
 
            • Any of the universal error types.
              • 
 
            • invalidParams - One or more fields are specified incorrectly.
              • 
@@ -3887,11 +4147,11 @@ Connecting to 127.0.0.1:5005
 
              ledger
              
 
              [Source]
              
 
              Retrieve information about the public ledger.
              
-
              Request Format
              
+
              Request Format
              
 
              An example of the request format:
              
-
              
+
              
 
-
              {
+
              {
     "id": 14,
     "command": "ledger",
     "ledger_index": "validated",
@@ -3903,7 +4163,7 @@ Connecting to 127.0.0.1:5005
 }
 
              
 
-
              {
+
              {
     "method": "ledger",
     "params": [
         {
@@ -3918,7 +4178,7 @@ Connecting to 127.0.0.1:5005
 }
 
              
 
-
              #Syntax: ledger ledger_index|ledger_hash [full|tx]
+
              #Syntax: ledger ledger_index|ledger_hash [full|tx]
 # "full" is equivalent to "full": true
 # "tx" is equivalent to "transactions": true
 rippled ledger current
@@ -3938,12 +4198,12 @@ rippled ledger current
 
 ledger_hash
 String
-(Optional) A 20-byte hex string for the ledger version to use. (See Specifying a Ledger).
+(Optional) A 20-byte hex string for the ledger version to use. (See Specifying a Ledger).
 
 
 ledger_index
 String or Unsigned Integer
-(Optional) The sequence number of the ledger to use, or a shortcut string to choose a ledger automatically. (See Specifying a Ledger)
+(Optional) The sequence number of the ledger to use, or a shortcut string to choose a ledger automatically. (See Specifying a Ledger)
 
 
 full
@@ -3978,11 +4238,11 @@ rippled ledger current
 
 
 
              The ledger field is deprecated and may be removed without further notice.
              
-
              Response Format
              
+
              Response Format
              
 
              An example of a successful response:
              
-
              
+
              
 
-
              {
+
              {
   "id": 4,
   "status": "success",
   "type": "response",
@@ -4012,7 +4272,7 @@ rippled ledger current
 }
 
              
 
-
              200 OK
+
              200 OK
 {
     "result": {
         "ledger": {
@@ -4146,7 +4406,7 @@ rippled ledger current
 
 
 
-
              Possible Errors
              
+
              Possible Errors
              
 
                
 
              • Any of the universal error types.
                • 
 
              • invalidParams - One or more fields are specified incorrectly, or one or more required fields are missing.
                • 
@@ -4156,17 +4416,17 @@ rippled ledger current
 
                ledger_closed
                
 
                [Source]
                
 
                The ledger_closed method returns the unique identifiers of the most recently closed ledger. (This ledger is not necessarily validated and immutable yet.)
                
-
                Request Format
                
+
                Request Format
                
 
                An example of the request format:
                
-
                
+
                
 
-
                {
+
                {
    "id": 2,
    "command": "ledger_closed"
 }
 
                
 
-
                {
+
                {
     "method": "ledger_closed",
     "params": [
         {}
@@ -4174,17 +4434,17 @@ rippled ledger current
 }
 
                
 
-
                #Syntax: ledger_closed
+
                #Syntax: ledger_closed
 rippled ledger_closed
 
                
 
                
 
                Try it!
                
 
                This method accepts no parameters.
                
-
                Response Format
                
+
                Response Format
                
 
                An example of a successful response:
                
-
                
+
                
 
-
                {
+
                {
   "id": 1,
   "status": "success",
   "type": "response",
@@ -4195,7 +4455,7 @@ rippled ledger_closed
 }
 
                
 
-
                200 OK
+
                200 OK
 {
     "result": {
         "ledger_hash": "8B5A0C5F6B198254A6E411AF55C29EE40AA86251D2E78DD0BB17647047FA9C24",
@@ -4227,24 +4487,24 @@ rippled ledger_closed
 
 
 
-
                Possible Errors
                
+
                Possible Errors
                
 
 
                ledger_current
                
 
                [Source]
                
 
                The ledger_current method returns the unique identifiers of the current in-progress ledger. This command is mostly useful for testing, because the ledger returned is still in flux.
                
-
                Request Format
                
+
                Request Format
                
 
                An example of the request format:
                
-
                
+
                
 
-
                {
+
                {
    "id": 2,
    "command": "ledger_current"
 }
 
                
 
-
                {
+
                {
     "method": "ledger_current",
     "params": [
         {}
@@ -4252,17 +4512,17 @@ rippled ledger_closed
 }
 
                
 
-
                #Syntax: ledger_current
+
                #Syntax: ledger_current
 rippled ledger_current
 
                
 
                
 
                Try it!
                
 
                The request contains no parameters.
                
-
                Response Format
                
+
                Response Format
                
 
                An example of a successful response:
                
-
                
+
                
 
-
                {
+
                {
   "id": 2,
   "status": "success",
   "type": "response",
@@ -4272,7 +4532,7 @@ rippled ledger_current
 }
 
                
 
-
                200 OK
+
                200 OK
 {
     "result": {
         "ledger_current_index": 8696233,
@@ -4299,18 +4559,18 @@ rippled ledger_current
 
 
 
                A ledger_hash field is not provided, because the hash of the current ledger is constantly changing along with its contents.
                
-
                Possible Errors
                
+
                Possible Errors
                
 
 
                ledger_data
                
 
                [Source]
                
 
                The ledger_data method retrieves contents of the specified ledger. You can iterate through several calls to retrieve the entire contents of a single ledger version.
                
-
                Request Format
                
+
                Request Format
                
 
                An example of the request format:
                
-
                
+
                
 
-
                {
+
                {
    "id": 2,
    "ledger_hash": "842B57C1CC0613299A686D3E9F310EC0422C84D3911E5056389AA7E5808A93C8",
    "command": "ledger_data",
@@ -4319,7 +4579,7 @@ rippled ledger_current
 }
 
                
 
-
                {
+
                {
     "method": "ledger_data",
     "params": [
         {
@@ -4350,12 +4610,12 @@ rippled ledger_current
 
 ledger_hash
 String
-(Optional) A 20-byte hex string for the ledger version to use. (See Specifying a Ledger)
+(Optional) A 20-byte hex string for the ledger version to use. (See Specifying a Ledger)
 
 
 ledger_index
 String or Unsigned Integer
-(Optional) The sequence number of the ledger to use, or a shortcut string to choose a ledger automatically. (See Specifying a Ledger)
+(Optional) The sequence number of the ledger to use, or a shortcut string to choose a ledger automatically. (See Specifying a Ledger)
 
 
 binary
@@ -4370,16 +4630,16 @@ rippled ledger_current
 
 marker
 (Not Specified)
-Value from a previous response value to specify where to resume retrieving data from.
+Value from a previous paginated response. Resume retrieving data where that response left off.
 
 
 
 
                The ledger field is deprecated and may be removed without further notice.
                
-
                Response Format
                
+
                Response Format
                
 
                An example of a successful response:
                
-
                
+
                
 
-
                {
+
                {
     "id": 2,
     "result": {
         "ledger_hash": "842B57C1CC0613299A686D3E9F310EC0422C84D3911E5056389AA7E5808A93C8",
@@ -4413,7 +4673,7 @@ rippled ledger_current
 }
 
                
 
-
                {
+
                {
     "id": 2,
     "result": {
         "ledger_hash": "842B57C1CC0613299A686D3E9F310EC0422C84D3911E5056389AA7E5808A93C8",
@@ -4509,7 +4769,7 @@ rippled ledger_current
 }
 
                
 
-
                200 OK
+
                200 OK
 {
     "result": {
         "ledger_hash": "842B57C1CC0613299A686D3E9F310EC0422C84D3911E5056389AA7E5808A93C8",
@@ -4570,7 +4830,7 @@ rippled ledger_current
 
 marker
 (Not Specified)
-Server-defined value. Pass this to the next call to resume where this call left off.
+Server-defined value indicating the response is paginated. Pass this to the next call to resume where this call left off.
 
 
 
@@ -4606,7 +4866,7 @@ rippled ledger_current
 
 
 
-
                Possible Errors
                
+
                Possible Errors
                
 
                  
 
                • Any of the universal error types
                  • 
 
                • invalidParams - One or more fields are specified incorrectly, or one or more required fields are missing.
                  • 
@@ -4616,11 +4876,11 @@ rippled ledger_current
 
                  [Source]
                  
 
                  The ledger_entry method returns a single ledger node from the Ripple Consensus Ledger in its raw format. See ledger format for information on the different types of objects you can retrieve.
                  
 
                  Note: There is no commandline version of this method. You can use the json command to access this method from the commandline instead.
                  
-
                  Request Format
                  
+
                  Request Format
                  
 
                  An example of the request format:
                  
-
                  
+
                  
 
-
                  {
+
                  {
   "id": 3,
   "command": "ledger_entry",
   "type": "account_root",
@@ -4629,7 +4889,7 @@ rippled ledger_current
 }
 
                  
 
-
                  {
+
                  {
     "method": "ledger_entry",
     "params": [
         {
@@ -4664,22 +4924,22 @@ rippled ledger_current
 
 index
 String
-(Optional) Specify the unique identifier of a single ledger entry to retrieve.
+(Optional) Specify the unique identifier of a single ledger entry to retrieve.
 
 
 account_root
 String - Address
-(Optional) Specify an AccountRoot node to retrieve.
+(Optional) Specify an AccountRoot node to retrieve.
 
 
 directory
 Object or String
-(Optional) Specify a DirectoryNode. (Directory nodes each contain a list of IDs for things contained in them.) If a string, interpret as the unique index to the directory, in hex. If an object, requires either dir_root or owner as a sub-field, plus optionally a sub_index sub-field.
+(Optional) Specify a DirectoryNode. (Directory nodes each contain a list of IDs for things contained in them.) If a string, interpret as the unique index to the directory, in hex. If an object, requires either dir_root or owner as a sub-field, plus optionally a sub_index sub-field.
 
 
 directory.sub_index
 Unsigned Integer
-(Optional) If provided, jumps to a further sub-node in the DirectoryNode.
+(Optional) If provided, jumps to a further sub-node in the DirectoryNode.
 
 
 directory.dir_root
@@ -4694,7 +4954,7 @@ rippled ledger_current
 
 offer
 Object or String
-(Optional) Specify an Offer node to retrieve. If a string, interpret as the unique index to the Offer. If an object, requires the sub-fields account and seq to uniquely identify the offer.
+(Optional) Specify an Offer node to retrieve. If a string, interpret as the unique index to the Offer. If an object, requires the sub-fields account and seq to uniquely identify the offer.
 
 
 offer.account
@@ -4709,7 +4969,7 @@ rippled ledger_current
 
 ripple_state
 Object
-(Optional) Object specifying the RippleState (trust line) node to retrieve. The accounts and currency sub-fields are required to uniquely specify the RippleState entry to retrieve.
+(Optional) Object specifying the RippleState (trust line) node to retrieve. The accounts and currency sub-fields are required to uniquely specify the RippleState entry to retrieve.
 
 
 ripple_state.accounts
@@ -4729,21 +4989,21 @@ rippled ledger_current
 
 ledger_hash
 String
-(Optional) A 20-byte hex string for the ledger version to use. (See Specifying a Ledger)
+(Optional) A 20-byte hex string for the ledger version to use. (See Specifying a Ledger)
 
 
 ledger_index
 String or Unsigned Integer
-(Optional) The sequence number of the ledger to use, or a shortcut string to choose a ledger automatically. (See Specifying a Ledger)
+(Optional) The sequence number of the ledger to use, or a shortcut string to choose a ledger automatically. (See Specifying a Ledger)
 
 
 
 
                  The generator and ledger parameters are deprecated and may be removed without further notice.
                  
-
                  Response Format
                  
+
                  Response Format
                  
 
                  An example of a successful response:
                  
-
                  
+
                  
 
-
                      "id": 3,
+
                      "id": 3,
     "result": {
         "index": "4F83A2CF7E70F77F79A307E6A472BFC2585B806A70833CCD1C26105BAE0D6E05",
         "ledger_index": 6889347,
@@ -4764,7 +5024,7 @@ rippled ledger_current
 }
 
                  
 
-
                  200 OK
+
                  200 OK
 {
     "result": {
         "index": "4F83A2CF7E70F77F79A307E6A472BFC2585B806A70833CCD1C26105BAE0D6E05",
@@ -4818,7 +5078,7 @@ rippled ledger_current
 
 
 
-
                  Possible Errors
                  
+
                  Possible Errors
                  
 
                    
 
                  • Any of the universal error types.
                    • 
 
                  • invalidParams - One or more fields are specified incorrectly, or one or more required fields are missing.
                    • 
@@ -4828,18 +5088,18 @@ rippled ledger_current
 
                    [Source]
                    
 
                    The ledger_request command tells server to fetch a specific ledger version from its connected peers. This only works if one of the server's immediately-connected peers has that ledger. You may need to run the command several times to completely fetch a ledger.
                    
 
                    The ledger_request request is an admin command that cannot be run by unprivileged users!
                    
-
                    Request Format
                    
+
                    Request Format
                    
 
                    An example of the request format:
                    
-
                    
+
                    
 
-
                    {
+
                    {
     "id": 102,
     "command": "ledger_request",
     "ledger_index": 13800000
 }
 
                    
 
-
                    rippled ledger_request 13800000
+
                    rippled ledger_request 13800000
 
                    
 
                    
 
                    The request includes the following parameters:
                    
@@ -4855,23 +5115,23 @@ rippled ledger_current
 
 ledger_index
 Number
-(Optional) Retrieve the specified ledger by its Ledger Index.
+(Optional) Retrieve the specified ledger by its Ledger Index.
 
 
 ledger_hash
 String
-(Optional) Retrieve the specified ledger by its identifying Hash.
+(Optional) Retrieve the specified ledger by its identifying Hash.
 
 
 
 
                    You must provide either ledger_index or ledger_hash but not both.
                    
-
                    Response Format
                    
+
                    Response Format
                    
 
                    The response follows the standard format. However, the request returns a failure response if it does not have the specified ledger even if it successfully instructed the rippled server to start retrieving the ledger.
                    
 
                    Note: To retrieve a ledger, the rippled server must have a direct peer with that ledger in its history. If none of the peers have the requested ledger, you can use the connect command or the fixed_ips section of the config file to add Ripple's full-history server at s2.ripple.com and then make the ledger_request request again.
                    
 
                    A failure response indicates the status of fetching the ledger. A successful response contains the information for the ledger in a similar format to the ledger command.
                    
-
                    
+
                    
 
-
                    Loading: "/etc/rippled.cfg"
+
                    Loading: "/etc/rippled.cfg"
 Connecting to 127.0.0.1:5005
 {
    "result" : {
@@ -4893,7 +5153,7 @@ Connecting to 127.0.0.1:5005
 }
 
                    
 
-
                    Loading: "/etc/rippled.cfg"
+
                    Loading: "/etc/rippled.cfg"
 Connecting to 127.0.0.1:5005
 {
    "result" : {
@@ -4936,7 +5196,7 @@ Connecting to 127.0.0.1:5005
 }
 
                    
 
-
                    Loading: "/etc/rippled.cfg"
+
                    Loading: "/etc/rippled.cfg"
 Connecting to 127.0.0.1:5005
 {
    "result" : {
@@ -5022,7 +5282,7 @@ Connecting to 127.0.0.1:5005
 
 
 
-
                    Possible Errors
                    
+
                    Possible Errors
                    
 
                      
 
                    • Any of the universal error types.
                      • 
 
                    • 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.
                      • 
@@ -5032,22 +5292,22 @@ Connecting to 127.0.0.1:5005
 
                      [Source]
                      
 
                      The ledger_accept method forces the server to close the current-working ledger and move to the next ledger number. This method is intended for testing purposes only, and is only available when the rippled server is running stand-alone mode.
                      
 
                      The ledger_accept method is an admin command that cannot be run by unprivileged users!
                      
-
                      Request Format
                      
+
                      Request Format
                      
 
                      An example of the request format:
                      
-
                      
+
                      
 
-
                      {
+
                      {
    "id": "Accept my ledger!",
    "command": "ledger_accept"
 }
 
                      
 
-
                      #Syntax: ledger_accept
+
                      #Syntax: ledger_accept
 rippled ledger_accept
 
                      
 
                      
 
                      The request accepts no parameters.
                      
-
                      Response Format
                      
+
                      Response Format
                      
 
                      An example of a successful response:
                      
 
                      {
   "id": "Accept my ledger!",
@@ -5076,7 +5336,7 @@ rippled ledger_accept
 
 
 
                      Note: When you close a ledger, rippled determines the canonical order of transactions in that ledger and replays them. This can change the outcome of transactions that were provisionally applied to the current ledger.
                      
-
                      Possible Errors
                      
+
                      Possible Errors
                      
 
                        
 
                      • Any of the universal error types.
                        • 
 
                      • notStandAlone - If the rippled server is not currently running in stand-alone mode.
                        • 
@@ -5087,11 +5347,11 @@ rippled ledger_accept
 
                        tx
                        
 
                        [Source]
                        
 
                        The tx method retrieves information on a single transaction.
                        
-
                        Request Format
                        
+
                        Request Format
                        
 
                        An example of the request format:
                        
-
                        
+
                        
 
-
                        {
+
                        {
   "id": 1,
   "command": "tx",
   "transaction": "E08D6E9754025BA2534A78707605E0601F03ACE063687A0CA1BDDACFCD1698C7",
@@ -5099,7 +5359,7 @@ rippled ledger_accept
 }
 
                        
 
-
                        {
+
                        {
     "method": "tx",
     "params": [
         {
@@ -5110,7 +5370,7 @@ rippled ledger_accept
 }
 
                        
 
-
                        #Syntax: tx transaction [binary]
+
                        #Syntax: tx transaction [binary]
 rippled tx E08D6E9754025BA2534A78707605E0601F03ACE063687A0CA1BDDACFCD1698C7 false
 
                        
 
                        
@@ -5137,11 +5397,11 @@ rippled tx E08D6E9754025BA2534A78707605E0601F03ACE063687A0CA1BDDACFCD1698C7 fals
 
 
 
-
                        Response Format
                        
+
                        Response Format
                        
 
                        An example of a successful response:
                        
-
                        
+
                        
 
-
                        {
+
                        {
     "id": 1,
     "result": {
         "Account": "r3PDtZSa5LiYp1Ysn1vMuMzB59RzV3W9QH",
@@ -5308,7 +5568,7 @@ rippled tx E08D6E9754025BA2534A78707605E0601F03ACE063687A0CA1BDDACFCD1698C7 fals
 
 
 
-
                        Possible Errors
                        
+
                        Possible Errors
                        
 
                          
 
                        • Any of the universal error types.
                          • 
 
                        • invalidParams - One or more fields are specified incorrectly, or one or more required fields are missing.
                          • 
@@ -5317,11 +5577,11 @@ rippled tx E08D6E9754025BA2534A78707605E0601F03ACE063687A0CA1BDDACFCD1698C7 fals
 
                          transaction_entry
                          
 
                          [Source]
                          
 
                          The transaction_entry method retrieves information on a single transaction from a specific ledger version. (The tx command, by contrast, searches all ledgers for the specified transaction. We recommend using that method instead.)
                          
-
                          Request Format
                          
+
                          Request Format
                          
 
                          An example of the request format:
                          
-
                          
+
                          
 
-
                          {
+
                          {
   "id": 4,
   "command": "transaction_entry",
   "tx_hash": "E08D6E9754025BA2534A78707605E0601F03ACE063687A0CA1BDDACFCD1698C7",
@@ -5329,7 +5589,7 @@ rippled tx E08D6E9754025BA2534A78707605E0601F03ACE063687A0CA1BDDACFCD1698C7 fals
 }
 
                          
 
-
                          {
+
                          {
     "method": "transaction_entry",
     "params": [
         {
@@ -5340,7 +5600,7 @@ rippled tx E08D6E9754025BA2534A78707605E0601F03ACE063687A0CA1BDDACFCD1698C7 fals
 }
 
                          
 
-
                          #Syntax: transaction_entry transaction_hash ledger_index|ledger_hash
+
                          #Syntax: transaction_entry transaction_hash ledger_index|ledger_hash
 rippled transaction_entry E08D6E9754025BA2534A78707605E0601F03ACE063687A0CA1BDDACFCD1698C7 348734
 
                          
 
                          
@@ -5358,12 +5618,12 @@ rippled transaction_entry E08D6E9754025BA2534A78707605E0601F03ACE063687A0CA1BDDA
 
 ledger_hash
 String
-(Optional) A 20-byte hex string for the ledger version to use. (See Specifying a Ledger)
+(Optional) A 20-byte hex string for the ledger version to use. (See Specifying a Ledger)
 
 
 ledger_index
 String or Unsigned Integer
-(Optional) The sequence number of the ledger to use, or a shortcut string to choose a ledger automatically. (See Specifying a Ledger)
+(Optional) The sequence number of the ledger to use, or a shortcut string to choose a ledger automatically. (See Specifying a Ledger)
 
 
 tx_hash
@@ -5373,11 +5633,11 @@ rippled transaction_entry E08D6E9754025BA2534A78707605E0601F03ACE063687A0CA1BDDA
 
 
 
                          Note: This method does not support retrieving information from the current in-progress ledger. You must specify a ledger version in either ledger_index or ledger_hash.
                          
-
                          Response Format
                          
+
                          Response Format
                          
 
                          An example of a successful response:
                          
-
                          
+
                          
 
-
                          {
+
                          {
     "id": 4,
     "result": {
         "ledger_index": 348734,
@@ -5542,7 +5802,7 @@ rippled transaction_entry E08D6E9754025BA2534A78707605E0601F03ACE063687A0CA1BDDA
 
                        • The transaction exists, but not in the specified ledger version
                          • 
 
                        • The server does not have the specified ledger version available. Another server that has the correct version on hand may have a different response.
                          • 
 
                        
-
                        Possible Errors
                        
+
                        Possible Errors
                        
 
                          
 
                        • Any of the universal error types.
                          • 
 
                        • fieldNotFoundTransaction - The tx_hash field was omitted from the request
                          • 
@@ -5555,18 +5815,18 @@ rippled transaction_entry E08D6E9754025BA2534A78707605E0601F03ACE063687A0CA1BDDA
 
                          [Source]
                          
 
                          The tx_history method retrieves some of the most recent transactions made.
                          
 
                          Caution: This method is deprecated, and may be removed without further notice.
                          
-
                          Request Format
                          
+
                          Request Format
                          
 
                          An example of the request format:
                          
-
                          
+
                          
 
-
                          {
+
                          {
   "id": 5,
   "command": "tx_history",
   "start": 0
 }
 
                          
 
-
                          {
+
                          {
     "method": "tx_history",
     "params": [
         {
@@ -5576,7 +5836,7 @@ rippled transaction_entry E08D6E9754025BA2534A78707605E0601F03ACE063687A0CA1BDDA
 }
 
                          
 
-
                          #Syntax: tx_history [start]
+
                          #Syntax: tx_history [start]
 rippled tx_history 0
 
                          
 
                          
@@ -5598,11 +5858,11 @@ rippled tx_history 0
 
 
 
-
                          Response Format
                          
+
                          Response Format
                          
 
                          An example of a successful response:
                          
-
                          
+
                          
 
-
                          {
+
                          {
   "id": 2,
   "status": "success",
   "type": "response",
@@ -6052,7 +6312,7 @@ rippled tx_history 0
 }
 
                          
 
-
                          200 OK
+
                          200 OK
 {
     "result": {
         "index": 0,
@@ -6439,7 +6699,7 @@ rippled tx_history 0
 
 
 
                          The fields included in each transaction object vary slightly depending on the type of transaction. See Transaction Format for details.
                          
-
                          Possible Errors
                          
+
                          Possible Errors
                          
 
                            
 
                          • Any of the universal error types.
                            • 
 
                          • invalidParams - One or more fields are specified incorrectly, or one or more required fields are missing.
                            • 
@@ -6459,11 +6719,11 @@ rippled tx_history 0
 
                            [Source]
                            
 
                            The create subcommand of path_find creates an ongoing request to find possible paths along which a payment transaction could be made from one specified account such that another account receives a desired amount of some currency. The initial response contains a suggested path between the two addresses that would result in the desired amount being received. After that, the server sends additional messages, with "type": "path_find", with updates to the potential paths. The frequency of updates is left to the discretion of the server, but it usually means once every few seconds when there is a new ledger version.
                            
 
                            A client can only have one pathfinding request open at a time. If another pathfinding request is already open on the same connection, the old request is automatically closed and replaced with the new request.
                            
-
                            Request Format
                            
+
                            Request Format
                            
 
                            An example of the request format:
                            
-
                            
+
                            
 
-
                            {
+
                            {
     "id": 8,
     "command": "path_find",
     "subcommand": "create",
@@ -6511,21 +6771,21 @@ rippled tx_history 0
 
 send_max
 String or Object
-(Optional) Currency amount that would be spent in the transaction. Not compatible with source_currencies. New in: rippled 0.30.0
+(Optional) Currency amount that would be spent in the transaction. Not compatible with source_currencies. New in: rippled 0.30.0
 
 
 paths
 Array
-(Optional) Array of arrays of objects, representing payment paths to check. You can use this to keep updated on changes to particular paths you already know about, or to check the overall cost to make a payment along a certain path.
+(Optional) Array of arrays of objects, representing payment paths to check. You can use this to keep updated on changes to particular paths you already know about, or to check the overall cost to make a payment along a certain path.
 
 
 
 
                            The server also recognizes the following fields, but the results of using them are not guaranteed: source_currencies, bridges. These fields should be considered reserved for future use.
                            
-
                            Response Format
                            
+
                            Response Format
                            
 
                            An example of a successful response:
                            
-
                            
+
                            
 
-
                            {
+
                            {
   "id": 1,
   "status": "success",
   "type": "response",
@@ -6954,7 +7214,7 @@ rippled tx_history 0
 
 
 
-
                            Possible Errors
                            
+
                            Possible Errors
                            
 
                              
 
                            • Any of the universal error types.
                              • 
 
                            • invalidParams - One or more fields are specified incorrectly, or one or more required fields are missing.
                              • 
@@ -6964,9 +7224,9 @@ rippled tx_history 0
 
                              In addition to the initial response, the server sends more messages in a similar format to update on the status of payment paths over time. These messages include the id of the original WebSocket request so you can tell which request prompted them, and the field "type": "path_find" at the top level to indicate that they are additional responses. The other fields are defined in the same way as the initial response.
                              
 
                              If the follow-up includes "full_reply": true, then this is the best path that rippled can find as of the current ledger.
                              
 
                              Here is an example of an asychronous follow-up from a path_find create request:
                              
-
                              
+
                              
 
-
                              {
+
                              {
     "id": 1,
     "type": "path_find",
     "alternatives": [
@@ -6985,11 +7245,11 @@ rippled tx_history 0
 
                              path_find close
                              
 
                              [Source]
                              
 
                              The close subcommand of path_find instructs the server to stop sending information about the current open pathfinding request.
                              
-
                              Request Format
                              
+
                              Request Format
                              
 
                              An example of the request format:
                              
-
                              
+
                              
 
-
                              {
+
                              {
   "id": 57,
   "command": "path_find",
   "subcommand": "close"
@@ -7013,7 +7273,7 @@ rippled tx_history 0
 
 
 
-
                              Response Format
                              
+
                              Response Format
                              
 
                              If a pathfinding request was successfully closed, the response follows the same format as the initial response to path_find create, plus the following field:
                              
 
@@ -7032,7 +7292,7 @@ rippled tx_history 0
 
                              
 
 
                              
 
                              If there was no outstanding pathfinding request, an error is returned instead.
                              
-
                              Possible Errors
                              
+
                              Possible Errors
                              
 
                                
 
                              • Any of the universal error types.
                                • 
 
                              • invalidParams - If any fields are specified incorrectly, or any required fields are missing.
                                • 
@@ -7042,11 +7302,11 @@ rippled tx_history 0
 
                                path_find status
                                
 
                                [Source]
                                
 
                                The status subcommand of path_find requests an immediate update about the client's currently-open pathfinding request.
                                
-
                                Request Format
                                
+
                                Request Format
                                
 
                                An example of the request format:
                                
-
                                
+
                                
 
-
                                {
+
                                {
   "id": 58,
   "command": "path_find",
   "subcommand": "status"
@@ -7070,7 +7330,7 @@ rippled tx_history 0
 
 
 
-
                                Response Format
                                
+
                                Response Format
                                
 
                                If a pathfinding request is open, the response follows the same format as the initial response to path_find create, plus the following field:
                                
 
@@ -7089,7 +7349,7 @@ rippled tx_history 0
 
                                
 
 
                                
 
                                If there was no outstanding pathfinding request, an error is returned instead.
                                
-
                                Possible Errors
                                
+
                                Possible Errors
                                
 
                                  
 
                                • Any of the universal error types.
                                  • 
 
                                • invalidParams - One or more fields are specified incorrectly, or one or more required fields are missing.
                                  • 
@@ -7101,11 +7361,11 @@ rippled tx_history 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 multiple calls to stay updated, you should use path_find instead where possible.
                                  
 
                                  Although the rippled server tries 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 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 run by different parties, to minimize the risk of a single server returning poor results.
                                  
-
                                  Request Format
                                  
+
                                  Request Format
                                  
 
                                  An example of the request format:
                                  
-
                                  
+
                                  
 
-
                                  {
+
                                  {
     "id": 8,
     "command": "ripple_path_find",
     "source_account": "r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59",
@@ -7126,7 +7386,7 @@ rippled tx_history 0
 }
 
                                  
 
-
                                  {
+
                                  {
     "method": "ripple_path_find",
     "params": [
         {
@@ -7150,7 +7410,7 @@ rippled tx_history 0
 }
 
                                  
 
-
                                  #Syntax ripple_path_find json ledger_index|ledger_hash
+
                                  #Syntax ripple_path_find json ledger_index|ledger_hash
 rippled ripple_path_find '{"source_account": "r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59", "source_currencies": [ { "currency": "XRP" }, { "currency": "USD" } ], "destination_account": "r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59", "destination_amount": { "value": "0.001", "currency": "USD", "issuer": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B" } }'
 
                                  
 
                                  
@@ -7183,30 +7443,30 @@ rippled ripple_path_find '{"source_account": "r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59
 
 send_max
 String or Object
-(Optional) Currency amount that would be spent in the transaction. Cannot be used with source_currencies. New in: rippled 0.30.0
+(Optional) Currency amount that would be spent in the transaction. Cannot be used with source_currencies. New in: rippled 0.30.0
 
 
 source_currencies
 Array
-(Optional) Array of currencies that the source account might want to spend. Each entry in the array should be a JSON object with a mandatory currency field and optional issuer field, like how currency amounts are specified. Cannot contain more than 18 source currencies. By default, uses all source currencies available up to a maximum of 88 different currency/issuer pairs.
+(Optional) Array of currencies that the source account might want to spend. Each entry in the array should be a JSON object with a mandatory currency field and optional issuer field, like how currency amounts are specified. Cannot contain more than 18 source currencies. By default, uses all source currencies available up to a maximum of 88 different currency/issuer pairs.
 
 
 ledger_hash
 String
-(Optional) A 20-byte hex string for the ledger version to use. (See Specifying a Ledger)
+(Optional) A 20-byte hex string for the ledger version to use. (See Specifying a Ledger)
 
 
 ledger_index
 String or Unsigned Integer
-(Optional) The sequence number of the ledger to use, or a shortcut string to choose a ledger automatically. (See Specifying a Ledger)
+(Optional) The sequence number of the ledger to use, or a shortcut string to choose a ledger automatically. (See Specifying a Ledger)
 
 
 
-
                                  Response Format
                                  
+
                                  Response Format
                                  
 
                                  An example of a successful response:
                                  
-
                                  
+
                                  
 
-
                                  {
+
                                  {
     "id": 8,
     "status": "success",
     "type": "response",
@@ -7312,7 +7572,7 @@ rippled ripple_path_find '{"source_account": "r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59
 }
 
                                  
 
-
                                  200 OK
+
                                  200 OK
 {
     "result": {
         "alternatives": [
@@ -7467,7 +7727,7 @@ rippled ripple_path_find '{"source_account": "r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59
 
 
 
                                  The following fields are deprecated, and may be omitted: paths_canonical, and paths_expanded. If they appear, you should disregard them.
                                  
-
                                  Possible Errors
                                  
+
                                  Possible Errors
                                  
 
                                    
 
                                  • Any of the universal error types.
                                    • 
 
                                  • tooBusy - The server is under too much load to calculate paths. Not returned if you are connected as an admin.
                                    • 
@@ -7483,11 +7743,11 @@ rippled ripple_path_find '{"source_account": "r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59
 
                                    [Source]
                                    
 
                                    The sign method takes a transaction in JSON format and a secret key, and returns a signed binary representation of the transaction. The result is always different, even when you provide the same transaction JSON and secret key. To contribute one signature to a multi-signed transaction, use the sign_for command instead.
                                    
 
                                    Caution: Unless you run the rippled server yourself, you should do local signing with RippleAPI instead of using this command. An untrustworthy server could change the transaction before signing it, or use your secret key to sign additional arbitrary transactions as if they came from you.
                                    
-
                                    Request Format
                                    
+
                                    Request Format
                                    
 
                                    An example of the request format:
                                    
-
                                    
+
                                    
 
-
                                    {
+
                                    {
   "id": 2,
   "command": "sign",
   "tx_json" : {
@@ -7506,7 +7766,7 @@ rippled ripple_path_find '{"source_account": "r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59
 }
 
                                    
 
-
                                    {
+
                                    {
     "method": "sign",
     "params": [
         {
@@ -7528,7 +7788,7 @@ rippled ripple_path_find '{"source_account": "r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59
 }
 
                                    
 
-
                                    #Syntax: sign secret tx_json [offline]
+
                                    #Syntax: sign secret tx_json [offline]
 rippled sign s████████████████████████████ '{"TransactionType": "Payment", "Account": "rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn", "Destination": "ra5nK24KXen9AHvsdFTKHSANinZseWnPcX", "Amount": { "currency": "USD", "value": "1", "issuer" : "rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn" }, "Sequence": 360, "Fee": "10000"}' offline
 
                                    
 
                                    
@@ -7556,27 +7816,27 @@ rippled sign s██████████████████████
 
 secret
 String
-(Optional) Secret key of the account supplying the transaction, used to sign it. Do not send your secret to untrusted servers or through unsecured network connections. Cannot be used with key_type, seed, seed_hex, or passphrase.
+(Optional) Secret key of the account supplying the transaction, used to sign it. Do not send your secret to untrusted servers or through unsecured network connections. Cannot be used with key_type, seed, seed_hex, or passphrase.
 
 
 seed
 String
-(Optional) Secret key of the account supplying the transaction, used to sign it. Must be in base58 format. If provided, you must also specify the key_type. Cannot be used with secret, seed_hex, or passphrase.
+(Optional) Secret key of the account supplying the transaction, used to sign it. Must be in base58 format. If provided, you must also specify the key_type. Cannot be used with secret, seed_hex, or passphrase.
 
 
 seed_hex
 String
-(Optional) Secret key of the account supplying the transaction, used to sign it. Must be in hexadecimal format. If provided, you must also specify the key_type. Cannot be used with secret, seed, or passphrase.
+(Optional) Secret key of the account supplying the transaction, used to sign it. Must be in hexadecimal format. If provided, you must also specify the key_type. Cannot be used with secret, seed, or passphrase.
 
 
 passphrase
 String
-(Optional) Secret key of the account supplying the transaction, used to sign it, as a string passphrase. If provided, you must also specify the key_type. Cannot be used with secret, seed, or seed_hex.
+(Optional) Secret key of the account supplying the transaction, used to sign it, as a string passphrase. If provided, you must also specify the key_type. Cannot be used with secret, seed, or seed_hex.
 
 
 key_type
 String
-(Optional) Type of cryptographic key provided in this request. Valid types are secp256k1 or ed25519. Defaults to secp256k1. Cannot be used with secret. Caution: Ed25519 support is experimental.
+(Optional) Type of cryptographic key provided in this request. Valid types are secp256k1 or ed25519. Defaults to secp256k1. Cannot be used with secret. Caution: Ed25519 support is experimental.
 
 
 offline
@@ -7586,7 +7846,7 @@ rippled sign s██████████████████████
 
 build_path
 Boolean
-(Optional) If provided for a Payment-type transaction, automatically fill in the Paths field before signing. Caution: The server looks for the presence or absence of this field, not its value. This behavior may change.
+(Optional) If provided for a Payment-type transaction, automatically fill in the Paths field before signing. Caution: The server looks for the presence or absence of this field, not its value. This behavior may change.
 
 
 fee_mult_max
@@ -7615,11 +7875,11 @@ rippled sign s██████████████████████
 
 
                                  • Paths - For Payment-type transactions (excluding XRP-to-XRP transfers), the Paths field can be automatically filled, as if you did a ripple_path_find. Only filled if build_path is provided.
                                    • 
 
                                  
-
                                  Response Format
                                  
+
                                  Response Format
                                  
 
                                  An example of a successful response:
                                  
-
                                  
+
                                  
 
-
                                  {
+
                                  {
   "id": 2,
   "status": "success",
   "type": "response",
@@ -7645,7 +7905,7 @@ rippled sign s██████████████████████
 }
 
                                  
 
-
                                  200 OK
+
                                  200 OK
 {
     "result": {
         "status": "success",
@@ -7670,7 +7930,7 @@ rippled sign s██████████████████████
 }
 
                                  
 
-
                                  Loading: "/etc/rippled.cfg"
+
                                  Loading: "/etc/rippled.cfg"
 Connecting to 127.0.0.1:5005
 {
    "result" : {
@@ -7724,7 +7984,7 @@ Connecting to 127.0.0.1:5005
 
                                • Do not paste this error to a public place for debugging.
                                  • 
 
                                • Do not display the error message on a website, even by accident.
                                  • 
 
                                
-
                                Possible Errors
                                
+
                                Possible Errors
                                
 
                                  
 
                                • Any of the universal error types.
                                  • 
 
                                • invalidParams - One or more fields are specified incorrectly, or one or more required fields are missing.
                                  • 
@@ -7736,11 +7996,11 @@ Connecting to 127.0.0.1:5005
 
                                  [Source]
                                  
 
                                  The sign_for command provides one signature for a multi-signed transaction.
                                  
 
                                  This command requires the MultiSign amendment to be enabled. New in: rippled 0.31.0
                                  
-
                                  Request Format
                                  
+
                                  Request Format
                                  
 
                                  An example of the request format:
                                  
-
                                  
+
                                  
 
-
                                  {
+
                                  {
     "id": "sign_for_example",
     "command": "sign_for",
     "account": "rLFd1FzHMScFhLsXeaxStzv3UC97QHGAbM",
@@ -7762,7 +8022,7 @@ Connecting to 127.0.0.1:5005
 }
 
                                  
 
-
                                  POST http://localhost:5005/
+
                                  POST http://localhost:5005/
 {
     "method": "sign_for",
     "params": [{
@@ -7786,7 +8046,7 @@ Connecting to 127.0.0.1:5005
 }
 
                                  
 
-
                                  #Syntax: rippled sign_for <signer_address> <signer_secret> [offline]
+
                                  #Syntax: rippled sign_for <signer_address> <signer_secret> [offline]
 rippled sign_for rsA2LpzuawewSBQXkiju3YQTMzW13pAAdW s████████████████████████████ '{
     "TransactionType": "TrustSet",
     "Account": "rEuLyBCvcw4CFmzv8RepSiAoNgF8tTGJQC",
@@ -7825,36 +8085,36 @@ rippled sign_for rsA2LpzuawewSBQXkiju3YQTMzW13pAAdW s█████████
 
 secret
 String
-(Optional) The secret key to sign with. (Cannot be used with key_type.)
+(Optional) The secret key to sign with. (Cannot be used with key_type.)
 
 
 passphrase
 String
-(Optional) A passphrase to use as the secret key to sign with.
+(Optional) A passphrase to use as the secret key to sign with.
 
 
 seed
 String
-(Optional) A base58-encoded secret key to sign with.
+(Optional) A base58-encoded secret key to sign with.
 
 
 seed_hex
 String
-(Optional) A hexadecimal secret key to sign with.
+(Optional) A hexadecimal secret key to sign with.
 
 
 key_type
 String
-(Optional) The type of key to use for signing. This can be secp256k1 or ed25519. (Ed25519 support is experimental.)
+(Optional) The type of key to use for signing. This can be secp256k1 or ed25519. (Ed25519 support is experimental.)
 
 
 
 
                                  You must provide exactly 1 field with the secret key. You can use any of the following fields: secret, passphrase, seed, or seed_hex.
                                  
-
                                  Response Format
                                  
+
                                  Response Format
                                  
 
                                  An example of a successful response:
                                  
-
                                  
+
                                  
 
-
                                  {
+
                                  {
   "id": "sign_for_example",
   "status": "success",
   "type": "response",
@@ -7887,7 +8147,7 @@ rippled sign_for rsA2LpzuawewSBQXkiju3YQTMzW13pAAdW s█████████
 }
 
                                  
 
-
                                  200 OK
+
                                  200 OK
 {
    "result" : {
       "status" : "success",
@@ -7919,7 +8179,7 @@ rippled sign_for rsA2LpzuawewSBQXkiju3YQTMzW13pAAdW s█████████
 }
 
                                  
 
-
                                  Loading: "/etc/rippled.cfg"
+
                                  Loading: "/etc/rippled.cfg"
 Connecting to 127.0.0.1:5005
 {
    "result" : {
@@ -7974,7 +8234,7 @@ Connecting to 127.0.0.1:5005
 
 
 
-
                                  Possible Errors
                                  
+
                                  Possible Errors
                                  
 
                                    
 
                                  • Any of the universal error types.
                                    • 
 
                                  • invalidParams - One or more fields are specified incorrectly, or one or more required fields are missing.
                                    • 
@@ -8015,17 +8275,17 @@ Connecting to 127.0.0.1:5005
 
 
 
-
                                    Request Format
                                    
-
                                    
+
                                    Request Format
                                    
+
                                    
 
-
                                    {
+
                                    {
     "id": 3,
     "command": "submit",
     "tx_blob": "1200002280000000240000001E61D4838D7EA4C6800000000000000000000000000055534400000000004B4E9C06F24296074F7BC48F92A97916C6DC5EA968400000000000000B732103AB40A0490F9B7ED8DF29D246BF2D6269820A0EE7742ACDD457BEA7C7D0931EDB7447304502210095D23D8AF107DF50651F266259CC7139D0CD0C64ABBA3A958156352A0D95A21E02207FCF9B77D7510380E49FF250C21B57169E14E9B4ACFD314CEDC79DDD0A38B8A681144B4E9C06F24296074F7BC48F92A97916C6DC5EA983143E9D4A2B8AA0780F682D136F7A56D6724EF53754"
 }
 
                                    
 
-
                                    {
+
                                    {
     "method": "submit",
     "params": [
         {
@@ -8035,7 +8295,7 @@ Connecting to 127.0.0.1:5005
 }
 
                                    
 
-
                                    #Syntax: submit tx_blob
+
                                    #Syntax: submit tx_blob
 submit 1200002280000000240000000361D4838D7EA4C6800000000000000000000000000055534400000000004B4E9C06F24296074F7BC48F92A97916C6DC5EA968400000000000000A732103AB40A0490F9B7ED8DF29D246BF2D6269820A0EE7742ACDD457BEA7C7D0931EDB74473045022100D184EB4AE5956FF600E7536EE459345C7BBCF097A84CC61A93B9AF7197EDB98702201CEA8009B7BEEBAA2AACC0359B41C427C1C5B550A4CA4B80CF2174AF2D6D5DCE81144B4E9C06F24296074F7BC48F92A97916C6DC5EA983143E9D4A2B8AA0780F682D136F7A56D6724EF53754
 
                                    
 
                                    
@@ -8065,27 +8325,27 @@ submit 1200002280000000240000000361D4838D7EA4C6800000000000000000000000000055534
 
 secret
 String
-(Optional) Secret key of the account supplying the transaction, used to sign it. Do not send your secret to untrusted servers or through unsecured network connections. Cannot be used with key_type, seed, seed_hex, or passphrase.
+(Optional) Secret key of the account supplying the transaction, used to sign it. Do not send your secret to untrusted servers or through unsecured network connections. Cannot be used with key_type, seed, seed_hex, or passphrase.
 
 
 seed
 String
-(Optional) Secret key of the account supplying the transaction, used to sign it. Must be in base58 format. If provided, you must also specify the key_type. Cannot be used with secret, seed_hex, or passphrase.
+(Optional) Secret key of the account supplying the transaction, used to sign it. Must be in base58 format. If provided, you must also specify the key_type. Cannot be used with secret, seed_hex, or passphrase.
 
 
 seed_hex
 String
-(Optional) Secret key of the account supplying the transaction, used to sign it. Must be in hexadecimal format. If provided, you must also specify the key_type. Cannot be used with secret, seed, or passphrase.
+(Optional) Secret key of the account supplying the transaction, used to sign it. Must be in hexadecimal format. If provided, you must also specify the key_type. Cannot be used with secret, seed, or passphrase.
 
 
 passphrase
 String
-(Optional) Secret key of the account supplying the transaction, used to sign it, as a string passphrase. If provided, you must also specify the key_type. Cannot be used with secret, seed, or seed_hex.
+(Optional) Secret key of the account supplying the transaction, used to sign it, as a string passphrase. If provided, you must also specify the key_type. Cannot be used with secret, seed, or seed_hex.
 
 
 key_type
 String
-(Optional) Type of cryptographic key provided in this request. Valid types are secp256k1 or ed25519. Defaults to secp256k1. Cannot be used with secret. Caution: Ed25519 support is experimental.
+(Optional) Type of cryptographic key provided in this request. Valid types are secp256k1 or ed25519. Defaults to secp256k1. Cannot be used with secret. Caution: Ed25519 support is experimental.
 
 
 fail_hard
@@ -8100,7 +8360,7 @@ submit 1200002280000000240000000361D4838D7EA4C6800000000000000000000000000055534
 
 build_path
 Boolean
-(Optional) If provided for a Payment-type transaction, automatically fill in the Paths field before signing. You must omit this field if the transaction is a direct XRP-to-XRP transfer. Caution: The server looks for the presence or absence of this field, not its value. This behavior may change.
+(Optional) If provided for a Payment-type transaction, automatically fill in the Paths field before signing. You must omit this field if the transaction is a direct XRP-to-XRP transfer. Caution: The server looks for the presence or absence of this field, not its value. This behavior may change.
 
 
 fee_mult_max
@@ -8115,11 +8375,11 @@ submit 1200002280000000240000000361D4838D7EA4C6800000000000000000000000000055534
 
 
 
                                    See the sign command for detailed information on how the server automatically fills in certain fields.
                                    
-
                                    Request Format
                                    
+
                                    Request Format
                                    
 
                                    An example of the request format:
                                    
-
                                    
+
                                    
 
-
                                    {
+
                                    {
   "id": 2,
   "command": "submit",
   "tx_json" : {
@@ -8138,7 +8398,7 @@ submit 1200002280000000240000000361D4838D7EA4C6800000000000000000000000000055534
 }
 
                                    
 
-
                                    {
+
                                    {
     "method": "submit",
     "params": [
         {
@@ -8160,16 +8420,16 @@ submit 1200002280000000240000000361D4838D7EA4C6800000000000000000000000000055534
 }
 
                                    
 
-
                                    #Syntax: submit secret json [offline]
+
                                    #Syntax: submit secret json [offline]
 rippled submit s████████████████████████████ '{"Account": "rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn", "Amount": { "currency": "USD", "issuer": "rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn", "value": "1" }, "Destination": "ra5nK24KXen9AHvsdFTKHSANinZseWnPcX", "TransactionType": "Payment", "Fee": "10000"}'
 
                                    
 
                                    
 
                                    Try it!
                                    
-
                                    Response Format
                                    
+
                                    Response Format
                                    
 
                                    An example of a successful response:
                                    
-
                                    
+
                                    
 
-
                                    {
+
                                    {
   "id": 1,
   "status": "success",
   "type": "response",
@@ -8198,7 +8458,7 @@ rippled submit s█████████████████████
 }
 
                                    
 
-
                                    {
+
                                    {
     "result": {
         "engine_result": "tesSUCCESS",
         "engine_result_code": 0,
@@ -8225,7 +8485,7 @@ rippled submit s█████████████████████
 }
 
                                    
 
-
                                    Loading: "/etc/rippled.cfg"
+
                                    Loading: "/etc/rippled.cfg"
 Connecting to 127.0.0.1:5005
 {
    "result" : {
@@ -8298,7 +8558,7 @@ Connecting to 127.0.0.1:5005
 
                                  • Do not paste an error including your secret key to a public place for debugging.
                                    • 
 
                                  • Do not display an error message including your secret key on a website, even by accident.
                                    • 
 
                                  
-
                                  Possible Errors
                                  
+
                                  Possible Errors
                                  
 
                                    
 
                                  • Any of the universal error types.
                                    • 
 
                                  • invalidTransaction - The transaction is malformed or otherwise invalid.
                                    • 
@@ -8314,11 +8574,11 @@ Connecting to 127.0.0.1:5005
 
                                    [Source]
                                    
 
                                    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: rippled 0.31.0
                                    
-
                                    Request Format
                                    
+
                                    Request Format
                                    
 
                                    An example of the request format:
                                    
-
                                    
+
                                    
 
-
                                    {
+
                                    {
     "id": "submit_multisigned_example"
     "command": "submit_multisigned",
     "tx_json": {
@@ -8351,7 +8611,7 @@ Connecting to 127.0.0.1:5005
 }
 
                                    
 
-
                                    {
+
                                    {
     "method": "submit_multisigned",
     "params": [
         {
@@ -8390,7 +8650,7 @@ Connecting to 127.0.0.1:5005
 }
 
                                    
 
-
                                    #Syntax: submit_multisigned <tx_json>
+
                                    #Syntax: submit_multisigned <tx_json>
 rippled submit_multisigned '{
     "Account": "rEuLyBCvcw4CFmzv8RepSiAoNgF8tTGJQC",
     "Fee": "30000",
@@ -8445,11 +8705,11 @@ rippled submit_multisigned '{
 
 
 
-
                                    Response Format
                                    
+
                                    Response Format
                                    
 
                                    An example of a successful response:
                                    
-
                                    
+
                                    
 
-
                                    {
+
                                    {
   "id": "submit_multisigned_example",
   "status": "success",
   "type": "response",
@@ -8492,7 +8752,7 @@ rippled submit_multisigned '{
 }
 
                                    
 
-
                                    200 OK
+
                                    200 OK
 {
     "result": {
         "engine_result": "tesSUCCESS",
@@ -8571,7 +8831,7 @@ rippled submit_multisigned '{
 
 
 
-
                                    Possible Errors
                                    
+
                                    Possible Errors
                                    
 
                                      
 
                                    • Any of the universal error types.
                                      • 
 
                                    • invalidParams - One or more fields are specified incorrectly, or one or more required fields are missing.
                                      • 
@@ -8581,11 +8841,11 @@ rippled submit_multisigned '{
 
                                      book_offers
                                      
 
                                      [Source]
                                      
 
                                      The book_offers method retrieves a list of offers, also known as the order book, between two currencies. If the results are very large, a partial result is returned with a marker so that later requests can resume from where the previous one left off.
                                      
-
                                      Request Format
                                      
+
                                      Request Format
                                      
 
                                      An example of the request format:
                                      
-
                                      
+
                                      
 
-
                                      {
+
                                      {
   "id": 4,
   "command": "book_offers",
   "taker": "r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59",
@@ -8600,7 +8860,7 @@ rippled submit_multisigned '{
 }
 
                                      
 
-
                                      {
+
                                      {
     "method": "book_offers",
     "params": [
         {
@@ -8618,7 +8878,7 @@ rippled submit_multisigned '{
 }
 
                                      
 
-
                                      #Syntax: book_offers taker_pays taker_gets [taker [ledger [limit] ] ]
+
                                      #Syntax: book_offers taker_pays taker_gets [taker [ledger [limit] ] ]
 rippled book_offers 'USD/rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B' 'EUR/rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B'
 
                                      
 
                                      
@@ -8636,22 +8896,22 @@ rippled book_offers 'USD/rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B' 'EUR/rvYAfWj5gh67oV6
 
 ledger_hash
 String
-(Optional) A 20-byte hex string for the ledger version to use. (See Specifying a Ledger)
+(Optional) A 20-byte hex string for the ledger version to use. (See Specifying a Ledger)
 
 
 ledger_index
 String or Unsigned Integer
-(Optional) The sequence number of the ledger to use, or a shortcut string to choose a ledger automatically. (See Specifying a Ledger)
+(Optional) The sequence number of the ledger to use, or a shortcut string to choose a ledger automatically. (See Specifying a Ledger)
 
 
 limit
 Unsigned Integer
-(Optional) If provided, the server does not provide more than this many offers in the results. The total number of results returned may be fewer than the limit, because the server omits unfunded offers.
+(Optional) If provided, the server does not provide more than this many offers in the results. The total number of results returned may be fewer than the limit, because the server omits unfunded offers.
 
 
 taker
 String
-(Optional) The Address of an account to use as a perspective. Unfunded offers placed by this account are always included in the response. (You can use this to look up your own orders to cancel them.)
+(Optional) The Address of an account to use as a perspective. Unfunded offers placed by this account are always included in the response. (You can use this to look up your own orders to cancel them.)
 
 
 taker_gets
@@ -8665,11 +8925,11 @@ rippled book_offers 'USD/rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B' 'EUR/rvYAfWj5gh67oV6
 
 
 
-
                                      Response Format
                                      
+
                                      Response Format
                                      
 
                                      An example of a successful response:
                                      
-
                                      
+
                                      
 
-
                                      {
+
                                      {
   "id": 11,
   "status": "success",
   "type": "response",
@@ -8727,7 +8987,7 @@ rippled book_offers 'USD/rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B' 'EUR/rvYAfWj5gh67oV6
 }
 
                                      
 
-
                                      200 OK
+
                                      200 OK
 {
     "result": {
         "ledger_current_index": 8696243,
@@ -8797,7 +9057,7 @@ rippled book_offers 'USD/rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B' 'EUR/rvYAfWj5gh67oV6
 
 
 
-
                                      Possible Errors
                                      
+
                                      Possible Errors
                                      
 
                                        
 
                                      • Any of the universal error types.
                                        • 
 
                                      • invalidParams - One or more fields are specified incorrectly, or one or more required fields are missing.
                                        • 
@@ -8808,24 +9068,267 @@ rippled book_offers 'USD/rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B' 'EUR/rvYAfWj5gh67oV6
 
                                      • dstIsrMalformed - The issuer field of the taker_gets field in the request is not valid.
                                        • 
 
                                      • badMarket - The desired order book does not exist; for example, offers to exchange a currency for itself.
                                        • 
 
                                      
+
                                      channel_authorize
                                      
+
                                      [Source]
                                      
+
                                      (Requires the PayChan amendment to be enabled. New in: rippled 0.33.0)
                                      
+
                                      The channel_authorize method creates a signature that can be used to redeem a specific amount of XRP from a payment channel.
                                      
+
                                      Request Format
                                      
+
                                      An example of the request format:
                                      
+
                                      
+
+
                                      {
+    "id": "channel_authorize_example_id1",
+    "command": "channel_authorize",
+    "channel_id": "5DB01B7FFED6B67E6B0414DED11E051D2EE2B7619CE0EAA6286D67A3A4D5BDB3",
+    "secret": "s████████████████████████████",
+    "amount": "1000000"
+}
+
                                      
+
+
                                      POST http://localhost:5005/
+Content-Type: application/json
+
+{
+    "method": "channel_authorize",
+    "params": [{
+        "channel_id": "5DB01B7FFED6B67E6B0414DED11E051D2EE2B7619CE0EAA6286D67A3A4D5BDB3",
+        "secret": "s████████████████████████████",
+        "amount": "1000000"
+    }]
+}
+
                                      
+
+
                                      #Syntax: channel_authorize <private_key> <channel_id> <drops>
+rippled channel_authorize s████████████████████████████ 5DB01B7FFED6B67E6B0414DED11E051D2EE2B7619CE0EAA6286D67A3A4D5BDB3 1000000
+
                                      
+
                                      
+
                                      The request includes the following parameters:
                                      
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
                                      FieldTypeDescription
                                      channel_idStringThe unique ID of the payment channel to use.
                                      secretStringThe secret key to use to sign the claim. This must be the same key pair as the public key specified in the channel.
                                      amountStringCumulative amount of XRP, in drops, to authorize. If the destination has already received a lesser amount of XRP from this channel, the signature created by this method can be redeemed for the difference.
                                      
+
                                      Note: You cannot use Ed25519 keys to sign claims with this method. This is a known bug.
                                      
+
                                      Response Format
                                      
+
                                      An example of a successful response:
                                      
+
                                      
+
+
                                      {
+    "id": "channel_authorize_example_id1",
+    "status": "success"
+    "result": {
+        "signature": "304402204EF0AFB78AC23ED1C472E74F4299C0C21F1B21D07EFC0A3838A420F76D783A400220154FB11B6F54320666E4C36CA7F686C16A3A0456800BBC43746F34AF50290064",
+    }
+}
+
                                      
+
+
                                      200 OK
+
+{
+    "result": {
+        "signature": "304402204EF0AFB78AC23ED1C472E74F4299C0C21F1B21D07EFC0A3838A420F76D783A400220154FB11B6F54320666E4C36CA7F686C16A3A0456800BBC43746F34AF50290064",
+        "status": "success"
+    }
+}
+
                                      
+
+
                                      {
+    "result": {
+        "signature": "304402204EF0AFB78AC23ED1C472E74F4299C0C21F1B21D07EFC0A3838A420F76D783A400220154FB11B6F54320666E4C36CA7F686C16A3A0456800BBC43746F34AF50290064",
+        "status": "success"
+    }
+}
+
                                      
+
                                      
+
                                      The response follows the standard format, with a successful result containing the following fields:
                                      
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
                                      FieldTypeDescription
                                      signatureStringThe signature for this claim, as a hexadecimal value. To verify this signature or process the claim, the destination account of the payment channel must send a PaymentChannelClaim transaction with this signature, the exact Channel ID, XRP amount, and public key of the channel.
                                      
+
                                      Possible Errors
                                      
+
                                        
+
                                      • Any of the universal error types.
                                        • 
+
                                      • badSeed - The value specified in the secret field was not a valid secret key.
                                        • 
+
                                      • channelAmtMalformed - The value specified in the amount field was not a valid XRP amount. See Specifying Currency Amounts for details.
                                        • 
+
                                      • channelMalformed - The value specified in the channel_id field of the reqeuest was not a valid Channel ID. The Channel ID should be a 256-bit (64-character) hexadecimal string.
                                        • 
+
                                      
+
                                      channel_verify
                                      
+
                                      [Source]
                                      
+
                                      (Requires the PayChan amendment to be enabled. New in: rippled 0.33.0)
                                      
+
                                      The channel_verify method checks the validity of a signature that can be used to redeem a specific amount of XRP from a payment channel.
                                      
+
                                      Request Format
                                      
+
                                      An example of the request format:
                                      
+
                                      
+
+
                                      {
+    "id": 1,
+    "command": "channel_verify",
+    "channel_id": "5DB01B7FFED6B67E6B0414DED11E051D2EE2B7619CE0EAA6286D67A3A4D5BDB3",
+    "signature": "304402204EF0AFB78AC23ED1C472E74F4299C0C21F1B21D07EFC0A3838A420F76D783A400220154FB11B6F54320666E4C36CA7F686C16A3A0456800BBC43746F34AF50290064",
+    "public_key": "aB44YfzW24VDEJQ2UuLPV2PvqcPCSoLnL7y5M1EzhdW4LnK5xMS3",
+    "amount": "1000000"
+}
+
                                      
+
+
                                      POST http://localhost:5005/
+Content-Type: application/json
+
+{
+    "method": "channel_verify",
+    "params": [{
+        "channel_id": "5DB01B7FFED6B67E6B0414DED11E051D2EE2B7619CE0EAA6286D67A3A4D5BDB3",
+        "signature": "304402204EF0AFB78AC23ED1C472E74F4299C0C21F1B21D07EFC0A3838A420F76D783A400220154FB11B6F54320666E4C36CA7F686C16A3A0456800BBC43746F34AF50290064",
+        "public_key": "aB44YfzW24VDEJQ2UuLPV2PvqcPCSoLnL7y5M1EzhdW4LnK5xMS3",
+        "amount": "1000000"
+    }]
+}
+
                                      
+
+
                                      #Syntax: channel_verify <public_key> <channel_id> <amount> <signature>
+rippled channel_verify aB44YfzW24VDEJQ2UuLPV2PvqcPCSoLnL7y5M1EzhdW4LnK5xMS3 5DB01B7FFED6B67E6B0414DED11E051D2EE2B7619CE0EAA6286D67A3A4D5BDB3 1000000 304402204EF0AFB78AC23ED1C472E74F4299C0C21F1B21D07EFC0A3838A420F76D783A400220154FB11B6F54320666E4C36CA7F686C16A3A0456800BBC43746F34AF50290064
+
                                      
+
                                      
+
                                      The request includes the following parameters:
                                      
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
                                      FieldTypeDescription
                                      amountStringThe amount of XRP, in drops, the provided signature authorizes.
                                      channel_idStringThe Channel ID of the channel that provides the XRP. This is a 64-character hexadecimal string.
                                      public_keyStringThe public key of the channel and the key pair that was used to create the signature, in base58 format. (One way to get the public key in base58 format is to use the wallet_propose command.)
                                      signatureStringThe signature to verify, in hexadecimal.
                                      
+
                                      Response Format
                                      
+
                                      An example of a successful response:
                                      
+
                                      
+
+
                                      {
+    "id": 1,
+    "status": "success",
+    "type": "response",
+    "result": {
+        "signature_verified":true
+    }
+}
+
                                      
+
+
                                      200 OK
+
+{
+    "result": {
+        "signature_verified":true,
+        "status":"success"
+    }
+}
+
                                      
+
+
                                      {
+    "result": {
+        "signature_verified":true,
+        "status":"success"
+    }
+}
+
                                      
+
                                      
+
                                      The response follows the standard format, with a successful result containing the following fields:
                                      
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
                                      FieldTypeDescription
                                      signature_verifiedBooleanIf true, the signature is valid for the stated amount, channel, and public key.
                                      
+
                                      Caution: This does not indicate check that the channel has sufficient XRP allocated to it. Before considering a claim valid, you should look up the channel in the latest validated ledger and confirm that the channel is open and its amount value is equal or greater than the amount of the claim. To do so, use the account_channels method.
                                      
+
                                      Possible Errors
                                      
+
                                        
+
                                      • Any of the universal error types.
                                        • 
+
                                      • invalidParams - One or more fields are specified incorrectly, or one or more required fields are missing.
                                        • 
+
                                      • publicMalformed - The public_key field of the request is not a valid public key in the correct format. Public keys are 33 bytes and must be represented in base58. The base58 representation of account public keys starts with the letter a.
                                        • 
+
                                      • channelMalformed - The channel_id field of the request is not a valid Channel ID. The Channel ID must be a 256-bit (64-character) hexadecimal string.
                                        • 
+
                                      • channelAmtMalformed - The value specified in the amount field was not a valid XRP amount.
                                        • 
+
                                      
 
                                      Subscriptions
                                      
 
                                      Using subscriptions, you can have the server push updates to your client when various events happen, so that you can know and react right away. Subscriptions are only supported in the WebSocket API, where you can receive additional responses in the same channel.
                                      
 
                                      JSON-RPC support for subscription callbacks is deprecated and may not work as expected.
                                      
 
                                      subscribe
                                      
 
                                      [Source]
                                      
 
                                      The subscribe method requests periodic notifications from the server when certain events happen.
                                      
-
                                      Request Format
                                      
+
                                      Request Format
                                      
 
                                      An example of the request format:
                                      
-
                                      
+
                                      
 
-
                                      {
+
                                      {
   "id": "Example watch Bitstamp's hot wallet",
   "command": "subscribe",
   "accounts": ["rrpNnNLKrartuEqfJGpqyDwPj1AFPg9vn1"]
 }
 
                                      
 
-
                                      {
+
                                      {
     "id": "Example subscribe to XRP/GateHub USD order book",
     "command": "subscribe",
     "books": [
@@ -8843,7 +9346,7 @@ rippled book_offers 'USD/rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B' 'EUR/rvYAfWj5gh67oV6
 }
 
                                      
 
-
                                      {
+
                                      {
   "id": "Example watch for new validated ledgers",
   "command": "subscribe",
   "streams": ["ledger"]
@@ -8864,22 +9367,22 @@ rippled book_offers 'USD/rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B' 'EUR/rvYAfWj5gh67oV6
 
 streams
 Array
-(Optional) Array of string names of generic streams to subscribe to, as explained below
+(Optional) Array of string names of generic streams to subscribe to, as explained below
 
 
 accounts
 Array
-(Optional) Array with the unique base58 addresses of accounts to monitor for validated transactions. The server sends a notification for any transaction that affects at least one of these accounts.
+(Optional) Array with the unique base58 addresses of accounts to monitor for validated transactions. The server sends a notification for any transaction that affects at least one of these accounts.
 
 
 accounts_proposed
 Array
-(Optional) Like accounts, but include transactions that are not yet finalized.
+(Optional) Like accounts, but include transactions that are not yet finalized.
 
 
 books
 Array
-(Optional) Array of objects defining order books to monitor for updates, as detailed below.
+(Optional) Array of objects defining order books to monitor for updates, as detailed below.
 
 
 url
@@ -8889,12 +9392,12 @@ rippled book_offers 'USD/rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B' 'EUR/rvYAfWj5gh67oV6
 
 url_username
 String
-(Optional) Username to provide for basic authentication at the callback URL.
+(Optional) Username to provide for basic authentication at the callback URL.
 
 
 url_password
 String
-(Optional) Password to provide for basic authentication at the callback URL.
+(Optional) Password to provide for basic authentication at the callback URL.
 
 
 
@@ -8946,11 +9449,11 @@ rippled book_offers 'USD/rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B' 'EUR/rvYAfWj5gh67oV6
 
 
 
-
                                      Response Format
                                      
+
                                      Response Format
                                      
 
                                      An example of a successful response:
                                      
-
                                      
+
                                      
 
-
                                      {
+
                                      {
   "id": "Example watch Bitstamp's hot wallet",
   "status": "success",
   "type": "response",
@@ -8966,13 +9469,13 @@ rippled book_offers 'USD/rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B' 'EUR/rvYAfWj5gh67oV6
 
                                    • Stream: ledger - Information about the ledgers on hand and current fee schedule, such as fee_base (current base fee for transactions in XRP), fee_ref (current base fee for transactions in fee units), ledger_hash (hash of the latest validated ledger), reserve_base (minimum reserve for accounts), and more.
                                      • 
 
                                    • books - No fields returned by default. If "snapshot": true is set in the request, returns offers (an array of offer definition objects defining the order book)
                                      • 
 
                                    
-
                                    Possible Errors
                                    
+
                                    Possible Errors
                                    
 
                                      
 
                                    • Any of the universal error types.
                                      • 
 
                                    • invalidParams - One or more fields are specified incorrectly, or one or more required fields are missing.
                                      • 
 
                                    • noPermission - The request included the url field, but you are not connected as an admin.
                                      • 
-
                                    • unknownStream - One or more the members of the streams field in the request was not recognized as a valid stream name.
                                      • 
-
                                    • malformedStream - The streams field of the request was not formatted properly.
                                      • 
+
                                    • unknownStream - One or more the members of the streams field of the request is not a valid stream name.
                                      • 
+
                                    • malformedStream - The streams field of the request is not formatted properly.
                                      • 
 
                                    • malformedAccount - One of the addresses in the accounts or accounts_proposed fields of the request is not a properly-formatted Ripple address. (Note:: You can subscribe to the stream of an address that does not yet have an entry in the global ledger to get a message when that address becomes funded.)
                                      • 
 
                                    • srcCurMalformed - One or more taker_pays sub-fields of the books field in the request is not formatted properly.
                                      • 
 
                                    • dstAmtMalformed - One or more taker_gets sub-fields of the books field in the request is not formatted properly.
                                      • 
@@ -9572,11 +10075,11 @@ rippled book_offers 'USD/rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B' 'EUR/rvYAfWj5gh67oV6
 
                                      unsubscribe
                                      
 
                                      [Source]
                                      
 
                                      The unsubscribe command tells the server to stop sending messages for a particular subscription or set of subscriptions.
                                      
-
                                      Request Format
                                      
+
                                      Request Format
                                      
 
                                      An example of the request format:
                                      
-
                                      
+
                                      
 
-
                                      {
+
                                      {
     "id": "Unsubscribe a lot of stuff",
     "command": "unsubscribe",
     "streams": ["ledger","server","transactions","transactions_proposed"],
@@ -9611,22 +10114,22 @@ rippled book_offers 'USD/rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B' 'EUR/rvYAfWj5gh67oV6
 
 streams
 Array
-(Optional) Array of string names of generic streams to unsubscribe from, including ledger, server, transactions, and transactions_proposed.
+(Optional) Array of string names of generic streams to unsubscribe from, including ledger, server, transactions, and transactions_proposed.
 
 
 accounts
 Array
-(Optional) Array of unique base58 account addresses to stop receiving updates for. (This only stops those messages if you previously subscribed to those accounts specifically. You cannot use this to filter accounts out of the general transactions stream.)
+(Optional) Array of unique base58 account addresses to stop receiving updates for. (This only stops those messages if you previously subscribed to those accounts specifically. You cannot use this to filter accounts out of the general transactions stream.)
 
 
 accounts_proposed
 Array
-(Optional) Like accounts, but for accounts_proposed subscriptions that included not-yet-validated transactions.
+(Optional) Like accounts, but for accounts_proposed subscriptions that included not-yet-validated transactions.
 
 
 books
 Array
-(Optional) Array of objects defining order books to unsubscribe from, as explained below.
+(Optional) Array of objects defining order books to unsubscribe from, as explained below.
 
 
 
@@ -9658,11 +10161,11 @@ rippled book_offers 'USD/rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B' 'EUR/rvYAfWj5gh67oV6
 
 
 
-
                                      Response Format
                                      
+
                                      Response Format
                                      
 
                                      An example of a successful response:
                                      
-
                                      
+
                                      
 
-
                                      {
+
                                      {
     "id": "Unsubscribe a lot of stuff",
     "result": {},
     "status": "success",
@@ -9671,12 +10174,12 @@ rippled book_offers 'USD/rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B' 'EUR/rvYAfWj5gh67oV6
 
                                      
 
                                      
 
                                      The response follows the standard format, with a successful result containing no fields.
                                      
-
                                      Possible Errors
                                      
+
                                      Possible Errors
                                      
 
                                        
 
                                      • Any of the universal error types.
                                        • 
 
                                      • invalidParams - One or more fields are specified incorrectly, or one or more required fields are missing.
                                        • 
 
                                      • noPermission - The request included the url field, but you are not connected as an admin.
                                        • 
-
                                      • malformedStream - The streams field of the request was not formatted properly.
                                        • 
+
                                      • malformedStream - The streams field of the request is not formatted properly.
                                        • 
 
                                      • malformedAccount - One of the addresses in the accounts or accounts_proposed fields of the request is not a properly-formatted Ripple address.
                                          
 
                                        • Note:: You can subscribe to the stream of an address that does not yet have an entry in the global ledger to get a message when that address becomes funded.
                                          • 
 
                                        
@@ -9692,17 +10195,17 @@ rippled book_offers 'USD/rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B' 'EUR/rvYAfWj5gh67oV6
 
                                        server_info
                                        
 
                                        [Source]
                                        
 
                                        The server_info command asks the server for a human-readable version of various information about the rippled server being queried.
                                        
-
                                        Request Format
                                        
+
                                        Request Format
                                        
 
                                        An example of the request format:
                                        
-
                                        
+
                                        
 
-
                                        {
+
                                        {
   "id": 1,
   "command": "server_info"
 }
 
                                        
 
-
                                        {
+
                                        {
     "method": "server_info",
     "params": [
         {}
@@ -9710,17 +10213,17 @@ rippled book_offers 'USD/rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B' 'EUR/rvYAfWj5gh67oV6
 }
 
                                        
 
-
                                        #Syntax: server_info
+
                                        #Syntax: server_info
 rippled server_info
 
                                        
 
                                        
 
                                        Try it!
                                        
 
                                        The request does not takes any parameters.
                                        
-
                                        Response Format
                                        
+
                                        Response Format
                                        
 
                                        An example of a successful response:
                                        
-
                                        
+
                                        
 
-
                                        {
+
                                        {
   "id": 1,
   "status": "success",
   "type": "response",
@@ -9822,7 +10325,7 @@ rippled server_info
 }
 
                                        
 
-
                                        200 OK
+
                                        200 OK
 {
    "result" : {
       "info" : {
@@ -10111,24 +10614,24 @@ rippled server_info
 
 
 
                                        Note: If the closed_ledger field is present and has a small seq value (less than 8 digits), that indicates rippled does not currently have a copy of the validated ledger from the peer-to-peer network. This could mean your server is still syncing. Typically, it takes about 5 minutes to sync with the network, depending on your connection speed and hardware specs.
                                        
-
                                        Possible Errors
                                        
+
                                        Possible Errors
                                        
 
 
                                        server_state
                                        
 
                                        [Source]
                                        
 
                                        The server_state command asks the server for various machine-readable information about the rippled server's current state. The results are almost the same as server_info, but using units that are easier to process instead of easier to read. (For example, XRP values are given in integer drops instead of scientific notation or decimal values, and time is given in milliseconds instead of seconds.)
                                        
-
                                        Request Format
                                        
+
                                        Request Format
                                        
 
                                        An example of the request format:
                                        
-
                                        
+
                                        
 
-
                                        {
+
                                        {
   "id": 2,
   "command": "server_state"
 }
 
                                        
 
-
                                        {
+
                                        {
     "method": "server_state",
     "params": [
         {}
@@ -10136,17 +10639,17 @@ rippled server_info
 }
 
                                        
 
-
                                        #Syntax: server_state
+
                                        #Syntax: server_state
 rippled server_state
 
                                        
 
                                        
 
                                        Try it!
                                        
 
                                        The request does not takes any parameters.
                                        
-
                                        Response Format
                                        
+
                                        Response Format
                                        
 
                                        An example of a successful response:
                                        
-
                                        
+
                                        
 
-
                                        {
+
                                        {
   "id": 2,
   "status": "success",
   "type": "response",
@@ -10239,7 +10742,7 @@ rippled server_state
 }
 
                                        
 
-
                                        200 OK
+
                                        200 OK
 {
    "result" : {
       "state" : {
@@ -10491,7 +10994,7 @@ rippled server_state
 
 
 
-
                                        Possible Errors
                                        
+
                                        Possible Errors
                                        
 
@@ -10499,18 +11002,18 @@ rippled server_state
 
                                        [Source]
                                        
 
                                        With online_delete and advisory_delete configuration options enabled, the can_delete method informs the rippled server of the latest ledger which may be deleted.
                                        
 
                                        The can_delete method is an admin command that cannot be run by unprivileged users.
                                        
-
                                        Request Format
                                        
+
                                        Request Format
                                        
 
                                        An example of the request format:
                                        
-
                                        
+
                                        
 
-
                                        {
+
                                        {
   "id": 2,
   "command": "can_delete",
   "can_delete": 11320417
 }
 
                                        
 
-
                                        {
+
                                        {
     "method": "can_delete",
     "params": [
         {
@@ -10520,7 +11023,7 @@ rippled server_state
 }
 
                                        
 
-
                                        #Syntax can_delete [<ledger_index>|<ledger_hash>|now|always|never]
+
                                        #Syntax can_delete [<ledger_index>|<ledger_hash>|now|always|never]
 rippled can_delete 11320417
 
                                        
 
                                        
@@ -10561,7 +11064,7 @@ a successful result containing the following fields:
                                        
 
 
 
                                        Use this command with no parameter to query the existing can_delete setting.
                                        
-
                                        Possible Errors
                                        
+
                                        Possible Errors
                                        
 
                                          
 
                                        • Any of the universal error types.
                                          • 
 
                                        • notEnabled - Not enabled in configuration.
                                          • 
@@ -10573,17 +11076,17 @@ a successful result containing the following fields:
                                          
 
                                          [Source]
                                          
 
                                          The consensus_info command provides information about the consensus process for debugging purposes.
                                          
 
                                          The consensus_info method is an admin command that cannot be run by unprivileged users.
                                          
-
                                          Request Format
                                          
+
                                          Request Format
                                          
 
                                          An example of the request format:
                                          
-
                                          
+
                                          
 
-
                                          {
+
                                          {
     "id": 99,
     "command": "consensus_info"
 }
 
                                          
 
-
                                          {
+
                                          {
     "method": "consensus_info",
     "params": [
         {}
@@ -10591,16 +11094,16 @@ a successful result containing the following fields:
                                          
 }
 
                                          
 
-
                                          #Syntax: consensus_info
+
                                          #Syntax: consensus_info
 rippled consensus_info
 
                                          
 
                                          
 
                                          The request has no parameters.
                                          
-
                                          Response Format
                                          
+
                                          Response Format
                                          
 
                                          An example of a successful response:
                                          
-
                                          
+
                                          
 
-
                                          {
+
                                          {
    "result" : {
       "info" : {
          "acquired" : {
@@ -10672,7 +11175,7 @@ rippled consensus_info
 }
 
                                          
 
-
                                          Loading: "/etc/rippled.cfg"
+
                                          Loading: "/etc/rippled.cfg"
 Connecting to 127.0.0.1:5005
 {
    "result" : {
@@ -10807,7 +11310,7 @@ Connecting to 127.0.0.1:5005
 
 
                                          It is also normal to get a minimal result where the only field in info is "consensus": "none". This indicates that the server is in between consensus rounds.
                                          
 
                                          The results of the consensus_info command can vary dramatically if you run it several times, even in short succession.
                                          
-
                                          Possible Errors
                                          
+
                                          Possible Errors
                                          
 
@@ -10815,18 +11318,18 @@ Connecting to 127.0.0.1:5005
 
                                          [Source]
                                          
 
                                          The fetch_info command returns information about objects that this server is currently fetching from the network, and how many peers have that information. It can also be used to reset current fetches.
                                          
 
                                          The fetch_info method is an admin command that cannot be run by unprivileged users.
                                          
-
                                          Request Format
                                          
+
                                          Request Format
                                          
 
                                          An example of the request format:
                                          
-
                                          
+
                                          
 
-
                                          {
+
                                          {
     "id": 91,
     "command": "fetch_info",
     "clear": false
 }
 
                                          
 
-
                                          {
+
                                          {
     "method": "fetch_info",
     "params": [
         {
@@ -10836,7 +11339,7 @@ Connecting to 127.0.0.1:5005
 }
 
                                          
 
-
                                          #Syntax: fetch_info [clear]
+
                                          #Syntax: fetch_info [clear]
 rippled fetch_info
 
                                          
 
                                          
@@ -10857,11 +11360,11 @@ rippled fetch_info
 
 
 
-
                                          Response Format
                                          
+
                                          Response Format
                                          
 
                                          An example of a successful response:
                                          
-
                                          
+
                                          
 
-
                                          {
+
                                          {
    "result" : {
       "info" : {
          "348928" : {
@@ -10896,7 +11399,7 @@ rippled fetch_info
 }
 
                                          
 
-
                                          Loading: "/etc/rippled.cfg"
+
                                          Loading: "/etc/rippled.cfg"
 Connecting to 127.0.0.1:5005
 {
    "result" : {
@@ -10992,7 +11495,7 @@ Connecting to 127.0.0.1:5005
 
 
 
-
                                          Possible Errors
                                          
+
                                          Possible Errors
                                          
 
@@ -11001,17 +11504,17 @@ Connecting to 127.0.0.1:5005
 
                                          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: rippled 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 unprivileged users.
                                          
-
                                          Request Format
                                          
+
                                          Request Format
                                          
 
                                          An example of the request format:
                                          
-
                                          
+
                                          
 
-
                                          {
+
                                          {
   "id": "list_all_features",
   "command": "feature"
 }
 
                                          
 
-
                                          {
+
                                          {
   "id": "reject_multi_sign",
   "command": "feature",
   "feature": "4C97EBA926031A7CF7D7B36FDE3ED66DDA5421192D63DE53FFB46E43B9DC8373",
@@ -11019,7 +11522,7 @@ Connecting to 127.0.0.1:5005
 }
 
                                          
 
-
                                          {
+
                                          {
     "method": "feature",
     "params": [
         {
@@ -11030,7 +11533,7 @@ Connecting to 127.0.0.1:5005
 }
 
                                          
 
-
                                          #Syntax: feature [<feature_id> [accept|reject]]
+
                                          #Syntax: feature [<feature_id> [accept|reject]]
 rippled feature 4C97EBA926031A7CF7D7B36FDE3ED66DDA5421192D63DE53FFB46E43B9DC8373 accept
 
                                          
 
                                          
@@ -11047,7 +11550,7 @@ rippled feature 4C97EBA926031A7CF7D7B36FDE3ED66DDA5421192D63DE53FFB46E43B9DC8373
 
 feature
 String
-(Optional) The unique ID of an amendment, as hexadecimal; or the short name of the amendment. If provided, limits the response to one amendment. Otherwise, the response lists all amendments.
+(Optional) The unique ID of an amendment, as hexadecimal; or the short name of the amendment. If provided, limits the response to one amendment. Otherwise, the response lists all amendments.
 
 
 vetoed
@@ -11057,11 +11560,11 @@ rippled feature 4C97EBA926031A7CF7D7B36FDE3ED66DDA5421192D63DE53FFB46E43B9DC8373
 
 
 
                                          Note: You can configure your server to vote in favor of a new amendment, even if the server does not currently know how to apply that amendment, by specifying the amendment ID in the feature field. For example, you might want to do this if you plan to upgrade soon to a new rippled version that does support the amendment.
                                          
-
                                          Response Format
                                          
+
                                          Response Format
                                          
 
                                          An example of a successful response:
                                          
-
                                          
+
                                          
 
-
                                          {
+
                                          {
   "id": "list_all_features",
   "status": "success",
   "type": "response",
@@ -11102,7 +11605,7 @@ rippled feature 4C97EBA926031A7CF7D7B36FDE3ED66DDA5421192D63DE53FFB46E43B9DC8373
 }
 
                                          
 
-
                                          {
+
                                          {
     "id": "reject_multi_sign",
     "status": "success",
     "type": "response",
@@ -11119,7 +11622,7 @@ rippled feature 4C97EBA926031A7CF7D7B36FDE3ED66DDA5421192D63DE53FFB46E43B9DC8373
 }
 
                                          
 
-
                                          200 OK
+
                                          200 OK
 {
     "result": {
         "4C97EBA926031A7CF7D7B36FDE3ED66DDA5421192D63DE53FFB46E43B9DC8373": {
@@ -11133,7 +11636,7 @@ rippled feature 4C97EBA926031A7CF7D7B36FDE3ED66DDA5421192D63DE53FFB46E43B9DC8373
 }
 
                                          
 
-
                                          Loading: "/etc/rippled.cfg"
+
                                          Loading: "/etc/rippled.cfg"
 Connecting to 127.0.0.1:5005
 {
     "result": {
@@ -11181,7 +11684,7 @@ Connecting to 127.0.0.1:5005
 
 
 
                                          Caution: The name for an amendment does not strictly indicate what that amendment does. The name is not guaranteed to be unique or consistent across servers.
                                          
-
                                          Possible Errors
                                          
+
                                          Possible Errors
                                          
 
                                            
 
                                          • Any of the universal error types.
                                            • 
 
                                          • badFeature - The feature specified was invalidly formatted, or the server does not know an amendment with that name.
                                            • 
@@ -11190,32 +11693,32 @@ Connecting to 127.0.0.1:5005
 
                                            [Source]
                                            
 
                                            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: rippled 0.31.0
                                            
 
                                            This is a public command available to unprivileged users. Updated in: rippled 0.32.0
                                            
-
                                            Request Format
                                            
+
                                            Request Format
                                            
 
                                            An example of the request format:
                                            
-
                                            
+
                                            
 
-
                                            {
+
                                            {
   "id": "fee_websocket_example",
   "command": "fee"
 }
 
                                            
 
-
                                            {
+
                                            {
     "method": "fee",
     "params": [{}]
 }
 
                                            
 
-
                                            #Syntax: fee
+
                                            #Syntax: fee
 rippled fee
 
                                            
 
                                            
 
                                            The request does not include any parameters.
                                            
-
                                            Response Format
                                            
+
                                            Response Format
                                            
 
                                            An example of a successful response:
                                            
-
                                            
+
                                            
 
-
                                            {
+
                                            {
   "id": "fee_websocket_example",
   "status": "success",
   "type": "response",
@@ -11241,7 +11744,7 @@ rippled fee
 }
 
                                            
 
-
                                            200 OK
+
                                            200 OK
 {
     "result": {
         "current_ledger_size": "56",
@@ -11266,7 +11769,7 @@ rippled fee
 }
 
                                            
 
-
                                            Loading: "/etc/rippled.cfg"
+
                                            Loading: "/etc/rippled.cfg"
 Connecting to 127.0.0.1:5005
 {
    "result" : {
@@ -11379,7 +11882,7 @@ Connecting to 127.0.0.1:5005
 
 
 
-
                                            Possible Errors
                                            
+
                                            Possible Errors
                                            
 
@@ -11387,18 +11890,18 @@ Connecting to 127.0.0.1:5005
 
                                            [Source]
                                            
 
                                            The get_counts command provides various stats about the health of the server, mostly the number of objects of different types that it currently holds in memory.
                                            
 
                                            The get_counts method is an admin command that cannot be run by unprivileged users.
                                            
-
                                            Request Format
                                            
+
                                            Request Format
                                            
 
                                            An example of the request format:
                                            
-
                                            
+
                                            
 
-
                                            {
+
                                            {
     "id": 90,
     "command": "get_counts",
     "min_count": 100
 }
 
                                            
 
-
                                            {
+
                                            {
     "method": "get_counts",
     "params": [
         {
@@ -11408,7 +11911,7 @@ Connecting to 127.0.0.1:5005
 }
 
                                            
 
-
                                            #Syntax: get_counts [min_count]
+
                                            #Syntax: get_counts [min_count]
 rippled get_counts 100
 
                                            
 
                                            
@@ -11429,11 +11932,11 @@ rippled get_counts 100
 
 
 
-
                                            Response Format
                                            
+
                                            Response Format
                                            
 
                                            An example of a successful response:
                                            
-
                                            
+
                                            
 
-
                                            {
+
                                            {
    "result" : {
       "AL_hit_rate" : 48.36725616455078,
       "HashRouterEntry" : 3048,
@@ -11467,7 +11970,7 @@ rippled get_counts 100
 }
 
                                            
 
-
                                            Loading: "/etc/rippled.cfg"
+
                                            Loading: "/etc/rippled.cfg"
 Connecting to 127.0.0.1:5005
 {
    "result" : {
@@ -11531,20 +12034,20 @@ Connecting to 127.0.0.1:5005
 
 
 
                                            For most other entries, the value indicates the number of objects of that type currently in memory.
                                            
-
                                            Possible Errors
                                            
+
                                            Possible Errors
                                            
 
                                              
 
                                            • Any of the universal error types.
                                              • 
 
                                            • invalidParams - One or more fields are specified incorrectly, or one or more required fields are missing.
                                              • 
 
                                            
 
                                            ledger_cleaner
                                            
 
                                            [Source]
                                            
-
                                            The ledger_cleaner command controls the Ledger Cleaner, an asynchronous maintenance process that can find and repair corruption in rippled's database of ledgers.
                                            
+
                                            The ledger_cleaner command controls the Ledger Cleaner, an asynchronous maintenance process that can find and repair corruption in rippled's database of ledgers.
                                            
 
                                            The ledger_cleaner method is an admin command that cannot be run by unprivileged users.
                                            
-
                                            Request Format
                                            
+
                                            Request Format
                                            
 
                                            An example of the request format:
                                            
-
                                            
+
                                            
 
-
                                            {
+
                                            {
     "command": "ledger_cleaner",
     "max_ledger": 13818756,
     "min_ledger": 13818000,
@@ -11565,45 +12068,45 @@ Connecting to 127.0.0.1:5005
 
 ledger
 Number (Ledger Sequence Number)
-(Optional) If provided, check and correct this specific ledger only.
+(Optional) If provided, check and correct this specific ledger only.
 
 
 max_ledger
 Number (Ledger Sequence Number)
-(Optional) Configure the ledger cleaner to check ledgers with sequence numbers equal or lower than this.
+(Optional) Configure the ledger cleaner to check ledgers with sequence numbers equal or lower than this.
 
 
 min_ledger
 Number (Ledger Sequence Number)
-(Optional) Configure the ledger cleaner to check ledgers with sequence numbers equal or higher than this.
+(Optional) Configure the ledger cleaner to check ledgers with sequence numbers equal or higher than this.
 
 
 full
 Boolean
-(Optional) If true, fix ledger state nodes and transations in the specified ledger(s). Defaults to false. Automatically set to true if ledger is provided.
+(Optional) If true, fix ledger state nodes and transations in the specified ledger(s). Defaults to false. Automatically set to true if ledger is provided.
 
 
 fix_txns
 Boolean
-(Optional) If true, correct transaction in the specified ledger(s). Overrides full if provided.
+(Optional) If true, correct transaction in the specified ledger(s). Overrides full if provided.
 
 
 check_nodes
 Boolean
-(Optional) If true, correct ledger state nodes in the specified ledger(s). Overrides full if provided.
+(Optional) If true, correct ledger state nodes in the specified ledger(s). Overrides full if provided.
 
 
 stop
 Boolean
-(Optional) If true, disable the ledger cleaner.
+(Optional) If true, disable the ledger cleaner.
 
 
 
-
                                            Response Format
                                            
+
                                            Response Format
                                            
 
                                            An example of a successful response:
                                            
-
                                            
+
                                            
 
-
                                            200 OK
+
                                            200 OK
 {
    "result" : {
       "message" : "Cleaner configured",
@@ -11630,20 +12133,20 @@ Connecting to 127.0.0.1:5005
 
 
 
-
                                            Possible Errors
                                            
+
                                            Possible Errors
                                            
 
                                              
 
                                            • Any of the universal error types.
                                              • 
-
                                            • internal if one the parameters was specified in a way that the server couldn't interpret. (This is a bug, and it should return invalidParams instead.)
                                              • 
+
                                            • internal if one the parameters is specified incorrectly. (This is a bug; the intended error code is invalidParams.)
                                              • 
 
                                            
 
                                            log_level
                                            
 
                                            [Source]
                                            
 
                                            The log_level command changes the rippled server's logging verbosity, or returns the current logging level for each category (called a partition) of log messages.
                                            
 
                                            The log_level method is an admin command that cannot be run by unprivileged users.
                                            
-
                                            Request Format
                                            
+
                                            Request Format
                                            
 
                                            An example of the request format:
                                            
-
                                            
+
                                            
 
-
                                            {
+
                                            {
     "id": "ll1",
     "command": "log_level",
     "severity": "debug",
@@ -11651,7 +12154,7 @@ Connecting to 127.0.0.1:5005
 }
 
                                            
 
-
                                            #Syntax: log_level [[partition] severity]
+
                                            #Syntax: log_level [[partition] severity]
 rippled log_level PathRequest debug
 
                                            
 
                                            
@@ -11668,20 +12171,20 @@ rippled log_level PathRequest debug
 
 severity
 String
-(Optional) What level of verbosity to set logging at. Valid values are, in order from least to most verbose: fatal, error, warn, info, debug, and trace. If omitted, return current log verbosity for all categories.
+(Optional) What level of verbosity to set logging at. Valid values are, in order from least to most verbose: fatal, error, warn, info, debug, and trace. If omitted, return current log verbosity for all categories.
 
 
 partition
 String
-(Optional) Ignored unless severity is provided. Which logging category to modify. If omitted, or if provided with the value base, set logging level for all categories.
+(Optional) Ignored unless severity is provided. Which logging category to modify. If omitted, or if provided with the value base, set logging level for all categories.
 
 
 
-
                                            Response Format
                                            
+
                                            Response Format
                                            
 
                                            Examples of successful responses:
                                            
-
                                            
+
                                            
 
-
                                            Loading: "/etc/rippled.cfg"
+
                                            Loading: "/etc/rippled.cfg"
 Connecting to 127.0.0.1:5005
 {
    "result" : {
@@ -11690,7 +12193,7 @@ Connecting to 127.0.0.1:5005
 }
 
                                            
 
-
                                            Loading: "/etc/rippled.cfg"
+
                                            Loading: "/etc/rippled.cfg"
 Connecting to 127.0.0.1:5005
 {
    "result" : {
@@ -11769,7 +12272,7 @@ Connecting to 127.0.0.1:5005
 
 
 
-
                                            Possible Errors
                                            
+
                                            Possible Errors
                                            
 
                                              
 
                                            • Any of the universal error types.
                                              • 
 
                                            • invalidParams - One or more fields are specified incorrectly, or one or more required fields are missing.
                                              • 
@@ -11778,25 +12281,25 @@ Connecting to 127.0.0.1:5005
 
                                              [Source]
                                              
 
                                              The logrotate command closes and reopens the log file. This is intended to help with log rotation on Linux file systems.
                                              
 
                                              The logrotate method is an admin command that cannot be run by unprivileged users.
                                              
-
                                              Request Format
                                              
+
                                              Request Format
                                              
 
                                              An example of the request format:
                                              
-
                                              
+
                                              
 
-
                                              {
+
                                              {
     "id": "lr1",
     "command": "logrotate"
 }
 
                                              
 
-
                                              rippled logrotate
+
                                              rippled logrotate
 
                                              
 
                                              
 
                                              The request includes no parameters.
                                              
-
                                              Response Format
                                              
+
                                              Response Format
                                              
 
                                              An example of a successful response:
                                              
-
                                              
+
                                              
 
-
                                              200 OK
+
                                              200 OK
 {
    "result" : {
       "message" : "The log file was closed and reopened.",
@@ -11806,7 +12309,7 @@ Connecting to 127.0.0.1:5005
 
 
                                              
 
-
                                              Loading: "/etc/rippled.cfg"
+
                                              Loading: "/etc/rippled.cfg"
 Connecting to 127.0.0.1:5005
 {
    "result" : {
@@ -11834,7 +12337,7 @@ Connecting to 127.0.0.1:5005
 
 
 
-
                                              Possible Errors
                                              
+
                                              Possible Errors
                                              
 
@@ -11842,18 +12345,18 @@ Connecting to 127.0.0.1:5005
 
                                              [Source]
                                              
 
                                              Use the validation_create command to generate the keys for a rippled validating node. Similar to the wallet_propose command, this command makes no real changes, but only generates a set of keys in the proper format.
                                              
 
                                              The validation_create method is an admin command that cannot be run by unprivileged users.
                                              
-
                                              Request Format
                                              
+
                                              Request Format
                                              
 
                                              An example of the request format:
                                              
-
                                              
+
                                              
 
-
                                              {
+
                                              {
     "id": 0,
     "command": "validation_create",
     "secret": "BAWL MAN JADE MOON DOVE GEM SON NOW HAD ADEN GLOW TIRE"
 }
 
                                              
 
-
                                              {
+
                                              {
     "method": "validation_create",
     "params": [
         {
@@ -11863,7 +12366,7 @@ Connecting to 127.0.0.1:5005
 }
 
                                              
 
-
                                              #Syntax: validation_create [secret]
+
                                              #Syntax: validation_create [secret]
 rippled validation_create "BAWL MAN JADE MOON DOVE GEM SON NOW HAD ADEN GLOW TIRE"
 
                                              
 
                                              
@@ -11880,16 +12383,16 @@ rippled validation_create "BAWL MAN JADE MOON DOVE GEM SON NOW HAD ADEN GLOW TIR
 
 secret
 String
-(Optional) Use this value as a seed to generate the credentials. The same secret always generates the same credentials. You can provide the seed in RFC-1751 format or Ripple's base58 format. If omitted, generate a random seed.
+(Optional) Use this value as a seed to generate the credentials. The same secret always generates the same credentials. You can provide the seed in RFC-1751 format or Ripple's base58 format. If omitted, generate a random seed.
 
 
 
 
                                              Note: The security of your validator depends on the entropy of your seed. Do not use a secret value that is not sufficiently randomized for real business purposes. We recommend omitting the secret when generating new credentials for the first time.
                                              
-
                                              Response Format
                                              
+
                                              Response Format
                                              
 
                                              An example of a successful response:
                                              
-
                                              
+
                                              
 
-
                                              {
+
                                              {
    "result" : {
       "status" : "success",
       "validation_key" : "FAWN JAVA JADE HEAL VARY HER REEL SHAW GAIL ARCH BEN IRMA",
@@ -11899,7 +12402,7 @@ rippled validation_create "BAWL MAN JADE MOON DOVE GEM SON NOW HAD ADEN GLOW TIR
 }
 
                                              
 
-
                                              Loading: "/etc/rippled.cfg"
+
                                              Loading: "/etc/rippled.cfg"
 Connecting to 127.0.0.1:5005
 {
    "result" : {
@@ -11938,7 +12441,7 @@ Connecting to 127.0.0.1:5005
 
 
 
-
                                              Possible Errors
                                              
+
                                              Possible Errors
                                              
 
                                                
 
                                              • Any of the universal error types.
                                                • 
 
                                              • badSeed - The request provided an invalid seed value. This usually means that the seed value appears to be a valid string of a different format, such as an account address or validation public key.
                                                • 
@@ -11947,18 +12450,18 @@ Connecting to 127.0.0.1:5005
 
                                                [Source]
                                                
 
                                                The validation_seed command temporarily sets the secret value that rippled uses to sign validations. This value resets based on the config file when you restart the server.
                                                
 
                                                The validation_seed request is an admin command that cannot be run by unprivileged users!
                                                
-
                                                Request Format
                                                
+
                                                Request Format
                                                
 
                                                An example of the request format:
                                                
-
                                                
+
                                                
 
-
                                                {
+
                                                {
     "id": "set_seed_1",
     "command": "validation_seed",
     "secret": "BAWL MAN JADE MOON DOVE GEM SON NOW HAD ADEN GLOW TIRE"
 }
 
                                                
 
-
                                                #Syntax: validation_seed [secret]
+
                                                #Syntax: validation_seed [secret]
 rippled validation_seed 'BAWL MAN JADE MOON DOVE GEM SON NOW HAD ADEN GLOW TIRE'
 
                                                
 
                                                
@@ -11975,15 +12478,15 @@ rippled validation_seed 'BAWL MAN JADE MOON DOVE GEM SON NOW HAD ADEN GLOW TIRE'
 
 secret
 String
-(Optional) If present, use this value as the secret value for the validating key pair. Valid formats include base58, RFC-1751, or as a passphrase. If omitted, disables proposing validations to the network.
+(Optional) If present, use this value as the secret value for the validating key pair. Valid formats include base58, RFC-1751, or as a passphrase. If omitted, disables proposing validations to the network.
 
 
 
-
                                                Response Format
                                                
+
                                                Response Format
                                                
 
                                                An example of a successful response:
                                                
-
                                                
+
                                                
 
-
                                                200 OK
+
                                                200 OK
 {
    "result" : {
       "status" : "success",
@@ -11994,7 +12497,7 @@ rippled validation_seed 'BAWL MAN JADE MOON DOVE GEM SON NOW HAD ADEN GLOW TIRE'
 }
 
                                                
 
-
                                                Loading: "/etc/rippled.cfg"
+
                                                Loading: "/etc/rippled.cfg"
 Connecting to 127.0.0.1:5005
 {
    "result" : {
@@ -12033,7 +12536,7 @@ Connecting to 127.0.0.1:5005
 
 
 
-
                                                Possible Errors
                                                
+
                                                Possible Errors
                                                
 
                                                  
 
                                                • Any of the universal error types.
                                                  • 
 
                                                • badSeed - The request provided an invalid secret value. This usually means that the secret value appears to be a valid string of a different format, such as an account address or validation public key.
                                                  • 
@@ -12042,25 +12545,25 @@ Connecting to 127.0.0.1:5005
 
                                                  [Source]
                                                  
 
                                                  The peers command returns a list of all other rippled servers currently connected to this one, including information on their connection and sync status.
                                                  
 
                                                  The peers request is an admin command that cannot be run by unprivileged users!
                                                  
-
                                                  Request Format
                                                  
+
                                                  Request Format
                                                  
 
                                                  An example of the request format:
                                                  
-
                                                  
+
                                                  
 
-
                                                  {
+
                                                  {
     "id": 2,
     "command": "peers"
 }
 
                                                  
 
-
                                                  rippled peers
+
                                                  rippled peers
 
                                                  
 
                                                  
 
                                                  The request includes no additional parameters.
                                                  
-
                                                  Response Format
                                                  
+
                                                  Response Format
                                                  
 
                                                  An example of a successful response:
                                                  
-
                                                  
+
                                                  
 
-
                                                  {
+
                                                  {
   "id": 2,
   "status": "success",
   "type": "response",
@@ -12172,7 +12675,7 @@ Connecting to 127.0.0.1:5005
 }
 
                                                  
 
-
                                                  {
+
                                                  {
    "result" : {
       "cluster" : {},
       "peers" : [
@@ -12282,7 +12785,7 @@ Connecting to 127.0.0.1:5005
 }
 
                                                  
 
-
                                                  Loading: "/etc/rippled.cfg"
+
                                                  Loading: "/etc/rippled.cfg"
 Connecting to 127.0.0.1:5005
 {
    "result" : {
@@ -12515,7 +13018,7 @@ Connecting to 127.0.0.1:5005
 
 
 
-
                                                  Possible Errors
                                                  
+
                                                  Possible Errors
                                                  
 
@@ -12523,25 +13026,25 @@ Connecting to 127.0.0.1:5005
 
                                                  [Source]
                                                  
 
                                                  The print command returns the current status of various internal subsystems, including peers, the ledger cleaner, and the resource manager.
                                                  
 
                                                  The print request is an admin command that cannot be run by unprivileged users!
                                                  
-
                                                  Request Format
                                                  
+
                                                  Request Format
                                                  
 
                                                  An example of the request format:
                                                  
-
                                                  
+
                                                  
 
-
                                                  {
+
                                                  {
     "id": "print_req_1",
     "command": "print"
 }
 
                                                  
 
-
                                                  rippled print
+
                                                  rippled print
 
                                                  
 
                                                  
 
                                                  The request includes no parameters.
                                                  
-
                                                  Response Format
                                                  
+
                                                  Response Format
                                                  
 
                                                  An example of a successful response:
                                                  
-
                                                  
+
                                                  
 
-
                                                  Loading: "/etc/rippled.cfg"
+
                                                  Loading: "/etc/rippled.cfg"
 Connecting to 127.0.0.1:5005
 {
    "result" : {
@@ -12726,7 +13229,7 @@ Connecting to 127.0.0.1:5005
 
                                                  
 
                                                  
 
                                                  The response follows the standard format. Additional fields in the result depend on the internal state of the rippled server. The results of this command are subject to change without notice.
                                                  
-
                                                  Possible Errors
                                                  
+
                                                  Possible Errors
                                                  
 
@@ -12735,17 +13238,17 @@ Connecting to 127.0.0.1:5005
 
                                                  ping
                                                  
 
                                                  [Source]
                                                  
 
                                                  The ping command returns an acknowledgement, so that clients can test the connection status and latency.
                                                  
-
                                                  Request Format
                                                  
+
                                                  Request Format
                                                  
 
                                                  An example of the request format:
                                                  
-
                                                  
+
                                                  
 
-
                                                  {
+
                                                  {
     "id": 1,
     "command": "ping"
 }
 
                                                  
 
-
                                                  {
+
                                                  {
     "method": "ping",
     "params": [
         {}
@@ -12753,17 +13256,17 @@ Connecting to 127.0.0.1:5005
 }
 
                                                  
 
-
                                                  #Syntax: ping
+
                                                  #Syntax: ping
 rippled ping
 
                                                  
 
                                                  
 
                                                  Try it!
                                                  
 
                                                  The request includes no parameters.
                                                  
-
                                                  Response Format
                                                  
+
                                                  Response Format
                                                  
 
                                                  An example of a successful response:
                                                  
-
                                                  
+
                                                  
 
-
                                                  {
+
                                                  {
     "id": 1,
     "result": {},
     "status": "success",
@@ -12771,7 +13274,7 @@ rippled ping
 }
 
                                                  
 
-
                                                  200 OK
+
                                                  200 OK
 {
     "result": {
         "status": "success"
@@ -12780,24 +13283,24 @@ rippled ping
 
                                                  
 
                                                  
 
                                                  The response follows the standard format, with a successful result containing no fields. The client can measure the round-trip time from request to response as latency.
                                                  
-
                                                  Possible Errors
                                                  
+
                                                  Possible Errors
                                                  
 
 
                                                  random
                                                  
 
                                                  [Source]
                                                  
 
                                                  The random command provides a random number to be used as a source of entropy for random number generation by clients.
                                                  
-
                                                  Request Format
                                                  
+
                                                  Request Format
                                                  
 
                                                  An example of the request format:
                                                  
-
                                                  
+
                                                  
 
-
                                                  {
+
                                                  {
     "id": 1,
     "command": "random"
 }
 
                                                  
 
-
                                                  {
+
                                                  {
     "method": "random",
     "params": [
         {}
@@ -12805,16 +13308,16 @@ rippled ping
 }
 
                                                  
 
-
                                                  #Syntax: random
+
                                                  #Syntax: random
 rippled random
 
                                                  
 
                                                  
 
                                                  The request includes no parameters.
                                                  
-
                                                  Response Format
                                                  
+
                                                  Response Format
                                                  
 
                                                  An example of a successful response:
                                                  
-
                                                  
+
                                                  
 
-
                                                  {
+
                                                  {
     "id": 1,
     "result": {
         "random": "8ED765AEBBD6767603C2C9375B2679AEC76E6A8133EF59F04F9FC1AAA70E41AF"
@@ -12824,7 +13327,7 @@ rippled random
 }
 
                                                  
 
-
                                                  200 OK
+
                                                  200 OK
 {
     "result": {
         "random": "4E57146AA47BC6E88FDFE8BAA235B900126C916B6CC521550996F590487B837A",
@@ -12850,26 +13353,26 @@ rippled random
 
 
 
-
                                                  Possible Errors
                                                  
+
                                                  Possible Errors
                                                  
 
                                                    
 
                                                  • Any of the universal error types.
                                                    • 
 
                                                  • internal - Some internal error occurred, possibly relating to the random number generator.
                                                    • 
 
                                                  
 
                                                  json
                                                  
 
                                                  The json method is a proxy to running other commands, and accepts the parameters for the command as a JSON value. It is exclusive to the Commandline client, and intended for cases where the commandline syntax for specifying parameters is inadequate or undesirable.
                                                  
-
                                                  Request Format
                                                  
+
                                                  Request Format
                                                  
 
                                                  An example of the request format:
                                                  
-
                                                  
+
                                                  
 
-
                                                  # Syntax: json method json_stanza
+
                                                  # Syntax: json method json_stanza
 rippled -q json ledger_closed '{}'
 
                                                  
 
                                                  
-
                                                  Response Format
                                                  
+
                                                  Response Format
                                                  
 
                                                  An example of a successful response:
                                                  
-
                                                  
+
                                                  
 
-
                                                  {
+
                                                  {
    "result" : {
       "ledger_hash" : "8047C3ECF1FA66326C1E57694F6814A1C32867C04D3D68A851367EE2F89BBEF3",
       "ledger_index" : 390308,
@@ -12883,18 +13386,18 @@ rippled -q json ledger_closed '{}'
 
                                                  [Source]
                                                  
 
                                                  The connect command forces the rippled server to connect to a specific peer rippled server.
                                                  
 
                                                  The connect request is an admin command that cannot be run by unprivileged users!
                                                  
-
                                                  Request Format
                                                  
+
                                                  Request Format
                                                  
 
                                                  An example of the request format:
                                                  
-
                                                  
+
                                                  
 
-
                                                  {
+
                                                  {
     "command": "connect",
     "ip": "192.170.145.88",
     "port": 51235
 }
 
                                                  
 
-
                                                  {
+
                                                  {
     "method": "connect",
     "params": [
         {
@@ -12905,7 +13408,7 @@ rippled -q json ledger_closed '{}'
 }
 
                                                  
 
-
                                                  #Syntax: connect ip [port]
+
                                                  #Syntax: connect ip [port]
 rippled connect 192.170.145.88 51235
 
                                                  
 
                                                  
@@ -12927,15 +13430,15 @@ rippled connect 192.170.145.88 51235
 
 port
 Number
-(Optional) Port number to use when connecting. Defaults to 6561.
+(Optional) Port number to use when connecting. Defaults to 6561.
 
 
 
-
                                                  Response Format
                                                  
+
                                                  Response Format
                                                  
 
                                                  An example of a successful response:
                                                  
-
                                                  
+
                                                  
 
-
                                                  {
+
                                                  {
    "result" : {
       "message" : "connecting",
       "status" : "success"
@@ -12943,7 +13446,7 @@ rippled connect 192.170.145.88 51235
 }
 
                                                  
 
-
                                                  Loading: "/etc/rippled.cfg"
+
                                                  Loading: "/etc/rippled.cfg"
 Connecting to 127.0.0.1:5005
 {
    "result" : {
@@ -12970,7 +13473,7 @@ Connecting to 127.0.0.1:5005
 
 
 
-
                                                  Possible Errors
                                                  
+
                                                  Possible Errors
                                                  
 
                                                    
 
                                                  • Any of the universal error types.
                                                    • 
 
                                                  • invalidParams - One or more fields are specified incorrectly, or one or more required fields are missing.
                                                    • 
@@ -12980,17 +13483,17 @@ Connecting to 127.0.0.1:5005
 
                                                    [Source]
                                                    
 
                                                    Gracefully shuts down the server.
                                                    
 
                                                    The stop request is an admin command that cannot be run by unprivileged users!
                                                    
-
                                                    Request Format
                                                    
+
                                                    Request Format
                                                    
 
                                                    An example of the request format:
                                                    
-
                                                    
+
                                                    
 
-
                                                    {
+
                                                    {
     "id": 0,
     "command": "stop"
 }
 
                                                    
 
-
                                                    {
+
                                                    {
     "method": "stop",
     "params": [
         {}
@@ -12998,15 +13501,15 @@ Connecting to 127.0.0.1:5005
 }
 
                                                    
 
-
                                                    rippled stop
+
                                                    rippled stop
 
                                                    
 
                                                    
 
                                                    The request includes no parameters.
                                                    
-
                                                    Response Format
                                                    
+
                                                    Response Format
                                                    
 
                                                    An example of a successful response:
                                                    
-
                                                    
+
                                                    
 
-
                                                    {
+
                                                    {
    "result" : {
       "message" : "ripple server stopping",
       "status" : "success"
@@ -13014,7 +13517,7 @@ Connecting to 127.0.0.1:5005
 }
 
                                                    
 
-
                                                    Loading: "/etc/rippled.cfg"
+
                                                    Loading: "/etc/rippled.cfg"
 Connecting to 127.0.0.1:5005
 {
    "result" : {
@@ -13041,7 +13544,7 @@ Connecting to 127.0.0.1:5005
 
 
 
-
                                                    Possible Errors
                                                    
+
                                                    Possible Errors
                                                    
 
@@ -13058,7 +13561,7 @@ protocol = peer
 
                                                    
 
                                                    Peer Crawler
                                                    
 
                                                    The Peer Crawler asks a rippled server to report information about the other rippled servers it is connected to as peers. The peers command in the WebSocket and JSON-RPC APIs also returns a similar, more comprehensive set of information, but requires administrative access to the server. The Peer Crawler response is available to other servers on a non-privileged basis through the Peer Protocol (RTXP) port.
                                                    
-
                                                    Request Format
                                                    
+
                                                    Request Format
                                                    
 
                                                    To request the Peer Crawler information, make the following HTTP request:
                                                    
 
                                                      
 
                                                    • Protocol: https
                                                      • 
@@ -13068,7 +13571,7 @@ protocol = peer
 
                                                    • Path: /crawl
                                                      • 
 
                                                    • Notes: Most rippled servers use a self-signed certificate to respond to the request. By default, most tools (including web browsers) flag or block such responses for being untrusted. You must ignore the certificate checking (for example, if using cURL, add the --insecure flag) to display a response from those servers.
                                                      • 
 
                                                    
-
                                                    Response Format
                                                    
+
                                                    Response Format
                                                    
 
                                                    The response has the status code 200 OK and a JSON object in the message body.
                                                    
 
                                                    The JSON object has the following fields:
                                                    
 
@@ -13131,12 +13634,12 @@ protocol = peer
 
                                                    
 
                                                    Example
                                                    
 
                                                    Request:
                                                    
-
                                                    
+
                                                    
 
-
                                                    GET https://s1.ripple.com:51235/crawl
+
                                                    GET https://s1.ripple.com:51235/crawl
 
                                                    
 
-
                                                    curl -k https://s1.ripple.com:51235/crawl
+
                                                    curl -k https://s1.ripple.com:51235/crawl
 
                                                    
 
                                                    
 
                                                    Response: