# BookOffer | xrpl
Documentation for xrpl

# Interface BookOffer

#### Hierarchy

- Offer
  - BookOffer

- Defined in packages/xrpl/src/models/methods/bookOffers.ts:51

#####
Index

### Properties

Account
BookDirectory
BookNode
Expiration?
Flags
LedgerEntryType
OwnerNode
PreviousTxnID
PreviousTxnLgrSeq
Sequence
TakerGets
TakerPays
index
owner_funds?
quality?
taker_gets_funded?
taker_pays_funded?

## Properties

### Account

Account: string

The address of the account that placed this Offer.

Inherited from Offer.Account

- Defined in packages/xrpl/src/models/ledger/Offer.ts:10

### BookDirectory

BookDirectory: string

The ID of the Offer Directory that links to this Offer.

Inherited from Offer.BookDirectory

- Defined in packages/xrpl/src/models/ledger/Offer.ts:24

### BookNode

BookNode: string

A hint indicating which page of the Offer Directory links to this object, in case the directory consists of multiple pages.

Inherited from Offer.BookNode

- Defined in packages/xrpl/src/models/ledger/Offer.ts:29

### `Optional` Expiration

Expiration?: number

The time this Offer expires, in seconds since the Ripple Epoch.

Inherited from Offer.Expiration

- Defined in packages/xrpl/src/models/ledger/Offer.ts:46

### Flags

Flags: number

A bit-map of boolean flags enabled for this Offer.

Inherited from Offer.Flags

- Defined in packages/xrpl/src/models/ledger/Offer.ts:8

### LedgerEntryType

LedgerEntryType: "Offer"

Inherited from Offer.LedgerEntryType

- Defined in packages/xrpl/src/models/ledger/Offer.ts:6

### OwnerNode

OwnerNode: string

A hint indicating which page of the Owner Directory links to this object, in case the directory consists of multiple pages.

Inherited from Offer.OwnerNode

- Defined in packages/xrpl/src/models/ledger/Offer.ts:34

### PreviousTxnID

PreviousTxnID: string

The identifying hash of the transaction that most recently modified this object.

Inherited from Offer.PreviousTxnID

- Defined in packages/xrpl/src/models/ledger/Offer.ts:39

### PreviousTxnLgrSeq

PreviousTxnLgrSeq: number

The index of the ledger that contains the transaction that most recently modified this object.

Inherited from Offer.PreviousTxnLgrSeq

- Defined in packages/xrpl/src/models/ledger/Offer.ts:44

### Sequence

Sequence: number

The Sequence value of the OfferCreate transaction that created this Offer object. Used in combination with the Account to identify this Offer.

Inherited from Offer.Sequence

- Defined in packages/xrpl/src/models/ledger/Offer.ts:15

### TakerGets

TakerGets: Amount

The remaining amount and type of currency being provided by the Offer creator.

Inherited from Offer.TakerGets

- Defined in packages/xrpl/src/models/ledger/Offer.ts:22

### TakerPays

TakerPays: Amount

The remaining amount and type of currency requested by the Offer creator.

Inherited from Offer.TakerPays

- Defined in packages/xrpl/src/models/ledger/Offer.ts:17

### index

index: string

Inherited from Offer.index

- Defined in packages/xrpl/src/models/ledger/BaseLedgerEntry.ts:2

### `Optional` owner_funds

owner_funds?: string

Amount of the TakerGets currency the side placing the offer has available to be traded. (XRP is represented as drops; any other currency is represented as a decimal value.) If a trader has multiple offers in the same book, only the highest-ranked offer includes this field.

- Defined in packages/xrpl/src/models/methods/bookOffers.ts:58

### `Optional` quality

quality?: string

The exchange rate, as the ratio taker_pays divided by taker_gets. For fairness, offers that have the same quality are automatically taken first-in, first-out.

- Defined in packages/xrpl/src/models/methods/bookOffers.ts:74

### `Optional` taker_gets_funded

taker_gets_funded?: Amount

The maximum amount of currency that the taker can get, given the funding status of the offer.

- Defined in packages/xrpl/src/models/methods/bookOffers.ts:63

### `Optional` taker_pays_funded

taker_pays_funded?: Amount

The maximum amount of currency that the taker would pay, given the funding status of the offer.

- Defined in packages/xrpl/src/models/methods/bookOffers.ts:68

Generated using TypeDoc