[docs-agent] Add UTXO WebSockets page per chain (Bitcoin / BCH / LTC / DOGE)#1329
Open
alchemy-bot wants to merge 1 commit into
Open
[docs-agent] Add UTXO WebSockets page per chain (Bitcoin / BCH / LTC / DOGE)#1329alchemy-bot wants to merge 1 commit into
alchemy-bot wants to merge 1 commit into
Conversation
…/ DOGE) Adds a new "UTXO WebSockets" reference page under the existing UTXO sub-section for each of the four UTXO chains (Bitcoin, Bitcoin Cash, Litecoin, Dogecoin), alongside UTXO Overview, UTXO Migration Guide, and UTXO API Endpoints. Each page is modeled on the existing newHeads template (Supported Networks / Parameters / Response / Request / Result) and documents the four Blockbook WebSocket subscriptions (subscribeNewBlock, subscribeNewTransaction, subscribeAddresses, subscribeFiatRates) plus the one-shot request methods accepted on the WebSocket connection. Source for the protocol: Trezor Blockbook docs (https://github.com/trezor/blockbook/blob/master/docs/api.md#websocket-api). Connection URL pattern (wss://<network>.g.alchemy.com/v2/<apiKey>) and supported networks confirmed against OMGWINNING/chain-config (multinetworkws + edgeproxy api.yml). Refs DOCS-97 Requested-by: @andra-catana
🔗 Preview Mode
|
silviu-androne
approved these changes
May 26, 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.
Summary
Adds a new
UTXO WebSocketsreference page under each UTXO chain's existingUTXOsub-section, sibling toUTXO Overview,UTXO Migration Guide, andUTXO API Endpoints. Each page documents how to connect to the Blockbook WebSocket interface, the JSON envelope used for all messages, the four push-based subscriptions (subscribeNewBlock,subscribeNewTransaction,subscribeAddresses,subscribeFiatRates), and the one-shot request methods that the same WebSocket connection accepts.The structure follows the existing
newHeadstemplate (Supported Networks / Parameters / Response / Request / Result per subscription) and the protocol is sourced from the Trezor Blockbook docs, which is the underlying indexer for Alchemy's UTXO stack.What landed
content/api-reference/bitcoin/utxo-websockets.mdxcontent/api-reference/bitcoincash/utxo-websockets.mdxcontent/api-reference/litecoin/utxo-websockets.mdxcontent/api-reference/dogecoin/utxo-websockets.mdxcontent/docs.ymlUTXO WebSocketsnav entry under each chain's UTXO sectionSourcing notes
wss://<network>.g.alchemy.com/v2/<apiKey>was confirmed againstOMGWINNING/chain-config:src/main/resources/configs/multinetworkws/multi_network_ws/multi_network_ws.yml(prod) and.../staging/multi_network_ws.yml(staging) both wire all 8 Bitcoin-ecosystem networks (BITCOIN_*,BITCOINCASH_*,LITECOIN_*,DOGECOIN_*) intoraw_subscription_handler_matcheswith node-routing tagblockbook, i.e. native Blockbook WebSocket protocol passed through unchanged.src/main/resources/configs/edgeproxy/products/prod/api.ymlcore RPC route^(/v2|/jsonrpc|/fastrpc/v1)(?:/[^/]+)?/?$covers/v2/<apiKey>withGET(needed for the WebSocket upgrade), so connection lands on the same host as the REST UTXO API and JSON-RPC.src/openapi/utxo/utxo.yaml(Bitcoin: mainnet + testnet4; BCH/LTC: mainnet + testnet; Dogecoin: mainnet only, matching the DOCS-86 docs-side dogecoin-testnet deprecation).Reviewer flags
subscribeNewTransactionrequires the backend to be running with the-enablesubnewtxflag per Blockbook docs. Each page carries an<Info>warning that this firehose may not be enabled on all networks; users should fall back tosubscribeAddresses. If you know whether prod Blockbook nodes have-enablesubnewtxenabled for all 4 chains, happy to tighten the wording in a follow-up.getMempoolFilters/getBlockFilter/getFiatRatesForTimestamps/estimateFeeare listed in the request-methods table per Blockbook's WebSocket interface even though they aren't in theutxo.yamlREST whitelist — they're WS-only.Linear
DOCS-97 - https://linear.app/alchemyapi/issue/DOCS-97/docs-add-utxo-websockets-page-per-chain-bitcoin-bch-ltc-doge
Requested by
@andra-catana (via Slack thread)