Interface LedgerDataResponse

The response expected from a LedgerDataRequest.

interface LedgerDataResponse {
    api_version?: number;
    forwarded?: boolean;
    id: string | number;
    result: {
        ledger_hash: string;
        ledger_index: number;
        marker?: unknown;
        state: LedgerDataLedgerState[];
        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_hash: string;
    ledger_index: number;
    marker?: unknown;
    state: LedgerDataLedgerState[];
    validated?: boolean;
}

Type declaration

  • ledger_hash: string

    Unique identifying hash of this ledger version.

  • ledger_index: number

    The ledger index of this ledger version.

  • Optionalmarker?: unknown

    Server-defined value indicating the response is paginated. Pass this to the next call to resume where this call left off.

  • state: LedgerDataLedgerState[]

    Array of JSON objects containing data from the ledger's state tree, as defined below.

  • Optionalvalidated?: boolean

Optionalstatus

status?: string

type

type: string

Optionalwarning

warning?: "load"

Optionalwarnings

warnings?: ResponseWarning[]

Settings

Member Visibility

On This Page

Properties