Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface BookOffersResponse

Expected response from a BookOffersResponse.

Hierarchy

  • BaseResponse
    • BookOffersResponse

Index

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[] }

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.

status

status: string

type

type: string

Optional warning

warning: "load"

Optional warnings

warnings: Warning[]

Generated using TypeDoc