xrpl
    Preparing search index...

    Interface SubscribeRequest

    The subscribe method requests periodic notifications from the server when certain events happen. Expects a response in the form of a SubscribeResponse.

    interface SubscribeRequest {
        accounts?: string[];
        accounts_proposed?: string[];
        api_version?: number;
        books?: SubscribeBook[];
        command: "subscribe";
        id?: string | number;
        streams?: StreamType[];
        url?: string;
        url_password?: string;
        url_username?: string;
        [x: string]: unknown;
    }

    Hierarchy (View Summary)

    Indexable

    • [x: string]: unknown
    Index

    Properties

    accounts? accounts_proposed? api_version? books? command id? streams? url? url_password? url_username?

    Properties

    accounts?: string[]

    Array with the unique addresses of accounts to monitor for validated transactions. The addresses must be in the XRP Ledger's base58 format. The server sends a notification for any transaction that affects at least one of these accounts.

    accounts_proposed?: string[]

    Like accounts, but include transactions that are not yet finalized.

    api_version?: number

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

    books?: SubscribeBook[]

    Array of objects defining order books to monitor for updates, as detailed Below.

    command: "subscribe"

    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 subscribe to.

    url?: string

    URL where the server sends a JSON-RPC callbacks for each event. Admin-only.

    url_password?: string

    Password to provide for basic authentication at the callback URL.

    url_username?: string

    Username to provide for basic authentication at the callback URL.

    Settings

    Member Visibility

    On This Page

    Properties