blockSubscribe

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "blockSubscribe",
  "params": [
    "all",
    {
      "commitment": "confirmed",
      "transactionDetails": "none",
      "showRewards": false
    }
  ]
}

{
  "jsonrpc": "2.0",
  "error": {
    "code": -32601,
    "message": "Method not found"
  },
  "id": 1
}

Subscribe to receive notification anytime a new block is confirmed or finalized.

On ThorNode

The upstream node does not enable block subscriptions; the request returns -32601 Method not found. Use Yellowstone gRPC or poll getBlock.

Parameters

array

required

Hide properties

string | object

required

Filter criteria for the logs to receive results by account type; currently supported:

all - include all transactions in block
A JSON object with the following field:
- mentionsAccountOrProgram: <string> - return only transactions that mention the provided public key (as base-58 encoded string). If no mentions in a given block, then no notification will be sent.

object

Configuration object containing the following fields:

string

The commitment level for the subscription. Can be finalized, confirmed, or processed.

string

Encoding format for the transaction data.

string

Level of transaction detail to return.

number

The max transaction version to return in responses.

boolean

Whether to show rewards in the response.

Notification format

The notification will be an object with the following fields:

slot: <u64> - The corresponding slot.
err: <object|null> - Error if something went wrong publishing the notification otherwise null.
block: <object|null> - A block object as seen in the getBlock RPC HTTP method.

Response

integer

Subscription id (needed to unsubscribe)

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "blockSubscribe",
  "params": [
    "all",
    {
      "commitment": "confirmed",
      "transactionDetails": "none",
      "showRewards": false
    }
  ]
}

{
  "jsonrpc": "2.0",
  "error": {
    "code": -32601,
    "message": "Method not found"
  },
  "id": 1
}

API reference

ThorEdge RPC

FastGate RPC

Yellowstone gRPC

Bifrost

Hofund

On ThorNode

Parameters

Notification format

Response

​On ThorNode

​Parameters

​Notification format

​Response

On ThorNode

Parameters

Notification format

Response