Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface BookOffersRequest

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

Hierarchy

  • BaseRequest
    • BookOffersRequest

Index

Properties

Optional api_version

api_version: number

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

command

command: "book_offers"

Optional id

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.

Optional ledger_hash

ledger_hash: string

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

Optional ledger_index

ledger_index: LedgerIndex

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

Optional limit

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.

Optional taker

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

taker_gets: TakerAmount

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

taker_pays: TakerAmount

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.

Generated using TypeDoc