docs(odds): document exchange liquidity fields + correct max_bet coverage#244
Open
paperclip-resolver[bot] wants to merge 1 commit into
Open
docs(odds): document exchange liquidity fields + correct max_bet coverage#244paperclip-resolver[bot] wants to merge 1 commit into
paperclip-resolver[bot] wants to merge 1 commit into
Conversation
…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
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
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