Interface AccountInfoResponse

Response expected from a AccountInfoRequest.

interface AccountInfoResponse {
    api_version?: number;
    forwarded?: boolean;
    id: string | number;
    result: {
        account_data: AccountRoot;
        account_flags?: AccountInfoAccountFlags;
        ledger_current_index?: number;
        ledger_index?: number;
        queue_data?: AccountQueueData;
        validated?: boolean;
    } & { signer_lists?: SignerList[] };
    status?: string;
    type: string;
    warning?: "load";
    warnings?: ResponseWarning[];
}

Hierarchy

  • BaseAccountInfoResponse
    • AccountInfoResponse

Properties

api_version? forwarded? id result status? type warning? warnings?

Properties

Optionalapi_version

api_version?: number

Optionalforwarded

forwarded?: boolean

id

id: string | number

result

result: {
    account_data: AccountRoot;
    account_flags?: AccountInfoAccountFlags;
    ledger_current_index?: number;
    ledger_index?: number;
    queue_data?: AccountQueueData;
    validated?: boolean;
} & { signer_lists?: SignerList[] }

Type declaration

  • account_data: AccountRoot

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

  • Optionalaccount_flags?: AccountInfoAccountFlags

    A map of account flags parsed out. This will only be available for rippled nodes 1.11.0 and higher.

  • Optionalledger_current_index?: number

    The ledger index of the current in-progress ledger, which was used when retrieving this information.

  • Optionalledger_index?: number

    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.

  • Optionalqueue_data?: AccountQueueData

    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.

  • Optionalvalidated?: boolean

    True if this data is from a validated ledger version; if omitted or set to false, this data is not final.

  • Optionalsigner_lists?: SignerList[]

    If requested, 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.

Optionalstatus

status?: string

type

type: string

Optionalwarning

warning?: "load"

Optionalwarnings

warnings?: ResponseWarning[]

Settings

Member Visibility

On This Page

Properties