API reference

Cyberd provides a JSON-RPC type API. The HTTP endpoint is served under localhost:20657. WebSockets are the preferred transport for cyberd RPC and are used by applications, such as cyb. The default WebSocket connection endpoint for cyberd is ws://localhost:26657/websocket. There are test endpoints available at https://titan.cybernode.ai/api/ and ws://titan.cybernode.ai/websocket.

Standard Methods

Query Example

Query the HTTP endpoint using curl:

curl --data '{"method":"status","params":[],"id":"1","jsonrpc":"2.0"}' \
-H "Content-Type: application/json" -X POST earth.cybernode.ai:34657

Query ws endpoint from JS:

let websocket = new WebSocket("ws://earth.cybernode.ai:34657/websocket");
websocket.send(JSON.stringify({
  "method":"status",
  "params":[],
  "id":"1",
  "jsonrpc":"2.0"
}));

Method Overview

The following is an overview of the RPC methods and their current status. Click the method name for further detail, such as parameter, and this will return information.

Method Details

Notifications (WebSocket-specific)

Cyberd uses standard JSON-RPC notifications to notify clients of changes rather than requiring clients to poll cyberd for updates. JSON-RPC notifications are a subset of requests, but do not contain an ID. The notification type is categorized by the query params field.

Subscribe Example

Subscribe for new block headers from JS:

 let websocket = new WebSocket("ws://earth.cybernode.ai:34657/websocket");
 websocket.send(JSON.stringify({
   "method": "subscribe",
   "params": ["tm.event='NewBlockHeader'"],
   "id": "1",
   "jsonrpc": "2.0"
 }));

Events Overview

Events Details

NewBlockHeader

CoinsReceived

CoinsSend

СidsLinked

SignedTxCommitted