Skip to content

[docs-agent] Add UTXO WebSockets page per chain (Bitcoin / BCH / LTC / DOGE)#1329

Merged
Tudor1217 merged 1 commit into
mainfrom
docs/utxo-websockets-per-chain
May 26, 2026
Merged

[docs-agent] Add UTXO WebSockets page per chain (Bitcoin / BCH / LTC / DOGE)#1329
Tudor1217 merged 1 commit into
mainfrom
docs/utxo-websockets-per-chain

Conversation

@alchemy-bot
Copy link
Copy Markdown
Contributor

Summary

Adds a new UTXO WebSockets reference page under each UTXO chain's existing UTXO sub-section, sibling to UTXO Overview, UTXO Migration Guide, and UTXO 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 newHeads template (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

File Change
content/api-reference/bitcoin/utxo-websockets.mdx new
content/api-reference/bitcoincash/utxo-websockets.mdx new
content/api-reference/litecoin/utxo-websockets.mdx new
content/api-reference/dogecoin/utxo-websockets.mdx new
content/docs.yml added one UTXO WebSockets nav entry under each chain's UTXO section

Sourcing notes

  • WebSocket URL pattern wss://<network>.g.alchemy.com/v2/<apiKey> was confirmed against OMGWINNING/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_*) into raw_subscription_handler_matches with node-routing tag blockbook, i.e. native Blockbook WebSocket protocol passed through unchanged.
    • src/main/resources/configs/edgeproxy/products/prod/api.yml core RPC route ^(/v2|/jsonrpc|/fastrpc/v1)(?:/[^/]+)?/?$ covers /v2/<apiKey> with GET (needed for the WebSocket upgrade), so connection lands on the same host as the REST UTXO API and JSON-RPC.
  • Supported-networks list per page mirrors 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

  • subscribeNewTransaction requires the backend to be running with the -enablesubnewtx flag per Blockbook docs. Each page carries an <Info> warning that this firehose may not be enabled on all networks; users should fall back to subscribeAddresses. If you know whether prod Blockbook nodes have -enablesubnewtx enabled for all 4 chains, happy to tighten the wording in a follow-up.
  • Example payloads borrow Blockbook's documented BTC-style txids/blockhashes on all 4 chains. Addresses are swapped to chain-appropriate formats (CashAddr for BCH, bech32+legacy for LTC, P2PKH for DOGE). Per the DOCS-71 follow-up learning, this is acceptable as a launch baseline; rotating to real per-chain examples can be a follow-up if needed.
  • getMempoolFilters / getBlockFilter / getFiatRatesForTimestamps / estimateFee are listed in the request-methods table per Blockbook's WebSocket interface even though they aren't in the utxo.yaml REST 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)

…/ 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
@alchemy-bot alchemy-bot requested a review from a team as a code owner May 25, 2026 09:57
@github-actions
Copy link
Copy Markdown

github-actions Bot commented May 25, 2026

🔗 Preview Mode

Name Status Preview Updated (UTC)
Alchemy Docs ✅ Ready 🔗 Visit Preview May 25, 2026, 9:58 AM

@Tudor1217 Tudor1217 merged commit 45ea84e into main May 26, 2026
8 checks passed
@Tudor1217 Tudor1217 deleted the docs/utxo-websockets-per-chain branch May 26, 2026 16:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants