logsSubscribe

Subscribe to transaction logging.

Endpoints

Websockets are available on mainnet and devnet with the following URLs:

• Mainnet wss://mainnet.helius-rpc.com/?api-key=<API_KEY>
• Devnet wss://devnet.helius-rpc.com/?api-key=<API_KEY>

Websockets have a 10-minute inactivity timer; implementing health checks and sending pings every minute is heavily recommended to keep the websocket connection alive.

Authorizations

api-key · string · required

Your Helius API key. You can get one for free in the dashboard.

Body

params · array · required

Hide properties

filter · string | object · required

Filter criteria for the logs to receive results by account type. The following filters types are currently supported:

• all - subscribe to all transactions except for simple vote transactions
• allWithVotes - subscribe to all transactions, including simple vote transactions
• A JSON object with the following field:
  • mentions: [ <string> ] - array containing a single Pubkey (as base-58 encoded string); if present, subscribe to only transactions mentioning this address

Note: The mentions field currently only supports one Pubkey string per method call. Listing additional addresses will result in an error.

config · object

Configuration object containing the following fields:

commitment · string

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

Response

result · integer

Subscription id (needed to unsubscribe)

Notification Format

The notification will be an RpcResponse JSON object with value equal to:

• signature: <string> - The transaction signature base58 encoded.
• err: <object|null> - Error if transaction failed, null if transaction succeeded. See TransactionError definitions.
• logs: <array[string]> - Array of log messages the transaction instructions output during execution.

Request

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "logsSubscribe",
  "params": [
    {
      "mentions": ["11111111111111111111111111111111"]
    },
    {
      "commitment": "finalized"
    }
  ]
}

Response

{
  "jsonrpc": "2.0",
  "result": 24040,
  "id": 1
}