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

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

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "getOrderbookParameters",
  "description": "Parameters for getOrderbook",
  "type": "object",
  "properties": {
    "address": {
      "$ref": "address",
      "description": "Address of an account to use as point-of-view. (This affects which unfunded offers are returned.)"
    },
    "orderbook": {
      "$ref": "orderbook",
      "description": "The order book to get."
    },
    "options": {
      "description": "Options to determine what to return.",
      "properties": {
        "limit": {
          "type": "integer",
          "minimum": 1,
          "description": "Return at most this many orders from the order book."
        },
        "ledgerVersion": {
          "$ref": "ledgerVersion",
          "description": "Return the order book as of this historical ledger version."
        }
      },
      "additionalProperties": false
    }
  },
  "required": ["address", "orderbook"],
  "additionalProperties": false
}