Skip to main content

account_objects

POST
Returns the ledger entries owned by an account in their raw format.It lets you inspect the objects associated with the account by type, such as offers, trust lines, Escrows and Checks.
param[0]
parametersobjectrequired
accountstringrequired
The account to look up.
typestring
The ledger entry type to return. Both canonical and short names can be used.(e.g.) offer, state, escrow, check, payment_channel, signer_list, ticket, nft_offer
deletion_blockers_onlyboolean
Whether to return only the entries that block account deletion.
limitinteger
The number of entries to return. Pass a value between 10 and 400.
markerstring
A value that marks a pagination position. Pass the marker value from a previous response to retrieve the next page.Its format depends on the server implementation, so use it verbatim without interpreting its contents.
ledger_hashstring
The hash of the ledger version to use. Pass a 32-byte hex string.
ledger_indexoneOf
Specifies the ledger version to use. Pass a ledger index as an integer, or use one of the shortcut strings below.
  • validated: Uses the most recent ledger version validated by the network.
  • closed: Uses the most recent ledger version the server has closed. It may not be validated.
  • current: Uses the in-progress ledger version the server is currently building.
The ledger index of the version to use.
Responses
accountstring
The account the request was made from the perspective of.
The list of ledger entries owned by the account. The field composition varies by entry type.Entries shared between two accounts, such as trust lines, may include ones owned by the counterparty.
LedgerEntryTypestring
The type of the ledger entry.
indexstring
The ID that identifies the ledger entry.
PreviousTxnIDstring
The ID of the transaction that most recently modified this entry.
PreviousTxnLgrSeqinteger
The ledger index of the ledger containing the transaction that most recently modified this entry.
limitinteger
The limit value used in the request.
markerstring
A value that marks a pagination position. Pass the marker value from a previous response to retrieve the next page.Its format depends on the server implementation, so use it verbatim without interpreting its contents.
ledger_hashstring
The hash of the ledger version used. Returned when a validated ledger version was queried.
ledger_indexinteger
The ledger index of the version used. Returned when a validated ledger version was queried.
ledger_current_indexinteger
The ledger index of the in-progress ledger. Returned when the current ledger was queried.
validatedboolean
Whether the response was derived from a validated ledger version.
codestringrequired
Code identifying the cause of the failed request.
messagestringrequired
Detailed message including the name and value of the invalid parameter.
{
  "code": "ERROR_CODE",
  "message": "Unauthorized"
}
cURL
curl -X POST 'https://xrpl-mainnet.nodit.io' \
  -H 'Content-Type: application/json' \
  -H 'X-API-KEY: nodit-demo' \
  -d '{
    "method": "account_objects",
    "params": [
      {
        "account": "r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59",
        "type": "offer",
        "deletion_blockers_only": false,
        "limit": 200
      }
    ]
  }'