eth_subscribe

Updated on 2024-11-14 GMT+08:00

View PDF

Introduction

This API creates a new subscription for particular events. The node returns a subscription ID. For each event that matches the subscription, a notification with relevant data is sent together with the subscription ID. It consumes 120 CUs.

Parameter Description

Parameter	Type	Description
Event type	String	The type of event to listen to.
Optional parameters	String	Optional parameters to include to describe the type of event to listen to (e.g. newHeads, newPendingTransactions, logs).

Return Value

While the subscription is active, you will receive events formatted as an object described below:

Event Object:

jsonrpc: always 2.0.
method: always eth_subscription.
params: an object with the following fields:
- subscription: the subscription ID returned by the API that creates this subscription. This ID will be attached to all received events and can also be used to cancel the subscription using eth_unsubscribe.
- result: an object whose contents vary depending on the event type.

Request

wscat -c wss://your-http-endpoint/v1/<API-KEY> -x '{"jsonrpc":"2.0", "id": 1, "method": "eth_subscribe", "params": ["logs"]}'

Parent topic: Shared Edition

Previous topic: eth_getBalance

Next topic: eth_unsubscribe

Feedback

Was this page helpful?

Helpful Not helpful

Provide feedback

Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.

The system is busy. Please try again later.

Which of the following issues have you encountered?

Content is inconsistent with the product UI

Unclear descriptions

Lack of examples or code

Incorrect steps

Can't find what I need

Lack of best practices

Feedback (optional)

0/500

Select at least one type of issue, and enter your comments or suggestions.

Enter a maximum of 500 characters.

Submit Cancel

For any further questions, feel free to contact us through the chatbot.

Chatbot