Skip to content

Requests

Request objects describe provider-neutral filters and time ranges. Provider- specific query parameters remain inside each adapter.

requests

Provider-neutral request and subscription objects.

MarketQuery dataclass

MarketQuery(
    asset_class: AssetClass | None = None,
    market_types: frozenset[MarketType] = frozenset(),
    base: str = "",
    quote: str = "",
    settle: str = "",
    active: bool | None = None,
    margin_supported: bool | None = None,
    linear: bool | None = None,
    inverse: bool | None = None,
)

Provider-neutral filters for catalog discovery.

matches

matches(listing: MarketListing) -> bool

Return whether a normalized listing satisfies every supplied filter.

TradeSubscription dataclass

TradeSubscription(
    instrument: Instrument,
    start_ms: int | None = None,
    start_sequence: int = 0,
)

A live stream beginning at start_ms and after start_sequence.