API introduction

Start quickly with SPECTER API route groups, integration flow, and operational boundaries

Launch app

Use the hosted interface while you test endpoint payloads.

Run quickstart

Execute a full create -> publish -> scan loop in minutes.

View API auth and errors

Confirm error shapes and production hardening requirements.

Base URL

• Local default: http://localhost:3001

Route groups

Integration path

1. Verify server health

   Call GET /health and confirm status: "ok" before sending write requests.

2. Generate recipient keys

   Call POST /api/v1/keys/generate and securely store secret fields.

3. Create and publish stealth announcement

   Use POST /api/v1/stealth/create, then publish with POST /api/v1/registry/announcements.

4. Scan for discoveries

   Use POST /api/v1/stealth/scan with your viewing/spending keys and optional filters.

Health check examples

cURL

curl -s http://localhost:3001/health | jq .

JavaScript

const res = await fetch("http://localhost:3001/health");
const data = await res.json();
console.log(data.status, data.version);

Health response schema

status · string · required

Server status string ("ok" when healthy).

version · string · required

Current backend package version.

uptime_seconds · integer · required

Elapsed process uptime in seconds.

announcements_count · integer · required

Current in-memory registry count.

use_testnet · boolean · required

true when backend is configured for Sepolia/testnet.

Operational boundaries

Authentication

No HTTP auth middleware is implemented in current routes.

Rate limiting

No API-level rate limiter is implemented in current server code.

CORS

CORS allows any origin, method, and header (CorsLayer::allow_origin(Any) etc.).

Run production traffic behind your own gateway controls for auth, rate limiting, and abuse protection.