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

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

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "getAccountObjectsOptions",
  "description": "Request options for getAccountObjects",
  "type": "object",
  "properties": {
    "address": {
      "$ref": "address",
      "description": "The address of the account to get the account objects of."
    },
    "options": {
      "description": "Options that affect what to return.",
      "properties": {
        "type": {
          "type": "string",
          "enum": [
            "check",
            "escrow",
            "offer",
            "payment_channel",
            "signer_list",
            "state"
          ],
          "description":
            "(Optional) Filter results to include only this type of ledger object. The valid types are: `check`, `escrow`, `offer`, `payment_channel`, `signer_list`, and `state` (trust line)."
        },
        "ledgerHash": {
          "type": "string",
          "description":
            "(Optional) A 20-byte hex string for the ledger version to use."
        },
        "ledgerIndex": {
          "oneOf": [
            {
              "$ref": "ledgerVersion"
            },
            {
              "type": "string"
            }
          ],
          "description":
            "(Optional) The sequence number of the ledger to use, or a shortcut string to choose a ledger automatically."
        },
        "limit": {
          "type": "integer",
          "minimum": 1,
          "description":
            "(Optional) The maximum number of objects to include in the results."
        }
      },
      "additionalProperties": false
    }
  },
  "required": ["address"],
  "additionalProperties": false
}