Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface BookOffersResponse

Expected response from a BookOffersRequest.

Hierarchy

  • BaseResponse
    • BookOffersResponse

Index

Properties

api_version?: number
forwarded?: boolean
id: string | number
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
status?: string
type: string
warning?: "load"
warnings?: Warning[]

Generated using TypeDoc