Skip to content

API Reference

Complete API documentation for Calimero nodes and clients.

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

  • 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

Common methods:

  • context.create - Create a new context
  • context.list - List all contexts
  • context.call - Call a method on a context
  • app.install - Install an application
  • identity.create - Create an identity

Authentication

Most endpoints require JWT authentication. See Identity for authentication flows.

Complete Documentation

For complete API documentation, including all methods, request/response formats, and error codes:

→ core/crates/server/README.md

Client SDKs

For easier client development, use the official SDKs:

CLI Reference

For command-line operations, see meroctl CLI.