The single WebSocket endpoint over which all relay JSON-RPC messages
flow. Each direction is a stream of JSON-RPC 2.0 frames; correlation
uses the standard JSON-RPC `id` field.
Messages sent from client (dApp or wallet) to the relay.
subscribe
relayToClient
Messages delivered from the relay to a client.
Messages
irn_publish
Publish an encrypted message to a topic.
Content-Type:
irn_subscribe
Subscribe to a single topic; returns a subscriptionId.
Content-Type:
irn_unsubscribe
Unsubscribe a previous subscription on a topic.
Content-Type:
irn_batchSubscribe
Subscribe to many topics in one call.
Content-Type:
irn_batchUnsubscribe
Unsubscribe many (topic, subscriptionId) pairs at once.
Content-Type:
irn_subscription_response
Client acknowledgement that the pushed message was received.
Content-Type:
irn_subscription
Server-initiated delivery of a published message to a subscribed
client. The `data.message` payload is an encrypted envelope whose
plaintext, once decrypted with the pairing/session symmetric key, is
Content-Type:
irn_publish_response
irn_publish (response)
Content-Type:
irn_subscribe_response
irn_subscribe (response)
Content-Type:
irn_unsubscribe_response
irn_unsubscribe (response)
Content-Type:
irn_batchSubscribe_response
irn_batchSubscribe (response)
Content-Type:
irn_batchUnsubscribe_response
irn_batchUnsubscribe (response)
Content-Type:
About AsyncAPI
The AsyncAPI specification describes event-driven APIs the way OpenAPI describes request/response APIs. A channel is the named pipe — a webhook URL, a Kafka topic, a WebSocket route, an MQTT subject — that producers and consumers publish or subscribe to. Each channel carries one or more messages with structured payloads, and an operation declares whether a given party sends or receives on that channel.
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.