xrpl
    Preparing search index...

    Interface LedgerRequest

    Retrieve information about the public ledger. Expects a response in the form of a LedgerResponse.

    const ledger: LedgerRequest = {
     "id": 14,
     "command": "ledger",
     "ledger_index": "validated",
     "full": false,
     "accounts": false,
     "transactions": false,
     "expand": false,
     "owner_funds": false
    }
    interface LedgerRequest {
        accounts?: boolean;
        api_version?: number;
        binary?: boolean;
        command: "ledger";
        expand?: boolean;
        full?: boolean;
        id?: string | number;
        ledger_hash?: string;
        ledger_index?: LedgerIndex;
        owner_funds?: boolean;
        queue?: boolean;
        transactions?: boolean;
        type?: LedgerEntryFilter;
        [x: string]: unknown;
    }

    Hierarchy (View Summary)

    Indexable

    • [x: string]: unknown
    Index

    Properties

    accounts? api_version? binary? command expand? full? id? ledger_hash? ledger_index? owner_funds? queue? transactions? type?

    Properties

    accounts?: boolean

    Admin required. If true, return information on accounts in the ledger. Ignored if you did not specify a ledger version. Defaults to false.

    api_version?: number

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

    binary?: boolean

    If true, and transactions and expand are both also true, return transaction information in binary format (hexadecimal string) instead of JSON format.

    command: "ledger"

    The name of the API method.

    expand?: boolean

    Provide full JSON-formatted information for transaction/account information instead of only hashes. Defaults to false. Ignored unless you request transactions, accounts, or both.

    full?: boolean

    Admin required If true, return full information on the entire ledger. Ignored if you did not specify a ledger version. Defaults to false.

    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.

    owner_funds?: boolean

    If true, include owner_funds field in the metadata of OfferCreate transactions in the response. Defaults to false. Ignored unless transactions are included and expand is true.

    queue?: boolean

    If true, and the command is requesting the current ledger, includes an array of queued transactions in the results.

    transactions?: boolean

    If true, return information on transactions in the specified ledger version. Defaults to false. Ignored if you did not specify a ledger version.

    type?: LedgerEntryFilter

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

    Settings

    Member Visibility

    On This Page

    Properties