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

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

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "getTransactionsParameters",
  "description": "Parameters for getTransactions",
  "type": "object",
  "properties": {
    "address": {
      "$ref": "address",
      "description": "The address of the account to get transactions for."
    },
    "options": {
      "description": "Options to filter the resulting transactions.",
      "properties": {
        "start": {
          "$ref": "hash256",
          "description": "If specified, start the results from this transaction. You cannot use `start` with `minLedgerVersion` or `maxLedgerVersion`. When `start` is specified, these ledger versions are determined internally."
        },
        "limit": {
          "type": "integer",
          "minimum": 1,
          "description": "If specified, return at most this many transactions."
        },
        "minLedgerVersion": {
          "$ref": "ledgerVersion",
          "description": "Return only transactions in this ledger version or higher."
        },
        "maxLedgerVersion": {
          "$ref": "ledgerVersion",
          "description": "Return only transactions in this ledger version or lower."
        },
        "earliestFirst": {
          "type": "boolean",
          "description": "If true, sort transactions so that the earliest ones come first. By default, the newest transactions come first."
        },
        "excludeFailures": {
          "type": "boolean",
          "description": "If true, the result omits transactions that did not succeed."
        },
        "initiated": {
          "type": "boolean",
          "description": "If true, return only transactions initiated by the account specified by `address`. If false, return only transactions not initiated by the account specified by `address`."
        },
        "counterparty": {
          "$ref": "address",
          "description": "If provided, only return transactions with this account as a counterparty to the transaction."
        },
        "types": {
          "type": "array",
          "items": {"$ref": "transactionType"},
          "description": "Only return transactions of the specified [Transaction Types](#transaction-types)."
        },
        "includeRawTransactions": {
          "description": "Include raw transaction data. For advanced users; exercise caution when interpreting this data. "
        },
        "binary": {
          "type": "boolean",
          "description": "If true, return transactions in binary format rather than JSON."
        }
      },
      "additionalProperties": false,
      "not": {
        "anyOf": [
          {"required": ["start", "minLedgerVersion"]},
          {"required": ["start", "maxLedgerVersion"]}
        ]
      }
    }
  },
  "additionalProperties": false,
  "required": ["address"]
}