API Reference
Complete API documentation for Calimero nodes and clients.
Server API
Section titled “Server API”Calimero nodes expose a JSON-RPC API over HTTP with WebSocket support for real-time subscriptions.
Base URL: http://localhost:2528 (default)
Endpoints
Section titled “Endpoints”- JSON-RPC:
/jsonrpc- Standard JSON-RPC 2.0 calls - WebSocket:
/ws- Real-time subscriptions - SSE:
/sse- Server-Sent Events for subscriptions - Admin API:
/admin-api/- Node management endpoints
API Methods
Section titled “API Methods”Common methods:
context.create- Create a new contextcontext.list- List all contextscontext.call- Call a method on a contextapp.install- Install an applicationidentity.create- Create an identity
Authentication
Section titled “Authentication”Most endpoints require JWT authentication. See Identity for authentication flows.
Complete Documentation
Section titled “Complete Documentation”For complete API documentation, including all methods, request/response formats, and error codes:
→ core/crates/server/README.md
Client SDKs
Section titled “Client SDKs”For easier client development, use the official SDKs:
- JavaScript/TypeScript:
@calimero/client- See Client SDKs - Python:
calimero-client-py- See Client SDKs - Rust:
core/crates/client
CLI Reference
Section titled “CLI Reference”For command-line operations, see meroctl CLI.
Related Topics
Section titled “Related Topics”- Tools & APIs - SDKs and developer tools
- Core Concepts - Architecture and concepts
- Running Nodes - Node setup