ARCHIVE/xrpl-dev-portal
1
0
Fork 0
mirror of https://github.com/XRPLF/xrpl-dev-portal.git synced 2025-11-18 02:35:49 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #3237 from XRPLF/update_account_objects

Browse Source 
Update account_objects docs
This commit is contained in:
Rome Reginelli
2025-08-15 12:19:27 -07:00
committed by GitHub
parent 207e50caa2 30e6767f58
commit 94686086ee
8 changed files with 595 additions and 1181 deletions
Download Patch File Download Diff File Expand all files Collapse all files

39
docs/references/http-websocket-apis/api-conventions/ledger-entry-short-names.md Normal file
View File

@@ -0,0 +1,39 @@
# Short Names of Ledger Entries
Some API methods, specifically the [account_objects method][] and [ledger_data method][], allow filtering the ledger entries they return based on the type of ledger entry. The type field you specify can use either the canonical name of the [ledger entry](../../protocol/ledger-data/ledger-entry-types/index.md) or a short name, as in the following table.
The "Ownable" column indicates whether the ledger entry type can appear in owner directories. Ledger entries that are not ownable cannot appear in `account_objects` responses and cannot be used as a `type` filter in that method.
| Canonical Name | Short Name | Ownable | Related Amendment |
| -------------------- | --------------------- | ------- |---|
| `AccountRoot` | `account` | No | |
| `Amendments` | `amendments` | No | |
| `AMM` | `amm` | No | {% amendment-disclaimer name="AMM" compact=true /%} |
| `Bridge` | `bridge` | Yes | {% amendment-disclaimer name="XChainBridge" compact=true /%} |
| `Check` | `check` | Yes | {% amendment-disclaimer name="Checks" compact=true /%} |
| `Credential` | `credential` | Yes | {% amendment-disclaimer name="Credentials" compact=true /%} |
| `Delegate` | `delegate` | Yes | {% amendment-disclaimer name="PermissionDelegation" compact=true /%} |
| `DepositPreauth` | `deposit_preauth` | Yes | {% amendment-disclaimer name="DepositPreauth" compact=true /%} |
| `DID` | `did` | Yes | {% amendment-disclaimer name="DID" compact=true /%} |
| `DirectoryNode` | `directory` | No | |
| `Escrow` | `escrow` | Yes | |
| `FeeSettings` | `fee` | No | |
| `LedgerHashes` | `hashes` | No | |
| `MPToken` | `mptoken` | Yes | {% amendment-disclaimer name="MPTokensV1" compact=true /%} |
| `MPTokenIssuance` | `mpt_issuance` | Yes | {% amendment-disclaimer name="MPTokensV1" compact=true /%} |
| `NegativeUNL` | `nunl` | No | {% amendment-disclaimer name="NegativeUNL" compact=true /%} |
| `NFTokenOffer` | `nft_offer` | Yes | {% amendment-disclaimer name="NonFungibleTokensV1_1" compact=true /%} |
| `NFTokenPage` | `nft_page` | Yes | {% amendment-disclaimer name="NonFungibleTokensV1_1" compact=true /%} |
| `Offer` | `offer` | Yes | |
| `Oracle` | `oracle` | Yes | {% amendment-disclaimer name="PriceOracle" compact=true /%} |
| `PayChannel` | `payment_channel` | Yes | |
| `PermissionedDomain` | `permissioned_domain` | Yes | {% amendment-disclaimer name="PermissionedDomains" compact=true /%} |
| `RippleState` | `state` | Yes | |
| `SignerList` | `signer_list` | Yes | |
| `Ticket` | `ticket` | Yes | {% amendment-disclaimer name="TicketBatch" compact=true /%} |
| `XChainOwnedClaimID` | `xchain_owned_claim_id` | Yes | {% amendment-disclaimer name="XChainBridge" compact=true /%} |
| `XChainOwnedCreate`<wbr>`AccountClaimID` | `xchain_owned_`<wbr>`create_account_claim_id` | Yes | {% amendment-disclaimer name="XChainBridge" compact=true /%} |
<!-- Author's note: used <wbr> (word break opportunity) so that the long xchain names don't cause the table to scroll horizontally. -->
{% raw-partial file="/docs/_snippets/common-links.md" /%}

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

File diff suppressed because it is too large Load Diff

24
docs/references/http-websocket-apis/public-api-methods/ledger-methods/ledger_data.md
View File

@@ -59,29 +59,7 @@ 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. 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` |
| `type` | String | No | Filter results to a specific type of ledger entry. This field accepts canonical names of [ledger entry types](../../../protocol/ledger-data/ledger-entry-types/index.md) (case insensitive) or [short names](../../api-conventions/ledger-entry-short-names.md). If omitted, return ledger entries of all types. |
The `ledger` field is deprecated and may be removed without further notice.