For the complete documentation index, see llms.txt. This page is also available as Markdown.

account_offers

Retrieves a list of offers made by a given account that are outstanding as of a particular ledger version.

This method will use 40 Compute Units.


Reference: Here

Parameters

  • account (string, required) Look up Offers placed by this account.

  • ledger_hash (string, optional) The unique hash of the ledger version to use.

  • ledger_index (number or string, optional) The ledger index of the ledger to use, or a shortcut string such as validated, closed or current.

  • limit (number, optional) Limit the number of Offers to retrieve. Must be within the inclusive range 10 to 400. The default is 200.

  • marker (marker, optional) Value from a previous paginated response. Resume retrieving data where that response left off.

Returns

  • account (string) The account that made the offers.

  • offers (array) Array of offer objects, each with flags, seq, taker_gets, taker_pays, quality and optionally expiration.

  • ledger_current_index (number) Omitted if ledger_hash or ledger_index was provided.

  • ledger_index (number) The ledger index of the ledger version used.

  • ledger_hash (string) The identifying hash of the ledger version used.

  • marker (marker) Server-defined value indicating the response is paginated. Omitted when there are no additional pages.

Over WebSocket, send {"id":1,"command":"account_offers","account":"rMxCKbEDwqr76QuheSUMdEGf4B9xJ8m5De","ledger_index":"validated","limit":10} to wss://mainnet.xrpl.validationcloud.io/v1/<YOUR_API_KEY_HERE>.

Last updated

Was this helpful?