API Reference

Omne nodes expose a JSON-RPC 2.0 API over HTTP and WebSocket transports. This is the same API surface the SDK communicates with internally.

Endpoint

By default, omne-node listens on the address specified by --bind:

http://<bind-address>:<port>
ws://<bind-address>:<port>

Example: http://127.0.0.1:9944

Transport

HTTP

Standard JSON-RPC over HTTP POST:

curl -X POST http://127.0.0.1:9944 \
  -H "Content-Type: application/json" \
  -d '{"jsonrpc":"2.0","method":"omne_blockNumber","params":[],"id":1}'

WebSocket

Persistent connection for subscriptions and real-time events:

const client = new OmneClient('ws://127.0.0.1:9944')
await client.connect()

Authentication

When deployment guardrails are enabled, requests require:

• Authorization: Bearer <token> header
• X-Omne-Nonce header (unique per request, prevents replay)

The SDK and CLI handle this automatically when OMNE_RPC_TOKEN is set.

export OMNE_RPC_TOKEN="your-api-token"

Rate limiting

Endpoints support per-key rate limiting. When exceeded, responses include:

Rate-limited requests return HTTP 429.

Non-RPC endpoints

Method reference

See JSON-RPC Methods for the complete method listing.