Interface BookOffersResponse

Expected response from a BookOffersRequest.

Hierarchy

BaseResponse
- BookOffersResponse

Index

Properties

api_version? forwarded? id result status? type warning? warnings?

Properties

`Optional` api_version

api_version?: number

`Optional` forwarded

forwarded?: boolean

id

id: string | number

result

result: {
    ledger_current_index?: number;
    ledger_hash?: string;
    ledger_index?: number;
    offers: BookOffer[];
    validated?: boolean;
}

Type declaration

Optional ledger_current_index?: number

The ledger index of the current in-progress ledger version, which was used to retrieve this information.
Optional ledger_hash?: string

The identifying hash of the ledger version that was used when retrieving this data, as requested.
Optional ledger_index?: number

The ledger index of the ledger version that was used when retrieving this data, as requested.
offers: BookOffer[]

Array of offer objects, each of which has the fields of an Offer object.
Optional validated?: boolean

`Optional` status

status?: string

type

type: string

`Optional` warning

warning?: "load"

`Optional` warnings

warnings?: ResponseWarning[]

Generated using TypeDoc