Modules§
- blocking
- Blocking facade over the canonical async Polaris client.
Structs§
- Asset
Amount - One asset and its economically binding amount.
- BboQuery
- BboQuote
- Catalog
Access - Catalog
Count - Catalog
Instrument - Catalog
Market - Catalog
Query - Catalog
Response - Depth
Metrics Row - Diagnostic
- Events
Query - Required inclusive collector-time window for the authenticated
/eventsroute. - Funding
Rate Row - One partial flat row from
/funding-rates. - Historical
Rows Query - Filters for the direct historical row endpoints. Times are inclusive Unix milliseconds.
- Instruments
Query - Filters for option-contract discovery.
marketis the normalized underlying. - Instruments
Response - Intent
Data - Venue-independent projection of an RFQ, quote, or executable intent.
- Intent
Event V2 - Intent
Quote - A solver or venue response to an RFQ.
- Intent
Row - One pair-shaped intent observation from
/intents. - Intent
Rows Query - L2Orderbooks
Query - Required inclusive millisecond window for
/l2-orderbooks. - L2Updates
Query - Filters for flat source snapshots and deltas from
/l2-updates. - Legacy
Intent Event - Legacy
Option Ticker Event - Legacy
Orderbook Event - Legacy
Perpetual Ticker Event - Legacy
Point Series Event - Legacy
Standard Event - Legacy
Trade Data - Legacy
Trade Event - Meta
Response - Public API discovery links returned by
/meta. - Observed
Statistic - Ohlcv
Row - One venue-published candle update from
/ohlcv. - Ohlcv
Rows Query - Option
Contract - One venue-native option contract in the instrument catalog.
- Option
Contract Statistics - Option
Greeks - Option
Ticker Data - Option
Ticker Event V2 - Option
Ticker Row - One partial flat row from
/options-ticker. - Option
Ticker Rows Query - Orderbook
Builder - Reconstruct complete order books from standardized snapshot and delta events.
- Orderbook
Data - Orderbook
Data V2 - Orderbook
Event V2 - Orderbook
L2Row - One flat top-25 L2 row with all nullable fixed level fields from the API.
- Orderbook
Level - Perpetual
Ticker Data - Perpetual
Ticker Event V2 - Point
Series Data - Point
Series Event V2 - Polaris
Client - Polaris
Client Builder - Propamm
Quote - Propamm
Quote Ladder Data - Propamm
Quote Ladder Event - Propamm
Quote Ladder Values - Quote
Row - One PropAMM quote point from
/quotes. - Quote
Rows Query - RawCapture
Row - One capture from
GET /raw. - RawChannel
Query - Query for exact captures from one venue-native raw channel.
exchangeandeventmap to the API’ssourceandchannelfilters. - RawQuery
- Settlement
Transaction - A chain transaction that executes or settles an intent.
- Standard
Event V2 - Stream
Query - Trade
Data V2 - Trade
Event V2 - Trade
Row - One flat row from
/trades. - Trade
Rows Query - Trade filters.
instrumentselects one exact venue-native instrument.
Enums§
- Amount
Kind - Whether an intent fixes its inputs or outputs.
- Intent
Event - Intent
Status - Canonical execution lifecycle for an intent.
- Mixed
Event Row - A typed flat row from the authenticated mixed
/eventsstream. - Mixed
Event Type - Ohlcv
Interval - Option
Ticker Event - Orderbook
Event - Perpetual
Ticker Event - Point
Series Event - Polaris
Error - Standard
Event - Time
Input - Trade
Event