Skip to main content

account_info

POST
Returns core information about an account.It lets you check the XRP balance, the sequence number, the account flags and the number of owned objects.

📘 If the account does not exist in the ledger, an actNotFound error is returned.

param[0]
parametersobjectrequired
accountstringrequired
The account to look up.
queueboolean
Whether to also return the statistics for this account's queued transactions.It can be used only when ledger_index is set to current.
signer_listsboolean
Whether to also return the SignerList objects associated with the account.
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
The AccountRoot ledger object for the account.
Accountstring
The account address.
Balancestring
The XRP balance of the account, in drops.
Flagsinteger
A bit-map of boolean flags enabled for the account.
LedgerEntryTypestring
The ledger entry type. Always returns AccountRoot.
OwnerCountinteger
The number of ledger objects owned by the account that count toward its reserve.
PreviousTxnIDstring
The ID of the transaction that most recently modified this object.
PreviousTxnLgrSeqinteger
The ledger index of the ledger containing the transaction that most recently modified this object.
Sequenceinteger
The next sequence number the account will use for a transaction.
indexstring
The ID that identifies this ledger entry.
The enabled state of each account flag.
defaultRippleboolean
Whether rippling is enabled by default for tokens issued by this account.
depositAuthboolean
Whether Deposit Authorization is enabled.
disableMasterKeyboolean
Whether use of the master key is disabled.
disallowIncomingCheckboolean
Whether incoming Checks are blocked.
disallowIncomingNFTokenOfferboolean
Whether incoming NFToken offers are blocked.
disallowIncomingPayChanboolean
Whether incoming Payment Channels are blocked.
disallowIncomingTrustlineboolean
Whether incoming trust lines are blocked.
disallowIncomingXRPboolean
Whether the account is marked as discouraging incoming XRP.
globalFreezeboolean
Whether all tokens issued by this account are frozen.
noFreezeboolean
Whether the ability to freeze has been permanently given up.
passwordSpentboolean
Whether the free key change has been used.
requireAuthorizationboolean
Whether the issuer's authorization is required to use a trust line.
requireDestinationTagboolean
Whether incoming payments require a destination tag.
signer_listsarray
The list of SignerList objects associated with the account.In API v1 it is returned under account_data; in API v2 and Clio it is returned at the root level.
Data on this account's queued transactions. Returned when queue is set to true in the request.
txn_countinteger
The number of queued transactions.
auth_change_queuedboolean
Whether any queued transaction changes signing authority.
lowest_sequenceinteger
The lowest sequence number among the queued transactions.
highest_sequenceinteger
The highest sequence number among the queued transactions.
max_spend_drops_totalstring
The maximum total XRP the queued transactions could debit, in drops.
transactionsarray
Data for an individual queued transaction.
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_info",
    "params": [
      {
        "account": "r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59",
        "queue": false,
        "signer_lists": false
      }
    ]
  }'