ARCHIVE/xrpl-dev-portal
1
0
Fork 0
mirror of https://github.com/XRPLF/xrpl-dev-portal.git synced 2026-04-29 15:37:48 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #2970 from XRPLF/1839-document-ignore_default-field

Browse Source 
1839 - Document ignore_default field for account_lines API method
This commit is contained in:
Rome Reginelli
2025-04-10 12:10:53 -07:00
committed by GitHub
parent 5280d318b6 50164eb92e
commit 831276f2c1
21 changed files with 613 additions and 381 deletions
Download Patch File Download Diff File Expand all files Collapse all files

274
_api-examples/account_lines/jsonrpc-response.json Normal file
View File

@@ -0,0 +1,274 @@
{
"result": {
"account": "r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59",
"ledger_current_index": 95348091,
"lines": [
{
"account": "r3vi7mWxru9rJCxETCyA1CHvzL96eZWx5z",
"balance": "0",
"currency": "ASP",
"limit": "0",
"limit_peer": "10",
"no_ripple": false,
"no_ripple_peer": false,
"quality_in": 0,
"quality_out": 0
},
{
"account": "r3vi7mWxru9rJCxETCyA1CHvzL96eZWx5z",
"balance": "0",
"currency": "XAU",
"limit": "0",
"limit_peer": "0",
"no_ripple": true,
"no_ripple_peer": true,
"quality_in": 0,
"quality_out": 0
},
{
"account": "rMwjYedjc7qqtKYVLiAccJSmCwih4LnE2q",
"balance": "5",
"currency": "USD",
"limit": "5",
"limit_peer": "0",
"no_ripple": true,
"no_ripple_peer": false,
"quality_in": 0,
"quality_out": 0
},
{
"account": "rHpXfibHgSb64n8kK9QWDpdbfqSpYbM9a4",
"balance": "481.992867407479",
"currency": "MXN",
"limit": "1000",
"limit_peer": "0",
"no_ripple": false,
"no_ripple_peer": false,
"quality_in": 0,
"quality_out": 0
},
{
"account": "rLEsXccBGNR3UPuPu2hUXPjziKC3qKSBun",
"balance": "0.793598266778297",
"currency": "EUR",
"limit": "1",
"limit_peer": "0",
"no_ripple": true,
"no_ripple_peer": false,
"quality_in": 0,
"quality_out": 0
},
{
"account": "rnuF96W4SZoCJmbHYBFoJZpR8eCaxNvekK",
"balance": "0",
"currency": "CNY",
"limit": "3",
"limit_peer": "0",
"no_ripple": true,
"no_ripple_peer": false,
"quality_in": 0,
"quality_out": 0
},
{
"account": "rGwUWgN5BEg3QGNY3RX2HfYowjUTZdid3E",
"balance": "1.336889190631542",
"currency": "DYM",
"limit": "3",
"limit_peer": "0",
"no_ripple": false,
"no_ripple_peer": false,
"quality_in": 0,
"quality_out": 0
},
{
"account": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B",
"balance": "0.3488146605801446",
"currency": "CHF",
"limit": "0",
"limit_peer": "0",
"no_ripple": false,
"no_ripple_peer": false,
"quality_in": 0,
"quality_out": 0
},
{
"account": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B",
"balance": "0",
"currency": "BTC",
"limit": "3",
"limit_peer": "0",
"no_ripple": false,
"no_ripple_peer": false,
"quality_in": 0,
"quality_out": 0
},
{
"account": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B",
"balance": "11.68225001668339",
"currency": "USD",
"limit": "5000",
"limit_peer": "0",
"no_ripple": false,
"no_ripple_peer": false,
"quality_in": 0,
"quality_out": 0
},
{
"account": "rpgKWEmNqSDAGFhy5WDnsyPqfQxbWxKeVd",
"balance": "-0.00111",
"currency": "BTC",
"limit": "0",
"limit_peer": "10",
"no_ripple": false,
"no_ripple_peer": false,
"quality_in": 0,
"quality_out": 0
},
{
"account": "rBJ3YjwXi2MGbg7GVLuTXUWQ8DjL7tDXh4",
"balance": "-0.0008744482690504699",
"currency": "BTC",
"limit": "0",
"limit_peer": "10",
"no_ripple": false,
"no_ripple_peer": false,
"quality_in": 0,
"quality_out": 0
},
{
"account": "rLEsXccBGNR3UPuPu2hUXPjziKC3qKSBun",
"balance": "0",
"currency": "USD",
"limit": "1",
"limit_peer": "0",
"no_ripple": false,
"no_ripple_peer": false,
"quality_in": 0,
"quality_out": 0
},
{
"account": "razqQKzJRdB4UxFPWf5NEpEG3WMkmwgcXA",
"balance": "9.07619790068559",
"currency": "CNY",
"limit": "100",
"limit_peer": "0",
"no_ripple": true,
"no_ripple_peer": false,
"quality_in": 0,
"quality_out": 0
},
{
"account": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B",
"balance": "7.292695098901099",
"currency": "JPY",
"limit": "0",
"limit_peer": "0",
"no_ripple": true,
"no_ripple_peer": false,
"quality_in": 0,
"quality_out": 0
},
{
"account": "r3vi7mWxru9rJCxETCyA1CHvzL96eZWx5z",
"balance": "0",
"currency": "AUX",
"limit": "0",
"limit_peer": "0",
"no_ripple": true,
"no_ripple_peer": true,
"quality_in": 0,
"quality_out": 0
},
{
"account": "r9vbV3EHvXWjSkeQ6CAcYVPGeq7TuiXY2X",
"balance": "0.0004557360418801623",
"currency": "USD",
"limit": "1",
"limit_peer": "0",
"no_ripple": true,
"no_ripple_peer": false,
"quality_in": 0,
"quality_out": 0
},
{
"account": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B",
"balance": "12.41688780720394",
"currency": "EUR",
"limit": "100",
"limit_peer": "0",
"no_ripple": true,
"no_ripple_peer": false,
"quality_in": 0,
"quality_out": 0
},
{
"account": "rfF3PNkwkq1DygW2wum2HK3RGfgkJjdPVD",
"balance": "35",
"currency": "USD",
"limit": "500",
"limit_peer": "0",
"no_ripple": true,
"no_ripple_peer": false,
"quality_in": 0,
"quality_out": 0
},
{
"account": "rwUVoVMSURqNyvocPCcvLu3ygJzZyw8qwp",
"balance": "-5",
"currency": "JOE",
"limit": "0",
"limit_peer": "50",
"no_ripple": false,
"no_ripple_peer": true,
"quality_in": 0,
"quality_out": 0
},
{
"account": "rE6R3DWF9fBD7CyiQciePF9SqK58Ubp8o2",
"balance": "0",
"currency": "USD",
"limit": "0",
"limit_peer": "100",
"no_ripple": false,
"no_ripple_peer": true,
"quality_in": 0,
"quality_out": 0
},
{
"account": "rE6R3DWF9fBD7CyiQciePF9SqK58Ubp8o2",
"balance": "0",
"currency": "JOE",
"limit": "0",
"limit_peer": "100",
"no_ripple": false,
"no_ripple_peer": true,
"quality_in": 0,
"quality_out": 0
},
{
"account": "rs9M85karFkCRjvc6KMWn8Coigm9cbcgcx",
"balance": "0",
"currency": "015841551A748AD2C1F76FF6ECB0CCCD00000000",
"limit": "10.01037626125837",
"limit_peer": "0",
"no_ripple": true,
"no_ripple_peer": false,
"quality_in": 0,
"quality_out": 0
},
{
"account": "rEhDDUUNxpXgEHVJtC2cjXAgyx5VCFxdMF",
"balance": "0",
"currency": "USD",
"limit": "0",
"limit_peer": "1",
"no_ripple": false,
"no_ripple_peer": false,
"quality_in": 0,
"quality_out": 0
}
],
"status": "success",
"validated": false
}
}

