All URIs are relative to https://rest-canary.onflow.org/v1/
| Method | HTTP request | Description |
|---|---|---|
| SubscribeEventsGet | Get /subscribe_events | Subscribe events |
SubscribeEvents SubscribeEventsGet(ctx, optional) Subscribe events
IMPORTANT NOTE: This is a WebSocket connection, so the ws:// or wss:// schema should be used to subscribe to this endpoint. This endpoint streams on-chain events for all blocks starting at the requested start block, up until the latest available block. Once the latest block is reached, the stream will remain open, and responses will be sent for each new block as it becomes available.
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| optional | *SubscribeEventsApiSubscribeEventsGetOpts | optional parameters | nil if no parameters |
Optional parameters are passed through a pointer to a SubscribeEventsApiSubscribeEventsGetOpts struct
| Name | Type | Description | Notes |
|---|---|---|---|
| startHeight | optional.Interface of BlockHeight | The block height of the events being streamed. Either provide this parameter or `start_block_id` parameter. This parameter is incompatible with `start_block_id` parameter. | |
| startBlockId | optional.Interface of string | The block id of the events being streamed. Either provide this parameter or `start_height` parameter. This parameter is incompatible with `start_height` parameter. | |
| heartbeatInterval | optional.String | Interval in block heights at which the server should return a heartbeat message to the client. | |
| eventTypes | optional.Interface of []string | A comma-separated list of events type to include. | |
| addresses | optional.Interface of []string | A comma-separated list of addresses who's events should be included. | |
| contracts | optional.Interface of []string | A comma-separated list of contracts who's events should be included. |
No authorization required
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]