{ "openapi": "3.1.0", "info": { "title": "XE Testnet node API", "version": "1.0.0", "summary": "JSON HTTP API exposed by every XE node; served publicly by the London testnet node.", "description": "Every XE node exposes the same JSON HTTP API (default `http://127.0.0.1:8080`, `--api-port`/`--api-bind` to change it). This document describes the public London testnet node (network `testnet-0001`), reachable through the versioned `https://test.network/api/v1` proxy, its unversioned alias `https://test.network/api`, or directly at `https://ldn.test.network/api`.\n\n**Versioning.** URL-path versioning: the major version is the first segment after /api (currently v1); every response carries `X-API-Version`. Changes within a major are additive only; a new major keeps the previous one alive for 180 days; deprecations are signalled with `deprecated: true` here and `Deprecation` (RFC 9745) + `Sunset` (RFC 8594) headers at least 90 days ahead. Full policy: https://test.network/developers#versioning and `x-versioning` below.\n\n**Amounts are micro-units.** 1 XE = 1 XUSD = 1,000,000 micro-units; every amount, balance and weight is an integer micro-unit count.\n\n**Authentication is per-endpoint.** Most reads are open. `POST /lease/request` and the parameterless `/chat/events` firehose are operator-only (admin bearer token). Reading a specific account's chat requires an ownership proof — see the `ownershipProof` security scheme.\n\n**Rate limits** are per client IP and request class: reads 1000 per 5s, writes 50 per 5s (the node's own 200/s and 10/s with bursts of 1,000 and 50). Every response carries `RateLimit-Policy` and `RateLimit` (draft-ietf-httpapi-ratelimit-headers) plus the legacy `RateLimit-Limit`/`RateLimit-Remaining`/`RateLimit-Reset`; a 429 adds `Retry-After`. Details: https://test.network/developers#rate-limits and `x-rate-limits` below.\n\n**Errors** are always JSON. Every 4xx/5xx from the proxy is the `Error` schema (`error.code`, `error.message`, `error.hint`, `error.docs`); the node's own JSON errors pass through unchanged.\n\n**Testnet state:** XUSD is not issued, no compute providers are online and there are no open leases, so lease-scoped lookups return 404 and lease submissions cannot complete today. Send/receive/burn, the faucet (1,000 XE per account per day at https://faucet.test.network), chat, the state chain and every read endpoint work.\n\nHuman documentation: https://test.network/docs/api. Source: https://github.com/xeprotocol/xe (GPL-3.0).", "termsOfService": "https://test.network/about", "contact": { "name": "XE L1 Ltd.", "url": "https://test.network/contact", "email": "hello@xe.network" }, "license": { "name": "GNU General Public License v3.0", "identifier": "GPL-3.0-only" } }, "externalDocs": { "description": "XE Testnet documentation", "url": "https://test.network/docs" }, "servers": [ { "url": "https://test.network/api/v1", "description": "test.network proxy, versioned (v1) — pin this in integrations" }, { "url": "https://test.network/api", "description": "test.network proxy, unversioned alias of the current major version" }, { "url": "https://ldn.test.network/api", "description": "London testnet node, direct and unversioned; no RateLimit headers or JSON error wrapping" } ], "tags": [ { "name": "Accounts" }, { "name": "Blocks" }, { "name": "Leases" }, { "name": "State Chain" }, { "name": "Directory" }, { "name": "Chat" }, { "name": "Node" } ], "paths": { "/accounts": { "get": { "operationId": "listAccounts", "tags": [ "Accounts" ], "summary": "List all accounts", "description": "Returns accounts known by the node with balances and frontier hashes. Balances are micro-units (1 XE = 1 XUSD = 1,000,000 micro-units).", "parameters": [], "responses": { "200": { "description": "Every account the node knows.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccountList" } } } }, "400": { "description": "Bad request: malformed JSON, a body that fails the operation's schema, or an unsigned/invalid block. `error.code` is `bad_request`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No such route or object (unknown path, unknown account, or a lease-scoped lookup while the testnet has no leases). `error.code` is `not_found`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded for the request class. Back off for Retry-After seconds; RateLimit reports the window. Policies: read 1000/5s, write 50/5s. `error.code` is `rate_limited`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "The node failed while handling the request. `error.code` is `upstream_error`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "502": { "description": "The node could not be reached or answered with a non-HTTP error. `error.code` is `upstream_unavailable`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "The node is temporarily unavailable. `error.code` is `upstream_unavailable`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "504": { "description": "The node did not answer in time. `error.code` is `upstream_timeout`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "default": { "description": "Any other error. The node's own JSON error bodies pass through unchanged; every non-JSON error is wrapped in the `Error` shape by the test.network proxy, so a 4xx/5xx body is always JSON with a machine-readable `error.code`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/accounts/{address}/balance": { "get": { "operationId": "getAccountBalance", "tags": [ "Accounts" ], "summary": "Get account balance", "description": "Returns per-asset balances for one account, in micro-units.", "parameters": [ { "name": "address", "in": "path", "required": true, "description": "Account address, 64 hex characters.", "schema": { "type": "string" }, "example": "c33d2e40114d952510fc90065337363f063f36fed14e484a3b957b35eb7227a8" } ], "responses": { "200": { "description": "Balances keyed by asset code.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Balances" } } } }, "400": { "description": "Bad request: malformed JSON, a body that fails the operation's schema, or an unsigned/invalid block. `error.code` is `bad_request`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No such route or object (unknown path, unknown account, or a lease-scoped lookup while the testnet has no leases). `error.code` is `not_found`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded for the request class. Back off for Retry-After seconds; RateLimit reports the window. Policies: read 1000/5s, write 50/5s. `error.code` is `rate_limited`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "The node failed while handling the request. `error.code` is `upstream_error`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "502": { "description": "The node could not be reached or answered with a non-HTTP error. `error.code` is `upstream_unavailable`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "The node is temporarily unavailable. `error.code` is `upstream_unavailable`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "504": { "description": "The node did not answer in time. `error.code` is `upstream_timeout`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "default": { "description": "Any other error. The node's own JSON error bodies pass through unchanged; every non-JSON error is wrapped in the `Error` shape by the test.network proxy, so a 4xx/5xx body is always JSON with a machine-readable `error.code`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/accounts/{address}/chain": { "get": { "operationId": "getAccountChain", "tags": [ "Accounts" ], "summary": "Get account chain", "description": "Returns the account block chain from oldest to newest, paginated.", "parameters": [ { "name": "address", "in": "path", "required": true, "description": "Account address, 64 hex characters.", "schema": { "type": "string" }, "example": "c33d2e40114d952510fc90065337363f063f36fed14e484a3b957b35eb7227a8" }, { "name": "offset", "in": "query", "required": false, "description": "Number of entries to skip.", "schema": { "type": "integer" } }, { "name": "limit", "in": "query", "required": false, "description": "Maximum number of entries to return.", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Blocks, oldest first.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BlockList" } } } }, "400": { "description": "Bad request: malformed JSON, a body that fails the operation's schema, or an unsigned/invalid block. `error.code` is `bad_request`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No such route or object (unknown path, unknown account, or a lease-scoped lookup while the testnet has no leases). `error.code` is `not_found`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded for the request class. Back off for Retry-After seconds; RateLimit reports the window. Policies: read 1000/5s, write 50/5s. `error.code` is `rate_limited`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "The node failed while handling the request. `error.code` is `upstream_error`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "502": { "description": "The node could not be reached or answered with a non-HTTP error. `error.code` is `upstream_unavailable`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "The node is temporarily unavailable. `error.code` is `upstream_unavailable`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "504": { "description": "The node did not answer in time. `error.code` is `upstream_timeout`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "default": { "description": "Any other error. The node's own JSON error bodies pass through unchanged; every non-JSON error is wrapped in the `Error` shape by the test.network proxy, so a 4xx/5xx body is always JSON with a machine-readable `error.code`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/accounts/{address}/keyset": { "get": { "operationId": "getAccountKeyset", "tags": [ "Accounts" ], "summary": "Get multisig keyset", "description": "Returns the multisig keyset for an account when present.", "parameters": [ { "name": "address", "in": "path", "required": true, "description": "Account address, 64 hex characters.", "schema": { "type": "string" }, "example": "c33d2e40114d952510fc90065337363f063f36fed14e484a3b957b35eb7227a8" } ], "responses": { "200": { "description": "The account's current keyset.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Keyset" } } } }, "400": { "description": "Bad request: malformed JSON, a body that fails the operation's schema, or an unsigned/invalid block. `error.code` is `bad_request`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No such route or object (unknown path, unknown account, or a lease-scoped lookup while the testnet has no leases). `error.code` is `not_found`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded for the request class. Back off for Retry-After seconds; RateLimit reports the window. Policies: read 1000/5s, write 50/5s. `error.code` is `rate_limited`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "The node failed while handling the request. `error.code` is `upstream_error`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "502": { "description": "The node could not be reached or answered with a non-HTTP error. `error.code` is `upstream_unavailable`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "The node is temporarily unavailable. `error.code` is `upstream_unavailable`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "504": { "description": "The node did not answer in time. `error.code` is `upstream_timeout`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "default": { "description": "Any other error. The node's own JSON error bodies pass through unchanged; every non-JSON error is wrapped in the `Error` shape by the test.network proxy, so a 4xx/5xx body is always JSON with a machine-readable `error.code`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/accounts/{address}/reputation": { "get": { "operationId": "getAccountReputation", "tags": [ "Accounts" ], "summary": "Get account reputation", "description": "Returns the reputation aggregate for one account, built from on-chain lease activity.", "parameters": [ { "name": "address", "in": "path", "required": true, "description": "Account address, 64 hex characters.", "schema": { "type": "string" }, "example": "c33d2e40114d952510fc90065337363f063f36fed14e484a3b957b35eb7227a8" } ], "responses": { "200": { "description": "Reputation aggregate.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Reputation" } } } }, "400": { "description": "Bad request: malformed JSON, a body that fails the operation's schema, or an unsigned/invalid block. `error.code` is `bad_request`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No such route or object (unknown path, unknown account, or a lease-scoped lookup while the testnet has no leases). `error.code` is `not_found`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded for the request class. Back off for Retry-After seconds; RateLimit reports the window. Policies: read 1000/5s, write 50/5s. `error.code` is `rate_limited`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "The node failed while handling the request. `error.code` is `upstream_error`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "502": { "description": "The node could not be reached or answered with a non-HTTP error. `error.code` is `upstream_unavailable`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "The node is temporarily unavailable. `error.code` is `upstream_unavailable`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "504": { "description": "The node did not answer in time. `error.code` is `upstream_timeout`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "default": { "description": "Any other error. The node's own JSON error bodies pass through unchanged; every non-JSON error is wrapped in the `Error` shape by the test.network proxy, so a 4xx/5xx body is always JSON with a machine-readable `error.code`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/reputation": { "get": { "operationId": "listReputations", "tags": [ "Accounts" ], "summary": "All reputations", "description": "Returns reputation aggregates for every known account.", "parameters": [], "responses": { "200": { "description": "One aggregate per account.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReputationList" } } } }, "400": { "description": "Bad request: malformed JSON, a body that fails the operation's schema, or an unsigned/invalid block. `error.code` is `bad_request`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No such route or object (unknown path, unknown account, or a lease-scoped lookup while the testnet has no leases). `error.code` is `not_found`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded for the request class. Back off for Retry-After seconds; RateLimit reports the window. Policies: read 1000/5s, write 50/5s. `error.code` is `rate_limited`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "The node failed while handling the request. `error.code` is `upstream_error`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "502": { "description": "The node could not be reached or answered with a non-HTTP error. `error.code` is `upstream_unavailable`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "The node is temporarily unavailable. `error.code` is `upstream_unavailable`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "504": { "description": "The node did not answer in time. `error.code` is `upstream_timeout`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "default": { "description": "Any other error. The node's own JSON error bodies pass through unchanged; every non-JSON error is wrapped in the `Error` shape by the test.network proxy, so a 4xx/5xx body is always JSON with a machine-readable `error.code`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/blocks/send": { "post": { "operationId": "submitSendBlock", "tags": [ "Blocks" ], "summary": "Submit send block", "description": "Submits a signed send block. Requires a valid signature, hash, post-block balance, and PoW nonce; the destination must differ from the sending account.", "parameters": [], "responses": { "200": { "description": "Block accepted.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SubmitResult" } } } }, "400": { "description": "Bad request: malformed JSON, a body that fails the operation's schema, or an unsigned/invalid block. `error.code` is `bad_request`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No such route or object (unknown path, unknown account, or a lease-scoped lookup while the testnet has no leases). `error.code` is `not_found`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded for the request class. Back off for Retry-After seconds; RateLimit reports the window. Policies: read 1000/5s, write 50/5s. `error.code` is `rate_limited`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "The node failed while handling the request. `error.code` is `upstream_error`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "502": { "description": "The node could not be reached or answered with a non-HTTP error. `error.code` is `upstream_unavailable`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "The node is temporarily unavailable. `error.code` is `upstream_unavailable`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "504": { "description": "The node did not answer in time. `error.code` is `upstream_timeout`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "default": { "description": "Any other error. The node's own JSON error bodies pass through unchanged; every non-JSON error is wrapped in the `Error` shape by the test.network proxy, so a 4xx/5xx body is always JSON with a machine-readable `error.code`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SendBlock" }, "example": { "type": "send", "account": "c33d2e40114d952510fc90065337363f063f36fed14e484a3b957b35eb7227a8", "previous": "", "balance": 0, "timestamp": 0, "asset": "XE", "destination": "934dce0b20d4f36a8bd25f14bbe1666daa6e75c8f54b0c68eca2c17cc0a64a6c", "amount": 1, "signature": "", "hash": "", "pow_nonce": 0 } } } } } }, "/blocks/receive": { "post": { "operationId": "submitReceiveBlock", "tags": [ "Blocks" ], "summary": "Submit receive block", "description": "Submits a signed receive block. 'source' is the hash of the pending send block being received.", "parameters": [], "responses": { "200": { "description": "Block accepted.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SubmitResult" } } } }, "400": { "description": "Bad request: malformed JSON, a body that fails the operation's schema, or an unsigned/invalid block. `error.code` is `bad_request`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No such route or object (unknown path, unknown account, or a lease-scoped lookup while the testnet has no leases). `error.code` is `not_found`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded for the request class. Back off for Retry-After seconds; RateLimit reports the window. Policies: read 1000/5s, write 50/5s. `error.code` is `rate_limited`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "The node failed while handling the request. `error.code` is `upstream_error`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "502": { "description": "The node could not be reached or answered with a non-HTTP error. `error.code` is `upstream_unavailable`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "The node is temporarily unavailable. `error.code` is `upstream_unavailable`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "504": { "description": "The node did not answer in time. `error.code` is `upstream_timeout`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "default": { "description": "Any other error. The node's own JSON error bodies pass through unchanged; every non-JSON error is wrapped in the `Error` shape by the test.network proxy, so a 4xx/5xx body is always JSON with a machine-readable `error.code`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReceiveBlock" }, "example": { "type": "receive", "account": "c33d2e40114d952510fc90065337363f063f36fed14e484a3b957b35eb7227a8", "previous": "0", "balance": 0, "timestamp": 0, "asset": "XE", "source": "", "signature": "", "hash": "", "pow_nonce": 0 } } } } } }, "/blocks/lease": { "post": { "operationId": "submitLeaseBlock", "tags": [ "Blocks" ], "summary": "Submit lease block", "description": "Submits a signed compute lease block: XUSD escrow to a provider plus the requested vcpus/memory_mb/disk_gb/duration and an access public key.", "parameters": [], "responses": { "200": { "description": "Block accepted.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SubmitResult" } } } }, "400": { "description": "Bad request: malformed JSON, a body that fails the operation's schema, or an unsigned/invalid block. `error.code` is `bad_request`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No such route or object (unknown path, unknown account, or a lease-scoped lookup while the testnet has no leases). `error.code` is `not_found`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded for the request class. Back off for Retry-After seconds; RateLimit reports the window. Policies: read 1000/5s, write 50/5s. `error.code` is `rate_limited`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "The node failed while handling the request. `error.code` is `upstream_error`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "502": { "description": "The node could not be reached or answered with a non-HTTP error. `error.code` is `upstream_unavailable`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "The node is temporarily unavailable. `error.code` is `upstream_unavailable`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "504": { "description": "The node did not answer in time. `error.code` is `upstream_timeout`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "default": { "description": "Any other error. The node's own JSON error bodies pass through unchanged; every non-JSON error is wrapped in the `Error` shape by the test.network proxy, so a 4xx/5xx body is always JSON with a machine-readable `error.code`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LeaseBlock" }, "example": { "type": "lease", "account": "c33d2e40114d952510fc90065337363f063f36fed14e484a3b957b35eb7227a8", "previous": "", "balance": 0, "timestamp": 0, "asset": "XUSD", "destination": "", "amount": 1, "vcpus": 1, "memory_mb": 1024, "disk_gb": 10, "duration": 3600, "access_pub_key": "", "signature": "", "hash": "", "pow_nonce": 0 } } } } } }, "/blocks/lease_accept": { "post": { "operationId": "submitLeaseAcceptBlock", "tags": [ "Blocks" ], "summary": "Submit lease accept", "description": "Submits a provider lease acceptance block referencing the lease block via 'source'.", "parameters": [], "responses": { "200": { "description": "Block accepted.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SubmitResult" } } } }, "400": { "description": "Bad request: malformed JSON, a body that fails the operation's schema, or an unsigned/invalid block. `error.code` is `bad_request`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No such route or object (unknown path, unknown account, or a lease-scoped lookup while the testnet has no leases). `error.code` is `not_found`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded for the request class. Back off for Retry-After seconds; RateLimit reports the window. Policies: read 1000/5s, write 50/5s. `error.code` is `rate_limited`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "The node failed while handling the request. `error.code` is `upstream_error`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "502": { "description": "The node could not be reached or answered with a non-HTTP error. `error.code` is `upstream_unavailable`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "The node is temporarily unavailable. `error.code` is `upstream_unavailable`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "504": { "description": "The node did not answer in time. `error.code` is `upstream_timeout`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "default": { "description": "Any other error. The node's own JSON error bodies pass through unchanged; every non-JSON error is wrapped in the `Error` shape by the test.network proxy, so a 4xx/5xx body is always JSON with a machine-readable `error.code`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LeaseAcceptBlock" }, "example": { "type": "lease_accept", "account": "", "previous": "", "balance": 0, "timestamp": 0, "asset": "XUSD", "source": "", "signature": "", "hash": "", "pow_nonce": 0 } } } } } }, "/blocks/lease_settle": { "post": { "operationId": "submitLeaseSettleBlock", "tags": [ "Blocks" ], "summary": "Submit lease settle", "description": "Submits a provider lease settlement block referencing the lease block via 'source'.", "parameters": [], "responses": { "200": { "description": "Block accepted.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SubmitResult" } } } }, "400": { "description": "Bad request: malformed JSON, a body that fails the operation's schema, or an unsigned/invalid block. `error.code` is `bad_request`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No such route or object (unknown path, unknown account, or a lease-scoped lookup while the testnet has no leases). `error.code` is `not_found`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded for the request class. Back off for Retry-After seconds; RateLimit reports the window. Policies: read 1000/5s, write 50/5s. `error.code` is `rate_limited`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "The node failed while handling the request. `error.code` is `upstream_error`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "502": { "description": "The node could not be reached or answered with a non-HTTP error. `error.code` is `upstream_unavailable`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "The node is temporarily unavailable. `error.code` is `upstream_unavailable`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "504": { "description": "The node did not answer in time. `error.code` is `upstream_timeout`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "default": { "description": "Any other error. The node's own JSON error bodies pass through unchanged; every non-JSON error is wrapped in the `Error` shape by the test.network proxy, so a 4xx/5xx body is always JSON with a machine-readable `error.code`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LeaseSettleBlock" }, "example": { "type": "lease_settle", "account": "", "previous": "", "balance": 0, "timestamp": 0, "asset": "XUSD", "source": "", "signature": "", "hash": "", "pow_nonce": 0 } } } } } }, "/blocks/lease_cancel": { "post": { "operationId": "submitLeaseCancelBlock", "tags": [ "Blocks" ], "summary": "Submit lease cancel", "description": "Submits a consumer lease cancellation block. Only the consumer can cancel, and only before the lease is accepted.", "parameters": [], "responses": { "200": { "description": "Block accepted.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SubmitResult" } } } }, "400": { "description": "Bad request: malformed JSON, a body that fails the operation's schema, or an unsigned/invalid block. `error.code` is `bad_request`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No such route or object (unknown path, unknown account, or a lease-scoped lookup while the testnet has no leases). `error.code` is `not_found`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded for the request class. Back off for Retry-After seconds; RateLimit reports the window. Policies: read 1000/5s, write 50/5s. `error.code` is `rate_limited`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "The node failed while handling the request. `error.code` is `upstream_error`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "502": { "description": "The node could not be reached or answered with a non-HTTP error. `error.code` is `upstream_unavailable`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "The node is temporarily unavailable. `error.code` is `upstream_unavailable`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "504": { "description": "The node did not answer in time. `error.code` is `upstream_timeout`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "default": { "description": "Any other error. The node's own JSON error bodies pass through unchanged; every non-JSON error is wrapped in the `Error` shape by the test.network proxy, so a 4xx/5xx body is always JSON with a machine-readable `error.code`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LeaseCancelBlock" }, "example": { "type": "lease_cancel", "account": "c33d2e40114d952510fc90065337363f063f36fed14e484a3b957b35eb7227a8", "previous": "", "balance": 0, "timestamp": 0, "asset": "XUSD", "source": "", "signature": "", "hash": "", "pow_nonce": 0 } } } } } }, "/blocks/lease_force_settle": { "post": { "operationId": "submitLeaseForceSettleBlock", "tags": [ "Blocks" ], "summary": "Submit lease force settle", "description": "Submits a consumer force-settle block to recover escrow from an expired lease the provider never settled.", "parameters": [], "responses": { "200": { "description": "Block accepted.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SubmitResult" } } } }, "400": { "description": "Bad request: malformed JSON, a body that fails the operation's schema, or an unsigned/invalid block. `error.code` is `bad_request`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No such route or object (unknown path, unknown account, or a lease-scoped lookup while the testnet has no leases). `error.code` is `not_found`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded for the request class. Back off for Retry-After seconds; RateLimit reports the window. Policies: read 1000/5s, write 50/5s. `error.code` is `rate_limited`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "The node failed while handling the request. `error.code` is `upstream_error`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "502": { "description": "The node could not be reached or answered with a non-HTTP error. `error.code` is `upstream_unavailable`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "The node is temporarily unavailable. `error.code` is `upstream_unavailable`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "504": { "description": "The node did not answer in time. `error.code` is `upstream_timeout`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "default": { "description": "Any other error. The node's own JSON error bodies pass through unchanged; every non-JSON error is wrapped in the `Error` shape by the test.network proxy, so a 4xx/5xx body is always JSON with a machine-readable `error.code`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LeaseForceSettleBlock" }, "example": { "type": "lease_force_settle", "account": "c33d2e40114d952510fc90065337363f063f36fed14e484a3b957b35eb7227a8", "previous": "", "balance": 0, "timestamp": 0, "asset": "XUSD", "source": "", "signature": "", "hash": "", "pow_nonce": 0 } } } } } }, "/blocks/multisig_open": { "post": { "operationId": "submitMultisigOpenBlock", "tags": [ "Blocks" ], "summary": "Open multisig account", "description": "Submits a multisig account open block with a keyset {keys, threshold} and a signatures array in place of the single signature.", "parameters": [], "responses": { "200": { "description": "Block accepted.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SubmitResult" } } } }, "400": { "description": "Bad request: malformed JSON, a body that fails the operation's schema, or an unsigned/invalid block. `error.code` is `bad_request`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No such route or object (unknown path, unknown account, or a lease-scoped lookup while the testnet has no leases). `error.code` is `not_found`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded for the request class. Back off for Retry-After seconds; RateLimit reports the window. Policies: read 1000/5s, write 50/5s. `error.code` is `rate_limited`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "The node failed while handling the request. `error.code` is `upstream_error`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "502": { "description": "The node could not be reached or answered with a non-HTTP error. `error.code` is `upstream_unavailable`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "The node is temporarily unavailable. `error.code` is `upstream_unavailable`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "504": { "description": "The node did not answer in time. `error.code` is `upstream_timeout`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "default": { "description": "Any other error. The node's own JSON error bodies pass through unchanged; every non-JSON error is wrapped in the `Error` shape by the test.network proxy, so a 4xx/5xx body is always JSON with a machine-readable `error.code`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MultisigOpenBlock" }, "example": { "type": "multisig_open", "account": "c33d2e40114d952510fc90065337363f063f36fed14e484a3b957b35eb7227a8", "previous": "0", "balance": 0, "timestamp": 0, "asset": "XE", "keyset": { "keys": [ "c33d2e40114d952510fc90065337363f063f36fed14e484a3b957b35eb7227a8", "934dce0b20d4f36a8bd25f14bbe1666daa6e75c8f54b0c68eca2c17cc0a64a6c" ], "threshold": 2 }, "signatures": [ { "public_key": "c33d2e40114d952510fc90065337363f063f36fed14e484a3b957b35eb7227a8", "signature": "" } ], "hash": "", "pow_nonce": 0 } } } } } }, "/blocks/multisig_update": { "post": { "operationId": "submitMultisigUpdateBlock", "tags": [ "Blocks" ], "summary": "Update multisig keyset", "description": "Submits a multisig keyset update block signed by the current keyset's threshold.", "parameters": [], "responses": { "200": { "description": "Block accepted.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SubmitResult" } } } }, "400": { "description": "Bad request: malformed JSON, a body that fails the operation's schema, or an unsigned/invalid block. `error.code` is `bad_request`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No such route or object (unknown path, unknown account, or a lease-scoped lookup while the testnet has no leases). `error.code` is `not_found`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded for the request class. Back off for Retry-After seconds; RateLimit reports the window. Policies: read 1000/5s, write 50/5s. `error.code` is `rate_limited`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "The node failed while handling the request. `error.code` is `upstream_error`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "502": { "description": "The node could not be reached or answered with a non-HTTP error. `error.code` is `upstream_unavailable`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "The node is temporarily unavailable. `error.code` is `upstream_unavailable`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "504": { "description": "The node did not answer in time. `error.code` is `upstream_timeout`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "default": { "description": "Any other error. The node's own JSON error bodies pass through unchanged; every non-JSON error is wrapped in the `Error` shape by the test.network proxy, so a 4xx/5xx body is always JSON with a machine-readable `error.code`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MultisigUpdateBlock" }, "example": { "type": "multisig_update", "account": "c33d2e40114d952510fc90065337363f063f36fed14e484a3b957b35eb7227a8", "previous": "", "balance": 0, "timestamp": 0, "asset": "XE", "keyset": { "keys": [ "c33d2e40114d952510fc90065337363f063f36fed14e484a3b957b35eb7227a8", "934dce0b20d4f36a8bd25f14bbe1666daa6e75c8f54b0c68eca2c17cc0a64a6c" ], "threshold": 1 }, "signatures": [ { "public_key": "c33d2e40114d952510fc90065337363f063f36fed14e484a3b957b35eb7227a8", "signature": "" } ], "hash": "", "pow_nonce": 0 } } } } } }, "/blocks/burn": { "post": { "operationId": "submitBurnBlock", "tags": [ "Blocks" ], "summary": "Submit burn block", "description": "Submits a signed burn block, permanently destroying XE (XE only).", "parameters": [], "responses": { "200": { "description": "Block accepted.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SubmitResult" } } } }, "400": { "description": "Bad request: malformed JSON, a body that fails the operation's schema, or an unsigned/invalid block. `error.code` is `bad_request`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No such route or object (unknown path, unknown account, or a lease-scoped lookup while the testnet has no leases). `error.code` is `not_found`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded for the request class. Back off for Retry-After seconds; RateLimit reports the window. Policies: read 1000/5s, write 50/5s. `error.code` is `rate_limited`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "The node failed while handling the request. `error.code` is `upstream_error`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "502": { "description": "The node could not be reached or answered with a non-HTTP error. `error.code` is `upstream_unavailable`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "The node is temporarily unavailable. `error.code` is `upstream_unavailable`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "504": { "description": "The node did not answer in time. `error.code` is `upstream_timeout`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "default": { "description": "Any other error. The node's own JSON error bodies pass through unchanged; every non-JSON error is wrapped in the `Error` shape by the test.network proxy, so a 4xx/5xx body is always JSON with a machine-readable `error.code`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BurnBlock" }, "example": { "type": "burn", "account": "c33d2e40114d952510fc90065337363f063f36fed14e484a3b957b35eb7227a8", "previous": "", "balance": 0, "timestamp": 0, "asset": "XE", "amount": 1, "signature": "", "hash": "", "pow_nonce": 0 } } } } } }, "/blocks/mint": { "post": { "operationId": "submitMintBlock", "tags": [ "Blocks" ], "summary": "Submit mint block", "description": "Submits a signed XUSD mint block. Only accounts listed in the sys.minter state key are authorized. XUSD is not issued on this testnet today — the faucet hands out XE from a pre-funded wallet instead.", "parameters": [], "responses": { "200": { "description": "Block accepted.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SubmitResult" } } } }, "400": { "description": "Bad request: malformed JSON, a body that fails the operation's schema, or an unsigned/invalid block. `error.code` is `bad_request`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No such route or object (unknown path, unknown account, or a lease-scoped lookup while the testnet has no leases). `error.code` is `not_found`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded for the request class. Back off for Retry-After seconds; RateLimit reports the window. Policies: read 1000/5s, write 50/5s. `error.code` is `rate_limited`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "The node failed while handling the request. `error.code` is `upstream_error`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "502": { "description": "The node could not be reached or answered with a non-HTTP error. `error.code` is `upstream_unavailable`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "The node is temporarily unavailable. `error.code` is `upstream_unavailable`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "504": { "description": "The node did not answer in time. `error.code` is `upstream_timeout`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "default": { "description": "Any other error. The node's own JSON error bodies pass through unchanged; every non-JSON error is wrapped in the `Error` shape by the test.network proxy, so a 4xx/5xx body is always JSON with a machine-readable `error.code`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MintBlock" }, "example": { "type": "mint", "account": "", "previous": "", "balance": 0, "timestamp": 0, "asset": "XUSD", "amount": 1, "signature": "", "hash": "", "pow_nonce": 0 } } } } } }, "/blocks/{hash}": { "get": { "operationId": "getBlock", "tags": [ "Blocks" ], "summary": "Get block by hash", "description": "Returns a block by its hash.", "parameters": [ { "name": "hash", "in": "path", "required": true, "description": "Block hash, 64 hex characters.", "schema": { "type": "string" }, "example": "14e44dd494642a5444d0f417f53d05fb209662f9bd36777f062432930516a0ec" } ], "responses": { "200": { "description": "The block.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Block" } } } }, "400": { "description": "Bad request: malformed JSON, a body that fails the operation's schema, or an unsigned/invalid block. `error.code` is `bad_request`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No such route or object (unknown path, unknown account, or a lease-scoped lookup while the testnet has no leases). `error.code` is `not_found`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded for the request class. Back off for Retry-After seconds; RateLimit reports the window. Policies: read 1000/5s, write 50/5s. `error.code` is `rate_limited`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "The node failed while handling the request. `error.code` is `upstream_error`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "502": { "description": "The node could not be reached or answered with a non-HTTP error. `error.code` is `upstream_unavailable`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "The node is temporarily unavailable. `error.code` is `upstream_unavailable`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "504": { "description": "The node did not answer in time. `error.code` is `upstream_timeout`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "default": { "description": "Any other error. The node's own JSON error bodies pass through unchanged; every non-JSON error is wrapped in the `Error` shape by the test.network proxy, so a 4xx/5xx body is always JSON with a machine-readable `error.code`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/blocks/recent": { "get": { "operationId": "listRecentBlocks", "tags": [ "Blocks" ], "summary": "Recent blocks", "description": "Returns the newest account-chain blocks. Optional ?limit and ?since (unix nanoseconds).", "parameters": [ { "name": "limit", "in": "query", "required": false, "description": "Maximum number of blocks to return.", "schema": { "type": "integer" } }, { "name": "since", "in": "query", "required": false, "description": "Only blocks newer than this unix-nanosecond timestamp.", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Newest blocks first.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BlockList" } } } }, "400": { "description": "Bad request: malformed JSON, a body that fails the operation's schema, or an unsigned/invalid block. `error.code` is `bad_request`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No such route or object (unknown path, unknown account, or a lease-scoped lookup while the testnet has no leases). `error.code` is `not_found`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded for the request class. Back off for Retry-After seconds; RateLimit reports the window. Policies: read 1000/5s, write 50/5s. `error.code` is `rate_limited`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "The node failed while handling the request. `error.code` is `upstream_error`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "502": { "description": "The node could not be reached or answered with a non-HTTP error. `error.code` is `upstream_unavailable`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "The node is temporarily unavailable. `error.code` is `upstream_unavailable`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "504": { "description": "The node did not answer in time. `error.code` is `upstream_timeout`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "default": { "description": "Any other error. The node's own JSON error bodies pass through unchanged; every non-JSON error is wrapped in the `Error` shape by the test.network proxy, so a 4xx/5xx body is always JSON with a machine-readable `error.code`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/leases": { "get": { "operationId": "listLeases", "tags": [ "Leases" ], "summary": "List leases", "description": "Returns known compute leases. Filter with ?state=created|accepted|settled|cancelled|unfulfilled.", "parameters": [ { "name": "state", "in": "query", "required": false, "description": "Only leases in this lifecycle state.", "schema": { "type": "string", "enum": [ "created", "accepted", "settled", "cancelled", "unfulfilled" ] } } ], "responses": { "200": { "description": "Leases; [] while the testnet has none.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LeaseList" } } } }, "400": { "description": "Bad request: malformed JSON, a body that fails the operation's schema, or an unsigned/invalid block. `error.code` is `bad_request`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No such route or object (unknown path, unknown account, or a lease-scoped lookup while the testnet has no leases). `error.code` is `not_found`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded for the request class. Back off for Retry-After seconds; RateLimit reports the window. Policies: read 1000/5s, write 50/5s. `error.code` is `rate_limited`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "The node failed while handling the request. `error.code` is `upstream_error`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "502": { "description": "The node could not be reached or answered with a non-HTTP error. `error.code` is `upstream_unavailable`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "The node is temporarily unavailable. `error.code` is `upstream_unavailable`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "504": { "description": "The node did not answer in time. `error.code` is `upstream_timeout`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "default": { "description": "Any other error. The node's own JSON error bodies pass through unchanged; every non-JSON error is wrapped in the `Error` shape by the test.network proxy, so a 4xx/5xx body is always JSON with a machine-readable `error.code`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/leases/{hash}": { "get": { "operationId": "getLease", "tags": [ "Leases" ], "summary": "Get lease", "description": "Returns one lease by lease hash. Needs a real lease hash — the testnet currently has no open leases (GET /leases returns []).", "parameters": [ { "name": "hash", "in": "path", "required": true, "description": "Lease block hash.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "The lease.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Lease" } } } }, "400": { "description": "Bad request: malformed JSON, a body that fails the operation's schema, or an unsigned/invalid block. `error.code` is `bad_request`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No such route or object (unknown path, unknown account, or a lease-scoped lookup while the testnet has no leases). `error.code` is `not_found`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded for the request class. Back off for Retry-After seconds; RateLimit reports the window. Policies: read 1000/5s, write 50/5s. `error.code` is `rate_limited`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "The node failed while handling the request. `error.code` is `upstream_error`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "502": { "description": "The node could not be reached or answered with a non-HTTP error. `error.code` is `upstream_unavailable`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "The node is temporarily unavailable. `error.code` is `upstream_unavailable`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "504": { "description": "The node did not answer in time. `error.code` is `upstream_timeout`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "default": { "description": "Any other error. The node's own JSON error bodies pass through unchanged; every non-JSON error is wrapped in the `Error` shape by the test.network proxy, so a 4xx/5xx body is always JSON with a machine-readable `error.code`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/providers": { "get": { "operationId": "listProviders", "tags": [ "Leases" ], "summary": "List providers", "description": "Returns compute providers registered with the node.", "parameters": [], "responses": { "200": { "description": "Providers; [] while none are online.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProviderList" } } } }, "400": { "description": "Bad request: malformed JSON, a body that fails the operation's schema, or an unsigned/invalid block. `error.code` is `bad_request`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No such route or object (unknown path, unknown account, or a lease-scoped lookup while the testnet has no leases). `error.code` is `not_found`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded for the request class. Back off for Retry-After seconds; RateLimit reports the window. Policies: read 1000/5s, write 50/5s. `error.code` is `rate_limited`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "The node failed while handling the request. `error.code` is `upstream_error`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "502": { "description": "The node could not be reached or answered with a non-HTTP error. `error.code` is `upstream_unavailable`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "The node is temporarily unavailable. `error.code` is `upstream_unavailable`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "504": { "description": "The node did not answer in time. `error.code` is `upstream_timeout`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "default": { "description": "Any other error. The node's own JSON error bodies pass through unchanged; every non-JSON error is wrapped in the `Error` shape by the test.network proxy, so a 4xx/5xx body is always JSON with a machine-readable `error.code`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/certificate": { "get": { "operationId": "getNodeCertificate", "tags": [ "Leases" ], "summary": "Node perf certificate", "description": "Returns this node's performance certificate (provider mode only).", "parameters": [], "responses": { "200": { "description": "This node's certificate.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Certificate" } } } }, "400": { "description": "Bad request: malformed JSON, a body that fails the operation's schema, or an unsigned/invalid block. `error.code` is `bad_request`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No such route or object (unknown path, unknown account, or a lease-scoped lookup while the testnet has no leases). `error.code` is `not_found`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded for the request class. Back off for Retry-After seconds; RateLimit reports the window. Policies: read 1000/5s, write 50/5s. `error.code` is `rate_limited`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "The node failed while handling the request. `error.code` is `upstream_error`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "502": { "description": "The node could not be reached or answered with a non-HTTP error. `error.code` is `upstream_unavailable`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "The node is temporarily unavailable. `error.code` is `upstream_unavailable`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "504": { "description": "The node did not answer in time. `error.code` is `upstream_timeout`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "default": { "description": "Any other error. The node's own JSON error bodies pass through unchanged; every non-JSON error is wrapped in the `Error` shape by the test.network proxy, so a 4xx/5xx body is always JSON with a machine-readable `error.code`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/certificate/{provider}": { "get": { "operationId": "getProviderCertificate", "tags": [ "Leases" ], "summary": "Provider perf certificate", "description": "Returns the performance certificate for a specific provider address.", "parameters": [ { "name": "provider", "in": "path", "required": true, "description": "Provider account address.", "schema": { "type": "string" }, "example": "934dce0b20d4f36a8bd25f14bbe1666daa6e75c8f54b0c68eca2c17cc0a64a6c" } ], "responses": { "200": { "description": "The provider's certificate.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Certificate" } } } }, "400": { "description": "Bad request: malformed JSON, a body that fails the operation's schema, or an unsigned/invalid block. `error.code` is `bad_request`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No such route or object (unknown path, unknown account, or a lease-scoped lookup while the testnet has no leases). `error.code` is `not_found`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded for the request class. Back off for Retry-After seconds; RateLimit reports the window. Policies: read 1000/5s, write 50/5s. `error.code` is `rate_limited`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "The node failed while handling the request. `error.code` is `upstream_error`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "502": { "description": "The node could not be reached or answered with a non-HTTP error. `error.code` is `upstream_unavailable`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "The node is temporarily unavailable. `error.code` is `upstream_unavailable`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "504": { "description": "The node did not answer in time. `error.code` is `upstream_timeout`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "default": { "description": "Any other error. The node's own JSON error bodies pass through unchanged; every non-JSON error is wrapped in the `Error` shape by the test.network proxy, so a 4xx/5xx body is always JSON with a machine-readable `error.code`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/lease/request": { "post": { "operationId": "requestLease", "tags": [ "Leases" ], "summary": "Request lease", "description": "Asks the node to build, sign, and escrow a lease from its own wallet.\n\nOperator-only.\n\nOperator-only: requires Authorization: Bearer ; signs and escrows from the node operator's own wallet. Shown for reference.", "parameters": [], "responses": { "200": { "description": "The lease the node created.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Lease" } } } }, "400": { "description": "Bad request: malformed JSON, a body that fails the operation's schema, or an unsigned/invalid block. `error.code` is `bad_request`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing credentials for a gated endpoint. `error.code` is `unauthorized`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Credentials present but not sufficient (wrong admin token, failed ownership proof). `error.code` is `forbidden`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No such route or object (unknown path, unknown account, or a lease-scoped lookup while the testnet has no leases). `error.code` is `not_found`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded for the request class. Back off for Retry-After seconds; RateLimit reports the window. Policies: read 1000/5s, write 50/5s. `error.code` is `rate_limited`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "The node failed while handling the request. `error.code` is `upstream_error`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "502": { "description": "The node could not be reached or answered with a non-HTTP error. `error.code` is `upstream_unavailable`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "The node is temporarily unavailable. `error.code` is `upstream_unavailable`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "504": { "description": "The node did not answer in time. `error.code` is `upstream_timeout`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "default": { "description": "Any other error. The node's own JSON error bodies pass through unchanged; every non-JSON error is wrapped in the `Error` shape by the test.network proxy, so a 4xx/5xx body is always JSON with a machine-readable `error.code`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LeaseRequest" }, "example": { "vcpus": 1, "memory_mb": 1024, "disk_gb": 10, "duration": 3600, "access_pub_key": "c33d2e40114d952510fc90065337363f063f36fed14e484a3b957b35eb7227a8" } } } }, "security": [ { "adminToken": [] } ] } }, "/attestation/request": { "post": { "operationId": "requestAttestation", "tags": [ "Leases" ], "summary": "Request attestation", "description": "Requests a timekeeper attestation for a lease. Needs a real lease hash — the testnet currently has no open leases (GET /leases returns []).", "parameters": [], "responses": { "200": { "description": "The attestation.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Attestation" } } } }, "400": { "description": "Bad request: malformed JSON, a body that fails the operation's schema, or an unsigned/invalid block. `error.code` is `bad_request`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No such route or object (unknown path, unknown account, or a lease-scoped lookup while the testnet has no leases). `error.code` is `not_found`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded for the request class. Back off for Retry-After seconds; RateLimit reports the window. Policies: read 1000/5s, write 50/5s. `error.code` is `rate_limited`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "The node failed while handling the request. `error.code` is `upstream_error`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "502": { "description": "The node could not be reached or answered with a non-HTTP error. `error.code` is `upstream_unavailable`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "The node is temporarily unavailable. `error.code` is `upstream_unavailable`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "504": { "description": "The node did not answer in time. `error.code` is `upstream_timeout`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "default": { "description": "Any other error. The node's own JSON error bodies pass through unchanged; every non-JSON error is wrapped in the `Error` shape by the test.network proxy, so a 4xx/5xx body is always JSON with a machine-readable `error.code`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AttestationRequest" }, "example": { "lease_hash": "" } } } } } }, "/vms": { "get": { "operationId": "listVms", "tags": [ "Leases" ], "summary": "List VMs", "description": "Returns VM records known to the provider.", "parameters": [], "responses": { "200": { "description": "VM records.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VmList" } } } }, "400": { "description": "Bad request: malformed JSON, a body that fails the operation's schema, or an unsigned/invalid block. `error.code` is `bad_request`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No such route or object (unknown path, unknown account, or a lease-scoped lookup while the testnet has no leases). `error.code` is `not_found`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded for the request class. Back off for Retry-After seconds; RateLimit reports the window. Policies: read 1000/5s, write 50/5s. `error.code` is `rate_limited`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "The node failed while handling the request. `error.code` is `upstream_error`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "502": { "description": "The node could not be reached or answered with a non-HTTP error. `error.code` is `upstream_unavailable`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "The node is temporarily unavailable. `error.code` is `upstream_unavailable`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "504": { "description": "The node did not answer in time. `error.code` is `upstream_timeout`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "default": { "description": "Any other error. The node's own JSON error bodies pass through unchanged; every non-JSON error is wrapped in the `Error` shape by the test.network proxy, so a 4xx/5xx body is always JSON with a machine-readable `error.code`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/vms/{lease}": { "get": { "operationId": "getVm", "tags": [ "Leases" ], "summary": "Get VM", "description": "Returns VM details for a lease. Needs a real lease hash — the testnet currently has no open leases (GET /leases returns []).", "parameters": [ { "name": "lease", "in": "path", "required": true, "description": "Lease block hash.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "The VM record.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Vm" } } } }, "400": { "description": "Bad request: malformed JSON, a body that fails the operation's schema, or an unsigned/invalid block. `error.code` is `bad_request`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No such route or object (unknown path, unknown account, or a lease-scoped lookup while the testnet has no leases). `error.code` is `not_found`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded for the request class. Back off for Retry-After seconds; RateLimit reports the window. Policies: read 1000/5s, write 50/5s. `error.code` is `rate_limited`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "The node failed while handling the request. `error.code` is `upstream_error`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "502": { "description": "The node could not be reached or answered with a non-HTTP error. `error.code` is `upstream_unavailable`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "The node is temporarily unavailable. `error.code` is `upstream_unavailable`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "504": { "description": "The node did not answer in time. `error.code` is `upstream_timeout`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "default": { "description": "Any other error. The node's own JSON error bodies pass through unchanged; every non-JSON error is wrapped in the `Error` shape by the test.network proxy, so a 4xx/5xx body is always JSON with a machine-readable `error.code`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/tunnel/{leaseHash}/tcp": { "post": { "operationId": "openTcpTunnel", "tags": [ "Leases" ], "summary": "TCP tunnel", "description": "Opens a raw TCP tunnel into a leased VM. Takes no JSON body: authentication is an X-Signature header (ed25519 signature over the 32 decoded lease-hash bytes with the lease's access key), after which the HTTP connection is hijacked into a byte stream.\n\nNot runnable from the browser: the response is a hijacked raw TCP stream, and the required X-Signature header needs the lease access key. Use the xe CLI or curl instead. Needs a real lease hash — the testnet currently has no open leases (GET /leases returns []).", "parameters": [ { "name": "leaseHash", "in": "path", "required": true, "description": "Lease block hash.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "The connection is hijacked into a raw TCP byte stream.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/octet-stream": { "schema": { "type": "string" } } } }, "400": { "description": "Bad request: malformed JSON, a body that fails the operation's schema, or an unsigned/invalid block. `error.code` is `bad_request`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing credentials for a gated endpoint. `error.code` is `unauthorized`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Credentials present but not sufficient (wrong admin token, failed ownership proof). `error.code` is `forbidden`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No such route or object (unknown path, unknown account, or a lease-scoped lookup while the testnet has no leases). `error.code` is `not_found`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded for the request class. Back off for Retry-After seconds; RateLimit reports the window. Policies: read 1000/5s, write 50/5s. `error.code` is `rate_limited`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "The node failed while handling the request. `error.code` is `upstream_error`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "502": { "description": "The node could not be reached or answered with a non-HTTP error. `error.code` is `upstream_unavailable`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "The node is temporarily unavailable. `error.code` is `upstream_unavailable`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "504": { "description": "The node did not answer in time. `error.code` is `upstream_timeout`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "default": { "description": "Any other error. The node's own JSON error bodies pass through unchanged; every non-JSON error is wrapped in the `Error` shape by the test.network proxy, so a 4xx/5xx body is always JSON with a machine-readable `error.code`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "leaseAccessSignature": [] } ] } }, "/statechain/tip": { "get": { "operationId": "getStateChainTip", "tags": [ "State Chain" ], "summary": "State chain tip", "description": "Returns the latest state chain block.", "parameters": [], "responses": { "200": { "description": "The newest state block.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StateBlock" } } } }, "400": { "description": "Bad request: malformed JSON, a body that fails the operation's schema, or an unsigned/invalid block. `error.code` is `bad_request`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No such route or object (unknown path, unknown account, or a lease-scoped lookup while the testnet has no leases). `error.code` is `not_found`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded for the request class. Back off for Retry-After seconds; RateLimit reports the window. Policies: read 1000/5s, write 50/5s. `error.code` is `rate_limited`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "The node failed while handling the request. `error.code` is `upstream_error`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "502": { "description": "The node could not be reached or answered with a non-HTTP error. `error.code` is `upstream_unavailable`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "The node is temporarily unavailable. `error.code` is `upstream_unavailable`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "504": { "description": "The node did not answer in time. `error.code` is `upstream_timeout`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "default": { "description": "Any other error. The node's own JSON error bodies pass through unchanged; every non-JSON error is wrapped in the `Error` shape by the test.network proxy, so a 4xx/5xx body is always JSON with a machine-readable `error.code`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/statechain/blocks/{index}": { "get": { "operationId": "getStateBlock", "tags": [ "State Chain" ], "summary": "State block by index", "description": "Returns a state chain block by index.", "parameters": [ { "name": "index", "in": "path", "required": true, "description": "Zero-based block index.", "schema": { "type": "string" }, "example": "0" } ], "responses": { "200": { "description": "The state block.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StateBlock" } } } }, "400": { "description": "Bad request: malformed JSON, a body that fails the operation's schema, or an unsigned/invalid block. `error.code` is `bad_request`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No such route or object (unknown path, unknown account, or a lease-scoped lookup while the testnet has no leases). `error.code` is `not_found`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded for the request class. Back off for Retry-After seconds; RateLimit reports the window. Policies: read 1000/5s, write 50/5s. `error.code` is `rate_limited`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "The node failed while handling the request. `error.code` is `upstream_error`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "502": { "description": "The node could not be reached or answered with a non-HTTP error. `error.code` is `upstream_unavailable`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "The node is temporarily unavailable. `error.code` is `upstream_unavailable`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "504": { "description": "The node did not answer in time. `error.code` is `upstream_timeout`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "default": { "description": "Any other error. The node's own JSON error bodies pass through unchanged; every non-JSON error is wrapped in the `Error` shape by the test.network proxy, so a 4xx/5xx body is always JSON with a machine-readable `error.code`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/statechain/blocks": { "get": { "operationId": "listStateBlocks", "tags": [ "State Chain" ], "summary": "State blocks", "description": "Returns state chain blocks and block count. Optional ?start and ?limit.", "parameters": [ { "name": "start", "in": "query", "required": false, "description": "First block index to return.", "schema": { "type": "integer" } }, { "name": "limit", "in": "query", "required": false, "description": "Maximum number of blocks to return.", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "A page of state blocks.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StateBlockPage" } } } }, "400": { "description": "Bad request: malformed JSON, a body that fails the operation's schema, or an unsigned/invalid block. `error.code` is `bad_request`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No such route or object (unknown path, unknown account, or a lease-scoped lookup while the testnet has no leases). `error.code` is `not_found`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded for the request class. Back off for Retry-After seconds; RateLimit reports the window. Policies: read 1000/5s, write 50/5s. `error.code` is `rate_limited`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "The node failed while handling the request. `error.code` is `upstream_error`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "502": { "description": "The node could not be reached or answered with a non-HTTP error. `error.code` is `upstream_unavailable`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "The node is temporarily unavailable. `error.code` is `upstream_unavailable`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "504": { "description": "The node did not answer in time. `error.code` is `upstream_timeout`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "default": { "description": "Any other error. The node's own JSON error bodies pass through unchanged; every non-JSON error is wrapped in the `Error` shape by the test.network proxy, so a 4xx/5xx body is always JSON with a machine-readable `error.code`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } }, "post": { "operationId": "submitStateBlock", "tags": [ "State Chain" ], "summary": "Submit state block", "description": "Submits a state chain block signed by the DAO keyset threshold.", "parameters": [], "responses": { "200": { "description": "The appended state block.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StateBlock" } } } }, "400": { "description": "Bad request: malformed JSON, a body that fails the operation's schema, or an unsigned/invalid block. `error.code` is `bad_request`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No such route or object (unknown path, unknown account, or a lease-scoped lookup while the testnet has no leases). `error.code` is `not_found`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded for the request class. Back off for Retry-After seconds; RateLimit reports the window. Policies: read 1000/5s, write 50/5s. `error.code` is `rate_limited`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "The node failed while handling the request. `error.code` is `upstream_error`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "502": { "description": "The node could not be reached or answered with a non-HTTP error. `error.code` is `upstream_unavailable`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "The node is temporarily unavailable. `error.code` is `upstream_unavailable`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "504": { "description": "The node did not answer in time. `error.code` is `upstream_timeout`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "default": { "description": "Any other error. The node's own JSON error bodies pass through unchanged; every non-JSON error is wrapped in the `Error` shape by the test.network proxy, so a 4xx/5xx body is always JSON with a machine-readable `error.code`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StateBlockSubmission" }, "example": { "ops": [ { "action": "set", "key": "demo.key", "value": "demo" } ], "signatures": [] } } } } } }, "/statechain/kv/{key}": { "get": { "operationId": "getStateValue", "tags": [ "State Chain" ], "summary": "State value", "description": "Returns one state chain key-value entry (or a prefix lookup).", "parameters": [ { "name": "key", "in": "path", "required": true, "description": "State key, e.g. sys.network_id.", "schema": { "type": "string" }, "example": "sys.network_id" } ], "responses": { "200": { "description": "The entry.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StateValue" } } } }, "400": { "description": "Bad request: malformed JSON, a body that fails the operation's schema, or an unsigned/invalid block. `error.code` is `bad_request`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No such route or object (unknown path, unknown account, or a lease-scoped lookup while the testnet has no leases). `error.code` is `not_found`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded for the request class. Back off for Retry-After seconds; RateLimit reports the window. Policies: read 1000/5s, write 50/5s. `error.code` is `rate_limited`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "The node failed while handling the request. `error.code` is `upstream_error`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "502": { "description": "The node could not be reached or answered with a non-HTTP error. `error.code` is `upstream_unavailable`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "The node is temporarily unavailable. `error.code` is `upstream_unavailable`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "504": { "description": "The node did not answer in time. `error.code` is `upstream_timeout`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "default": { "description": "Any other error. The node's own JSON error bodies pass through unchanged; every non-JSON error is wrapped in the `Error` shape by the test.network proxy, so a 4xx/5xx body is always JSON with a machine-readable `error.code`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/statechain/kv": { "get": { "operationId": "listStateValues", "tags": [ "State Chain" ], "summary": "All state values", "description": "Returns state chain key-value entries. Optional ?prefix filter plus ?offset/?limit pagination.", "parameters": [ { "name": "prefix", "in": "query", "required": false, "description": "Only keys starting with this prefix.", "schema": { "type": "string" } }, { "name": "offset", "in": "query", "required": false, "description": "Number of entries to skip.", "schema": { "type": "integer" } }, { "name": "limit", "in": "query", "required": false, "description": "Maximum number of entries to return.", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Entries.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StateValueList" } } } }, "400": { "description": "Bad request: malformed JSON, a body that fails the operation's schema, or an unsigned/invalid block. `error.code` is `bad_request`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No such route or object (unknown path, unknown account, or a lease-scoped lookup while the testnet has no leases). `error.code` is `not_found`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded for the request class. Back off for Retry-After seconds; RateLimit reports the window. Policies: read 1000/5s, write 50/5s. `error.code` is `rate_limited`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "The node failed while handling the request. `error.code` is `upstream_error`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "502": { "description": "The node could not be reached or answered with a non-HTTP error. `error.code` is `upstream_unavailable`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "The node is temporarily unavailable. `error.code` is `upstream_unavailable`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "504": { "description": "The node did not answer in time. `error.code` is `upstream_timeout`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "default": { "description": "Any other error. The node's own JSON error bodies pass through unchanged; every non-JSON error is wrapped in the `Error` shape by the test.network proxy, so a 4xx/5xx body is always JSON with a machine-readable `error.code`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/statechain/keyset": { "get": { "operationId": "getDaoKeyset", "tags": [ "State Chain" ], "summary": "DAO keyset", "description": "Returns the current DAO keyset (M-of-N timekeepers).", "parameters": [], "responses": { "200": { "description": "The DAO keyset.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Keyset" } } } }, "400": { "description": "Bad request: malformed JSON, a body that fails the operation's schema, or an unsigned/invalid block. `error.code` is `bad_request`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No such route or object (unknown path, unknown account, or a lease-scoped lookup while the testnet has no leases). `error.code` is `not_found`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded for the request class. Back off for Retry-After seconds; RateLimit reports the window. Policies: read 1000/5s, write 50/5s. `error.code` is `rate_limited`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "The node failed while handling the request. `error.code` is `upstream_error`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "502": { "description": "The node could not be reached or answered with a non-HTTP error. `error.code` is `upstream_unavailable`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "The node is temporarily unavailable. `error.code` is `upstream_unavailable`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "504": { "description": "The node did not answer in time. `error.code` is `upstream_timeout`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "default": { "description": "Any other error. The node's own JSON error bodies pass through unchanged; every non-JSON error is wrapped in the `Error` shape by the test.network proxy, so a 4xx/5xx body is always JSON with a machine-readable `error.code`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/directory/register": { "post": { "operationId": "registerDirectoryEntry", "tags": [ "Directory" ], "summary": "Register directory entry", "description": "Registers an account-to-peer mapping, signed by the account key over the registration payload.", "parameters": [], "responses": { "200": { "description": "The stored registration.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DirectoryEntry" } } } }, "400": { "description": "Bad request: malformed JSON, a body that fails the operation's schema, or an unsigned/invalid block. `error.code` is `bad_request`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No such route or object (unknown path, unknown account, or a lease-scoped lookup while the testnet has no leases). `error.code` is `not_found`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded for the request class. Back off for Retry-After seconds; RateLimit reports the window. Policies: read 1000/5s, write 50/5s. `error.code` is `rate_limited`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "The node failed while handling the request. `error.code` is `upstream_error`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "502": { "description": "The node could not be reached or answered with a non-HTTP error. `error.code` is `upstream_unavailable`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "The node is temporarily unavailable. `error.code` is `upstream_unavailable`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "504": { "description": "The node did not answer in time. `error.code` is `upstream_timeout`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "default": { "description": "Any other error. The node's own JSON error bodies pass through unchanged; every non-JSON error is wrapped in the `Error` shape by the test.network proxy, so a 4xx/5xx body is always JSON with a machine-readable `error.code`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DirectoryRegistration" }, "example": { "account": "c33d2e40114d952510fc90065337363f063f36fed14e484a3b957b35eb7227a8", "node_peer": "", "timestamp": 0, "signature": "" } } } } } }, "/directory": { "get": { "operationId": "listDirectory", "tags": [ "Directory" ], "summary": "List directory", "description": "Returns account-to-peer registrations, paginated.", "parameters": [ { "name": "offset", "in": "query", "required": false, "description": "Number of entries to skip.", "schema": { "type": "integer" } }, { "name": "limit", "in": "query", "required": false, "description": "Maximum number of entries to return.", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Registrations.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DirectoryEntryList" } } } }, "400": { "description": "Bad request: malformed JSON, a body that fails the operation's schema, or an unsigned/invalid block. `error.code` is `bad_request`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No such route or object (unknown path, unknown account, or a lease-scoped lookup while the testnet has no leases). `error.code` is `not_found`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded for the request class. Back off for Retry-After seconds; RateLimit reports the window. Policies: read 1000/5s, write 50/5s. `error.code` is `rate_limited`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "The node failed while handling the request. `error.code` is `upstream_error`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "502": { "description": "The node could not be reached or answered with a non-HTTP error. `error.code` is `upstream_unavailable`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "The node is temporarily unavailable. `error.code` is `upstream_unavailable`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "504": { "description": "The node did not answer in time. `error.code` is `upstream_timeout`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "default": { "description": "Any other error. The node's own JSON error bodies pass through unchanged; every non-JSON error is wrapped in the `Error` shape by the test.network proxy, so a 4xx/5xx body is always JSON with a machine-readable `error.code`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/directory/{account}": { "get": { "operationId": "getDirectoryEntry", "tags": [ "Directory" ], "summary": "Lookup directory entry", "description": "Returns the registration for one account (404 if the account has not registered or its entry expired).", "parameters": [ { "name": "account", "in": "path", "required": true, "description": "Account address, 64 hex characters.", "schema": { "type": "string" }, "example": "c33d2e40114d952510fc90065337363f063f36fed14e484a3b957b35eb7227a8" } ], "responses": { "200": { "description": "The registration.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DirectoryEntry" } } } }, "400": { "description": "Bad request: malformed JSON, a body that fails the operation's schema, or an unsigned/invalid block. `error.code` is `bad_request`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No such route or object (unknown path, unknown account, or a lease-scoped lookup while the testnet has no leases). `error.code` is `not_found`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded for the request class. Back off for Retry-After seconds; RateLimit reports the window. Policies: read 1000/5s, write 50/5s. `error.code` is `rate_limited`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "The node failed while handling the request. `error.code` is `upstream_error`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "502": { "description": "The node could not be reached or answered with a non-HTTP error. `error.code` is `upstream_unavailable`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "The node is temporarily unavailable. `error.code` is `upstream_unavailable`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "504": { "description": "The node did not answer in time. `error.code` is `upstream_timeout`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "default": { "description": "Any other error. The node's own JSON error bodies pass through unchanged; every non-JSON error is wrapped in the `Error` shape by the test.network proxy, so a 4xx/5xx body is always JSON with a machine-readable `error.code`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/chat/send": { "post": { "operationId": "sendChatMessage", "tags": [ "Chat" ], "summary": "Send chat message", "description": "Sends a peer-to-peer chat message. Requires a full pre-signed envelope — the node no longer signs messages on behalf of callers.", "parameters": [], "responses": { "200": { "description": "The accepted envelope.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChatMessage" } } } }, "400": { "description": "Bad request: malformed JSON, a body that fails the operation's schema, or an unsigned/invalid block. `error.code` is `bad_request`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No such route or object (unknown path, unknown account, or a lease-scoped lookup while the testnet has no leases). `error.code` is `not_found`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded for the request class. Back off for Retry-After seconds; RateLimit reports the window. Policies: read 1000/5s, write 50/5s. `error.code` is `rate_limited`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "The node failed while handling the request. `error.code` is `upstream_error`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "502": { "description": "The node could not be reached or answered with a non-HTTP error. `error.code` is `upstream_unavailable`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "The node is temporarily unavailable. `error.code` is `upstream_unavailable`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "504": { "description": "The node did not answer in time. `error.code` is `upstream_timeout`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "default": { "description": "Any other error. The node's own JSON error bodies pass through unchanged; every non-JSON error is wrapped in the `Error` shape by the test.network proxy, so a 4xx/5xx body is always JSON with a machine-readable `error.code`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChatMessage" }, "example": { "id": "", "from": "c33d2e40114d952510fc90065337363f063f36fed14e484a3b957b35eb7227a8", "to": "934dce0b20d4f36a8bd25f14bbe1666daa6e75c8f54b0c68eca2c17cc0a64a6c", "message": "hello testnet", "timestamp": 0, "signature": "", "pow_nonce": 0 } } } } } }, "/chat/auth/challenge": { "get": { "operationId": "getChatAuthChallenge", "tags": [ "Chat" ], "summary": "Chat auth challenge", "description": "Issues a single-use challenge. Sign it with your account key and pass account, challenge, and sig to the chat read endpoints as ownership proof.", "parameters": [], "responses": { "200": { "description": "A fresh challenge.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChatChallenge" } } } }, "400": { "description": "Bad request: malformed JSON, a body that fails the operation's schema, or an unsigned/invalid block. `error.code` is `bad_request`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No such route or object (unknown path, unknown account, or a lease-scoped lookup while the testnet has no leases). `error.code` is `not_found`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded for the request class. Back off for Retry-After seconds; RateLimit reports the window. Policies: read 1000/5s, write 50/5s. `error.code` is `rate_limited`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "The node failed while handling the request. `error.code` is `upstream_error`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "502": { "description": "The node could not be reached or answered with a non-HTTP error. `error.code` is `upstream_unavailable`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "The node is temporarily unavailable. `error.code` is `upstream_unavailable`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "504": { "description": "The node did not answer in time. `error.code` is `upstream_timeout`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "default": { "description": "Any other error. The node's own JSON error bodies pass through unchanged; every non-JSON error is wrapped in the `Error` shape by the test.network proxy, so a 4xx/5xx body is always JSON with a machine-readable `error.code`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/chat/messages": { "get": { "operationId": "listChatMessages", "tags": [ "Chat" ], "summary": "Chat messages", "description": "Returns stored chat messages for an account. Requires an ownership proof: get a challenge from /chat/auth/challenge, sign it, and pass account, challenge, and sig. Optional ?since (unix nanoseconds).", "parameters": [ { "name": "account", "in": "query", "required": true, "description": "Account address, 64 hex characters.", "schema": { "type": "string" }, "example": "c33d2e40114d952510fc90065337363f063f36fed14e484a3b957b35eb7227a8" }, { "name": "pub_key", "in": "query", "required": true, "description": "Hex ed25519 public key of `account`. Required: an address is a hash of the key and cannot verify a signature on its own.", "schema": { "type": "string" } }, { "name": "challenge", "in": "query", "required": true, "description": "Single-use challenge from GET /chat/auth/challenge.", "schema": { "type": "string" } }, { "name": "sig", "in": "query", "required": true, "description": "ed25519 signature over sha256(\"xe/chat-read-auth/v1\\0\" || challenge) by the account key, hex.", "schema": { "type": "string" } }, { "name": "since", "in": "query", "required": false, "description": "Only messages newer than this unix-nanosecond timestamp.", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Stored messages.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChatMessageList" } } } }, "400": { "description": "Bad request: malformed JSON, a body that fails the operation's schema, or an unsigned/invalid block. `error.code` is `bad_request`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing credentials for a gated endpoint. `error.code` is `unauthorized`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Credentials present but not sufficient (wrong admin token, failed ownership proof). `error.code` is `forbidden`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No such route or object (unknown path, unknown account, or a lease-scoped lookup while the testnet has no leases). `error.code` is `not_found`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded for the request class. Back off for Retry-After seconds; RateLimit reports the window. Policies: read 1000/5s, write 50/5s. `error.code` is `rate_limited`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "The node failed while handling the request. `error.code` is `upstream_error`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "502": { "description": "The node could not be reached or answered with a non-HTTP error. `error.code` is `upstream_unavailable`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "The node is temporarily unavailable. `error.code` is `upstream_unavailable`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "504": { "description": "The node did not answer in time. `error.code` is `upstream_timeout`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "default": { "description": "Any other error. The node's own JSON error bodies pass through unchanged; every non-JSON error is wrapped in the `Error` shape by the test.network proxy, so a 4xx/5xx body is always JSON with a machine-readable `error.code`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "ownershipProof": [] } ] } }, "/chat/contacts": { "get": { "operationId": "listChatContacts", "tags": [ "Chat" ], "summary": "Chat contacts", "description": "Returns known chat contacts.", "parameters": [], "responses": { "200": { "description": "Contacts.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChatContactList" } } } }, "400": { "description": "Bad request: malformed JSON, a body that fails the operation's schema, or an unsigned/invalid block. `error.code` is `bad_request`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No such route or object (unknown path, unknown account, or a lease-scoped lookup while the testnet has no leases). `error.code` is `not_found`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded for the request class. Back off for Retry-After seconds; RateLimit reports the window. Policies: read 1000/5s, write 50/5s. `error.code` is `rate_limited`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "The node failed while handling the request. `error.code` is `upstream_error`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "502": { "description": "The node could not be reached or answered with a non-HTTP error. `error.code` is `upstream_unavailable`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "The node is temporarily unavailable. `error.code` is `upstream_unavailable`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "504": { "description": "The node did not answer in time. `error.code` is `upstream_timeout`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "default": { "description": "Any other error. The node's own JSON error bodies pass through unchanged; every non-JSON error is wrapped in the `Error` shape by the test.network proxy, so a 4xx/5xx body is always JSON with a machine-readable `error.code`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/chat/events": { "get": { "operationId": "streamChatEvents", "tags": [ "Chat" ], "summary": "Chat event stream", "description": "SSE stream of new messages. A named account requires an ownership proof (account, challenge, sig); with no account it is the unfiltered firehose, which is operator-only and returns 403 without the admin token.", "parameters": [ { "name": "account", "in": "query", "required": false, "description": "Account address, 64 hex characters.", "schema": { "type": "string" }, "example": "c33d2e40114d952510fc90065337363f063f36fed14e484a3b957b35eb7227a8" }, { "name": "pub_key", "in": "query", "required": false, "description": "Hex ed25519 public key of `account`. Required: an address is a hash of the key and cannot verify a signature on its own.", "schema": { "type": "string" } }, { "name": "challenge", "in": "query", "required": false, "description": "Single-use challenge from GET /chat/auth/challenge.", "schema": { "type": "string" } }, { "name": "sig", "in": "query", "required": false, "description": "ed25519 signature over sha256(\"xe/chat-read-auth/v1\\0\" || challenge) by the account key, hex.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Server-sent events, one `ChatMessage` JSON object per event.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "text/event-stream": { "schema": { "type": "string" } } } }, "400": { "description": "Bad request: malformed JSON, a body that fails the operation's schema, or an unsigned/invalid block. `error.code` is `bad_request`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing credentials for a gated endpoint. `error.code` is `unauthorized`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Credentials present but not sufficient (wrong admin token, failed ownership proof). `error.code` is `forbidden`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No such route or object (unknown path, unknown account, or a lease-scoped lookup while the testnet has no leases). `error.code` is `not_found`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded for the request class. Back off for Retry-After seconds; RateLimit reports the window. Policies: read 1000/5s, write 50/5s. `error.code` is `rate_limited`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "The node failed while handling the request. `error.code` is `upstream_error`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "502": { "description": "The node could not be reached or answered with a non-HTTP error. `error.code` is `upstream_unavailable`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "The node is temporarily unavailable. `error.code` is `upstream_unavailable`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "504": { "description": "The node did not answer in time. `error.code` is `upstream_timeout`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "default": { "description": "Any other error. The node's own JSON error bodies pass through unchanged; every non-JSON error is wrapped in the `Error` shape by the test.network proxy, so a 4xx/5xx body is always JSON with a machine-readable `error.code`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "ownershipProof": [] } ] } }, "/node": { "get": { "operationId": "getNodeInfo", "tags": [ "Node" ], "summary": "Node info", "description": "Returns node identity, version, network, and peers.", "parameters": [], "responses": { "200": { "description": "Node info.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NodeInfo" } } } }, "400": { "description": "Bad request: malformed JSON, a body that fails the operation's schema, or an unsigned/invalid block. `error.code` is `bad_request`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No such route or object (unknown path, unknown account, or a lease-scoped lookup while the testnet has no leases). `error.code` is `not_found`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded for the request class. Back off for Retry-After seconds; RateLimit reports the window. Policies: read 1000/5s, write 50/5s. `error.code` is `rate_limited`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "The node failed while handling the request. `error.code` is `upstream_error`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "502": { "description": "The node could not be reached or answered with a non-HTTP error. `error.code` is `upstream_unavailable`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "The node is temporarily unavailable. `error.code` is `upstream_unavailable`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "504": { "description": "The node did not answer in time. `error.code` is `upstream_timeout`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "default": { "description": "Any other error. The node's own JSON error bodies pass through unchanged; every non-JSON error is wrapped in the `Error` shape by the test.network proxy, so a 4xx/5xx body is always JSON with a machine-readable `error.code`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/pending/{address}": { "get": { "operationId": "listPendingForAccount", "tags": [ "Node" ], "summary": "Pending for account", "description": "Returns pending sends for an account.", "parameters": [ { "name": "address", "in": "path", "required": true, "description": "Account address, 64 hex characters.", "schema": { "type": "string" }, "example": "c33d2e40114d952510fc90065337363f063f36fed14e484a3b957b35eb7227a8" } ], "responses": { "200": { "description": "Unreceived sends to the account.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PendingSendList" } } } }, "400": { "description": "Bad request: malformed JSON, a body that fails the operation's schema, or an unsigned/invalid block. `error.code` is `bad_request`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No such route or object (unknown path, unknown account, or a lease-scoped lookup while the testnet has no leases). `error.code` is `not_found`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded for the request class. Back off for Retry-After seconds; RateLimit reports the window. Policies: read 1000/5s, write 50/5s. `error.code` is `rate_limited`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "The node failed while handling the request. `error.code` is `upstream_error`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "502": { "description": "The node could not be reached or answered with a non-HTTP error. `error.code` is `upstream_unavailable`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "The node is temporarily unavailable. `error.code` is `upstream_unavailable`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "504": { "description": "The node did not answer in time. `error.code` is `upstream_timeout`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "default": { "description": "Any other error. The node's own JSON error bodies pass through unchanged; every non-JSON error is wrapped in the `Error` shape by the test.network proxy, so a 4xx/5xx body is always JSON with a machine-readable `error.code`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/pending": { "get": { "operationId": "listPending", "tags": [ "Node" ], "summary": "All pending sends", "description": "Returns all pending sends known to the node.", "parameters": [], "responses": { "200": { "description": "All unreceived sends.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PendingSendList" } } } }, "400": { "description": "Bad request: malformed JSON, a body that fails the operation's schema, or an unsigned/invalid block. `error.code` is `bad_request`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No such route or object (unknown path, unknown account, or a lease-scoped lookup while the testnet has no leases). `error.code` is `not_found`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded for the request class. Back off for Retry-After seconds; RateLimit reports the window. Policies: read 1000/5s, write 50/5s. `error.code` is `rate_limited`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "The node failed while handling the request. `error.code` is `upstream_error`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "502": { "description": "The node could not be reached or answered with a non-HTTP error. `error.code` is `upstream_unavailable`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "The node is temporarily unavailable. `error.code` is `upstream_unavailable`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "504": { "description": "The node did not answer in time. `error.code` is `upstream_timeout`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "default": { "description": "Any other error. The node's own JSON error bodies pass through unchanged; every non-JSON error is wrapped in the `Error` shape by the test.network proxy, so a 4xx/5xx body is always JSON with a machine-readable `error.code`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/frontiers": { "get": { "operationId": "listFrontiers", "tags": [ "Node" ], "summary": "Frontiers", "description": "Returns account frontier hashes.", "parameters": [], "responses": { "200": { "description": "Address → frontier hash.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Frontiers" } } } }, "400": { "description": "Bad request: malformed JSON, a body that fails the operation's schema, or an unsigned/invalid block. `error.code` is `bad_request`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No such route or object (unknown path, unknown account, or a lease-scoped lookup while the testnet has no leases). `error.code` is `not_found`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded for the request class. Back off for Retry-After seconds; RateLimit reports the window. Policies: read 1000/5s, write 50/5s. `error.code` is `rate_limited`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "The node failed while handling the request. `error.code` is `upstream_error`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "502": { "description": "The node could not be reached or answered with a non-HTTP error. `error.code` is `upstream_unavailable`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "The node is temporarily unavailable. `error.code` is `upstream_unavailable`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "504": { "description": "The node did not answer in time. `error.code` is `upstream_timeout`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "default": { "description": "Any other error. The node's own JSON error bodies pass through unchanged; every non-JSON error is wrapped in the `Error` shape by the test.network proxy, so a 4xx/5xx body is always JSON with a machine-readable `error.code`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/delegation": { "get": { "operationId": "getDelegation", "tags": [ "Node" ], "summary": "Delegation weights", "description": "Returns representative vote weights in micro-XE.", "parameters": [], "responses": { "200": { "description": "Representative → weight.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Delegation" } } } }, "400": { "description": "Bad request: malformed JSON, a body that fails the operation's schema, or an unsigned/invalid block. `error.code` is `bad_request`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No such route or object (unknown path, unknown account, or a lease-scoped lookup while the testnet has no leases). `error.code` is `not_found`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded for the request class. Back off for Retry-After seconds; RateLimit reports the window. Policies: read 1000/5s, write 50/5s. `error.code` is `rate_limited`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "The node failed while handling the request. `error.code` is `upstream_error`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "502": { "description": "The node could not be reached or answered with a non-HTTP error. `error.code` is `upstream_unavailable`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "The node is temporarily unavailable. `error.code` is `upstream_unavailable`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "504": { "description": "The node did not answer in time. `error.code` is `upstream_timeout`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "default": { "description": "Any other error. The node's own JSON error bodies pass through unchanged; every non-JSON error is wrapped in the `Error` shape by the test.network proxy, so a 4xx/5xx body is always JSON with a machine-readable `error.code`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/conflicts": { "get": { "operationId": "listConflicts", "tags": [ "Node" ], "summary": "Conflicts", "description": "Returns detected account-chain conflicts.", "parameters": [], "responses": { "200": { "description": "Conflicts.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConflictList" } } } }, "400": { "description": "Bad request: malformed JSON, a body that fails the operation's schema, or an unsigned/invalid block. `error.code` is `bad_request`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No such route or object (unknown path, unknown account, or a lease-scoped lookup while the testnet has no leases). `error.code` is `not_found`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded for the request class. Back off for Retry-After seconds; RateLimit reports the window. Policies: read 1000/5s, write 50/5s. `error.code` is `rate_limited`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "The node failed while handling the request. `error.code` is `upstream_error`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "502": { "description": "The node could not be reached or answered with a non-HTTP error. `error.code` is `upstream_unavailable`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "The node is temporarily unavailable. `error.code` is `upstream_unavailable`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "504": { "description": "The node did not answer in time. `error.code` is `upstream_timeout`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "default": { "description": "Any other error. The node's own JSON error bodies pass through unchanged; every non-JSON error is wrapped in the `Error` shape by the test.network proxy, so a 4xx/5xx body is always JSON with a machine-readable `error.code`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/conflicts/{account}": { "get": { "operationId": "listConflictsForAccount", "tags": [ "Node" ], "summary": "Conflicts for account", "description": "Returns conflicts scoped to one account.", "parameters": [ { "name": "account", "in": "path", "required": true, "description": "Account address, 64 hex characters.", "schema": { "type": "string" }, "example": "c33d2e40114d952510fc90065337363f063f36fed14e484a3b957b35eb7227a8" } ], "responses": { "200": { "description": "Conflicts on that account chain.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConflictList" } } } }, "400": { "description": "Bad request: malformed JSON, a body that fails the operation's schema, or an unsigned/invalid block. `error.code` is `bad_request`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No such route or object (unknown path, unknown account, or a lease-scoped lookup while the testnet has no leases). `error.code` is `not_found`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded for the request class. Back off for Retry-After seconds; RateLimit reports the window. Policies: read 1000/5s, write 50/5s. `error.code` is `rate_limited`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "The node failed while handling the request. `error.code` is `upstream_error`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "502": { "description": "The node could not be reached or answered with a non-HTTP error. `error.code` is `upstream_unavailable`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "The node is temporarily unavailable. `error.code` is `upstream_unavailable`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "504": { "description": "The node did not answer in time. `error.code` is `upstream_timeout`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "default": { "description": "Any other error. The node's own JSON error bodies pass through unchanged; every non-JSON error is wrapped in the `Error` shape by the test.network proxy, so a 4xx/5xx body is always JSON with a machine-readable `error.code`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } } }, "components": { "schemas": { "Error": { "type": "object", "description": "Structured error returned by the test.network API proxy when the upstream node did not itself answer with JSON, or when the proxy rejected or could not complete the request. Upstream JSON error bodies are passed through unchanged.", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "status", "message", "hint", "docs" ], "properties": { "code": { "type": "string", "description": "Stable machine-readable error code, snake_case.", "examples": [ "not_found", "bad_request", "upstream_unavailable", "upstream_error" ] }, "status": { "type": "integer", "description": "HTTP status code, repeated in the body." }, "message": { "type": "string", "description": "Human-readable summary." }, "hint": { "type": "string", "description": "What to try next: the fix, the right endpoint, or where the answer lives." }, "docs": { "type": "string", "format": "uri", "description": "Link to the relevant documentation." }, "openapi": { "type": "string", "format": "uri", "description": "Link to this OpenAPI document." }, "upstream": { "type": "object", "description": "Present when the node answered with a non-JSON error: its status and body.", "properties": { "status": { "type": "integer" }, "body": { "type": "string" } } } } } } }, "Address": { "type": "string", "pattern": "^[0-9a-f]{64}$", "description": "Account address: sha256(\"xe/account/v1\" || ed25519 public key), lower-case hex." }, "Hash": { "type": "string", "pattern": "^[0-9a-f]{64}$", "description": "32 bytes, lower-case hex (64 characters)." }, "MicroUnits": { "type": "integer", "minimum": 0, "description": "Amount in micro-units. 1 XE = 1 XUSD = 1,000,000 micro-units; every amount, balance and weight in the API is an integer micro-unit count." }, "Asset": { "type": "string", "enum": [ "XE", "XUSD" ], "description": "Asset code. XE is the native asset and the only one that carries vote weight; XUSD is specified but not issued on this testnet yet." }, "Keyset": { "type": "object", "required": [ "keys", "threshold" ], "properties": { "keys": { "type": "array", "items": { "type": "string", "pattern": "^[0-9a-f]{64}$", "description": "Account address: sha256(\"xe/account/v1\" || ed25519 public key), lower-case hex." }, "minItems": 1 }, "threshold": { "type": "integer", "minimum": 1 } } }, "Account": { "type": "object", "description": "An account known to the node.", "required": [ "address" ], "properties": { "address": { "type": "string", "pattern": "^[0-9a-f]{64}$", "description": "Account address: sha256(\"xe/account/v1\" || ed25519 public key), lower-case hex." }, "block_count": { "type": "integer", "description": "Number of blocks on the account chain." } }, "additionalProperties": true }, "AccountList": { "type": "array", "items": { "$ref": "#/components/schemas/Account" } }, "Balances": { "type": "object", "description": "Per-asset balances for one account, keyed by asset code, in micro-units.", "additionalProperties": { "type": "integer", "minimum": 0, "description": "Amount in micro-units. 1 XE = 1 XUSD = 1,000,000 micro-units; every amount, balance and weight in the API is an integer micro-unit count." } }, "Block": { "type": "object", "description": "An account-chain block. `type` selects the block kind; the remaining fields are those of the matching submission schema.", "required": [ "type", "account", "hash" ], "properties": { "type": { "type": "string" }, "account": { "type": "string", "pattern": "^[0-9a-f]{64}$", "description": "Account address: sha256(\"xe/account/v1\" || ed25519 public key), lower-case hex." }, "previous": { "type": "string", "description": "Hash of the previous block on this account chain, or \"0\" for the first block." }, "balance": { "type": "integer", "minimum": 0, "description": "Post-block balance of `asset` on this account, in micro-units." }, "timestamp": { "type": "integer", "description": "Block time as unix nanoseconds." }, "asset": { "type": "string", "enum": [ "XE", "XUSD" ], "description": "Asset code. XE is the native asset and the only one that carries vote weight; XUSD is specified but not issued on this testnet yet." }, "hash": { "type": "string", "pattern": "^[0-9a-f]{64}$", "description": "sha256 of the block content, hex." }, "pow_nonce": { "type": "integer", "description": "Proof-of-work nonce satisfying the block difficulty (DefaultDifficulty 0xfffff80000000000, roughly one second of work)." } }, "additionalProperties": true }, "BlockList": { "type": "array", "items": { "$ref": "#/components/schemas/Block" } }, "SubmitResult": { "type": "object", "description": "Acknowledgement of an accepted block submission.", "properties": { "hash": { "type": "string", "pattern": "^[0-9a-f]{64}$", "description": "32 bytes, lower-case hex (64 characters)." } }, "additionalProperties": true }, "Reputation": { "type": "object", "description": "Reputation aggregate for one account, built from on-chain lease activity.", "properties": { "account": { "type": "string", "pattern": "^[0-9a-f]{64}$", "description": "Account address: sha256(\"xe/account/v1\" || ed25519 public key), lower-case hex." } }, "additionalProperties": true }, "ReputationList": { "type": "array", "items": { "$ref": "#/components/schemas/Reputation" } }, "Lease": { "type": "object", "description": "A compute lease and its lifecycle state.", "properties": { "hash": { "type": "string", "pattern": "^[0-9a-f]{64}$", "description": "32 bytes, lower-case hex (64 characters)." }, "state": { "type": "string", "enum": [ "created", "accepted", "settled", "cancelled", "unfulfilled" ] }, "consumer": { "type": "string", "pattern": "^[0-9a-f]{64}$", "description": "Account address: sha256(\"xe/account/v1\" || ed25519 public key), lower-case hex." }, "provider": { "type": "string", "pattern": "^[0-9a-f]{64}$", "description": "Account address: sha256(\"xe/account/v1\" || ed25519 public key), lower-case hex." }, "vcpus": { "type": "integer", "minimum": 1 }, "memory_mb": { "type": "integer", "minimum": 1 }, "disk_gb": { "type": "integer", "minimum": 1 }, "duration": { "type": "integer", "minimum": 1, "description": "Lease duration in seconds." }, "access_pub_key": { "type": "string", "description": "Hex ed25519 public key used to authenticate VM access (SSH, TCP tunnel)." } }, "additionalProperties": true }, "LeaseList": { "type": "array", "items": { "$ref": "#/components/schemas/Lease" } }, "Provider": { "type": "object", "description": "A compute provider registered with the node.", "properties": { "address": { "type": "string", "pattern": "^[0-9a-f]{64}$", "description": "Account address: sha256(\"xe/account/v1\" || ed25519 public key), lower-case hex." } }, "additionalProperties": true }, "ProviderList": { "type": "array", "items": { "$ref": "#/components/schemas/Provider" } }, "Certificate": { "type": "object", "description": "A provider performance certificate.", "additionalProperties": true }, "Vm": { "type": "object", "description": "A VM record held by a provider for a lease.", "properties": { "lease": { "type": "string", "pattern": "^[0-9a-f]{64}$", "description": "32 bytes, lower-case hex (64 characters)." } }, "additionalProperties": true }, "VmList": { "type": "array", "items": { "$ref": "#/components/schemas/Vm" } }, "StateBlock": { "type": "object", "description": "A state-chain op block signed by the DAO keyset.", "properties": { "index": { "type": "integer", "minimum": 0 }, "hash": { "type": "string", "pattern": "^[0-9a-f]{64}$", "description": "32 bytes, lower-case hex (64 characters)." }, "ops": { "$ref": "#/components/schemas/StateOps" } }, "additionalProperties": true }, "StateBlockPage": { "type": "object", "description": "A page of state-chain blocks with the total block count.", "properties": { "blocks": { "type": "array", "items": { "$ref": "#/components/schemas/StateBlock" } }, "count": { "type": "integer" } }, "additionalProperties": true }, "StateOps": { "type": "array", "items": { "type": "object", "required": [ "action", "key" ], "properties": { "action": { "type": "string", "enum": [ "set", "delete" ] }, "key": { "type": "string", "examples": [ "sys.network_id", "sys.minter" ] }, "value": { "type": "string" } } } }, "StateBlockSubmission": { "type": "object", "description": "A state-chain block signed by the current DAO keyset threshold.", "required": [ "ops", "signatures" ], "properties": { "ops": { "$ref": "#/components/schemas/StateOps" }, "signatures": { "type": "array", "description": "One entry per signing key; at least `threshold` are required.", "items": { "type": "object", "required": [ "public_key", "signature" ], "properties": { "public_key": { "type": "string", "description": "Signer's ed25519 public key, hex." }, "signature": { "type": "string", "description": "ed25519 signature over the canonical block bytes, hex." } } } } } }, "StateValue": { "type": "object", "description": "One state-chain key/value entry.", "properties": { "key": { "type": "string" }, "value": { "type": "string" } }, "additionalProperties": true }, "StateValueList": { "type": "array", "items": { "$ref": "#/components/schemas/StateValue" } }, "DirectoryEntry": { "type": "object", "description": "A signed account-to-libp2p-peer registration with TTL expiry.", "properties": { "account": { "type": "string", "pattern": "^[0-9a-f]{64}$", "description": "Account address: sha256(\"xe/account/v1\" || ed25519 public key), lower-case hex." }, "node_peer": { "type": "string", "description": "libp2p peer id, e.g. 12D3KooW…" }, "timestamp": { "type": "integer" } }, "additionalProperties": true }, "DirectoryEntryList": { "type": "array", "items": { "$ref": "#/components/schemas/DirectoryEntry" } }, "DirectoryRegistration": { "type": "object", "required": [ "account", "node_peer", "timestamp", "signature" ], "properties": { "account": { "type": "string", "pattern": "^[0-9a-f]{64}$", "description": "Account address: sha256(\"xe/account/v1\" || ed25519 public key), lower-case hex." }, "node_peer": { "type": "string", "description": "Your libp2p peer id, e.g. 12D3KooW…" }, "timestamp": { "type": "integer", "description": "unix nanoseconds" }, "signature": { "type": "string", "description": "ed25519 signature by the account key over the registration payload, hex." } } }, "ChatMessage": { "type": "object", "description": "A pre-signed chat envelope. The node never signs on a caller's behalf.", "required": [ "id", "from", "to", "message", "timestamp", "signature", "pow_nonce" ], "properties": { "id": { "type": "string", "description": "Unique message id chosen by the sender." }, "from": { "type": "string", "pattern": "^[0-9a-f]{64}$", "description": "Account address: sha256(\"xe/account/v1\" || ed25519 public key), lower-case hex." }, "to": { "type": "string", "pattern": "^[0-9a-f]{64}$", "description": "Account address: sha256(\"xe/account/v1\" || ed25519 public key), lower-case hex." }, "message": { "type": "string" }, "timestamp": { "type": "integer", "description": "unix nanoseconds" }, "signature": { "type": "string", "description": "ed25519 signature by `from` over the canonical envelope bytes, hex." }, "pow_nonce": { "type": "integer" } } }, "ChatMessageList": { "type": "array", "items": { "$ref": "#/components/schemas/ChatMessage" } }, "ChatChallenge": { "type": "object", "description": "A single-use challenge. Sign sha256(\"xe/chat-read-auth/v1\\0\" || challenge) with the account key and pass account, pub_key, challenge and sig to the chat read endpoints.", "properties": { "challenge": { "type": "string" } }, "additionalProperties": true }, "ChatContactList": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "NodeInfo": { "type": "object", "description": "Node identity, version, network and peers.", "properties": { "network": { "type": "string", "examples": [ "testnet-0001" ] }, "version": { "type": "string" }, "peer_id": { "type": "string" }, "peers": { "type": "array", "items": { "type": "object", "additionalProperties": true } } }, "additionalProperties": true }, "PendingSendList": { "type": "array", "description": "Send blocks whose receive has not yet been published.", "items": { "$ref": "#/components/schemas/Block" } }, "Frontiers": { "type": "object", "description": "Account address → hash of the newest block on that account chain.", "additionalProperties": { "type": "string", "pattern": "^[0-9a-f]{64}$", "description": "32 bytes, lower-case hex (64 characters)." } }, "Delegation": { "type": "object", "description": "Representative address → delegated vote weight in micro-XE.", "additionalProperties": { "type": "integer", "minimum": 0, "description": "Amount in micro-units. 1 XE = 1 XUSD = 1,000,000 micro-units; every amount, balance and weight in the API is an integer micro-unit count." } }, "Conflict": { "type": "object", "description": "Two or more blocks claiming the same `previous` on one account chain.", "properties": { "account": { "type": "string", "pattern": "^[0-9a-f]{64}$", "description": "Account address: sha256(\"xe/account/v1\" || ed25519 public key), lower-case hex." } }, "additionalProperties": true }, "ConflictList": { "type": "array", "items": { "$ref": "#/components/schemas/Conflict" } }, "LeaseRequest": { "type": "object", "description": "Operator-only: asks the node to build, sign and escrow a lease from its own wallet.", "required": [ "vcpus", "memory_mb", "disk_gb", "duration", "access_pub_key" ], "properties": { "vcpus": { "type": "integer", "minimum": 1 }, "memory_mb": { "type": "integer", "minimum": 1 }, "disk_gb": { "type": "integer", "minimum": 1 }, "duration": { "type": "integer", "minimum": 1, "description": "Lease duration in seconds." }, "access_pub_key": { "type": "string", "description": "Hex ed25519 public key used to authenticate VM access (SSH, TCP tunnel)." } } }, "AttestationRequest": { "type": "object", "required": [ "lease_hash" ], "properties": { "lease_hash": { "type": "string", "pattern": "^[0-9a-f]{64}$", "description": "Hash of an accepted lease block." } } }, "Attestation": { "type": "object", "description": "A timekeeper attestation for a lease.", "additionalProperties": true }, "SendBlock": { "type": "object", "description": "Moves `amount` of `asset` from `account` to `destination`. The destination must differ from the sending account.", "required": [ "type", "account", "previous", "balance", "timestamp", "asset", "hash", "pow_nonce", "signature", "destination", "amount" ], "properties": { "type": { "type": "string", "const": "send" }, "account": { "type": "string", "pattern": "^[0-9a-f]{64}$", "description": "Account address: sha256(\"xe/account/v1\" || ed25519 public key), lower-case hex." }, "previous": { "type": "string", "description": "Hash of the previous block on this account chain, or \"0\" for the first block." }, "balance": { "type": "integer", "minimum": 0, "description": "Post-block balance of `asset` on this account, in micro-units." }, "timestamp": { "type": "integer", "description": "Block time as unix nanoseconds." }, "asset": { "type": "string", "enum": [ "XE", "XUSD" ], "description": "Asset code. XE is the native asset and the only one that carries vote weight; XUSD is specified but not issued on this testnet yet." }, "hash": { "type": "string", "pattern": "^[0-9a-f]{64}$", "description": "sha256 of the block content, hex." }, "pow_nonce": { "type": "integer", "description": "Proof-of-work nonce satisfying the block difficulty (DefaultDifficulty 0xfffff80000000000, roughly one second of work)." }, "destination": { "type": "string", "pattern": "^[0-9a-f]{64}$", "description": "Receiving account address." }, "amount": { "type": "integer", "minimum": 0, "description": "Amount in micro-units. 1 XE = 1 XUSD = 1,000,000 micro-units; every amount, balance and weight in the API is an integer micro-unit count." }, "signature": { "type": "string", "description": "ed25519 signature over the canonical block bytes, hex." } } }, "ReceiveBlock": { "type": "object", "description": "Claims a pending send. `source` is the hash of the send block being received.", "required": [ "type", "account", "previous", "balance", "timestamp", "asset", "hash", "pow_nonce", "signature", "source" ], "properties": { "type": { "type": "string", "const": "receive" }, "account": { "type": "string", "pattern": "^[0-9a-f]{64}$", "description": "Account address: sha256(\"xe/account/v1\" || ed25519 public key), lower-case hex." }, "previous": { "type": "string", "description": "Hash of the previous block on this account chain, or \"0\" for the first block." }, "balance": { "type": "integer", "minimum": 0, "description": "Post-block balance of `asset` on this account, in micro-units." }, "timestamp": { "type": "integer", "description": "Block time as unix nanoseconds." }, "asset": { "type": "string", "enum": [ "XE", "XUSD" ], "description": "Asset code. XE is the native asset and the only one that carries vote weight; XUSD is specified but not issued on this testnet yet." }, "hash": { "type": "string", "pattern": "^[0-9a-f]{64}$", "description": "sha256 of the block content, hex." }, "pow_nonce": { "type": "integer", "description": "Proof-of-work nonce satisfying the block difficulty (DefaultDifficulty 0xfffff80000000000, roughly one second of work)." }, "source": { "type": "string", "pattern": "^[0-9a-f]{64}$", "description": "Hash of the pending send block." }, "signature": { "type": "string", "description": "ed25519 signature over the canonical block bytes, hex." } } }, "LeaseBlock": { "type": "object", "description": "Escrows XUSD to a provider for a VM with the requested resources.", "required": [ "type", "account", "previous", "balance", "timestamp", "asset", "hash", "pow_nonce", "signature", "destination", "amount", "vcpus", "memory_mb", "disk_gb", "duration", "access_pub_key" ], "properties": { "type": { "type": "string", "const": "lease" }, "account": { "type": "string", "pattern": "^[0-9a-f]{64}$", "description": "Account address: sha256(\"xe/account/v1\" || ed25519 public key), lower-case hex." }, "previous": { "type": "string", "description": "Hash of the previous block on this account chain, or \"0\" for the first block." }, "balance": { "type": "integer", "minimum": 0, "description": "Post-block balance of `asset` on this account, in micro-units." }, "timestamp": { "type": "integer", "description": "Block time as unix nanoseconds." }, "asset": { "type": "string", "enum": [ "XE", "XUSD" ], "description": "Asset code. XE is the native asset and the only one that carries vote weight; XUSD is specified but not issued on this testnet yet." }, "hash": { "type": "string", "pattern": "^[0-9a-f]{64}$", "description": "sha256 of the block content, hex." }, "pow_nonce": { "type": "integer", "description": "Proof-of-work nonce satisfying the block difficulty (DefaultDifficulty 0xfffff80000000000, roughly one second of work)." }, "destination": { "type": "string", "pattern": "^[0-9a-f]{64}$", "description": "Provider address." }, "amount": { "type": "integer", "minimum": 0, "description": "XUSD escrowed for the lease, in micro-units." }, "vcpus": { "type": "integer", "minimum": 1 }, "memory_mb": { "type": "integer", "minimum": 1 }, "disk_gb": { "type": "integer", "minimum": 1 }, "duration": { "type": "integer", "minimum": 1, "description": "Lease duration in seconds." }, "access_pub_key": { "type": "string", "description": "Hex ed25519 public key used to authenticate VM access (SSH, TCP tunnel)." }, "signature": { "type": "string", "description": "ed25519 signature over the canonical block bytes, hex." } } }, "LeaseAcceptBlock": { "type": "object", "description": "Provider accepts a lease.", "required": [ "type", "account", "previous", "balance", "timestamp", "asset", "hash", "pow_nonce", "signature", "source" ], "properties": { "type": { "type": "string", "const": "lease_accept" }, "account": { "type": "string", "pattern": "^[0-9a-f]{64}$", "description": "Account address: sha256(\"xe/account/v1\" || ed25519 public key), lower-case hex." }, "previous": { "type": "string", "description": "Hash of the previous block on this account chain, or \"0\" for the first block." }, "balance": { "type": "integer", "minimum": 0, "description": "Post-block balance of `asset` on this account, in micro-units." }, "timestamp": { "type": "integer", "description": "Block time as unix nanoseconds." }, "asset": { "type": "string", "enum": [ "XE", "XUSD" ], "description": "Asset code. XE is the native asset and the only one that carries vote weight; XUSD is specified but not issued on this testnet yet." }, "hash": { "type": "string", "pattern": "^[0-9a-f]{64}$", "description": "sha256 of the block content, hex." }, "pow_nonce": { "type": "integer", "description": "Proof-of-work nonce satisfying the block difficulty (DefaultDifficulty 0xfffff80000000000, roughly one second of work)." }, "source": { "type": "string", "pattern": "^[0-9a-f]{64}$", "description": "Hash of the lease block this block refers to." }, "signature": { "type": "string", "description": "ed25519 signature over the canonical block bytes, hex." } } }, "LeaseSettleBlock": { "type": "object", "description": "Provider settles a lease and receives the escrow.", "required": [ "type", "account", "previous", "balance", "timestamp", "asset", "hash", "pow_nonce", "signature", "source" ], "properties": { "type": { "type": "string", "const": "lease_settle" }, "account": { "type": "string", "pattern": "^[0-9a-f]{64}$", "description": "Account address: sha256(\"xe/account/v1\" || ed25519 public key), lower-case hex." }, "previous": { "type": "string", "description": "Hash of the previous block on this account chain, or \"0\" for the first block." }, "balance": { "type": "integer", "minimum": 0, "description": "Post-block balance of `asset` on this account, in micro-units." }, "timestamp": { "type": "integer", "description": "Block time as unix nanoseconds." }, "asset": { "type": "string", "enum": [ "XE", "XUSD" ], "description": "Asset code. XE is the native asset and the only one that carries vote weight; XUSD is specified but not issued on this testnet yet." }, "hash": { "type": "string", "pattern": "^[0-9a-f]{64}$", "description": "sha256 of the block content, hex." }, "pow_nonce": { "type": "integer", "description": "Proof-of-work nonce satisfying the block difficulty (DefaultDifficulty 0xfffff80000000000, roughly one second of work)." }, "source": { "type": "string", "pattern": "^[0-9a-f]{64}$", "description": "Hash of the lease block this block refers to." }, "signature": { "type": "string", "description": "ed25519 signature over the canonical block bytes, hex." } } }, "LeaseCancelBlock": { "type": "object", "description": "Consumer cancels a lease. Only the consumer can cancel, and only before the lease is accepted.", "required": [ "type", "account", "previous", "balance", "timestamp", "asset", "hash", "pow_nonce", "signature", "source" ], "properties": { "type": { "type": "string", "const": "lease_cancel" }, "account": { "type": "string", "pattern": "^[0-9a-f]{64}$", "description": "Account address: sha256(\"xe/account/v1\" || ed25519 public key), lower-case hex." }, "previous": { "type": "string", "description": "Hash of the previous block on this account chain, or \"0\" for the first block." }, "balance": { "type": "integer", "minimum": 0, "description": "Post-block balance of `asset` on this account, in micro-units." }, "timestamp": { "type": "integer", "description": "Block time as unix nanoseconds." }, "asset": { "type": "string", "enum": [ "XE", "XUSD" ], "description": "Asset code. XE is the native asset and the only one that carries vote weight; XUSD is specified but not issued on this testnet yet." }, "hash": { "type": "string", "pattern": "^[0-9a-f]{64}$", "description": "sha256 of the block content, hex." }, "pow_nonce": { "type": "integer", "description": "Proof-of-work nonce satisfying the block difficulty (DefaultDifficulty 0xfffff80000000000, roughly one second of work)." }, "source": { "type": "string", "pattern": "^[0-9a-f]{64}$", "description": "Hash of the lease block this block refers to." }, "signature": { "type": "string", "description": "ed25519 signature over the canonical block bytes, hex." } } }, "LeaseForceSettleBlock": { "type": "object", "description": "Consumer recovers escrow from an expired lease the provider never settled.", "required": [ "type", "account", "previous", "balance", "timestamp", "asset", "hash", "pow_nonce", "signature", "source" ], "properties": { "type": { "type": "string", "const": "lease_force_settle" }, "account": { "type": "string", "pattern": "^[0-9a-f]{64}$", "description": "Account address: sha256(\"xe/account/v1\" || ed25519 public key), lower-case hex." }, "previous": { "type": "string", "description": "Hash of the previous block on this account chain, or \"0\" for the first block." }, "balance": { "type": "integer", "minimum": 0, "description": "Post-block balance of `asset` on this account, in micro-units." }, "timestamp": { "type": "integer", "description": "Block time as unix nanoseconds." }, "asset": { "type": "string", "enum": [ "XE", "XUSD" ], "description": "Asset code. XE is the native asset and the only one that carries vote weight; XUSD is specified but not issued on this testnet yet." }, "hash": { "type": "string", "pattern": "^[0-9a-f]{64}$", "description": "sha256 of the block content, hex." }, "pow_nonce": { "type": "integer", "description": "Proof-of-work nonce satisfying the block difficulty (DefaultDifficulty 0xfffff80000000000, roughly one second of work)." }, "source": { "type": "string", "pattern": "^[0-9a-f]{64}$", "description": "Hash of the lease block this block refers to." }, "signature": { "type": "string", "description": "ed25519 signature over the canonical block bytes, hex." } } }, "MultisigOpenBlock": { "type": "object", "description": "Opens a multisig account. `signatures` replaces the single `signature`.", "required": [ "type", "account", "previous", "balance", "timestamp", "asset", "hash", "pow_nonce", "signatures", "keyset" ], "properties": { "type": { "type": "string", "const": "multisig_open" }, "account": { "type": "string", "pattern": "^[0-9a-f]{64}$", "description": "Account address: sha256(\"xe/account/v1\" || ed25519 public key), lower-case hex." }, "previous": { "type": "string", "description": "Hash of the previous block on this account chain, or \"0\" for the first block." }, "balance": { "type": "integer", "minimum": 0, "description": "Post-block balance of `asset` on this account, in micro-units." }, "timestamp": { "type": "integer", "description": "Block time as unix nanoseconds." }, "asset": { "type": "string", "enum": [ "XE", "XUSD" ], "description": "Asset code. XE is the native asset and the only one that carries vote weight; XUSD is specified but not issued on this testnet yet." }, "hash": { "type": "string", "pattern": "^[0-9a-f]{64}$", "description": "sha256 of the block content, hex." }, "pow_nonce": { "type": "integer", "description": "Proof-of-work nonce satisfying the block difficulty (DefaultDifficulty 0xfffff80000000000, roughly one second of work)." }, "keyset": { "type": "object", "required": [ "keys", "threshold" ], "properties": { "keys": { "type": "array", "items": { "type": "string", "pattern": "^[0-9a-f]{64}$", "description": "Account address: sha256(\"xe/account/v1\" || ed25519 public key), lower-case hex." }, "minItems": 1 }, "threshold": { "type": "integer", "minimum": 1 } } }, "signatures": { "type": "array", "description": "One entry per signing key; at least `threshold` are required.", "items": { "type": "object", "required": [ "public_key", "signature" ], "properties": { "public_key": { "type": "string", "description": "Signer's ed25519 public key, hex." }, "signature": { "type": "string", "description": "ed25519 signature over the canonical block bytes, hex." } } } } } }, "MultisigUpdateBlock": { "type": "object", "description": "Rotates a multisig keyset; signed by the current keyset's threshold.", "required": [ "type", "account", "previous", "balance", "timestamp", "asset", "hash", "pow_nonce", "signatures", "keyset" ], "properties": { "type": { "type": "string", "const": "multisig_update" }, "account": { "type": "string", "pattern": "^[0-9a-f]{64}$", "description": "Account address: sha256(\"xe/account/v1\" || ed25519 public key), lower-case hex." }, "previous": { "type": "string", "description": "Hash of the previous block on this account chain, or \"0\" for the first block." }, "balance": { "type": "integer", "minimum": 0, "description": "Post-block balance of `asset` on this account, in micro-units." }, "timestamp": { "type": "integer", "description": "Block time as unix nanoseconds." }, "asset": { "type": "string", "enum": [ "XE", "XUSD" ], "description": "Asset code. XE is the native asset and the only one that carries vote weight; XUSD is specified but not issued on this testnet yet." }, "hash": { "type": "string", "pattern": "^[0-9a-f]{64}$", "description": "sha256 of the block content, hex." }, "pow_nonce": { "type": "integer", "description": "Proof-of-work nonce satisfying the block difficulty (DefaultDifficulty 0xfffff80000000000, roughly one second of work)." }, "keyset": { "type": "object", "required": [ "keys", "threshold" ], "properties": { "keys": { "type": "array", "items": { "type": "string", "pattern": "^[0-9a-f]{64}$", "description": "Account address: sha256(\"xe/account/v1\" || ed25519 public key), lower-case hex." }, "minItems": 1 }, "threshold": { "type": "integer", "minimum": 1 } } }, "signatures": { "type": "array", "description": "One entry per signing key; at least `threshold` are required.", "items": { "type": "object", "required": [ "public_key", "signature" ], "properties": { "public_key": { "type": "string", "description": "Signer's ed25519 public key, hex." }, "signature": { "type": "string", "description": "ed25519 signature over the canonical block bytes, hex." } } } } } }, "BurnBlock": { "type": "object", "description": "Permanently destroys `amount` of XE (XE only).", "required": [ "type", "account", "previous", "balance", "timestamp", "asset", "hash", "pow_nonce", "signature", "amount" ], "properties": { "type": { "type": "string", "const": "burn" }, "account": { "type": "string", "pattern": "^[0-9a-f]{64}$", "description": "Account address: sha256(\"xe/account/v1\" || ed25519 public key), lower-case hex." }, "previous": { "type": "string", "description": "Hash of the previous block on this account chain, or \"0\" for the first block." }, "balance": { "type": "integer", "minimum": 0, "description": "Post-block balance of `asset` on this account, in micro-units." }, "timestamp": { "type": "integer", "description": "Block time as unix nanoseconds." }, "asset": { "type": "string", "enum": [ "XE", "XUSD" ], "description": "Asset code. XE is the native asset and the only one that carries vote weight; XUSD is specified but not issued on this testnet yet." }, "hash": { "type": "string", "pattern": "^[0-9a-f]{64}$", "description": "sha256 of the block content, hex." }, "pow_nonce": { "type": "integer", "description": "Proof-of-work nonce satisfying the block difficulty (DefaultDifficulty 0xfffff80000000000, roughly one second of work)." }, "amount": { "type": "integer", "minimum": 0, "description": "Amount in micro-units. 1 XE = 1 XUSD = 1,000,000 micro-units; every amount, balance and weight in the API is an integer micro-unit count." }, "signature": { "type": "string", "description": "ed25519 signature over the canonical block bytes, hex." } } }, "MintBlock": { "type": "object", "description": "Mints XUSD. Only accounts listed under the state chain's `sys.minter` key are authorized. XUSD is not issued on this testnet today.", "required": [ "type", "account", "previous", "balance", "timestamp", "asset", "hash", "pow_nonce", "signature", "amount" ], "properties": { "type": { "type": "string", "const": "mint" }, "account": { "type": "string", "pattern": "^[0-9a-f]{64}$", "description": "Account address: sha256(\"xe/account/v1\" || ed25519 public key), lower-case hex." }, "previous": { "type": "string", "description": "Hash of the previous block on this account chain, or \"0\" for the first block." }, "balance": { "type": "integer", "minimum": 0, "description": "Post-block balance of `asset` on this account, in micro-units." }, "timestamp": { "type": "integer", "description": "Block time as unix nanoseconds." }, "asset": { "type": "string", "enum": [ "XE", "XUSD" ], "description": "Asset code. XE is the native asset and the only one that carries vote weight; XUSD is specified but not issued on this testnet yet." }, "hash": { "type": "string", "pattern": "^[0-9a-f]{64}$", "description": "sha256 of the block content, hex." }, "pow_nonce": { "type": "integer", "description": "Proof-of-work nonce satisfying the block difficulty (DefaultDifficulty 0xfffff80000000000, roughly one second of work)." }, "amount": { "type": "integer", "minimum": 0, "description": "Amount in micro-units. 1 XE = 1 XUSD = 1,000,000 micro-units; every amount, balance and weight in the API is an integer micro-unit count." }, "signature": { "type": "string", "description": "ed25519 signature over the canonical block bytes, hex." } } } }, "headers": { "X-API-Version": { "description": "Major API version that served the request (currently 1). Unversioned /api paths report the version they resolved to.", "schema": { "type": "integer", "example": 1 } }, "RateLimit-Policy": { "description": "Rate-limit policy in force for this request class (draft-ietf-httpapi-ratelimit-headers): \"name\";q=;w=.", "schema": { "type": "string", "example": "\"read\";q=1000;w=5" } }, "RateLimit": { "description": "Current quota state (draft-ietf-httpapi-ratelimit-headers): \"name\";r=;t=. Throttle when r approaches 0.", "schema": { "type": "string", "example": "\"read\";r=998;t=4" } }, "RateLimit-Limit": { "description": "Quota for the window (legacy RateLimit-* form of RateLimit-Policy q).", "schema": { "type": "integer", "example": 1000 } }, "RateLimit-Remaining": { "description": "Requests remaining in the window (legacy form of RateLimit r).", "schema": { "type": "integer", "example": 998 } }, "RateLimit-Reset": { "description": "Seconds until the window resets (legacy form of RateLimit t).", "schema": { "type": "integer", "example": 4 } }, "Retry-After": { "description": "Seconds to wait before retrying. Sent with every 429.", "schema": { "type": "integer", "example": 4 } }, "Deprecation": { "description": "Present only on deprecated endpoints or versions (RFC 9745): the date deprecation took effect, as @. Accompanied by Sunset and a Link rel=\"deprecation\".", "schema": { "type": "string", "example": "@1767225600" } }, "Sunset": { "description": "Present only on deprecated endpoints or versions (RFC 8594): the HTTP-date after which the endpoint is removed, at least 90 days after Deprecation.", "schema": { "type": "string", "example": "Wed, 01 Apr 2026 00:00:00 GMT" } } }, "responses": { "400": { "description": "Bad request: malformed JSON, a body that fails the operation's schema, or an unsigned/invalid block. `error.code` is `bad_request`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing credentials for a gated endpoint. `error.code` is `unauthorized`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Credentials present but not sufficient (wrong admin token, failed ownership proof). `error.code` is `forbidden`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No such route or object (unknown path, unknown account, or a lease-scoped lookup while the testnet has no leases). `error.code` is `not_found`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit exceeded for the request class. Back off for Retry-After seconds; RateLimit reports the window. Policies: read 1000/5s, write 50/5s. `error.code` is `rate_limited`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" }, "Retry-After": { "$ref": "#/components/headers/Retry-After" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "The node failed while handling the request. `error.code` is `upstream_error`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "502": { "description": "The node could not be reached or answered with a non-HTTP error. `error.code` is `upstream_unavailable`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "The node is temporarily unavailable. `error.code` is `upstream_unavailable`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "504": { "description": "The node did not answer in time. `error.code` is `upstream_timeout`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "default": { "description": "Any other error. The node's own JSON error bodies pass through unchanged; every non-JSON error is wrapped in the `Error` shape by the test.network proxy, so a 4xx/5xx body is always JSON with a machine-readable `error.code`.", "headers": { "X-API-Version": { "$ref": "#/components/headers/X-API-Version" }, "RateLimit-Policy": { "$ref": "#/components/headers/RateLimit-Policy" }, "RateLimit": { "$ref": "#/components/headers/RateLimit" }, "RateLimit-Limit": { "$ref": "#/components/headers/RateLimit-Limit" }, "RateLimit-Remaining": { "$ref": "#/components/headers/RateLimit-Remaining" }, "RateLimit-Reset": { "$ref": "#/components/headers/RateLimit-Reset" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "securitySchemes": { "adminToken": { "type": "http", "scheme": "bearer", "description": "Operator-only endpoints take `Authorization: Bearer `. The token belongs to the node operator; the public London node does not hand it out." }, "ownershipProof": { "type": "apiKey", "in": "query", "name": "sig", "description": "Chat reads prove account ownership with query parameters: `account`, `pub_key`, a single-use `challenge` from GET /chat/auth/challenge, and `sig` = ed25519 signature over sha256(\"xe/chat-read-auth/v1\\0\" || challenge) by the account key." }, "leaseAccessSignature": { "type": "apiKey", "in": "header", "name": "X-Signature", "description": "ed25519 signature over the 32 decoded lease-hash bytes with the lease's access key." } } }, "x-versioning": { "scheme": "url-path", "current": "v1", "versionedBase": "https://test.network/api/v1", "unversionedBase": "https://test.network/api", "docs": "https://test.network/developers#versioning", "rules": [ "The version is the first path segment after /api: https://test.network/api/v1/node. Every response also carries X-API-Version: 1.", "Unversioned paths (https://test.network/api/node) are an alias for the current major version and follow it when it changes; integrations that must not move pin the versioned path.", "Within a major version changes are additive only: new endpoints, new optional fields, new enum values. Clients must ignore fields they do not know. Removing or renaming a field, changing a type, or changing an endpoint's meaning happens only in a new major version.", "When a new major version ships, the previous one keeps working for at least 180 days.", "Deprecated endpoints and versions are announced in the OpenAPI document (`deprecated: true`) and on every response with a Deprecation header (RFC 9745, `Deprecation: @`), a Sunset header (RFC 8594, HTTP-date of removal) and a `Link: ; rel=\"deprecation\"` pointing at the migration notes. Sunset is never less than 90 days after the Deprecation date.", "Testnet wipes reset ledger state, not the API: identifiers change, the contract does not.", "The direct node endpoint https://ldn.test.network/api is unversioned and tracks the node release; the versioned contract is the https://test.network/api surface described by https://test.network/openapi.json." ] }, "x-rate-limits": { "docs": "https://test.network/developers#rate-limits", "scope": "per client IP, per request class", "policies": [ { "name": "read", "quota": 1000, "windowSeconds": 5, "description": "GET and HEAD requests: 1,000 per 5 seconds per client IP (200/s sustained)." }, { "name": "write", "quota": 50, "windowSeconds": 5, "description": "POST, PUT, PATCH and DELETE requests: 50 per 5 seconds per client IP (10/s sustained)." } ], "headers": [ "RateLimit-Policy", "RateLimit", "RateLimit-Limit", "RateLimit-Remaining", "RateLimit-Reset" ], "onExceeded": "429 with Retry-After and an Error body (code rate_limited)" } }