278
_api-examples/account_lines/ws-response.json Normal file
View File

@@ -0,0 +1,278 @@
{
"api_version": 2,
"id": "example_account_lines",
"result": {
"account": "r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59",
"ledger_current_index": 95348097,
"lines": [
{
"account": "r3vi7mWxru9rJCxETCyA1CHvzL96eZWx5z",
"balance": "0",
"currency": "ASP",
"limit": "0",
"limit_peer": "10",
"no_ripple": false,
"no_ripple_peer": false,
"quality_in": 0,
"quality_out": 0
},
{
"account": "r3vi7mWxru9rJCxETCyA1CHvzL96eZWx5z",
"balance": "0",
"currency": "XAU",
"limit": "0",
"limit_peer": "0",
"no_ripple": true,
"no_ripple_peer": true,
"quality_in": 0,
"quality_out": 0
},
{
"account": "rMwjYedjc7qqtKYVLiAccJSmCwih4LnE2q",
"balance": "5",
"currency": "USD",
"limit": "5",
"limit_peer": "0",
"no_ripple": true,
"no_ripple_peer": false,
"quality_in": 0,
"quality_out": 0
},
{
"account": "rHpXfibHgSb64n8kK9QWDpdbfqSpYbM9a4",
"balance": "481.992867407479",
"currency": "MXN",
"limit": "1000",
"limit_peer": "0",
"no_ripple": false,
"no_ripple_peer": false,
"quality_in": 0,
"quality_out": 0
},
{
"account": "rLEsXccBGNR3UPuPu2hUXPjziKC3qKSBun",
"balance": "0.793598266778297",
"currency": "EUR",
"limit": "1",
"limit_peer": "0",
"no_ripple": true,
"no_ripple_peer": false,
"quality_in": 0,
"quality_out": 0
},
{
"account": "rnuF96W4SZoCJmbHYBFoJZpR8eCaxNvekK",
"balance": "0",
"currency": "CNY",
"limit": "3",
"limit_peer": "0",
"no_ripple": true,
"no_ripple_peer": false,
"quality_in": 0,
"quality_out": 0
},
{
"account": "rGwUWgN5BEg3QGNY3RX2HfYowjUTZdid3E",
"balance": "1.336889190631542",
"currency": "DYM",
"limit": "3",
"limit_peer": "0",
"no_ripple": false,
"no_ripple_peer": false,
"quality_in": 0,
"quality_out": 0
},
{
"account": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B",
"balance": "0.3488146605801446",
"currency": "CHF",
"limit": "0",
"limit_peer": "0",
"no_ripple": false,
"no_ripple_peer": false,
"quality_in": 0,
"quality_out": 0
},
{
"account": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B",
"balance": "0",
"currency": "BTC",
"limit": "3",
"limit_peer": "0",
"no_ripple": false,
"no_ripple_peer": false,
"quality_in": 0,
"quality_out": 0
},
{
"account": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B",
"balance": "11.68225001668339",
"currency": "USD",
"limit": "5000",
"limit_peer": "0",
"no_ripple": false,
"no_ripple_peer": false,
"quality_in": 0,
"quality_out": 0
},
{
"account": "rpgKWEmNqSDAGFhy5WDnsyPqfQxbWxKeVd",
"balance": "-0.00111",
"currency": "BTC",
"limit": "0",
"limit_peer": "10",
"no_ripple": false,
"no_ripple_peer": false,
"quality_in": 0,
"quality_out": 0
},
{
"account": "rBJ3YjwXi2MGbg7GVLuTXUWQ8DjL7tDXh4",
"balance": "-0.0008744482690504699",
"currency": "BTC",
"limit": "0",
"limit_peer": "10",
"no_ripple": false,
"no_ripple_peer": false,
"quality_in": 0,
"quality_out": 0
},
{
"account": "rLEsXccBGNR3UPuPu2hUXPjziKC3qKSBun",
"balance": "0",
"currency": "USD",
"limit": "1",
"limit_peer": "0",
"no_ripple": false,
"no_ripple_peer": false,
"quality_in": 0,
"quality_out": 0
},
{
"account": "razqQKzJRdB4UxFPWf5NEpEG3WMkmwgcXA",
"balance": "9.07619790068559",
"currency": "CNY",
"limit": "100",
"limit_peer": "0",
"no_ripple": true,
"no_ripple_peer": false,
"quality_in": 0,
"quality_out": 0
},
{
"account": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B",
"balance": "7.292695098901099",
"currency": "JPY",
"limit": "0",
"limit_peer": "0",
"no_ripple": true,
"no_ripple_peer": false,
"quality_in": 0,
"quality_out": 0
},
{
"account": "r3vi7mWxru9rJCxETCyA1CHvzL96eZWx5z",
"balance": "0",
"currency": "AUX",
"limit": "0",
"limit_peer": "0",
"no_ripple": true,
"no_ripple_peer": true,
"quality_in": 0,
"quality_out": 0
},
{
"account": "r9vbV3EHvXWjSkeQ6CAcYVPGeq7TuiXY2X",
"balance": "0.0004557360418801623",
"currency": "USD",
"limit": "1",
"limit_peer": "0",
"no_ripple": true,
"no_ripple_peer": false,
"quality_in": 0,
"quality_out": 0
},
{
"account": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B",
"balance": "12.41688780720394",
"currency": "EUR",
"limit": "100",
"limit_peer": "0",
"no_ripple": true,
"no_ripple_peer": false,
"quality_in": 0,
"quality_out": 0
},
{
"account": "rfF3PNkwkq1DygW2wum2HK3RGfgkJjdPVD",
"balance": "35",
"currency": "USD",
"limit": "500",
"limit_peer": "0",
"no_ripple": true,
"no_ripple_peer": false,
"quality_in": 0,
"quality_out": 0
},
{
"account": "rwUVoVMSURqNyvocPCcvLu3ygJzZyw8qwp",
"balance": "-5",
"currency": "JOE",
"limit": "0",
"limit_peer": "50",
"no_ripple": false,
"no_ripple_peer": true,
"quality_in": 0,
"quality_out": 0
},
{
"account": "rE6R3DWF9fBD7CyiQciePF9SqK58Ubp8o2",
"balance": "0",
"currency": "USD",
"limit": "0",
"limit_peer": "100",
"no_ripple": false,
"no_ripple_peer": true,
"quality_in": 0,
"quality_out": 0
},
{
"account": "rE6R3DWF9fBD7CyiQciePF9SqK58Ubp8o2",
"balance": "0",
"currency": "JOE",
"limit": "0",
"limit_peer": "100",
"no_ripple": false,
"no_ripple_peer": true,
"quality_in": 0,
"quality_out": 0
},
{
"account": "rs9M85karFkCRjvc6KMWn8Coigm9cbcgcx",
"balance": "0",
"currency": "015841551A748AD2C1F76FF6ECB0CCCD00000000",
"limit": "10.01037626125837",
"limit_peer": "0",
"no_ripple": true,
"no_ripple_peer": false,
"quality_in": 0,
"quality_out": 0
},
{
"account": "rEhDDUUNxpXgEHVJtC2cjXAgyx5VCFxdMF",
"balance": "0",
"currency": "USD",
"limit": "0",
"limit_peer": "1",
"no_ripple": false,
"no_ripple_peer": false,
"quality_in": 0,
"quality_out": 0
}
],
"validated": false,
"_nodepref": "nonfh"
},
"status": "success",
"type": "response"
}

