For the complete documentation index, see llms.txt. This page is also available as Markdown.

signatureSubscribe

signatureSubscribe — Subscribe to a transaction signature's status

post
/

Subscribe to receive a notification when the transaction with the given signature reaches the specified commitment level. This is a subscription to a single notification that is automatically cancelled by the server once the signatureNotification is sent. Optionally, you can also receive notifications when the signature is first received by the RPC before processing begins. The transaction signature must be the first signature from the transaction. Parameters

  1. signature (required) — Base-58 transaction signature.

  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 signatureSubscribe.

Example: signatureSubscribePossible values:
Responses
200

Successful signatureSubscribe 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