Struct PolymarketDataClientConfig 

pub struct PolymarketDataClientConfig {

    pub instrument_config: Option<PolymarketInstrumentProviderConfig>,
    pub filters: Vec<Arc<dyn InstrumentFilter>>,
    pub base_url_http: Option<String>,
    pub base_url_ws: Option<String>,
    pub base_url_rtds: Option<String>,
    pub base_url_gamma: Option<String>,
    pub base_url_data_api: Option<String>,
    pub proxy_url: Option<String>,
    pub http_timeout_secs: u64,
    pub ws_timeout_secs: u64,
    pub ws_max_subscriptions: usize,
    pub update_instruments_interval_mins: Option<u64>,
    pub subscribe_new_markets: bool,
    pub new_market_filter: Option<Arc<dyn InstrumentFilter>>,
    pub new_market_fetch_max_concurrency: usize,
    pub drop_quotes_missing_side: bool,
    pub compute_effective_deltas: bool,
    pub auto_load_missing_instruments: bool,
    pub auto_load_debounce_ms: u64,
    pub auto_load_max_retries: u32,
    pub auto_load_retry_delay_initial_secs: f64,
    pub auto_load_retry_delay_max_secs: f64,
    pub resolve_poll_enabled: bool,
    pub resolve_poll_interval_secs: u64,
    pub resolve_poll_grace_secs: u64,
    pub resolve_poll_max_wait_secs: u64,
    pub transport_backend: TransportBackend,
}

Configuration for the Polymarket data client.

filters and new_market_filter hold Arc<dyn InstrumentFilter> trait objects and are skipped during serialization; they default to empty/None and must be installed programmatically after deserialization.

Fields

instrument_config: Option<PolymarketInstrumentProviderConfig>

filters: Vec<Arc<dyn InstrumentFilter>>

Instrument filters applied to all instruments during loading and discovery.

base_url_http: Option<String>

base_url_ws: Option<String>

base_url_rtds: Option<String>

base_url_gamma: Option<String>

base_url_data_api: Option<String>

proxy_url: Option<String>

Optional HTTP or HTTPS proxy URL for all HTTP and WebSocket transports.

http_timeout_secs: u64

HTTP timeout in seconds.

ws_timeout_secs: u64

WebSocket timeout in seconds.

ws_max_subscriptions: usize

update_instruments_interval_mins: Option<u64>

Instrument reload interval in minutes.

subscribe_new_markets: bool

Whether to subscribe to new-market discovery, resolution, and best-bid/ask events.

new_market_filter: Option<Arc<dyn InstrumentFilter>>

Optional filter applied to newly discovered markets before instrument emission.

new_market_fetch_max_concurrency: usize

Maximum concurrent instrument fetches spawned from new_market events.

This bounds adapter-side fan-out during event bursts and prevents request storms against Gamma.

drop_quotes_missing_side: bool

Whether to drop quote ticks when bid or ask prices are missing.

compute_effective_deltas: bool

Whether to maintain local book state and emit only the net changes from book snapshots, at an additional CPU and memory cost.

auto_load_missing_instruments: bool

Whether subscribe and request commands referencing an unknown instrument should trigger an ad-hoc load via the instrument provider. Concurrent misses within auto_load_debounce_ms are coalesced into a single batched request.

auto_load_debounce_ms: u64

The window (milliseconds) over which concurrent auto-load requests are batched.

auto_load_max_retries: u32

Maximum retry attempts on transient auto-load failures (markets in the CLOB hydration window that return empty clob_token_ids from Gamma, or that are absent from the bulk response). Set to 0 to disable retry.

auto_load_retry_delay_initial_secs: f64

Initial delay (seconds) between transient auto-load retries; backed off exponentially with positive jitter up to auto_load_retry_delay_max_secs.

auto_load_retry_delay_max_secs: f64

Maximum delay (seconds) between transient auto-load retries.

resolve_poll_enabled: bool

Whether automatic resolve polling is enabled.

resolve_poll_interval_secs: u64

Fixed interval between resolve poll cycles in seconds.

resolve_poll_grace_secs: u64

Grace period after expiration before a market becomes resolve poll eligible.

resolve_poll_max_wait_secs: u64

Maximum number of seconds to keep auto-polling after expiration before pausing.

transport_backend: TransportBackend

WebSocket transport backend (defaults to Sockudo).

Implementations

impl PolymarketDataClientConfig

pub fn builder() -> PolymarketDataClientConfigBuilder

Create an instance of PolymarketDataClientConfig using the builder syntax

impl PolymarketDataClientConfig

pub fn new() -> Self

pub fn validated_proxy_url(&self) -> Result<Option<ProxyUrl>, TransportError>

Returns the validated proxy URL, if configured.

Errors

Returns an error when the URL is malformed, has no host, or does not use HTTP or HTTPS.

pub const fn has_proxy_url(&self) -> bool

pub fn http_url(&self) -> String

pub fn ws_url(&self) -> String

pub fn rtds_url(&self) -> String

pub fn gamma_url(&self) -> String

pub fn data_api_url(&self) -> String

Trait Implementations

impl ClientConfig for PolymarketDataClientConfig

fn as_any(&self) -> &dyn Any

Return the configuration as a trait object.

impl Clone for PolymarketDataClientConfig

fn clone(&self) -> PolymarketDataClientConfig

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for PolymarketDataClientConfig

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for PolymarketDataClientConfig

fn default() -> Self

Returns the “default value” for a type.

impl DerefToPyAny for PolymarketDataClientConfig

impl<'de> Deserialize<'de> for PolymarketDataClientConfig

