Skip to content

iou.listOffers()

[Source]

List all open offers in the market for this IOU (both sides), tagged buy/sell relative to it.

Note

Unlike account.listOffers — which lists a single account's own resting offers — iou.listOffers reads the whole order book for the IOU across all accounts.

Signature

iou.listOffers(
  params: IOUListOffersParams,
): Promise<ListOffersResult>

Parameters

ParameterTypeRequiredDescription
tickerstringYesThe IOU currency code to anchor the book on.
issuerstringYesThe IOU issuer's r-address.

Returns

Resolves to a ListOffersResult:

FieldTypeDescription
datareadonly OfferSummary[]The shaped open offers, tagged buy/sell relative to the IOU. See account.listOffers for OfferSummary.

Underlying XRPL request

Read-only — no signer is required and nothing is submitted. Queries both sides of the order book with book_offers.

Example

const { data } = await client.iou.listOffers({
  ticker: 'USD',
  issuer: 'rIssuer...',
})