docs(odds): document exchange liquidity fields + correct max_bet coverage#244
Conversation
|
auto-rebase: |
…rage Adds documentation for the four exchange liquidity signals already emitted on /api/v1/odds (volume, volume_24h, open_interest, exchange_token_id) and corrects the max_bet field to mention SBObet alongside Pinnacle. Introduces a new concepts/liquidity.mdx page that enumerates what we surface, what we don't, and why — so future customer questions land on a docs page instead of generating Crisp follow-ups. Field emission verified against sharp-api-go/main.go (REST struct) and api-adapters: max_bet from Pinnacle + SBObet; volume + open_interest from Kalshi; volume_24h from Polymarket + Kalshi; exchange_token_id from Polymarket + SX Bet. Fixes #232
Mlaz-code
force-pushed
the
fix/232-liquidity-fields
branch
from
625c06e to
f712fcd
Compare
|
Rebased onto |
|
auto-rebase: |
# Conflicts: # content/en/api-reference/odds.mdx # content/en/concepts/liquidity.mdx
|
Merge gate (auto-classified): gate=fixes-issue — auto-classified by the gate-log enforcer (13min after merge, no Posted by |
1 participant
Summary
Closes the documentation gap that led Maya to incorrectly tell High Summit Holdings "we don't surface depth/size data" (2026-05-19 Crisp session_e256fef6).
/api/v1/oddsschema table:volume,volume_24h,open_interest,exchange_token_id. Each lists the books that actually emit it.max_betrow from "Currently Pinnacle only" → "Emitted by Pinnacle and SBObet".content/en/concepts/liquidity.mdxenumerating what we surface, what upstream books don't expose, and a recommended coverage-detection pattern. Wired into the concepts sidebar.Field-emission verification
max_betadapters/pinnacle.py:2524,adapters/sbobet.py:932volumeadapters/kalshi.py:2152, 2190volume_24hadapters/polymarket.py:1775,adapters/kalshi.py:2153, 2191open_interestadapters/kalshi.py:2154, 2192exchange_token_idadapters/polymarket.py:1777,adapters/sx_bet.py:817REST serialization confirmed in
sharp-api-go/main.go:633-637(snake_case on the REST struct).Notes
volume_24h/open_interest— not currently true on the wire (grep -n 'volume=|volume_24h=|open_interest=' adapters/novig.pyreturns nothing). Documented only what's actually emitted today; if Novig surfaces these later, doc bump is trivial.Fixes #232