xrpl
    Preparing search index...

    Interface AccountSponsoringResponse

    Response expected from an AccountSponsoringRequest.

    interface AccountSponsoringResponse {
        api_version?: number;
        forwarded?: boolean;
        id: string | number;
        result: {
            account: string;
            ledger_current_index?: number;
            ledger_hash?: string;
            ledger_index?: number;
            limit?: number;
            marker?: unknown;
            sponsored_objects: LedgerEntry.LedgerEntry[];
            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;
        ledger_current_index?: number;
        ledger_hash?: string;
        ledger_index?: number;
        limit?: number;
        marker?: unknown;
        sponsored_objects: LedgerEntry.LedgerEntry[];
        validated?: boolean;
    }

    Type Declaration

    • account: string

      The address of the sponsor account from the request.

    • 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?: unknown

      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.

    • sponsored_objects: LedgerEntry.LedgerEntry[]

      Array of ledger entries in this account's owner directory. This includes entries owned by this account and entries that are linked to this account but owned by someone else, such as escrows where this account is the destination. Each member is a ledger entry in its raw ledger format.

    • 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