[Filter] klay_subscribe

Creates a new subscription to specific events by using either RPC Pub/Sub over WebSockets or filters over HTTP. It allows clients to wait for events instead of polling for them.

The node will return a subscription id for each subscription created. For each event that matches the subscription, a notification with relevant data is sent together with the subscription id. If a connection is closed, all subscriptions created over the connection are removed.

JSONRPC: klay_subscribe

Request

application/json

Body

method stringrequired

Default value: klay_subscribe

Method name

id int64required

Default value: 1

Request ID, Random or Auto incrementation

jsonrpc stringrequired

Default value: 2.0

JSON-RPC Version (2.0)

params NotificationType[]

Possible values: [newHeads, logs]

A notification type: "newHeads" or "logs"

Responses

200

Return a subscription id when a subscription is created

application/json

Schema

Schema

jsonrpc stringrequired

Default value: 2.0

id int64required

error

object

code int64required

A Number that indicates the error type that occurred. This MUST be an integer.

| code | message | description | |-----|-----|-------| | -32700 | Parse error | invalid JSON was received by the server. An error occurred on the server while parsing the JSON text. | |-32602 | Invalid params | Invalid method parameter(s). |

message string

A String providing a short description of the error. The message SHOULD be limited to a concise single sentence.

data string

A Primitive or Structured value that contains additional information about the error. This may be omitted. The value of this member is defined by the Server (e.g. detailed error information, nested errors etc.).

result hex

A subscription id when a subscription is created. For each event that matches the subscription, a notification with relevant data will be delivered as well.

Example (from schema)

{
  "jsonrpc": "2.0",
  "id": 0,
  "error": {
    "code": -32700,
    "message": "Parse error",
    "data": "string"
  },
  "result": "0xbdab16c8e4ae1b9e6930c78359de3e0e"
}

• curl
• python
• nodejs
• java

• CURL

curl -L -X POST 'http://localhost:8551/klay/filter/subscribe' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "method": "klay_subscribe",
  "id": 1,
  "jsonrpc": "2.0",
  "params": [
    "newHeads"
  ]
}'

Request Collapse all

Base URL

http://localhost:8551

Body

{
  "method": "klay_subscribe",
  "id": 1,
  "jsonrpc": "2.0",
  "params": [
    "newHeads"
  ]
}

ResponseClear

Click the Send API Request button above and see the response here!