Options
All
  • Public
  • Public/Protected
  • All
Menu

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.

example
const ledgerData: LedgerDataRequest = {
"id": 2,
"ledger_hash": "842B57C1CC0613299A686D3E9F310EC0422C84D3911E5056389AA7E5808A93C8",
"command": "ledger_data",
"limit": 5,
"binary": true
}

Hierarchy

  • BaseRequest
    • LedgerDataRequest

Index

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"
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 to choose a ledger automatically.

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.

Generated using TypeDoc