xrpl
    Preparing search index...

    Interface BookOffersRequest

    The book_offers method retrieves a list of offers, also known as the order. Book, between two currencies. Returns an BookOffersResponse.

    interface BookOffersRequest {
        api_version?: number;
        command: "book_offers";
        domain?: string;
        id?: string | number;
        ledger_hash?: string;
        ledger_index?: LedgerIndex;
        limit?: number;
        taker?: string;
        taker_gets: BookOfferCurrency;
        taker_pays: BookOfferCurrency;
        [x: string]: unknown;
    }

    Hierarchy (View Summary)

    Indexable

    • [x: string]: unknown
    Index

    Properties

    api_version? command domain? id? ledger_hash? ledger_index? limit? taker? taker_gets taker_pays

    Properties

    api_version?: number

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

    command: "book_offers"

    The name of the API method.

    domain?: string

    The object ID of a PermissionedDomain object. If this field is provided, the response will include only valid domain offers associated with that specific domain. If omitted, the response will include only hybrid and open offers for the trading pair, excluding all domain-specific offers.

    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

    If provided, the server does not provide more than this many offers in the results. The total number of results returned may be fewer than the limit, because the server omits unfunded offers.

    taker?: string

    The Address of an account to use as a perspective. Unfunded offers placed by this account are always included in the response.

    taker_gets: BookOfferCurrency

    Specification of which currency the account taking the offer would receive, as an object with currency and issuer fields (omit issuer for XRP), like currency amounts.

    taker_pays: BookOfferCurrency

    Specification of which currency the account taking the offer would pay, as an object with currency and issuer fields (omit issuer for XRP), like currency amounts.

    Settings

    Member Visibility

    On This Page

    Properties