Skip to main content

FinFeedDataClient

Struct FinFeedDataClient 

Source
pub struct FinFeedDataClient { /* private fields */ }
Expand description

Prediction-market data client for requests and book, quote, trade, and bar polling subscriptions. Execution is unsupported. The injected sender supports standalone clients and runtime dispatch.

§Connection Lifecycle

Startup publishes every selected definition before readiness. Disconnect closes task admission and response publication before draining work. Reconnect uses fresh transport and instrument state after the previous generation drains.

§Polling Subscriptions

  • Quotes and trades share sampled latest-activity polls.
  • L2 MBP deltas and depth share validated current-book snapshots.
  • Bars publish periods closing after subscribe time, with a cutoff taken before each request. Their publication watermark survives reconnects. Provider OHLCV maps to LAST for compatibility; trade-only price provenance is unverified.

Polling guarantees neither completeness nor backfill.

§Market Status and Definition Refreshes

Fresh definition requests apply provider lifecycle metadata and publish instrument updates and correlated responses.

  • Closed and Resolved end all polling subscriptions and reject new ones for that outcome.
  • Open and Suspended keep polling.

If any selected definition fails to refresh, list refreshes preserve loaded definitions and outcome ownership. Historical requests remain available for loaded terminal definitions. The client infers no InstrumentStatus or InstrumentClose event.

§Historical Requests

Historical series require a start and share the configured attempt budget.

  • Trades and quotes retrieve covering UTC hours with checked overlapping continuation, then filter and order records by exposed timestamps. Completeness under provider processing-time selection remains unverified.
  • Quotes use entry time for ts_event and receive time for ts_init.
  • Trades use their sole timestamp for both fields and infer no aggressor side.
  • Bars continue from validated period ends, including short nonempty pages, and emit only complete external OHLCV periods contained in the requested window.

§Historical Books

Historical L2 books use hour-boundary selectors with checked overlapping continuation and replay returned records from a snapshot seed assumed to be complete. Source coverage, bounded timestamp delay, and continuity remain assumptions.

  • Numeric actions 0, 1, and 3 mean relative ADD, absolute SET, and replacement snapshot.
  • Source order and exchange timestamps are preserved. Each completed group’s derived ts_init is the cumulative maximum of processing clocks when present and exchange clocks otherwise. Seed placement and window bounds use this ordering clock, not measured receipt time.
  • Series begin with a generated replacement at start. Point snapshots select an end timestamp in request params.
  • Changed or noncontiguous overlap, nonprogress, exhausted allowance, missing seeds, rewound lower selectors at or past their hourly upper bound, and unsupported actions fail without partial delivery.

§Validation and Failures

Current books are validated atomically. Prices and raw sizes must fit the loaded definition exactly; OHLCV volumes allow bounded normalization of numeric tails at size precision. Asynchronous failures log an error and publish no response. Synchronous validation failures return an error.

Implementations§

Source§

impl FinFeedDataClient

Source

pub fn new( client_id: ClientId, config: FinFeedDataClientConfig, sender: EventSender<DataEvent>, ) -> Result<Self>

Constructs a disconnected client with explicit event plumbing.

The bootstrap deadline must be in [1, 86400] seconds. Poll spacing must be in [100, 86400000] milliseconds and the per-list poll limit in [1, 10000].

§Errors

Returns an error if:

  • Selections, credentials, REST controls, the bootstrap deadline, or polling bounds are invalid.
  • Neither an explicit key nor FINFEED_API_KEY is available.

Trait Implementations§

Source§

impl DataClient for FinFeedDataClient

Source§

fn client_id(&self) -> ClientId

Returns the unique identifier for this data client.
Source§

fn venue(&self) -> Option<Venue>

Returns the optional venue this client is associated with.
Source§

fn start(&mut self) -> Result<()>

Starts the data client. Read more
Source§

fn stop(&mut self) -> Result<()>

Stops the data client. Read more
Source§

fn reset(&mut self) -> Result<()>

Resets the data client to its initial state. Read more
Source§

fn dispose(&mut self) -> Result<()>

Disposes of client resources and cleans up. Read more
Source§

fn is_connected(&self) -> bool

Returns true if the client is currently connected.
Source§

fn is_disconnected(&self) -> bool

Returns true if the client is currently disconnected.
Source§

