# BookOffersRequest | xrpl
Documentation for xrpl

# Interface BookOffersRequest

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

#### Hierarchy

- BaseRequest
- LookupByLedgerRequest
  - BookOffersRequest

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

#####
Index

### Properties

api_version?
command
id?
ledger_hash?
ledger_index?
limit?
taker?
taker_gets
taker_pays

## Properties

### `Optional` api_version

api_version?: number

The API version to use. If omitted, use version 1.

Inherited from BaseRequest.api_version

- Defined in packages/xrpl/src/models/methods/baseMethod.ts:16

### command

command: "book_offers"

The name of the API method.

Overrides BaseRequest.command

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

### `Optional` id

id?: string | number

A unique value to identify this request. The response to this request uses the same id field. This way, even if responses arrive out of order, you know which request prompted which response.

Inherited from BaseRequest.id

- Defined in packages/xrpl/src/models/methods/baseMethod.ts:12

### `Optional` ledger_hash

ledger_hash?: string

A 20-byte hex string for the ledger version to use.

Inherited from LookupByLedgerRequest.ledger_hash

- Defined in packages/xrpl/src/models/methods/baseMethod.ts:21

### `Optional` ledger_index

ledger_index?: LedgerIndex

The ledger index of the ledger to use, or a shortcut string.

Inherited from LookupByLedgerRequest.ledger_index

- Defined in packages/xrpl/src/models/methods/baseMethod.ts:23

### `Optional` limit

limit?: number

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.

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

### `Optional` taker

taker?: string

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

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

### taker_gets

taker_gets: BookOfferCurrency

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.

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

### taker_pays

taker_pays: BookOfferCurrency

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.

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

Generated using TypeDoc