Skip to content

Commit c1fdc3e

Browse files
authored
Merge pull request #2707 from XRPLF/defi_136_ledger_entry_param
Add include_deleted param to ledger_entry
2 parents e538297 + 5646168 commit c1fdc3e

File tree

1 file changed

+2
-0
lines changed
  • docs/references/http-websocket-apis/public-api-methods/ledger-methods

1 file changed

+2
-0
lines changed

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

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,7 @@ This method can retrieve several different types of data. You can select which t
2525
| `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 %} |
2626
| `ledger_hash` | String | _(Optional)_ A 20-byte hex string for the ledger version to use. (See [Specifying Ledgers][]) |
2727
| `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][]) |
28+
| `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). |
2829

2930
The `generator` and `ledger` parameters are deprecated and may be removed without further notice.
3031

@@ -759,6 +760,7 @@ The response follows the [standard format][], with a successful result containin
759760
| `ledger_index` | Unsigned Integer | The [ledger index][] of the ledger that was used when retrieving this data. |
760761
| `node` | Object | _(Omitted if `"binary": true` specified.)_ Object containing the data of this ledger entry, according to the [ledger format][]. |
761762
| `node_binary` | String | _(Omitted unless `"binary":true` specified)_ The [binary representation](../../../protocol/binary-format.md) of the ledger object, as hexadecimal. |
763+
| `deleted_ledger_index` | String | _(Clio server only, returned if `include_deleted` parameter is set.)_ The [ledger index][] where the ledger entry object was deleted. |
762764

763765
An example of a successful response:
764766

0 commit comments

Comments
 (0)