logsSubscribe

logsSubscribe — Subscribe to transaction logs

post
/

Subscribe to transaction logging to receive notifications when transactions occur that match specified filter criteria. This method establishes a persistent WebSocket connection that will send real-time log notifications whenever transactions matching your filters are processed by the network. You can filter by all transactions, transactions with votes, or transactions mentioning specific accounts. Parameters

  1. filter (required) — Either the string all, the string allWithVotes, or {mentions: []}.

  2. config (optional) — Optional configuration object. Every field is optional; omit the entire object to use defaults.

Authorizations
AuthorizationstringOptional

Pass Authorization: <api-key> on each request.

Body
jsonrpcstring · enumRequired

JSON-RPC protocol version.

Example: 2.0Possible values:
idone ofRequired

Request identifier echoed back in the response.

Example: 1
stringOptional
or
integerOptional
methodstring · enumRequired

Must be logsSubscribe.

Example: logsSubscribePossible values:
Responses
200

Successful logsSubscribe response.

application/json

Base envelope of every JSON-RPC 2.0 response.

jsonrpcstring · enumRequiredExample: 2.0Possible values:
idone ofRequired

Echoed request id.

Example: 1
stringOptional
or
integerOptional
resultinteger · int64Required

Subscription id. Save this value to call the matching unsubscribe method later.

Example: 24040
post
/

Last updated