Interface AccountInfoRequest

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. Returns an AccountInfoResponse.

Hierarchy

Properties

account api_version? command id? ledger_hash? ledger_index? queue? signer_lists? strict?

Properties

account

account: string

A unique identifier for the account, most commonly the account's address.

Optional api_version

api_version?: number

The API version to use. If omitted, use version 1.

command

command: "account_info"

The name of the API method.

Optional id

id?: string | number

A unique value to identify this request. The response to this request uses the same id field. This way, even if responses arrive out of order, you know which request prompted which response.

Optional ledger_hash

ledger_hash?: string

A 20-byte hex string for the ledger version to use.

Optional ledger_index

ledger_index?: LedgerIndex

The ledger index of the ledger to use, or a shortcut string.

Optional queue

queue?: boolean

Whether to get info about this account's queued transactions. Can only be used when querying for the data from the current open ledger. Not available from servers in Reporting Mode.

Optional signer_lists

signer_lists?: boolean

Request SignerList objects associated with this account.

Optional strict

strict?: boolean

If true, then the account field only accepts a public key or XRP Ledger address. Otherwise, account can be a secret or passphrase (not recommended). The default is false.

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc