xrpl
    Preparing search index...

    Interface UnsubscribeRequest

    The unsubscribe command tells the server to stop sending messages for a particular subscription or set of subscriptions. Expects a response in the form of an UnsubscribeResponse.

    interface UnsubscribeRequest {
        accounts?: string[];
        accounts_proposed?: string[];
        api_version?: number;
        books?: UnsubscribeBook[];
        command: "unsubscribe";
        id?: string | number;
        streams?: StreamType[];
        [x: string]: unknown;
    }

    Hierarchy (View Summary)

    Indexable

    • [x: string]: unknown
    Index

    Properties

    accounts? accounts_proposed? api_version? books? command id? streams?

    Properties

    accounts?: string[]

    Array of unique account addresses to stop receiving updates for, in the. XRP Ledger's base58 format.

    accounts_proposed?: string[]

    Like accounts, but for accounts_proposed subscriptions that included not-yet-validated transactions.

    api_version?: number

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

    books?: UnsubscribeBook[]

    Array of objects defining order books to unsubscribe from, as explained below.

    command: "unsubscribe"

    The name of the API method.

    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.

    streams?: StreamType[]

    Array of string names of generic streams to unsubscribe from, including. Ledger, server, transactions, and transactions_proposed.

    Settings

    Member Visibility

    On This Page

    Properties