docs: add WebSockets and Socket.IO page to Stacks Blockchain API docs - #1151
Merged
Conversation
Contributor
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
leah-stacks
approved these changes
Aug 10, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Adds a new guide page,
content/docs/en/apis/stacks-blockchain-api/websockets.mdx, documenting the Stacks Blockchain API's two real-time channels, and registers it in the section sidebar viameta.json.The page covers:
/extended/v1/wsspeaking JSON-RPC 2.0, and Socket.IO on the API root), mainnet/testnet connection URLs, and a warning callout that pushed events are susceptible to re-orgs and shouldn't be treated as final.connectWebSocketClientandStacksApiSocketClientexamples from the@stacks/blockchain-api-clientREADME, plus a table of all nine subscription methods across both clients.subscriptionsquery param,subscribe/unsubscribeemits, dynamic topic names).