WebSocket API

This document provides a technical overview of the Noderr Protocol's WebSocket API, which is designed for applications that require real-time data streaming and event subscriptions.

Endpoint

The WebSocket API is accessible via the following endpoint:

wss://api.noderr.xyz/ws

Connection

To establish a connection with the WebSocket API, a client must initiate a WebSocket handshake with the endpoint. Once the connection is established, the client can send and receive JSON-formatted messages.

Authentication

All WebSocket connections must be authenticated. After establishing a connection, the client must send an authentication message containing a valid API key:

{
"type": "auth",
"token": "YOUR_API_KEY"
}

Subscriptions

Once authenticated, a client can subscribe to various channels to receive real-time updates. The following is an example of a subscription request to the prices channel:

{
"type": "subscribe",
"channel": "prices",
"symbols": ["ETH", "BTC", "USDC"]
}

Upon successful subscription, the client will begin to receive real-time updates for the specified symbols. For a complete list of available channels and subscription options, please refer to our interactive API documentation.