• Reference
Show / Hide Table of Contents
  • Xrpl.AddressCodec
    • AddressCodecException
    • B58
    • B58.Decoded
    • B58.Version
    • B58.Versions
    • EncodingFormatException
    • KeypairException
    • Utils
    • XrplAddressCodec
    • XrplAddressCodec.CodecAccountID
    • XrplAddressCodec.CodecAddress
    • XrplCodec
    • XrplCodec.DecodedSeed
  • Xrpl.BinaryCodec
    • BinaryCodecException
    • ExtenstionHelpers
    • ExtenstionHelpers.NumFunc
    • ISerializedType
    • StExtensions
    • XrplBinaryCodec
  • Xrpl.BinaryCodec.Binary
    • BinaryParser
    • BinarySerializer
    • BufferParser
    • BytesList
    • IBytesSink
    • StreamParser
  • Xrpl.BinaryCodec.Enums
    • AccountIdField
    • AmountField
    • BlobField
    • EngineResultField
    • Enumeration<T>
    • EnumItem
    • Field
    • FieldType
    • FromJson
    • FromParser
    • Hash128Field
    • Hash160Field
    • Hash256Field
    • LedgerEntryTypeField
    • PathSetField
    • SerializedEnumeration<TEnum, TOrd>
    • SerializedEnumItem<TOrd>
    • StArrayField
    • StObjectField
    • TransactionTypeField
    • Uint16Field
    • Uint32Field
    • Uint64Field
    • Uint8Field
    • Vector256Field
  • Xrpl.BinaryCodec.Hashing
    • HashPrefix
    • Sha512
  • Xrpl.BinaryCodec.Ledger
    • LedgerHeader
  • Xrpl.BinaryCodec.ShaMapTree
    • AccountState
    • ILeafWalker
    • IShaMapItem<T>
    • ITreeWalker
    • LedgerEntry
    • LedgerEntryReader
    • OnLeaf
    • PathToIndex
    • ShaMap
    • ShaMapDiff
    • ShaMapInner
    • ShaMapLeaf
    • ShaMapNode
    • TransactionResult
    • TransactionResultReader
    • TransactionTree
    • TreeWalker
  • Xrpl.BinaryCodec.Transactions
    • TxFormat
    • TxFormat.Requirement
    • TxFormatValidationException
  • Xrpl.BinaryCodec.Types
    • AccountId
    • Amount
    • AmountValue
    • Blob
    • Currency
    • EngineResult
    • EngineResult.EngineResultValues
    • Hash
    • Hash128
    • Hash160
    • Hash256
    • InvalidAmountValueException
    • InvalidJsonException
    • IouValue
    • Issue
    • LedgerEntryType
    • LedgerEntryType.Enumeration
    • Path
    • PathHop
    • PathSet
    • PrecisionException
    • StArray
    • StObject
    • StReader
    • TransactionType
    • TransactionType.Enumeration
    • Uint<T>
    • Uint16
    • Uint32
    • Uint64
    • Uint8
    • Vector256
  • Xrpl.BinaryCodec.Util
    • B16
    • Bits
    • ChannelUtils
  • Xrpl.Client
    • connection
    • connection.ConnectionOptions
    • connection.Trace
    • IXrplClient
    • OnConsensusStreamResponse
    • OnErrorResponse
    • OnLedgerStreamResponse
    • OnPathFindStream
    • OnPeerStatusStreamResponse
    • OnRippleResponse
    • OnTransactionStreamResponse
    • OnValidationsStreamResponse
    • XrplClient
  • Xrpl.Client.Exceptions
    • ConnectionError
    • DisconnectedError
    • NotConnectedError
    • NotFoundError
    • ResponseFormatError
    • RippledError
    • RippledNotInitializedError
    • RippleException
    • TimeoutError
    • UnexpectedError
    • ValidationException
    • XrplError
    • XRPLFaucetError
  • Xrpl.Client.Extensions
    • EmumExtensions
    • EnumerableExtensions
    • ExtensionHelpers
  • Xrpl.Client.Json.Converters
    • CurrencyConverter
    • GenericStringConverter<T>
    • LedgerBinaryConverter
    • LedgerIndexConverter
    • LOConverter
    • MetaBinaryConverter
    • RippleDateTimeConverter
    • StringOrArrayConverter
    • TransactionConverter
    • TransactionOrHashConverter
  • Xrpl.Keypairs
    • IXrplKeyPair
    • KeyPairExtensions
    • rKeypair
    • XrplKeypairs
  • Xrpl.Keypairs.Ed25519
    • EdKeyPair
  • Xrpl.Keypairs.K256
    • EcdsaSignature
    • K256KeyGenerator
    • K256KeyPair
    • Secp256K1
  • Xrpl.Keypairs.Utils
    • Sha512
  • Xrpl.Models
    • LedgerEntryType
    • StreamType
    • TransactionType
  • Xrpl.Models.Common
    • Common
    • Common.IssuedCurrency
    • Common.IssuedCurrencyAmount
    • Common.XRP
    • Currency
    • LedgerIndex
  • Xrpl.Models.Ledger
    • AccountRootFlags
    • BaseLedgerEntity
    • BaseLedgerEntry
    • EnableAmendmentFlags
    • HashOrTransaction
    • LedgerBinaryEntity
    • LedgerDataBinaryOrJson
    • LedgerEntity
    • LedgerIndexType
    • LOAccountRoot
    • LOAmendments
    • LOBaseLedger
    • LOCheck
    • LODepositPreauth
    • LODirectoryNode
    • LOEscrow
    • LOFeeSettings
    • LOLedger
    • LOLedgerCurrentIndex
    • LOLedgerData
    • LOLedgerEntry
    • LOLedgerHashes
    • LOOffer
    • LOPayChannel
    • LORippleState
    • LOSignerList
    • LOTicket
    • Majority
    • QueuedTransaction
    • RippleStateFlags
    • SignerEntry
  • Xrpl.Models.Methods
    • AccountChannels
    • AccountChannelsRequest
    • AccountCurrencies
    • AccountCurrenciesRequest
    • AccountInfo
    • AccountInfoRequest
    • AccountingStateInfo
    • AccountingStateSummary
    • AccountLines
    • AccountLinesRequest
    • AccountNFTs
    • AccountNFTsRequest
    • AccountObjects
    • AccountObjectsRequest
    • AccountOffers
    • AccountOffersRequest
    • AccountTransaction
    • AccountTransactions
    • AccountTransactionsRequest
    • BaseLedgerRequest
    • BookCurrency
    • BookOffersRequest
    • Channel
    • ChannelAuthorizeRequest
    • ChannelVerifyRequest
    • Drops
    • Fee
    • FeeRequest
    • GatewayBalances
    • GatewayBalancesRequest
    • Info
    • JobType
    • LastClose
    • LedgerClosedRequest
    • LedgerCurrentRequest
    • LedgerDataRequest
    • LedgerEntryRequest
    • LedgerEntryRequestType
    • LedgerRequest
    • Levels
    • Load
    • NFT
    • NFTBuyOffers
    • NFTBuyOffersRequest
    • NFTOffer
    • NFTSellOffers
    • NFTSellOffersRequest
    • NoRippleCheck
    • NoRippleCheckRequest
    • Offer
    • Path
    • PingRequest
    • QueueData
    • RandomRequest
    • RippleRequest
    • RippleState
    • RoleType
    • ServerInfo
    • ServerInfoRequest
    • ServerState
    • SubmitRequest
    • SubscribeBase
    • SubscribeBook
    • SubscribeRequest
    • TakerAmount
    • TransactionSummary
    • TrustLine
    • TxRequest
    • UnsubscribeRequest
    • ValidatedLedger
  • Xrpl.Models.Subscriptions
    • AlternativePath
    • BaseResponse
    • BaseStreamResponseResult
    • ConsensusStreamResponseResult
    • ErrorResponse
    • LedgerStreamResponseResult
    • OrderBookStreamResponseResult
    • PathFindStreamResult
    • PeerStatusStreamResponseResult
    • ResponseStreamType
    • RippleResponseWarning
    • TransactionStreamResponseResult
    • ValidationsStreamResponseResult
    • WarningDetails
  • Xrpl.Models.Transaction
    • AccountDelete
    • AccountDeleteResponse
    • AccountSet
    • AccountSetResponse
    • AccountSetTfFlags
    • AffectedNode
    • BaseTransactionResponse
    • BinaryTransaction
    • BinaryTransactionResponse
    • BookOffers
    • CheckCancel
    • CheckCancelResponse
    • CheckCash
    • CheckCashResponse
    • CheckCreate
    • CheckCreateResponse
    • Common
    • DepositPreauth
    • DepositPreauthResponse
    • EscrowCancel
    • EscrowCancelResponse
    • EscrowCreate
    • EscrowCreateResponse
    • EscrowFinish
    • EscrowFinishResponse
    • IAccountDelete
    • IAccountSet
    • IBaseTransactionResponse
    • ICheckCancel
    • ICheckCash
    • ICheckCreate
    • IDepositPreauth
    • IEscrowCancel
    • IEscrowCreate
    • IEscrowFinish
    • INFTokenAcceptOffer
    • INFTokenBurn
    • INFTokenCancelOffer
    • INFTokenCreateOffer
    • INFTokenMint
    • IOfferCancel
    • IOfferCreate
    • IPayment
    • IPaymentChannelClaim
    • IPaymentChannelCreate
    • IPaymentChannelFund
    • ISetRegularKey
    • ISignerListSet
    • ITicketCreate
    • ITransactionCommon
    • ITransactionResponseCommon
    • ITrustSet
    • Memo
    • MemoWrapper
    • Meta
    • NFTokenAcceptOffer
    • NFTokenAcceptOfferResponse
    • NFTokenBurn
    • NFTokenBurnResponse
    • NFTokenCancelOffer
    • NFTokenCancelOfferResponse
    • NFTokenCreateOffer
    • NFTokenCreateOfferFlags
    • NFTokenCreateOfferResponse
    • NFTokenMint
    • NFTokenMintFlags
    • NFTokenMintResponse
    • NodeInfo
    • Offer
    • OfferCancel
    • OfferCancelResponse
    • OfferCreate
    • OfferCreateFlags
    • OfferCreateResponse
    • OfferFlags
    • Payment
    • PaymentChannelClaim
    • PaymentChannelClaimFlags
    • PaymentChannelClaimResponse
    • PaymentChannelCreate
    • PaymentChannelCreateResponse
    • PaymentChannelFund
    • PaymentChannelFundResponse
    • PaymentFlags
    • PaymentResponse
    • SetRegularKey
    • SetRegularKeyResponse
    • Signer
    • SignerListSet
    • SignerListSetResponse
    • Submit
    • TicketCreate
    • TicketCreateResponse
    • TransactionCommon
    • TransactionResponseCommon
    • TrustSet
    • TrustSetFlags
    • TrustSetResponse
  • Xrpl.Models.Utils
    • EmptyClass
    • Flags
  • Xrpl.Sugar
    • AutofillSugar
    • AutofillSugar.AddressNTag
    • BalancesSugar
    • GetFeeXrpSugar
    • GetLedgerSugar
    • SubmitSugar
  • Xrpl.Utils
    • BigIntegerExtensions
    • Derive
    • GetBalanceChanges
    • ParseNFTID
    • Quality
    • SignPaymentChannelClaim
    • StringConversion
    • TimeConversion
    • VerifyPaymentChannelClaim
    • XrpConversion
  • Xrpl.Utils.Hashes
    • Hashes
    • HashLedger
    • LedgerSpaces
    • rHashPrefix
    • Sha512Half
  • Xrpl.Utils.Hashes.ShaMap
    • InnerNode
    • LeafNode
    • Node
    • SHAMap
  • Xrpl.Wallet
    • EasyTimer
    • SignatureResult
    • Signer
    • WalletSugar
    • WalletSugar.FaucetAccount
    • WalletSugar.FaucetNetwork
    • WalletSugar.FaucetWallet
    • WalletSugar.Funded
    • XrplWallet

Class BookOffersRequest

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

Inheritance
System.Object
RippleRequest
BaseLedgerRequest
BookOffersRequest
Inherited Members
BaseLedgerRequest.LedgerHash
BaseLedgerRequest.LedgerIndex
RippleRequest.Id
RippleRequest.Command
Namespace: Xrpl.Models.Methods
Assembly: Xrpl.dll
Syntax
public class BookOffersRequest : BaseLedgerRequest

Constructors

| Improve this Doc View Source

BookOffersRequest()

Declaration
public BookOffersRequest()

Properties

| Improve this Doc View Source

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
public uint? Limit { get; set; }
Property Value
Type Description
System.Nullable<System.UInt32>
| Improve this Doc View Source

Taker

The Address of an account to use as a perspective.
Unfunded offers placed by this account are always included in the response.

Declaration
public string Taker { get; set; }
Property Value
Type Description
System.String
| Improve this Doc View Source

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.

Declaration
public TakerAmount TakerGets { get; set; }
Property Value
Type Description
TakerAmount
| Improve this Doc View Source

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.

Declaration
public TakerAmount TakerPays { get; set; }
Property Value
Type Description
TakerAmount
  • Improve this Doc
  • View Source
In This Article
Back to top Generated by DocFX