JsonRpcResponseBody

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/blockvectra/json-schema/blockvectra-json-rpc-response-body-schema.json",
  "title": "JsonRpcResponseBody",
  "x-generated": "2026-11-02",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/json-rpc.yaml#/components/schemas/JsonRpcResponseBody",
  "oneOf": [
    {
      "$ref": "#/$defs/JsonRpcResponse"
    },
    {
      "$ref": "#/$defs/JsonRpcBatchResponse"
    }
  ],
  "$defs": {
    "JsonRpcBatchResponse": {
      "type": "array",
      "description": "In request order, one element per call that has an `id`; notifications take no slot.",
      "items": {
        "$ref": "#/$defs/JsonRpcResponse"
      }
    },
    "JsonRpcErrorObject": {
      "type": "object",
      "required": [
        "code",
        "message"
      ],
      "properties": {
        "code": {
          "type": "integer",
          "description": "Error code, see Section 4."
        },
        "message": {
          "type": "string"
        },
        "data": {
          "description": "Additional data. service errors carry `reason`, `docs_url` and `retryable` (and optionally extension fields such as `max` or `topup_url`, see Section 4). Additional data returned by the node (such as revert data) is passed through unchanged.",
          "properties": {
            "reason": {
              "type": "string",
              "description": "Stable snake_case cause code; see the reasons table in Section 4 for the possible values."
            },
            "docs_url": {
              "type": "string",
              "description": "`<docs base>/errors/#<reason>`, explaining the cause and the fix."
            },
            "retryable": {
              "type": "boolean",
              "description": "Whether sending the identical request again later can succeed."
            },
            "topup_url": {
              "type": "string",
              "description": "Only on `insufficient balance` (-32020): the console billing page."
            },
            "deposit_address_url": {
              "type": "string",
              "format": "uri",
              "minLength": 1,
              "description": "Optional on insufficient-balance 402: the full HTTPS deposit address endpoint, exactly as configured. Absent when not configured; never empty or null. the service only points at this URL and does not serve top-up paths."
            },
            "balance_units": {
              "type": "integer",
              "description": "Only on `insufficient balance` (-32020) when the balance is known: the account's remaining balance units, negative when overdrawn. Absent for an account that was never funded."
            },
            "balance_cu": {
              "type": "integer",
              "description": "Only on `insufficient balance` (-32020) when the balance is known: `balance_units` in CU at the current price (`balance_units * denominator / numerator`, truncated toward zero)."
            }
          }
        }
      }
    },
    "JsonRpcErrorResponse": {
      "type": "object",
      "required": [
        "jsonrpc",
        "id",
        "error"
      ],
      "properties": {
        "jsonrpc": {
          "type": "string",
          "const": "2.0"
        },
        "id": {
          "$ref": "#/$defs/JsonRpcId"
        },
        "error": {
          "$ref": "#/$defs/JsonRpcErrorObject"
        }
      }
    },
    "JsonRpcId": {
      "description": "Call id. A string, a number or `null` is recommended. A missing `id` member marks a notification; `\"id\": null` is not a\nnotification. The `id` in a response is always identical to the `id` in the request.\n",
      "type": [
        "string",
        "number",
        "null"
      ]
    },
    "JsonRpcResponse": {
      "oneOf": [
        {
          "$ref": "#/$defs/JsonRpcSuccessResponse"
        },
        {
          "$ref": "#/$defs/JsonRpcErrorResponse"
        }
      ]
    },
    "JsonRpcSuccessResponse": {
      "type": "object",
      "required": [
        "jsonrpc",
        "id",
        "result"
      ],
      "properties": {
        "jsonrpc": {
          "type": "string",
          "const": "2.0"
        },
        "id": {
          "$ref": "#/$defs/JsonRpcId"
        },
        "result": {
          "description": "The result given by the node. It can be any JSON value, including `null`."
        }
      }
    }
  }
}