ripple-lib/dist/npm/common/schemas/output/orderbook-orders.json

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

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "orderbookOrders",
  "type": "array",
  "items": {
    "description": "An order in the order book.",
    "type": "object",
    "properties": {
      "specification": {
        "$ref": "order",
        "description": "An order specification that would create an order equivalent to the current state of this order."
      },
      "properties": {
        "description": "Properties of the order not in the specification.",
        "type": "object",
        "properties": {
          "maker": {
            "$ref": "address",
            "description": "The address of the account that submitted the order."
          },
          "sequence": {
            "$ref": "sequence",
            "description": "The account sequence number of the transaction that created this order."
          },
          "makerExchangeRate": {
            "$ref": "value",
            "description": "The exchange rate from the point of view of the account that submitted the order (also known as \"quality\")."
          }
        },
        "required": ["maker", "sequence", "makerExchangeRate"],
        "addtionalProperties": false
      },
      "state": {
        "description": "The state of the order.",
        "type": "object",
        "properties": {
          "fundedAmount": {
            "$ref": "amount",
            "description": "How much of the amount the maker would have to pay that the maker currently holds."
          },
          "priceOfFundedAmount": {
            "$ref": "amount",
            "description": "How much the `fundedAmount` would convert to through the exchange rate of this order."
          }
        },
        "required": ["fundedAmount", "priceOfFundedAmount"],
        "additionalProperties": false
      },
      "data": {
        "description": "The raw order data. This may include `owner_funds`, `Flags`, and other fields.",
        "type": "object",
        "additionalProperties": true
      }
    },
    "required": ["specification", "properties", "data"],
    "additionalProperties": false
  }
}