fn connect<'life0, 'async_trait>( &'life0 mut self, ) -> Pin<Box<dyn Future<Output = Result<()>> + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

Connects the client to the data provider. Read more
Source§

fn disconnect<'life0, 'async_trait>( &'life0 mut self, ) -> Pin<Box<dyn Future<Output = Result<()>> + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

Disconnects the client from the data provider. Read more
Source§

fn request_instrument(&self, request: RequestInstrument) -> Result<()>

Requests detailed data for a single instrument. Read more
Source§

fn request_instruments(&self, request: RequestInstruments) -> Result<()>

Requests a list of instruments from the provider for a given venue. Read more
Source§

fn request_book_snapshot(&self, request: RequestBookSnapshot) -> Result<()>

Requests a snapshot of the order book for a specified instrument. Read more
Source§

fn request_quotes(&self, request: RequestQuotes) -> Result<()>

Requests historical or streaming quote data for a specified instrument. Read more
Source§

fn request_trades(&self, request: RequestTrades) -> Result<()>

Requests historical or streaming trade data for a specified instrument. Read more
Source§

fn request_bars(&self, request: RequestBars) -> Result<()>

Requests historical or streaming bar data for a specified instrument and bar type. Read more
Source§

fn subscribe_bars(&mut self, cmd: SubscribeBars) -> Result<()>

Subscribes to bar updates of the specified full bar types. Read more
Source§

fn unsubscribe_bars(&mut self, cmd: &UnsubscribeBars) -> Result<()>

Unsubscribes from bar updates of the specified full bar types. Read more
Source§

fn subscribe_book_deltas(&mut self, cmd: SubscribeBookDeltas) -> Result<()>

Subscribes to order book delta updates for the specified instruments. Read more
Source§

fn subscribe_book_depth(&mut self, cmd: SubscribeBookDepth) -> Result<()>

Subscribes to order book depth snapshot updates for the specified instruments. Read more
Source§

fn unsubscribe_book_deltas(&mut self, cmd: &UnsubscribeBookDeltas) -> Result<()>

Unsubscribes from order book delta updates for the specified instruments. Read more
Source§

fn unsubscribe_book_depth(&mut self, cmd: &UnsubscribeBookDepth) -> Result<()>

Unsubscribes from order book depth snapshot updates for the specified instruments. Read more
Source§

fn subscribe_quotes(&mut self, cmd: SubscribeQuotes) -> Result<()>

Subscribes to quote updates for the specified instruments. Read more
Source§

fn subscribe_trades(&mut self, cmd: SubscribeTrades) -> Result<()>

Subscribes to trade updates for the specified instruments. Read more
Source§

fn unsubscribe_quotes(&mut self, cmd: &UnsubscribeQuotes) -> Result<()>

Unsubscribes from quote updates for the specified instruments. Read more
Source§

fn unsubscribe_trades(&mut self, cmd: &UnsubscribeTrades) -> Result<()>

Unsubscribes from trade updates for the specified instruments. Read more
Source§

fn request_data(&self, _request: RequestCustomData) -> Result<()>

Sends a custom data request to the provider. Read more
Source§

fn request_book_depth(&self, request: RequestBookDepth) -> Result<()>

Requests historical order book depth data for a specified instrument. Read more
Source§

fn request_book_deltas(&self, request: RequestBookDeltas) -> Result<()>

Requests historical order book delta data for a specified instrument. Read more
Source§

fn request_funding_rates(&self, _request: RequestFundingRates) -> Result<()>

Requests historical or streaming funding rate data for a specified instrument. Read more
Source§

fn request_option_chain_reference_price( &self, _request: RequestOptionChainReferencePrice, ) -> Result<()>

Requests a reference price for an option-chain bootstrap. Read more
§

fn subscribe(&mut self, cmd: SubscribeCustomData) -> Result<(), Error>

Subscribes to custom data types according to the command. Read more
§

fn subscribe_instruments( &mut self, cmd: SubscribeInstruments, ) -> Result<(), Error>

Subscribes to instruments list for the specified venue. Read more
§

fn subscribe_instrument( &mut self, cmd: SubscribeInstrument, ) -> Result<(), Error>

Subscribes to definitions for the specified instruments. Read more
§

fn subscribe_mark_prices( &mut self, cmd: SubscribeMarkPrices, ) -> Result<(), Error>

Subscribes to mark price updates for the specified instruments. Read more
§

fn subscribe_index_prices( &mut self, cmd: SubscribeIndexPrices, ) -> Result<(), Error>

Subscribes to index price updates for the specified instruments. Read more
§

fn subscribe_funding_rates( &mut self, cmd: SubscribeFundingRates, ) -> Result<(), Error>

Subscribes to funding rate updates for the specified instruments. Read more
§

fn subscribe_instrument_status( &mut self, cmd: SubscribeInstrumentStatus, ) -> Result<(), Error>

Subscribes to status updates for the specified instruments. Read more
§

fn subscribe_instrument_close( &mut self, cmd: SubscribeInstrumentClose, ) -> Result<(), Error>

Subscribes to instrument close events for the specified instruments. Read more
§

fn subscribe_option_greeks( &mut self, cmd: SubscribeOptionGreeks, ) -> Result<(), Error>

Subscribes to exchange-provided option greeks for the specified instruments. Read more
§

fn subscribe_blocks(&mut self, cmd: SubscribeBlocks) -> Result<(), Error>

Subscribes to blocks for a specified blockchain. Read more
§

fn subscribe_pool(&mut self, cmd: SubscribePool) -> Result<(), Error>

Subscribes to pool definition updates for a specified AMM pool. Read more
§

fn subscribe_pool_swaps(&mut self, cmd: SubscribePoolSwaps) -> Result<(), Error>

Subscribes to pool swaps for a specified AMM pool. Read more
§

fn subscribe_pool_liquidity_updates( &mut self, cmd: SubscribePoolLiquidityUpdates, ) -> Result<(), Error>

Subscribes to pool liquidity updates for a specified AMM pool. Read more
§

fn subscribe_pool_fee_collects( &mut self, cmd: SubscribePoolFeeCollects, ) -> Result<(), Error>

Subscribes to pool fee collects for a specified AMM pool. Read more
§

fn subscribe_pool_flash_events( &mut self, cmd: SubscribePoolFlashEvents, ) -> Result<(), Error>

Subscribes to pool flash loan events for a specified AMM pool. Read more
§

fn unsubscribe(&mut self, cmd: &UnsubscribeCustomData) -> Result<(), Error>

Unsubscribes from custom data types according to the command. Read more
§

fn unsubscribe_instruments( &mut self, cmd: &UnsubscribeInstruments, ) -> Result<(), Error>

Unsubscribes from instruments list for the specified venue. Read more
§

fn unsubscribe_instrument( &mut self, cmd: &UnsubscribeInstrument, ) -> Result<(), Error>

Unsubscribes from data for the specified instruments. Read more
§

fn unsubscribe_mark_prices( &mut self, cmd: &UnsubscribeMarkPrices, ) -> Result<(), Error>

Unsubscribes from mark price updates for the specified instruments. Read more
§

fn unsubscribe_index_prices( &mut self, cmd: &UnsubscribeIndexPrices, ) -> Result<(), Error>

Unsubscribes from index price updates for the specified instruments. Read more
§

fn unsubscribe_funding_rates( &mut self, cmd: &UnsubscribeFundingRates, ) -> Result<(), Error>

Unsubscribes from funding rate updates for the specified instruments. Read more
§

fn unsubscribe_instrument_status( &mut self, cmd: &UnsubscribeInstrumentStatus, ) -> Result<(), Error>

Unsubscribes from instrument status updates for the specified instruments. Read more
§

fn unsubscribe_instrument_close( &mut self, cmd: &UnsubscribeInstrumentClose, ) -> Result<(), Error>

Unsubscribes from instrument close events for the specified instruments. Read more
§

fn unsubscribe_option_greeks( &mut self, cmd: &UnsubscribeOptionGreeks, ) -> Result<(), Error>

Unsubscribes from exchange-provided option greeks for the specified instruments. Read more
§

fn unsubscribe_blocks(&mut self, cmd: &UnsubscribeBlocks) -> Result<(), Error>

Unsubscribes from blocks for a specified blockchain. Read more
§

fn unsubscribe_pool(&mut self, cmd: &UnsubscribePool) -> Result<(), Error>

Unsubscribes from pool definition updates for a specified AMM pool. Read more
§

fn unsubscribe_pool_swaps( &mut self, cmd: &UnsubscribePoolSwaps, ) -> Result<(), Error>

Unsubscribes from swaps for a specified AMM pool. Read more
§

fn unsubscribe_pool_liquidity_updates( &mut self, cmd: &UnsubscribePoolLiquidityUpdates, ) -> Result<(), Error>

Unsubscribes from pool liquidity updates for a specified AMM pool. Read more
§

fn unsubscribe_pool_fee_collects( &mut self, cmd: &UnsubscribePoolFeeCollects, ) -> Result<(), Error>

Unsubscribes from pool fee collects for a specified AMM pool. Read more
§

fn unsubscribe_pool_flash_events( &mut self, cmd: &UnsubscribePoolFlashEvents, ) -> Result<(), Error>

Unsubscribes from pool flash loan events for a specified AMM pool. Read more
§

fn request_pool_snapshot( &self, request: RequestPoolSnapshot, ) -> Result<(), Error>

Requests a snapshot of a specific AMM pool. Read more
Source§

impl Debug for FinFeedDataClient

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Drop for FinFeedDataClient

Source§

fn drop(&mut self)

Executes the destructor for this type. Read more
Source§

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)
Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
§

impl<T> PolicyExt for T
where T: ?Sized,

§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns [Action::Follow] only if self and other return Action::Follow. Read more
§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns [Action::Follow] if either self or other returns Action::Follow. Read more
§

impl<T> PolicyExt for T
where T: ?Sized,

§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns [Action::Follow] only if self and other return Action::Follow. Read more
§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns [Action::Follow] if either self or other returns Action::Follow. Read more
§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

impl<T> Ungil for T
where T: Send,

§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

§

fn vzip(self) -> V

§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more