Class BookOffersRequest
The book_offers method retrieves a list of offers, also known as the order.
Book, between two currencies.
Returns an BookOffers.
Inherited Members
Namespace: Xrpl.Models.Methods
Assembly: Xrpl.dll
Syntax
public class BookOffersRequest : BaseLedgerRequest
Constructors
| Edit this page View SourceBookOffersRequest()
Declaration
public BookOffersRequest()
Properties
| Edit this page View SourceDomain
The permissioned domain whose book to read, as its 64-character ledger index; omitted for the open book.
Declaration
[JsonPropertyName("domain")]
public string Domain { get; set; }
Property Value
| Type | Description |
|---|---|
| string |
Limit
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.
Declaration
[JsonPropertyName("limit")]
public uint? Limit { get; set; }
Property Value
| Type | Description |
|---|---|
| uint? |
Taker
The Address of an account to use as a perspective.
Unfunded offers placed by this account are always included in the response.
Declaration
[JsonPropertyName("taker")]
public string Taker { get; set; }
Property Value
| Type | Description |
|---|---|
| string |
TakerGets
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, or with mpt_issuance_id alone for an MPT.
Declaration
[JsonPropertyName("taker_gets")]
public TakerAmount TakerGets { get; set; }
Property Value
| Type | Description |
|---|---|
| TakerAmount |
TakerPays
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, or with mpt_issuance_id alone for an MPT.
Declaration
[JsonPropertyName("taker_pays")]
public TakerAmount TakerPays { get; set; }
Property Value
| Type | Description |
|---|---|
| TakerAmount |
Methods
| Edit this page View SourceValidate()
Checks the request as rippled's book_offers handler does, in the same order, so a
request the node would refuse is refused before it is sent. BookOffers(BookOffersRequest, CancellationToken)
calls it.
Declaration
public void Validate()
Exceptions
| Type | Condition |
|---|---|
| ValidationException | A side is missing, names an MPT together with a currency or an issuer, carries a currency, issuer or MPT issuance ID the node cannot parse, gives XRP an issuer or an issued currency none; the taker is not an account or the domain not a 64-character hex ID; or both sides name the same asset. The message names the field and the rippled error code. |