where PolymarketDataClientConfig: Default,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<'a, 'py> FromPyObject<'a, 'py> for PolymarketDataClientConfig

where Self: Clone,

type Error = PyClassGuardError<'a, 'py>

The type returned in the event of a conversion error.

fn extract( obj: Borrowed<'a, 'py, PyAny>, ) -> Result<Self, <Self as FromPyObject<'a, 'py>>::Error>

Extracts Self from the bound smart pointer obj.

impl<'py> IntoPyObject<'py> for PolymarketDataClientConfig

type Target = PolymarketDataClientConfig

The Python output type

type Output = Bound<'py, <PolymarketDataClientConfig as IntoPyObject<'py>>::Target>

The smart pointer type to use.

type Error = PyErr

The type returned in the event of a conversion error.

fn into_pyobject( self, py: Python<'py>, ) -> Result<<Self as IntoPyObject<'_>>::Output, <Self as IntoPyObject<'_>>::Error>

Performs the conversion.

impl PyClass for PolymarketDataClientConfig

const NAME: &str = "PolymarketDataClientConfig"

Name of the class.

type Frozen = False

Whether the pyclass is frozen.

impl PyClassImpl for PolymarketDataClientConfig

const MODULE: Option<&str>

Module which the class will be associated with.

const IS_BASETYPE: bool = false

#[pyclass(subclass)]

const IS_SUBCLASS: bool = false

#[pyclass(extends=…)]

const IS_MAPPING: bool = false

#[pyclass(mapping)]

const IS_SEQUENCE: bool = false

#[pyclass(sequence)]

const IS_IMMUTABLE_TYPE: bool = false

#[pyclass(immutable_type)]

const RAW_DOC: &'static CStr = /// Configuration for the Polymarket data client. /// /// `filters` and `new_market_filter` hold `Arc<dyn InstrumentFilter>` trait objects /// and are skipped during serialization; they default to empty/`None` and must be /// installed programmatically after deserialization.

Docstring for the class provided on the struct or enum.

const DOC: &'static CStr

Fully rendered class doc, including the text_signature if a constructor is defined.

type Layout = <<PolymarketDataClientConfig as PyClassImpl>::BaseNativeType as PyClassBaseType>::Layout<PolymarketDataClientConfig>

Description of how this class is laid out in memory

type BaseType = PyAny

Base class

type ThreadChecker = NoopThreadChecker

This handles following two situations:

type Inventory = Pyo3MethodsInventoryForPolymarketDataClientConfig

type PyClassMutability = <<PyAny as PyClassBaseType>::PyClassMutability as PyClassMutability>::MutableChild

Immutable or mutable

type Dict = PyClassDummySlot

Specify this class has #[pyclass(dict)] or not.

type WeakRef = PyClassDummySlot

Specify this class has #[pyclass(weakref)] or not.

type BaseNativeType = PyAny

The closest native ancestor. This is PyAny by default, and when you declare #[pyclass(extends=PyDict)], it’s PyDict.

fn items_iter() -> PyClassItemsIter

fn lazy_type_object() -> &'static LazyTypeObject<Self>

fn dict_offset() -> Option<PyObjectOffset>

Used to provide the dictoffset slot (equivalent to tp_dictoffset)

fn weaklist_offset() -> Option<PyObjectOffset>

Used to provide the weaklistoffset slot (equivalent to tp_weaklistoffset

impl PyClassNewTextSignature for PolymarketDataClientConfig

const TEXT_SIGNATURE: &'static str = "(instrument_config=None, base_url_http=None, base_url_ws=None, base_url_gamma=None, base_url_data_api=None, http_timeout_secs=None, ws_timeout_secs=None, ws_max_subscriptions=None, update_instruments_interval_mins=..., subscribe_new_markets=None, auto_load_missing_instruments=None, auto_load_debounce_ms=None, auto_load_max_retries=None, auto_load_retry_delay_initial_secs=None, auto_load_retry_delay_max_secs=None, new_market_fetch_max_concurrency=None, resolve_poll_enabled=None, resolve_poll_interval_secs=None, resolve_poll_grace_secs=None, resolve_poll_max_wait_secs=None, base_url_rtds=None, transport_backend=None, drop_quotes_missing_side=None, proxy_url=None, compute_effective_deltas=None)"

impl PyStubType for PolymarketDataClientConfig

fn type_output() -> TypeInfo

The type to be used in the output signature, i.e. return type of the Python function or methods.

fn type_input() -> TypeInfo

The type to be used in the input signature, i.e. the arguments of the Python function or methods.

impl PyTypeInfo for PolymarketDataClientConfig

const NAME: &str = <Self as ::pyo3::PyClass>::NAME

👎Deprecated since 0.28.0:

prefer using ::type_object(py).name() to get the correct runtime value

Class name.

const MODULE: Option<&str> = <Self as ::pyo3::impl_::pyclass::PyClassImpl>::MODULE

👎Deprecated since 0.28.0:

prefer using ::type_object(py).module() to get the correct runtime value

Module name, if any.

fn type_object_raw(py: Python<'_>) -> *mut PyTypeObject

Returns the PyTypeObject instance for this type.

fn type_object(py: Python<'_>) -> Bound<'_, PyType>

Returns the safe abstraction over the type object.

fn is_type_of(object: &Bound<'_, PyAny>) -> bool

Checks if object is an instance of this type or a subclass of this type.

fn is_exact_type_of(object: &Bound<'_, PyAny>) -> bool

Checks if object is an instance of this type.

impl Serialize for PolymarketDataClientConfig

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.