xrpl
    Preparing search index...

    Interface LedgerDataRequest

    The ledger_data method retrieves contents of the specified ledger. You can iterate through several calls to retrieve the entire contents of a single ledger version.

    const ledgerData: LedgerDataRequest = {
      "id": 2,
      "ledger_hash": "842B57C1CC0613299A686D3E9F310EC0422C84D3911E5056389AA7E5808A93C8",
      "command": "ledger_data",
      "limit": 5,
      "binary": true
    }
    interface LedgerDataRequest {
        api_version?: number;
        binary?: boolean;
        command: "ledger_data";
        id?: string | number;
        ledger_hash?: string;
        ledger_index?: LedgerIndex;
        limit?: number;
        marker?: unknown;
        type?: LedgerEntryFilter;
        [x: string]: unknown;
    }

    Hierarchy (View Summary)

    Indexable

    • [x: string]: unknown
    Index

    Properties

    api_version? binary? command id? ledger_hash? ledger_index? limit? marker? type?

    Properties

    api_version?: number

    The API version to use. If omitted, use version 1.

    binary?: boolean

    If set to true, return ledger objects as hashed hex strings instead of JSON.

    command: "ledger_data"

    The name of the API method.

    id?: string | number

    A unique value to identify this request. The response to this request uses the same id field. This way, even if responses arrive out of order, you know which request prompted which response.

    ledger_hash?: string

    A 20-byte hex string for the ledger version to use.

    ledger_index?: LedgerIndex

    The ledger index of the ledger to use, or a shortcut string.

    limit?: number

    Limit the number of ledger objects to retrieve. The server is not required to honor this value.

    marker?: unknown

    Value from a previous paginated response. Resume retrieving data where that response left off.

    type?: LedgerEntryFilter

    If included, filter results to include only this type of ledger object.

    Settings

    Member Visibility

    On This Page

    Properties