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 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 | Requires the AMM. Loading... |
Bridge | bridge | Yes | Requires the XChainBridge. Loading... |
Check | check | Yes | Requires the Checks. Loading... |
Credential | credential | Yes | Requires the Credentials. Loading... |
Delegate | delegate | Yes | Requires the PermissionDelegation. Loading... |
DepositPreauth | deposit_preauth | Yes | Requires the DepositPreauth. Loading... |
DID | did | Yes | Requires the DID. Loading... |
DirectoryNode | directory | No | |
Escrow | escrow | Yes | |
FeeSettings | fee | No | |
LedgerHashes | hashes | No | |
MPToken | mptoken | Yes | Requires the MPTokensV1. Loading... |
MPTokenIssuance | mpt_issuance | Yes | Requires the MPTokensV1. Loading... |
NegativeUNL | nunl | No | Requires the NegativeUNL. Loading... |
NFTokenOffer | nft_offer | Yes | Requires the NonFungibleTokensV1_1. Loading... |
NFTokenPage | nft_page | Yes | Requires the NonFungibleTokensV1_1. Loading... |
Offer | offer | Yes | |
Oracle | oracle | Yes | Requires the PriceOracle. Loading... |
PayChannel | payment_channel | Yes | |
PermissionedDomain | permissioned_domain | Yes | Requires the PermissionedDomains. Loading... |
RippleState | state | Yes | |
SignerList | signer_list | Yes | |
Ticket | ticket | Yes | Requires the TicketBatch. Loading... |
XChainOwnedClaimID | xchain_owned_claim_id | Yes | Requires the XChainBridge. Loading... |
XChainOwnedCreate AccountClaimID | xchain_owned_ create_account_claim_id | Yes | Requires the XChainBridge. Loading... |