xrpl
    Preparing search index...

    Interface SubscribeBook

    interface SubscribeBook {
        both?: boolean;
        domain?: string;
        snapshot?: boolean;
        taker: string;
        taker_gets: Currency;
        taker_pays: Currency;
    }
    Index

    Properties

    both? domain? snapshot? taker taker_gets taker_pays

    Properties

    both?: boolean

    If true, return both sides of the order book. The default is false.

    domain?: string

    The object ID of a PermissionedDomain object. If this field is included, then the offers will be filtered to only show the valid domain offers for that domain.

    snapshot?: boolean

    If true, return the current state of the order book once when you subscribe before sending updates. The default is false.

    taker: string

    Unique account address to use as a perspective for viewing offers, in the. XRP Ledger's base58 format.

    taker_gets: Currency

    Specification of which currency the account taking the Offer would receive, as a currency object with no amount.

    taker_pays: Currency

    Specification of which currency the account taking the Offer would pay, as a currency object with no amount.

    Settings

    Member Visibility

    On This Page

    Properties