update docs for pr 5271

This commit is contained in:
Oliver Eggert
2025-02-27 12:16:21 -08:00
parent b77b490033
commit 2371af7ad8
3 changed files with 43 additions and 4 deletions

View File

@@ -59,10 +59,33 @@ A request can include the following fields:
| `binary` | Boolean | No | If `true`, return ledger entries as hexadecimal strings instead of JSON. The default is `false`. |
| `limit` | Number | No | Limit the number of ledger entries to retrieve. The server may return fewer than this number of entries. Cannot be more than 2048 (when requesting binary) or 256 (when requesting JSON). Positive values outside this range are replaced with the closest valid option. The default is the maximum. |
| `marker` | [Marker][] | No | Value from a previous paginated response. Resume retrieving data where that response left off. |
| `type` | String | No | Filter results to a specific type of ledger entry. The valid types are: `account`, `amendments`, `amm`, `check`, `deposit_preauth`, `directory`, `escrow`, `fee`, `hashes`, `nft_offer`, `offer`, `payment_channel`, `signer_list`, `state` (trust line), and `ticket`. |
| `type` | String | No | Filter results to a specific type of ledger entry. This field accepts canonical ledger entry names (case insensitive) or short names. |
Valid `type` field values are:
| Canonical Name | Short Name |
| ----------------- | ----------------- |
| `AccountRoot` | `account` |
| `Amendments` | `amendments` |
| `AMM` | `amm` |
| `Check` | `check` |
| `DepositPreauth` | `deposit_preauth` |
| `DirectoryNode` | `directory` |
| `Escrow` | `escrow` |
| `FeeSettings` | `fee` |
| `LedgerHashes` | `hashes` |
| `MPToken` | `mptoken` |
| `MPTokenIssuance` | `mpt_issuance` |
| `NFTokenOffer ` | `nft_offer` |
| `Offer` | `offer` |
| `PayChannel` | `payment_channel` |
| `RippleState` | `state` |
| `SignerList` | `signer_list` |
| `Ticket` | `ticket` |
The `ledger` field is deprecated and may be removed without further notice.
## Response Format
An example of a successful response: