xrpl
    Preparing search index...

    Interface AccountSponsoringRequest

    The account_sponsoring command returns information about accounts and ledger objects that are sponsored by the specified account. This is a Clio-only method that provides details about sponsorship relationships for XLS-68. Expects a response in the form of an AccountSponsoringResponse.

    interface AccountSponsoringRequest {
        account: string;
        api_version?: number;
        command: "account_sponsoring";
        deletion_blockers_only?: boolean;
        id?: string | number;
        ledger_hash?: string;
        ledger_index?: LedgerIndex;
        limit?: number;
        marker?: unknown;
        type?: AccountObjectType;
        [x: string]: unknown;
    }

    Hierarchy (View Summary)

    • BaseRequest
    • LookupByLedgerRequest
      • AccountSponsoringRequest

    Indexable

    • [x: string]: unknown
    Index

    Properties

    account api_version? command deletion_blockers_only? id? ledger_hash? ledger_index? limit? marker? type?

    Properties

    account: string

    A unique identifier for the account, most commonly the account's address. This is the sponsor account whose sponsorships will be returned.

    api_version?: number

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

    command: "account_sponsoring"

    The name of the API method.

    deletion_blockers_only?: boolean

    If true, the response only includes sponsored objects that would block the sponsored account from being deleted. The default is false.

    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.

    ledger_hash?: string

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

    ledger_index?: LedgerIndex

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

    limit?: number

    The maximum number of sponsored accounts to include in the results. Must be within the inclusive range 10 to 400 on non-admin connections. The default is 200.

    marker?: unknown

    Value from a previous paginated response. Resume retrieving data where that response left off.

    type?: AccountObjectType

    If included, filter results to include only sponsored objects of this ledger entry type.

    Settings

    Member Visibility

    On This Page

    Properties