Interface BookOffersResponse

Expected response from a BookOffersRequest.

interface BookOffersResponse {
    api_version?: number;
    forwarded?: boolean;
    id: string | number;
    result: {
        ledger_current_index?: number;
        ledger_hash?: string;
        ledger_index?: number;
        offers: BookOffer[];
        validated?: boolean;
    };
    status?: string;
    type: string;
    warning?: "load";
    warnings?: ResponseWarning[];
}

Hierarchy (View Summary)

Properties

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

Properties

Optionalapi_version

api_version?: number

Optionalforwarded

forwarded?: boolean

id

id: string | number

result

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

Type declaration

  • Optionalledger_current_index?: number

    The ledger index of the current in-progress ledger version, which was used to retrieve this information.

  • Optionalledger_hash?: string

    The identifying hash of the ledger version that was used when retrieving this data, as requested.

  • Optionalledger_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.

  • Optionalvalidated?: boolean

Optionalstatus

status?: string

type

type: string

Optionalwarning

warning?: "load"

Optionalwarnings

warnings?: ResponseWarning[]

Settings

Member Visibility

On This Page

Properties