ripple-lib/dist/npm/common/schemas/input/get-ledger.json

Deprecated - consider migrating to xrpl.js: https://xrpl.org/xrpljs2-migration-guide.html

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "getLedgerParameters",
  "description": "Parameters for getLedger",
  "type": "object",
  "properties": {
    "options": {
      "description": "Options affecting what ledger and how much data to return.",
      "properties": {
        "ledgerHash": {
          "type": "string",
          "description": "Get ledger data for this historical ledger hash."
        },
        "ledgerVersion": {
          "$ref": "ledgerVersion",
          "description": "Get ledger data for this historical ledger version."
        },
        "includeAllData": {
          "type": "boolean",
          "description": "Include the details of the transactions or state information if `includeTransactions` or `includeState` is set."
        },
        "includeTransactions": {
          "type": "boolean",
          "description": "Return an array of transactions in this ledger. By default, provides the identifying hashes for each transaction. If `includeAllData` is true, include the entire transaction JSON for each transaction instead."
        },
        "includeState": {
          "type": "boolean",
          "description": "Return an array of state data in this ledger. By default, provides the identifying hashes of state data. If `includeAllData` is true, return the state data in JSON form instead. **Admin required:** This is a very large amount of data."
        }
      },
      "additionalProperties": false
    }
  },
  "additionalProperties": false
}