Last updated

account_info

[Source]

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

Request Format

An example of an account_info request:

  1. WebSocket
  2. JSON-RPC
  3. Commandline
{
  "id": 2,
  "command": "account_info",
  "account": "rG1QQv2nh2gr7RCZ1P8YYcBUKCCN633jCn",
  "ledger_index": "current",
  "queue": true
}

Try it! >

The request contains the following parameters:

FieldTypeRequired?Description
accountString - AddressYesThe account to look up. Updated in: rippled 1.11.0
ledger_hashStringNoA 20-byte hex string for the ledger version to use. (See Specifying Ledgers)
ledger_indexNumber or StringNoThe ledger index of the ledger to use, or a shortcut string to choose a ledger automatically. (See Specifying Ledgers)
queueBooleanNoIf true, return stats about queued transactions sent by this account. Can only be used when querying for the data from the current open ledger. Not available from servers in Reporting Mode.
signer_listsBooleanNoAPI v1: If true, return any SignerList objects associated with this account.
API v2: Identical to v1, but also returns an invalidParams error if you provide a non-boolean value.

The following fields are deprecated and should not be provided: ident, ledger, strict.

Response Format

An example of a successful response:

  1. WebSocket
  2. JSON-RPC
  3. Commandline
{
    "id": 5,
    "status": "success",
    "type": "response",
    "result": {
        "account_data": {
            "Account": "rG1QQv2nh2gr7RCZ1P8YYcBUKCCN633jCn",
            "Balance": "999999999960",
            "Flags": 8388608,
            "LedgerEntryType": "AccountRoot",
            "OwnerCount": 0,
            "PreviousTxnID": "4294BEBE5B569A18C0A2702387C9B1E7146DC3A5850C1E87204951C6FDAA4C42",
            "PreviousTxnLgrSeq": 3,
            "Sequence": 6,
            "index": "92FA6A9FC8EA6018D5D16532D7795C91BFB0831355BDFDA177E86C8BF997985F"
        },
        "ledger_current_index": 4,
        "queue_data": {
            "auth_change_queued": true,
            "highest_sequence": 10,
            "lowest_sequence": 6,
            "max_spend_drops_total": "500",
            "transactions": [
                {
                    "auth_change": false,
                    "fee": "100",
                    "fee_level": "2560",
                    "max_spend_drops": "100",
                    "seq": 6
                },
                ... (trimmed for length) ...
                {
                    "LastLedgerSequence": 10,
                    "auth_change": true,
                    "fee": "100",
                    "fee_level": "2560",
                    "max_spend_drops": "100",
                    "seq": 10
                }
            ],
            "txn_count": 5
        },
        "validated": false
    }
}

The response follows the standard format, with the result containing the requested account, its data, and a ledger to which it applies, as the following fields:

FieldTypeDescription
account_dataObjectThe AccountRoot ledger object with this account's information, as stored in the ledger.
account_flagsObjectThe account's flag statuses (see below), based on the Flags field of the account. New in: rippled 1.11.0
signer_listsArrayAPI v1: (Omitted unless the request specified signer_lists and at least one SignerList is associated with the account.) Array of SignerList ledger objects associated with this account for Multi-Signing. Since an account can own at most one SignerList, this array must have exactly one member if it is present. The field is nested under account_data.
API v2: Identical to API v1, but the field is returned in the root response instead. Clio implements the API v2 behavior in all cases.
ledger_current_indexInteger(Omitted if ledger_index is provided instead) The ledger index of the current in-progress ledger, which was used when retrieving this information.
ledger_indexInteger(Omitted if ledger_current_index is provided instead) The ledger index of the ledger version used when retrieving this information. The information does not contain any changes from ledger versions newer than this one.
queue_dataObject(Omitted unless queue specified as true and querying the current open ledger.) Information about queued transactions sent by this account. This information describes the state of the local rippled server, which may be different from other servers in the peer-to-peer XRP Ledger network. Some fields may be omitted because the values are calculated "lazily" by the queuing mechanism.
validatedBooleanTrue if this data is from a validated ledger version; if omitted or set to false, this data is not final.

The account_flags field contains the following nested fields:

FieldTypeDescription
defaultRippleBooleanIf true, the account allows rippling on its trust lines by default.
depositAuthBooleanIf true, the account is using Deposit Authorization and does not accept any payments from unknown parties.
disableMasterKeyBooleanIf true, the account's master key pair is disabled.
disallowIncomingCheckBooleanIf true, the account does not allow others to send Checks to it. (Requires the DisallowIncoming amendment)
disallowIncomingNFTokenOfferBooleanIf true, the account does not allow others to make NFT buy or sell offers to it. (Requires the DisallowIncoming amendment)
disallowIncomingPayChanBooleanIf true, the account does not allow others to make Payment Channels to it. (Requires the DisallowIncoming amendment)
disallowIncomingTrustlineBooleanIf true, the account does not allow others to make trust lines to it. (Requires the DisallowIncoming amendment)
disallowIncomingXRPBooleanIf true, the account does not want to receive XRP from others. (This is advisory, and not enforced at a protocol level.)
globalFreezeBooleanIf true, all tokens issued by the account are currently frozen.
noFreezeBooleanIf true, the account has permanently given up the abilities to freeze individual trust lines or end a global freeze. See No Freeze for details.
passwordSpentBooleanIf false, the account can send a special key reset transaction with a transaction cost of 0. The protocol turns this flag on and off automatically; it is not controlled by a user-facing setting.
requireAuthorizationBooleanIf true, the account is using Authorized Trust Lines to limit who can hold the tokens it issues.
requireDestinationTagBooleanIf true, the account requires a destination tag on all payments it receives.

The queue_data field, if present, contains the following nested fields:

FieldTypeDescription
txn_countIntegerNumber of queued transactions from this address.
auth_change_queuedBoolean(May be omitted) Whether a transaction in the queue changes this address's ways of authorizing transactions. If true, this address can queue no further transactions until that transaction has been executed or dropped from the queue.
lowest_sequenceInteger(May be omitted) The lowest Sequence Number among transactions queued by this address.
highest_sequenceInteger(May be omitted) The highest Sequence Number among transactions queued by this address.
max_spend_drops_totalString(May be omitted) Integer amount of drops of XRP that could be debited from this address if every transaction in the queue consumes the maximum amount of XRP possible.
transactionsArray(May be omitted) Information about each queued transaction from this address.

Each object in the transactions array of queue_data, if present, may contain any or all of the following fields:

FieldTypeDescription
auth_changeBooleanWhether this transaction changes this address's ways of authorizing transactions.
feeStringThe Transaction Cost of this transaction, in drops of XRP.
fee_levelStringThe transaction cost of this transaction, relative to the minimum cost for this type of transaction, in fee levels.
max_spend_dropsStringThe maximum amount of XRP, in drops, this transaction could send or destroy.
seqIntegerThe Sequence Number of this transaction.

Possible Errors

  • Any of the universal error types.
  • invalidParams - One or more fields are specified incorrectly, or one or more required fields are missing. For example, the request specified queue as true but specified a ledger_index that is not the current open ledger.
  • actNotFound - The address specified in the account field of the request does not correspond to an account in the ledger.
  • lgrNotFound - The ledger specified by the ledger_hash or ledger_index does not exist, or it does exist but the server does not have it.