REST API reference

Full-node REST API for the Arrekta post-quantum, multi-asset blockchain.

Stability: v1 is frozen. Within v1 only additive changes are made (new optional fields, new endpoints); clients must ignore unknown fields. Hashes are lowercase hex; amounts are decimal strings of base units; errors are RFC 9457 problem+json with a stable code. Both node implementations (Rust and the Python reference) serve this contract.

Caching: every successful GET /v1/… response except the event stream carries a weak ETag; send it back in If-None-Match and an unchanged resource answers 304 Not Modified with no body.

Default local base URL: http://127.0.0.1:28332 (regtest API port). Through the platform gateway the same routes are under /v1/* with an X-API-Key header.

Groups

Conventions

• Amounts are decimal strings in base units (1 ARRK = 10⁸ base units), so they survive JSON number limits.
• Hashes are lowercase hex in natural byte order; Arrekta never byte-reverses hashes (merged-mining RPC values are the documented exception).
• Raw objects (transactions, blocks, checkpoints) are posted as hex in a {"hex": …} body.
• The merged-mining JSON-RPC endpoint POST /rpc is not part of the OpenAPI document; see Merged mining for pools.

Error model

Errors are RFC 9457 problem details, media type application/problem+json, with a stable machine-readable code. Branch on code, never on title or detail.

{
  "type": "https://docs.arrekta.com/errors/missing-inputs",
  "title": "consensus rule violated",
  "status": 422,
  "code": "missing-inputs",
  "detail": "…"
}

Problem

RFC 9457 problem details (media type application/problem+json).

Unknown fields may be added within v1; clients must ignore them.

Every code has a page in the error code reference, and the type URI resolves to it. The SDKs map problems to ArrektaError { status, code, title, detail } (see TypeScript errors and Python errors).