1
docs/_snippets/common-links.md
View File

@@ -532,6 +532,7 @@
[signメソッド]: /docs/references/http-websocket-apis/admin-api-methods/signing-methods/sign.md
[stand-alone mode]: /docs/concepts/networks-and-servers/rippled-server-modes.md#stand-alone-mode
[standard format]: /docs/references/http-websocket-apis/api-conventions/response-formatting.md
[String Number]: /docs/references/protocol/data-types/currency-formats#string-numbers
[stop command]: /docs/references/http-websocket-apis/admin-api-methods/server-control-methods/stop.md
[stop method]: /docs/references/http-websocket-apis/admin-api-methods/server-control-methods/stop.md
[stopメソッド]: /docs/references/http-websocket-apis/admin-api-methods/server-control-methods/stop.md

2
docs/references/http-websocket-apis/public-api-methods/account-methods/account_channels.md
View File

@@ -60,7 +60,7 @@ The request includes the following parameters:
|:----------------------|:---------------------|:----------|-------------|
| `account` | String - [Address][] | Yes | Look up channels where this account is the channel's owner/source. |
| `destination_account` | String - [Address][] | No | A second account; if provided, filter results to payment channels whose destination is this account. |
| `ledger_hash` | String | No | A 20-byte hex string for the ledger version to use. (See [Specifying Ledgers][]) |
| `ledger_hash` | String | No | The unique hash of the ledger version to use. (See [Specifying Ledgers][]) |
| `ledger_index` | Number or String | No | The [ledger index][] of the ledger to use, or a shortcut string to choose a ledger automatically. (See [Specifying Ledgers][]) |
| `limit` | Number | No | Limit the number of transactions to retrieve. Cannot be less than 10 or more than 400. Positive values outside this range are replaced with the closest valid option. The default is 200. |
| `marker` | [Marker][] | No | Value from a previous paginated response. Resume retrieving data where that response left off. |

2
docs/references/http-websocket-apis/public-api-methods/account-methods/account_currencies.md
View File

@@ -57,7 +57,7 @@ The request includes the following parameters:
| `Field` | Type | Required? | Description |
|:---------------|:---------------------|:----------|-------------|
| `account` | String - [Address][] | Yes | Look up currencies this account can send or receive. {% badge href="https://github.com/XRPLF/rippled/releases/tag/1.11.0" %}Updated in: rippled 1.11.0{% /badge %} |
| `ledger_hash` | String | No | A 20-byte hex string for the ledger version to use. (See [Specifying Ledgers][]) |
| `ledger_hash` | String | No | The unique hash of the ledger version to use. (See [Specifying Ledgers][]) |
| `ledger_index` | Number or String | No | The [ledger index][] of the ledger to use, or a shortcut string to choose a ledger automatically. (See [Specifying Ledgers][]) |
The following fields are deprecated and should not be provided: `account_index`, `strict`.

2
docs/references/http-websocket-apis/public-api-methods/account-methods/account_info.md
View File

@@ -61,7 +61,7 @@ The request contains the following parameters:
| `Field` | Type | Required? | Description |
|:---------------|:---------------------|:----------|-------------|
| `account` | String - [Address][] | Yes | The account to look up. {% badge href="https://github.com/XRPLF/rippled/releases/tag/1.11.0" %}Updated in: rippled 1.11.0{% /badge %} |
| `ledger_hash` | String | No | A 20-byte hex string for the ledger version to use. (See [Specifying Ledgers][]) |
| `ledger_hash` | String | No | The unique hash of the ledger version to use. (See [Specifying Ledgers][]) |
| `ledger_index` | Number or String | No | The [ledger index][] of the ledger to use, or a shortcut string to choose a ledger automatically. (See [Specifying Ledgers][]) |
| `queue` | Boolean | No | If `true`, return stats about [queued transactions](../../../../concepts/transactions/transaction-queue.md) sent by this account. Can only be used when querying for the data from the current open ledger. Not available from servers in [Reporting Mode][]. |
| `signer_lists` | Boolean | No | If `true`, return any [SignerList objects](../../../protocol/ledger-data/ledger-entry-types/signerlist.md) associated with this account. |

407
docs/references/http-websocket-apis/public-api-methods/account-methods/account_lines.md
View File

