Circles API Documentation

Machine-readable specs and interactive docs for all Circles protocol services

JSON-RPC Circles RPC API

40+ JSON-RPC 2.0 methods for querying balances, avatars, profiles, trust relations, events, groups, invitations, and transitive transfer paths.

Interactive Playground openrpc.json

REST Pathfinder API

Compute transitive transfer paths through the Circles trust network. Supports max flow, quantized mode, simulated balances, and debug stages.

Interactive Docs openapi.json Query Builder

Auth Authentication Service

Sign-In with Ethereum (SIWE), passkey registration, JWT issuance, JWKS endpoint, and service-to-service authentication.

Swagger UI openapi.json

REST Referrals API

Invitation links, referral distributions, and at-scale onboarding backend for the Circles protocol.

Swagger UI openapi.json

REST Profile Pinning Service

IPFS profile storage, content pinning, full-text search, and CID resolution. Indexes profiles from on-chain NameRegistry events.

Swagger UI openapi.json

REST Marketplace API

Product catalogs, shopping carts, checkout, order fulfillment, and seller management. Supports Odoo and CodeDispenser adapters.

Swagger UI openapi.json

REST Ethereum JSON-RPC

Standard Ethereum JSON-RPC (eth_*, net_*, web3_*) proxied to Nethermind. Use for block queries, transaction submission, and chain state.

Nethermind Dashboard

Monitoring Grafana

Dashboards for indexer performance, RPC metrics, pathfinder load, cache hit rates, and infrastructure health.

Grafana Dashboard

All specs are machine-readable — use them for client codegen, SDK generation, or AI agent tool discovery.
github.com/aboutcircles