Skip to content

Add docs for crypto Top-of-Book streams - #4031

Open
sebastian-lerner-link wants to merge 3 commits into
mainfrom
docs/crypto-top-of-book-mark-price
Open

Add docs for crypto Top-of-Book streams#4031
sebastian-lerner-link wants to merge 3 commits into
mainfrom
docs/crypto-top-of-book-mark-price

Conversation

@sebastian-lerner-link

Copy link
Copy Markdown
Contributor

Summary

  • Adds a new concept page documenting crypto Top-of-Book streams (Binance bookTicker, Hyperliquid l2Book), sourced from a single exchange's order book.
  • Confirmed via decoded on-chain reports (OPDATA-8206, OPDATA-6937) that all deployed Binance/Hyperliquid Top-of-Book streams use the RWA Advanced (v11) schema. One stream's friendly name string contains "V3" but its decoded report is V11 — a naming artifact, not the real schema.
  • Mark Price streams (OPDATA-6723-6728) are live but still hidden:true in RDD and use a legacy DataLink-only report format, not a documented Data Streams schema — held off on public docs for these until they're unhidden.
  • Latency wording kept qualitative ("sub-second under normal conditions") to match the rest of the docs, which never commit to a specific millisecond figure.
  • Linked from the crypto-streams index page and added to the sidebar nav.

Test plan

  • Visually verify the rendered page once deployed to preview
  • Confirm with Data Streams PM before folding in Mark Price / Index Price docs once those streams are unhidden

Sebastian Lerner added 3 commits August 6, 2026 15:52
Document the Binance- and Hyperliquid-sourced Top-of-Book (RWA Advanced
v11) and Perpetual Mark Price (Crypto Advanced v3) stream types,
confirmed released via OPDATA-8206 and OPDATA-7717, per the Crypto
Market Data Sourcing - Mark Price & Top-of-book requirements doc.
Decoded on-chain reports confirm all deployed Binance/Hyperliquid
Top-of-Book streams use v11 (RWA Advanced), including the one whose
stream name string contained "V3" (OPDATA-6937) — that was a naming
artifact, not the real schema.

Mark Price streams (OPDATA-6723-6728) are live but still hidden:true
in RDD and use a legacy DataLink-only report format, not the v3 Crypto
Advanced schema. Per team decision, holding off on public Mark Price
docs until those streams are unhidden.
Every other latency mention in the docs stays qualitative (low-latency,
sub-second) rather than committing to a specific millisecond figure.
Drop the 500ms number to match.
@sebastian-lerner-link
sebastian-lerner-link requested review from a team as code owners August 6, 2026 20:17
@vercel

vercel Bot commented Aug 6, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
documentation Ready Ready Preview Aug 6, 2026 8:17pm

Request Review

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.

1 participant