@@ -7,7 +7,8 @@ labels:
- Tokens
---
# account_lines
[[Source]](https://github.com/XRPLF/rippled/blob/master/src/ripple/rpc/handlers/AccountLines.cpp "Source")
[[Source]](https://github.com/XRPLF/rippled/blob/master/src/xrpld/rpc/handlers/AccountLines.cpp "Source")
The `account_lines` method returns information about an account's trust lines, which contain balances in all non-XRP currencies and assets. All information retrieved is relative to a particular version of the ledger.
@@ -20,9 +21,10 @@ An example of the request format:
{% tab label="WebSocket" %}
```json
{
"id": 1,
"id": "example_account_lines",
"command": "account_lines",
"account": "r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59"
"account": "r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59",
"api_version": 2
}
```
{% /tab %}
@@ -33,7 +35,8 @@ An example of the request format:
"method": "account_lines",
"params": [
{
"account": "r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59"
"account": "r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59",
"api_version": 2
}
]
}
@@ -53,14 +56,15 @@ rippled account_lines r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59
The request accepts the following parameters:
| `Field` | Type | Description |
|:---------------|:---------------------|:---------------|
| `account` | String - [Address][] | Look up trust lines connected to this account. |
| `ledger_hash` | String | _(Optional)_ A 20-byte hex string for the ledger version to use. (See [Specifying Ledgers][]) |
| `ledger_index` | Number or String | _(Optional)_ The [ledger index][] of the ledger to use, or a shortcut string to choose a ledger automatically. (See [Specifying Ledgers][]) |
| `peer` | String - [Address][] | _(Optional)_ A second account; if provided, filter results to trust lines connecting the two accounts. |
| `limit` | Number | _(Optional)_ Limit the number of trust lines to retrieve. The server may return less than the specified limit, even if there are more pages of results. Must be within the inclusive range 10 to 400. Positive values outside this range are replaced with the closest valid option. The default is 200. |
| `marker` | [Marker][] | _(Optional)_ Value from a previous paginated response. Resume retrieving data where that response left off. |
| Field | Type | Required? | Description |
|:-----------------|:---------------------|:----------|:------------|
| `account` | String - [Address][] | Yes | Look up trust lines connected to this account, from this account's perspective. |
| `ignore_default` | Boolean | No | If `true`, don't return trust lines where this account's side is in the default state. The default is `false`. |
| `ledger_hash` | String - [Hash][] | No | The unique hash of the ledger version to use. (See [Specifying Ledgers][]) |
| `ledger_index` | [Ledger Index][] | No | The [ledger index][] of the ledger to use, or a shortcut string to choose a ledger automatically. (See [Specifying Ledgers][]) |
| `limit` | Number | No | Limit the number of trust lines to retrieve. The server may return less than the specified limit, even if there are more pages of results. Must be within the inclusive range 10 to 400. Positive values outside this range are replaced with the closest valid option. The default is 200. |
| `marker` | [Marker][] | No | Value from a previous paginated response. Resume retrieving data where that response left off. |
| `peer` | String - [Address][] | No | A second account; if provided, filter results to trust lines connecting the two accounts. |
The following parameters are deprecated and may be removed without further notice: `ledger` and `peer_index`.
@@ -71,373 +75,48 @@ An example of a successful response:
{% tabs %}
{% tab label="WebSocket" %}
```json
{
"id": 1,
"status": "success",
"type": "response",
"result": {
"account": "r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59",
"lines": [
{
"account": "r3vi7mWxru9rJCxETCyA1CHvzL96eZWx5z",
"balance": "0",
"currency": "ASP",
"limit": "0",
"limit_peer": "10",
"quality_in": 0,
"quality_out": 0
},
{
"account": "r3vi7mWxru9rJCxETCyA1CHvzL96eZWx5z",
"balance": "0",
"currency": "XAU",
"limit": "0",
"limit_peer": "0",
"no_ripple": true,
"no_ripple_peer": true,
"quality_in": 0,
"quality_out": 0
},
{
"account": "rMwjYedjc7qqtKYVLiAccJSmCwih4LnE2q",
"balance": "3.497605752725159",
"currency": "USD",
"limit": "5",
"limit_peer": "0",
"no_ripple": true,
"quality_in": 0,
"quality_out": 0
}
]
}
}
```
{% code-snippet file="/_api-examples/account_lines/ws-response.json" language="json" /%}
{% /tab %}
{% tab label="JSON-RPC" %}
```json
200 OK
{
"result": {
"account": "r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59",
"lines": [
{
"account": "r3vi7mWxru9rJCxETCyA1CHvzL96eZWx5z",
"balance": "0",
"currency": "ASP",
"limit": "0",
"limit_peer": "10",
"quality_in": 0,
"quality_out": 0
},
{
"account": "r3vi7mWxru9rJCxETCyA1CHvzL96eZWx5z",
"balance": "0",
"currency": "XAU",
"limit": "0",
"limit_peer": "0",
"no_ripple": true,
"no_ripple_peer": true,
"quality_in": 0,
"quality_out": 0
},
{
"account": "rs9M85karFkCRjvc6KMWn8Coigm9cbcgcx",
"balance": "0",
"currency": "015841551A748AD2C1F76FF6ECB0CCCD00000000",
"limit": "10.01037626125837",
"limit_peer": "0",
"no_ripple": true,
"quality_in": 0,
"quality_out": 0
}
],
"status": "success"
}
}
```
{% code-snippet file="/_api-examples/account_lines/jsonrpc-response.json" language="json" prefix="200 OK\n\n" /%}
{% /tab %}
{% tab label="Commandline" %}
```json
{
"result" : {
"account" : "r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59",
"ledger_current_index" : 56867265,
"lines" : [
{
"account" : "r3vi7mWxru9rJCxETCyA1CHvzL96eZWx5z",
"balance" : "0",
"currency" : "ASP",
"limit" : "0",
"limit_peer" : "10",
"quality_in" : 0,
"quality_out" : 0
},
{
"account" : "r3vi7mWxru9rJCxETCyA1CHvzL96eZWx5z",
"balance" : "0",
"currency" : "XAU",
"limit" : "0",
"limit_peer" : "0",
"no_ripple" : true,
"no_ripple_peer" : true,
"quality_in" : 0,
"quality_out" : 0
},
{
"account" : "rMwjYedjc7qqtKYVLiAccJSmCwih4LnE2q",
"balance" : "5",
"currency" : "USD",
"limit" : "5",
"limit_peer" : "0",
"no_ripple" : true,
"quality_in" : 0,
"quality_out" : 0
},
{
"account" : "rHpXfibHgSb64n8kK9QWDpdbfqSpYbM9a4",
"balance" : "481.992867407479",
"currency" : "MXN",
"limit" : "1000",
"limit_peer" : "0",
"quality_in" : 0,
"quality_out" : 0
},
{
"account" : "rLEsXccBGNR3UPuPu2hUXPjziKC3qKSBun",
"balance" : "0.793598266778297",
"currency" : "EUR",
"limit" : "1",
"limit_peer" : "0",
"no_ripple" : true,
"quality_in" : 0,
"quality_out" : 0
},
{
"account" : "rnuF96W4SZoCJmbHYBFoJZpR8eCaxNvekK",
"balance" : "0",
"currency" : "CNY",
"limit" : "3",
"limit_peer" : "0",
"no_ripple" : true,
"quality_in" : 0,
"quality_out" : 0
},
{
"account" : "rGwUWgN5BEg3QGNY3RX2HfYowjUTZdid3E",
"balance" : "1.336889190631542",
"currency" : "DYM",
"limit" : "3",
"limit_peer" : "0",
"quality_in" : 0,
"quality_out" : 0
},
{
"account" : "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B",
"balance" : "0.3488146605801446",
"currency" : "CHF",
"limit" : "0",
"limit_peer" : "0",
"quality_in" : 0,
"quality_out" : 0
},
{
"account" : "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B",
"balance" : "0",
"currency" : "BTC",
"limit" : "3",
"limit_peer" : "0",
"quality_in" : 0,
"quality_out" : 0
},
{
"account" : "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B",
"balance" : "11.68225001668339",
"currency" : "USD",
"limit" : "5000",
"limit_peer" : "0",
"quality_in" : 0,
"quality_out" : 0
},
{
"account" : "rpgKWEmNqSDAGFhy5WDnsyPqfQxbWxKeVd",
"balance" : "-0.00111",
"currency" : "BTC",
"limit" : "0",
"limit_peer" : "10",
"quality_in" : 0,
"quality_out" : 0
},
{
"account" : "rBJ3YjwXi2MGbg7GVLuTXUWQ8DjL7tDXh4",
"balance" : "-0.0008744482690504699",
"currency" : "BTC",
"limit" : "0",
"limit_peer" : "10",
"quality_in" : 0,
"quality_out" : 0
},
{
"account" : "rLEsXccBGNR3UPuPu2hUXPjziKC3qKSBun",
"balance" : "0",
"currency" : "USD",
"limit" : "1",
"limit_peer" : "0",
"quality_in" : 0,
"quality_out" : 0
},
{
"account" : "razqQKzJRdB4UxFPWf5NEpEG3WMkmwgcXA",
"balance" : "9.07619790068559",
"currency" : "CNY",
"limit" : "100",
"limit_peer" : "0",
"no_ripple" : true,
"quality_in" : 0,
"quality_out" : 0
},
{
"account" : "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B",
"balance" : "7.292695098901099",
"currency" : "JPY",
"limit" : "0",
"limit_peer" : "0",
"no_ripple" : true,
"quality_in" : 0,
"quality_out" : 0
},
{
"account" : "r3vi7mWxru9rJCxETCyA1CHvzL96eZWx5z",
"balance" : "0",
"currency" : "AUX",
"limit" : "0",
"limit_peer" : "0",
"no_ripple" : true,
"no_ripple_peer" : true,
"quality_in" : 0,
"quality_out" : 0
},
{
"account" : "r9vbV3EHvXWjSkeQ6CAcYVPGeq7TuiXY2X",
"balance" : "0.0004557360418801623",
"currency" : "USD",
"limit" : "1",
"limit_peer" : "0",
"no_ripple" : true,
"quality_in" : 0,
"quality_out" : 0
},
{
"account" : "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B",
"balance" : "12.41688780720394",
"currency" : "EUR",
"limit" : "100",
"limit_peer" : "0",
"no_ripple" : true,
"quality_in" : 0,
"quality_out" : 0
},
{
"account" : "rfF3PNkwkq1DygW2wum2HK3RGfgkJjdPVD",
"balance" : "35",
"currency" : "USD",
"limit" : "500",
"limit_peer" : "0",
"no_ripple" : true,
"quality_in" : 0,
"quality_out" : 0
},
{
"account" : "rwUVoVMSURqNyvocPCcvLu3ygJzZyw8qwp",
"balance" : "-5",
"currency" : "JOE",
"limit" : "0",
"limit_peer" : "50",
"no_ripple_peer" : true,
"quality_in" : 0,
"quality_out" : 0
},
{
"account" : "rE6R3DWF9fBD7CyiQciePF9SqK58Ubp8o2",
"balance" : "0",
"currency" : "USD",
"limit" : "0",
"limit_peer" : "100",
"no_ripple_peer" : true,
"quality_in" : 0,
"quality_out" : 0
},
{
"account" : "rE6R3DWF9fBD7CyiQciePF9SqK58Ubp8o2",
"balance" : "0",
"currency" : "JOE",
"limit" : "0",
"limit_peer" : "100",
"no_ripple_peer" : true,
"quality_in" : 0,
"quality_out" : 0
},
{
"account" : "rs9M85karFkCRjvc6KMWn8Coigm9cbcgcx",
"balance" : "0",
"currency" : "015841551A748AD2C1F76FF6ECB0CCCD00000000",
"limit" : "10.01037626125837",
"limit_peer" : "0",
"no_ripple" : true,
"quality_in" : 0,
"quality_out" : 0
},
{
"account" : "rEhDDUUNxpXgEHVJtC2cjXAgyx5VCFxdMF",
"balance" : "0",
"currency" : "USD",
"limit" : "0",
"limit_peer" : "1",
"quality_in" : 0,
"quality_out" : 0
}
],
"status" : "success",
"validated" : false
}
}
```
{% code-snippet file="/_api-examples/account_lines/jsonrpc-response.json" language="json" prefix="Loading: \"/etc/opt/ripple/rippled.cfg\"\n2025-Apr-09 21:10:16.085500844 UTC HTTPClient:NFO Connecting to 127.0.0.1:5005\n\n" /%}
{% /tab %}
{% /tabs %}
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:
| `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. |
| `ledger_current_index` | Integer - [Ledger Index][] | _(Omitted if `ledger_hash` or `ledger_index` provided)_ The ledger index of the current open ledger, which was used when retrieving this information. |
| `ledger_index` | Integer - [Ledger Index][] | _(Omitted if `ledger_current_index` provided instead)_ The ledger index of the ledger version that was used when retrieving this data. |
| `ledger_hash` | String - [Hash][] | _(May be omitted)_ The identifying hash the ledger version that was used when retrieving this data. |
| `marker` | [Marker][] | 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. |
|`limit` | Unsigned Integer | The maximum number of trust lines retrieved. The server may return fewer than the specified limit, even if more results are available. If no limit was specified in the request, this defaults to 200. |
| Field | Type | Required? | Description |
|:-----------------------|:------------------|:----------|:------------|
| `account` | String | Yes | Unique [Address][] of the account this request corresponds to. This is the "perspective account" for purpose of the trust lines. |
| `lines` | Array | Yes | 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` | [Ledger Index][] | No | The ledger index that was used when retrieving this data. This field is only provided when using an open ledger version. |
| `ledger_index` | [Ledger Index][] | No | The ledger index that was used when retrieving this data. This field is only provided when using a closed ledger version. |
| `ledger_hash` | String - [Hash][] | No | The identifying hash the ledger version that was used when retrieving this data. This field is only provided when using a closed ledger version. |
| `marker` | [Marker][] | No | 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. |
|`limit` | Number | No | The maximum number of trust lines retrieved. The server may return fewer than the specified limit, even if more results are available. If no limit was specified in the request, use a default limit of 200. |
Each trust line object has some combination of the following fields:
| `Field` | Type | Description |
|:-----------------|:-----------------|:---------------------------------------|
| `account` | String | The unique [Address][] of the counterparty to this trust line. |
| `balance` | String | Representation of the numeric balance currently held against this line. A positive balance means that the perspective account holds value; a negative balance means that the perspective account owes value. |
| `currency` | String | A [Currency Code][] identifying what currency this trust line can hold. |
| `limit` | String | The maximum amount of the given currency that this account is willing to owe the peer account. |
| `limit_peer` | String | The maximum amount of currency that the counterparty account is willing to owe the perspective account. |
| `quality_in` | Unsigned Integer | Rate at which the account values incoming balances on this trust line, as a ratio of this value per 1 billion units. (For example, a value of 500 million represents a 0.5:1 ratio.) As a special case, 0 is treated as a 1:1 ratio. |
| `quality_out` | Unsigned Integer | Rate at which the account values outgoing balances on this trust line, as a ratio of this value per 1 billion units. (For example, a value of 500 million represents a 0.5:1 ratio.) As a special case, 0 is treated as a 1:1 ratio. |
| `no_ripple` | Boolean | _(May be omitted)_ If `true`, this account has enabled the [No Ripple flag](../../../../concepts/tokens/fungible-tokens/rippling.md) for this trust line. If present and `false`, this account has disabled the No Ripple flag, but, because the account also has the Default Ripple flag disabled, that is not considered [the default state](../../../protocol/ledger-data/ledger-entry-types/ripplestate.md#contributing-to-the-owner-reserve). If omitted, the account has the No Ripple flag disabled for this trust line and Default Ripple enabled. {% badge href="https://github.com/XRPLF/rippled/releases/tag/1.7.0" %}Updated in: rippled 1.7.0{% /badge %} |
| `no_ripple_peer` | Boolean | _(May be omitted)_ If `true`, the peer account has enabled the [No Ripple flag](../../../../concepts/tokens/fungible-tokens/rippling.md) for this trust line. If present and `false`, this account has disabled the No Ripple flag, but, because the account also has the Default Ripple flag disabled, that is not considered [the default state](../../../protocol/ledger-data/ledger-entry-types/ripplestate.md#contributing-to-the-owner-reserve). If omitted, the account has the No Ripple flag disabled for this trust line and Default Ripple enabled. {% badge href="https://github.com/XRPLF/rippled/releases/tag/1.7.0" %}Updated in: rippled 1.7.0{% /badge %} |
| `authorized` | Boolean | _(May be omitted)_ If `true`, this account has [authorized this trust line](../../../../concepts/tokens/fungible-tokens/authorized-trust-lines.md). The default is `false`. |
| `peer_authorized`| Boolean | _(May be omitted)_ If `true`, the peer account has [authorized this trust line](../../../../concepts/tokens/fungible-tokens/authorized-trust-lines.md). The default is `false`. |
| `freeze` | Boolean | _(May be omitted)_ If `true`, this account has [frozen](../../../../concepts/tokens/fungible-tokens/freezes.md) this trust line. The default is `false`. |
| `freeze_peer` | Boolean | _(May be omitted)_ If `true`, the peer account has [frozen](../../../../concepts/tokens/fungible-tokens/freezes.md) this trust line. The default is `false`. |
| Field | Type | Required? | Description |
|:-----------------|:---------------------------|:----------|:------------|
| `account` | String - [Address][] | Yes | The counterparty to this trust line. |
| `balance` | [String Number][] | Yes | Representation of the numeric balance currently held against this line. A positive balance means that the perspective account holds value; a negative balance means that the perspective account owes value. |
| `currency` | String - [Currency Code][] | Yes | The currency code of the token this trust line can hold. |
| `limit` | [String Number][] | Yes | The maximum amount of the given currency that this account is willing to owe the peer account |
| `limit_peer` | [String Number][] | Yes | The maximum amount of currency that the counterparty account is willing to owe the perspective account |
| `quality_in` | Number | Yes | Rate at which the account values incoming balances on this trust line, as a ratio of this value per 1 billion units. (For example, a value of 500 million represents a 0.5:1 ratio.) As a special case, 0 is treated as a 1:1 ratio. |
| `quality_out` | Number | Yes | Rate at which the account values outgoing balances on this trust line, as a ratio of this value per 1 billion units. (For example, a value of 500 million represents a 0.5:1 ratio.) As a special case, 0 is treated as a 1:1 ratio. |
| `no_ripple` | Boolean | No | If `true`, this account has enabled the [No Ripple flag](../../../../concepts/tokens/fungible-tokens/rippling.md) for this trust line. If present and `false`, this account has disabled the No Ripple flag, but, because the account also has the Default Ripple flag disabled, that is not considered [the default state](../../../protocol/ledger-data/ledger-entry-types/ripplestate.md#contributing-to-the-owner-reserve). If omitted, the account has the No Ripple flag disabled for this trust line and Default Ripple enabled. |
| `no_ripple_peer` | Boolean | No | If `true`, the peer account has enabled the [No Ripple flag](../../../../concepts/tokens/fungible-tokens/rippling.md) for this trust line. If present and `false`, this account has disabled the No Ripple flag, but, because the account also has the Default Ripple flag disabled, that is not considered [the default state](../../../protocol/ledger-data/ledger-entry-types/ripplestate.md#contributing-to-the-owner-reserve). If omitted, the account has the No Ripple flag disabled for this trust line and Default Ripple enabled. |
| `authorized` | Boolean | No | If `true`, the perspective account has [authorized this trust line](../../../../concepts/tokens/fungible-tokens/authorized-trust-lines.md). The default is `false`. |
| `peer_authorized`| Boolean | No | If `true`, the counterparty has [authorized this trust line](../../../../concepts/tokens/fungible-tokens/authorized-trust-lines.md). The default is `false`. |
| `freeze` | Boolean | No | If `true`, the perspective account has [frozen](../../../../concepts/tokens/fungible-tokens/freezes.md) this trust line. The default is `false`. |
| `freeze_peer` | Boolean | No | If `true`, the counterparty has [frozen](../../../../concepts/tokens/fungible-tokens/freezes.md) this trust line. The default is `false`. |
## Possible Errors

2
docs/references/http-websocket-apis/public-api-methods/account-methods/account_nfts.md
View File

@@ -51,7 +51,7 @@ 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 a list of NFTs owned by this account. |
| `ledger_hash` | String | _(Optional)_ A 20-byte hex string for the ledger version to use. (See [Specifying Ledgers][]) |
| `ledger_hash` | String | _(Optional)_ The unique hash of the ledger version to use. (See [Specifying Ledgers][]) |
| `ledger_index` | String or Number | _(Optional)_ The [ledger index][] of the ledger to use, or a shortcut string to choose a ledger automatically. (See [Specifying Ledgers][]) |
| `limit` | Integer | _(Optional)_ Limit the number of [token pages][NFTokenPage object] to retrieve. Each page can contain up to 32 NFTs. The `limit` value cannot be lower than 20 or more than 400. Positive values outside this range are replaced with the closest valid option. The default is 100. |
| `marker` | [Marker][] | _(Optional)_ Value from a previous paginated response. Resume retrieving data where that response left off. |

2
docs/references/http-websocket-apis/public-api-methods/account-methods/account_objects.md
View File

@@ -80,7 +80,7 @@ The request includes the following parameters:
|:-------------------------|:-----------------|:----------|-------------|
| `account` | String | Yes | A unique identifier for the account, most commonly the account's [Address][]. |
| `deletion_blockers_only` | Boolean | No | If `true`, the response only includes objects that would block this account from [being deleted](../../../../concepts/accounts/deleting-accounts.md). The default is `false`. |
| `ledger_hash` | [Hash][] | No | A 20-byte hex string for the ledger version to use. (See [Specifying Ledgers][]) |
| `ledger_hash` | [Hash][] | No | The unique hash of the ledger version to use. (See [Specifying Ledgers][]) |
| `ledger_index` | [Ledger Index][] | No | The [ledger index][] of the ledger to use, or a shortcut string to choose a ledger automatically. (See [Specifying Ledgers][]) |
| `limit` | Number | No | The maximum number of objects to include in the results. Must be within the inclusive range `10` to `400` on non-admin connections. The default is `200`. |
| `marker` | [Marker][] | No | Value from a previous paginated response. Resume retrieving data where that response left off. |

2
docs/references/http-websocket-apis/public-api-methods/account-methods/account_offers.md
View File

@@ -56,7 +56,7 @@ A request can include the following parameters:
| Field | Type | Required? | Description |
|:---------------|:---------------------|:----------|-------------|
| `account` | String - [Address][] | Yes | Look up Offers placed by this account. |
| `ledger_hash` | [Hash][] | No | A 20-byte hex string for the ledger version to use. (See [Specifying Ledgers][]) |
| `ledger_hash` | [Hash][] | No | The unique hash of the ledger version to use. (See [Specifying Ledgers][]) |
| `ledger_index` | [Ledger Index][] | No | The [ledger index][] of the ledger to use, or a shortcut string to choose a ledger automatically. (See [Specifying Ledgers][]) |
| `limit` | Number | No | Limit the number of Offers to retrieve. The server may return fewer than this number of results. Must be within the inclusive range 10 to 400. Positive values outside this range are replaced with the closest valid option.The default is 200. |
| `marker` | [Marker][] | No | Value from a previous paginated response. Resume retrieving data where that response left off. |

2
docs/references/http-websocket-apis/public-api-methods/account-methods/gateway_balances.md
View File

@@ -70,7 +70,7 @@ The request includes the following parameters:
| `account` | String | The [Address][] to check. This should be the [issuing address](../../../../concepts/accounts/account-types.md) |
| `strict` | Boolean | _(Optional)_ If true, only accept an address or public key for the account parameter. Defaults to false. |
| `hotwallet` | String or Array | _(Optional)_ An [operational address](../../../../concepts/accounts/account-types.md) 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 Ledgers][]) |
| `ledger_hash` | String | _(Optional)_ The unique hash of the ledger version to use. (See [Specifying Ledgers][]) |
| `ledger_index` | String or Unsigned Integer | _(Optional)_ The [ledger index][] of the ledger version to use, or a shortcut string to choose a ledger automatically. (See [Specifying Ledgers][]) |
## Response Format

2
docs/references/http-websocket-apis/public-api-methods/account-methods/noripple_check.md
View File

@@ -63,7 +63,7 @@ The request includes the following parameters:
| `role` | String | Whether the address refers to a `gateway` or `user`. Recommendations depend on the role of the account. Issuers must have Default Ripple enabled and must disable No Ripple on all trust lines. Users should have Default Ripple disabled, and should enable No Ripple on all trust lines. |
| `transactions` | Boolean | _(Optional)_ If `true`, include an array of suggested [transactions](../../../protocol/transactions/index.md), as JSON objects, that you can sign and submit to fix the problems. The default is `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 Ledgers][]) |
| `ledger_hash` | String | _(Optional)_ The unique hash of the ledger version to use. (See [Specifying Ledgers][]) |
| `ledger_index` | String or Unsigned Integer | _(Optional)_ The [ledger index][] of the ledger to use, or a shortcut string to choose a ledger automatically. (See [Specifying Ledgers][]) |
## Response Format

2
docs/references/http-websocket-apis/public-api-methods/clio-methods/ledger-clio.md
View File

@@ -34,7 +34,7 @@ The request can contain the following parameters:
| `Field` | Type | Description |
|:---------------|:---------------------------|:-------------------------------|
| `ledger_hash` | [Hash][] | _(Optional)_ A 20-byte hex string for the ledger version to use. (See [Specifying Ledgers][]). |
| `ledger_hash` | [Hash][] | _(Optional)_ The unique hash of the ledger version to use. (See [Specifying Ledgers][]). |
| `ledger_index` | [Ledger Index][] | _(Optional)_ The [ledger index][] of the ledger to use, or a shortcut string to choose a ledger automatically. (See [Specifying Ledgers][]) |
| `transactions` | Boolean | _(Optional)_ If `true`, return information on transactions in the specified ledger version. Defaults to `false`. Ignored if you did not specify a ledger version. |
| `expand` | Boolean | _(Optional)_ Provide full JSON-formatted information for transaction/account information instead of only hashes. Defaults to `false`. Ignored unless you request transactions. |

2
docs/references/http-websocket-apis/public-api-methods/clio-methods/nft_history.md
View File

@@ -53,7 +53,7 @@ The request contains the following parameters:
| `nft_id` | String | A unique identifier for the non-fungible token (NFT). |
| `ledger_index_min` | Integer | _(Optional)_ Use to specify the earliest ledger from which to include NFTs. A value of `-1` instructs the server to use the earliest validated ledger version available. |
| `ledger_index_max` | Integer | _(Optional)_ Use to specify the most recent ledger to include NFTs from. A value of `-1` instructs the server to use the most recent validated ledger version available. |
| `ledger_hash` | String | _(Optional)_ A 20-byte hex string for the ledger version to use. (See [Specifying Ledgers][]) |
| `ledger_hash` | String | _(Optional)_ The unique hash of the ledger version to use. (See [Specifying Ledgers][]) |
| `ledger_index` | String or Unsigned Integer | _(Optional)_ The [ledger index][] of the ledger to use, or a shortcut string to choose a ledger automatically. Do not specify the `ledger_index` as `closed` or `current`; doing so forwards the request to the P2P `rippled` server and the `nft_history` API is not available on `rippled`. (See [Specifying Ledgers][]) |
| `binary` | Boolean | _(Optional)_ Defaults to `false`. If set to `true`, returns transactions as hex strings instead of JSON. |
| `forward` | Boolean | _(Optional)_ Defaults to `false`. If set to `true`, returns values indexed with the oldest ledger first. Otherwise, the results are indexed with the newest ledger first. (Each page of results might not be internally ordered, but the pages are ordered overall.) |

2
docs/references/http-websocket-apis/public-api-methods/clio-methods/nft_info.md
View File

@@ -48,7 +48,7 @@ The request contains the following parameters:
| `Field` | Type | Description |
|:---------------|:---------------------------|:-------------------------------|
| `nft_id` | String | A unique identifier for the non-fungible token (NFT). |
| `ledger_hash` | String | _(Optional)_ A 20-byte hex string for the ledger version to use. (See [Specifying Ledgers][]) |
| `ledger_hash` | String | _(Optional)_ The unique hash of the ledger version to use. (See [Specifying Ledgers][]) |
| `ledger_index` | String or Unsigned Integer | _(Optional)_ The [ledger index][] of the ledger to use, or a shortcut string to choose a ledger automatically. Do not specify the `ledger_index` as `closed` or `current`; doing so forwards the request to the P2P `rippled` server and the `nft_info` API is not available on `rippled`. (See [Specifying Ledgers][]) |
If you do not specify a ledger version, Clio uses the latest validated ledger.

2
docs/references/http-websocket-apis/public-api-methods/ledger-methods/ledger_entry.md
View File

@@ -23,7 +23,7 @@ This method can retrieve several different types of data. You can select which t
| Field | Type | Description |
|:------------------------|:---------------------------|:----------------------|
| `binary` | Boolean | _(Optional)_ If `true`, return the requested ledger entry's contents as a hex string in the XRP Ledger's [binary format](../../../protocol/binary-format.md). Otherwise, return data in JSON format. The default is `false`. {% badge href="https://github.com/XRPLF/rippled/releases/tag/1.2.0" %}Updated in: rippled 1.2.0{% /badge %} |
| `ledger_hash` | String | _(Optional)_ A 20-byte hex string for the ledger version to use. (See [Specifying Ledgers][]) |
| `ledger_hash` | String | _(Optional)_ The unique hash of the ledger version to use. (See [Specifying Ledgers][]) |
| `ledger_index` | String or Unsigned Integer | _(Optional)_ The [ledger index][] of the ledger to use, or a shortcut string (e.g. "validated" or "closed" or "current") to choose a ledger automatically. (See [Specifying Ledgers][]) |
| `include_deleted` | Boolean | _(Optional, Clio servers only)_ If set to _true_ and the queried object has been deleted, return its complete data as it was prior to its deletion. If set to _false_ or not provided, and the queried object has been deleted, return `objectNotFound` (current behavior). |

2
docs/references/http-websocket-apis/public-api-methods/path-and-order-book-methods/book_offers.md
View File

@@ -73,7 +73,7 @@ The request includes the following parameters:
|:---------------|:-----------------|:----------|-------------|
| `taker_gets` | Object | Yes | The asset the account taking the Offer would receive, as a [currency without an amount](../../../protocol/data-types/currency-formats.md#specifying-without-amounts). |
| `taker_pays` | Object | Yes | The asset the account taking the Offer would pay, as a [currency without an amount](../../../protocol/data-types/currency-formats.md#specifying-without-amounts). |
| `ledger_hash` | [Hash][] | No | A 20-byte hex string for the ledger version to use. (See [Specifying Ledgers][]) |
| `ledger_hash` | [Hash][] | No | The unique hash of the ledger version to use. (See [Specifying Ledgers][]) |
| `ledger_index` | [Ledger Index][] | No | The [ledger index][] of the ledger to use, or a shortcut string to choose a ledger automatically. (See [Specifying Ledgers][]) |
| `limit` | Number | No | The maximum number of Offers to return. The response may include fewer results. |
| `taker` | String | No | The [Address][] of an account to use as a perspective. The response includes this account's Offers even if they are unfunded. (You can use this to see what Offers are above or below yours in the order book.) |

2
docs/references/http-websocket-apis/public-api-methods/path-and-order-book-methods/nft_buy_offers.md
View File

@@ -51,7 +51,7 @@ The request includes the following parameters:
| Field | Type | Description |
|:---------------|:-----------------|:-----------------------------------------|
| `nft_id` | String | The unique identifier of a [NFToken][] object. |
| `ledger_hash` | String | _(Optional)_ A 20-byte hex string for the ledger version to use. (See [Specifying Ledgers][]) |
| `ledger_hash` | String | _(Optional)_ The unique hash of the ledger version to use. (See [Specifying Ledgers][]) |
| `ledger_index` | String or Number | _(Optional)_ The [ledger index][] of the ledger to use, or a shortcut string to choose a ledger automatically. (See [Specifying Ledgers][]) |
| `limit` | Integer | _(Optional)_ Limit the number of NFT buy offers to retrieve. This value cannot be lower than 50 or more than 500. Positive values outside this range are replaced with the closest valid option. The default is 250. |
| `marker` | [Marker][] | _(Optional)_ Value from a previous paginated response. Resume retrieving data where that response left off. |

2
docs/references/http-websocket-apis/public-api-methods/path-and-order-book-methods/nft_sell_offers.md
View File

@@ -52,7 +52,7 @@ The request includes the following parameters:
| Field | Type | Description |
|:---------------|:-----------------|:-----------------------------------------|
| `nft_id` | String | The unique identifier of a [NFToken][] object. |
| `ledger_hash` | String | _(Optional)_ A 20-byte hex string for the ledger version to use. (See [Specifying Ledgers][]) |
| `ledger_hash` | String | _(Optional)_ The unique hash of the ledger version to use. (See [Specifying Ledgers][]) |
| `ledger_index` | String or Number | _(Optional)_ The [ledger index][] of the ledger to use, or a shortcut string to choose a ledger automatically. (See [Specifying Ledgers][]) |
| `limit` | Integer | _(Optional)_ Limit the number of NFT sell offers to retrieve. This value cannot be lower than 50 or more than 500. Positive values outside this range are replaced with the closest valid option. The default is 250. |
| `marker` | [Marker][] | _(Optional)_ Value from a previous paginated response. Resume retrieving data where that response left off. |

2
docs/references/http-websocket-apis/public-api-methods/path-and-order-book-methods/ripple_path_find.md
View File

@@ -92,7 +92,7 @@ The request includes the following parameters:
| `destination_amount` | String or Object | [Currency Amount][] that the destination account would receive in a transaction. **Special case:** 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][] that would be spent in the transaction. Cannot be used with `source_currencies`. |
| `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][Currency Amount] 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 Ledgers][]) |
| `ledger_hash` | String | _(Optional)_ The unique hash of the ledger version to use. (See [Specifying Ledgers][]) |
| `ledger_index` | String or Unsigned Integer | _(Optional)_ The [ledger index][] of the ledger to use, or a shortcut string to choose a ledger automatically. (See [Specifying Ledgers][]) |
## Response Format

2
docs/references/http-websocket-apis/public-api-methods/transaction-methods/transaction_entry.md
View File

@@ -57,7 +57,7 @@ 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 Ledgers][]) |
| `ledger_hash` | String | _(Optional)_ The unique hash of the ledger version to use. (See [Specifying Ledgers][]) |
| `ledger_index` | String or Unsigned Integer | _(Optional)_ The [ledger index][] of the ledger to use, or a shortcut string to choose a ledger automatically. (See [Specifying Ledgers][]) |
| `tx_hash` | String | Unique hash of the transaction you are looking up |