xrpl
    Preparing search index...

    Interface AccountObjectsResponse

    Response expected from an AccountObjectsRequest.

    interface AccountObjectsResponse {
        api_version?: number;
        forwarded?: boolean;
        id: string | number;
        result: {
            account: string;
            account_objects: AccountObject[];
            ledger_current_index?: number;
            ledger_hash?: string;
            ledger_index?: number;
            limit?: number;
            marker?: string;
            validated?: boolean;
        };
        status?: string;
        type: string;
        warning?: "load";
        warnings?: ResponseWarning[];
    }

    Hierarchy (View Summary)

    Index

    Properties

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

    Properties

    api_version?: number
    forwarded?: boolean
    id: string | number
    result: {
        account: string;
        account_objects: AccountObject[];
        ledger_current_index?: number;
        ledger_hash?: string;
        ledger_index?: number;
        limit?: number;
        marker?: string;
        validated?: boolean;
    }

    Type declaration

    • account: string

      Unique Address of the account this request corresponds to.

    • account_objects: AccountObject[]

      Array of objects owned by this account. Each object is in its raw ledger format.

    • Optionalledger_current_index?: number

      The ledger index of the current in-progress ledger version, which was used to generate this response.

    • Optionalledger_hash?: string

      The identifying hash of the ledger that was used to generate this response.

    • Optionalledger_index?: number

      The ledger index of the ledger version that was used to generate this response.

    • Optionallimit?: number

      The limit that was used in this request, if any.

    • Optionalmarker?: string

      Server-defined value indicating the response is paginated. Pass this to the next call to resume where this call left off. Omitted when there are no additional pages after this one.

    • Optionalvalidated?: boolean

      If included and set to true, the information in this response comes from a validated ledger version. Otherwise, the information is subject to change.

    status?: string
    type: string
    warning?: "load"
    warnings?: ResponseWarning[]

    Settings

    Member Visibility

    On This Page

    Properties