Skip to content

docs: clarify market stream and orderbook fields #45

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
cesarenaldi merged 1 commit into from
May 26, 2026
Merged

docs: clarify market stream and orderbook fields #45

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions src/polymarket/models/clob/order_book.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,9 @@ class OrderBook(BaseModel):
token_id: TokenId = Field(validation_alias="asset_id")
timestamp: datetime | None = None
bids: tuple[OrderBookLevel, ...]
"""Bid levels in ascending price order, lowest bid first."""
asks: tuple[OrderBookLevel, ...]
"""Ask levels in descending price order, highest ask first."""
min_order_size: _DecimalFromString
tick_size: _DecimalFromString
neg_risk: bool
Expand Down
8 changes: 7 additions & 1 deletion src/polymarket/streams/_specs.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,10 +25,16 @@

@dataclass(frozen=True, slots=True, kw_only=True)
class MarketSpec:
"""Subscribe to realtime market updates for one or more token ids."""
"""Subscribe to realtime market updates for one or more token ids.

Set ``custom_feature_enabled=True`` to additionally receive
``MarketBestBidAskEvent``, ``NewMarketEvent``, and ``MarketResolvedEvent``.
"""

token_ids: Sequence[str]
"""Token ids whose market events should be delivered."""
custom_feature_enabled: bool = False
"""Whether to enable top-of-book and market lifecycle events."""
topic: Literal["market"] = field(default="market", init=False)

def __post_init__(self) -> None:
Expand Down
Loading