Optional api_The API version to use. If omitted, use version 1.
The name of the API method.
Optional idA 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_A 20-byte hex string for the ledger version to use.
Optional ledger_The ledger index of the ledger to use, or a shortcut string.
Optional limitIf 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 takerThe Address of an account to use as a perspective. Unfunded offers placed by this account are always included in the response.
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.
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
The book_offers method retrieves a list of offers, also known as the order. Book, between two currencies. Returns an BookOffersResponse.