For the complete documentation index, see llms.txt. This page is also available as Markdown.

account_info

Retrieves information about an account, its activity, and its XRP balance. All information retrieved is relative to a particular version of the ledger.

This method will use 20 Compute Units.


Reference: Here

Parameters

  • account (string, required) The account to look up.

  • ledger_hash (string, optional) The unique hash of the ledger version to use.

  • ledger_index (number or string, optional) The ledger index of the ledger to use, or a shortcut string such as validated, closed or current.

  • queue (boolean, optional) If true, return stats about queued transactions sent by this account. Can only be used when querying the current open ledger.

  • signer_lists (boolean, optional) If true, return any SignerList objects associated with this account.

Returns

  • account_data (object) The AccountRoot ledger object with this account's information, as stored in the ledger.

  • account_flags (object) The account's flag statuses (for example defaultRipple, depositAuth, disableMasterKey, globalFreeze, requireAuthorization, requireDestinationTag), based on the Flags field of the account.

  • signer_lists (array) Omitted unless the request specified signer_lists and at least one SignerList is associated with the account.

  • ledger_current_index (number) Omitted if ledger_index is provided instead. The ledger index of the current in-progress ledger.

  • ledger_index (number) Omitted if ledger_current_index is provided instead. The ledger index of the ledger version used.

  • queue_data (object) Omitted unless queue is true and querying the current open ledger. Information about queued transactions sent by this account.

  • validated (boolean) True if this data is from a validated ledger version.

Over WebSocket, send {"id":1,"command":"account_info","account":"rMxCKbEDwqr76QuheSUMdEGf4B9xJ8m5De","ledger_index":"validated"} to wss://mainnet.xrpl.validationcloud.io/v1/<YOUR_API_KEY_HERE>.

Last updated

Was this helpful?