Struct Providers 

pub struct Providers { /* private fields */ }

Central provider configuration shared across query handles.

Build once with Providers::builder, then create lightweight Ticker handles that share the same underlying provider connections and authentication.

Example

use finance_query::{Providers, Provider, Fetch, Capability};

let providers = Providers::builder()
    .route(Capability::QUOTE, [Provider::Yahoo])
    .fetch(Fetch::Sequential)
    .build().await?;

// All Ticker handles share the same Arc<ProviderSet>
let aapl = providers.ticker("AAPL").build().await?;
let nvda = providers.ticker("NVDA").logo().build().await?;

Implementations

impl Providers

pub fn builder() -> ProvidersBuilder

Create a builder for configuring providers.

pub fn from_set(set: Arc<ProviderSet>) -> Self

Wrap a [ProviderSet] assembled by hand.

The lower-level counterpart to builder, for a caller that has already built its own adapters and route table. Nothing is initialised: ProviderAdapter::initialize is the builder’s job, so a hand-built set must be ready to use.

pub fn from_set_with_lang( set: Arc<ProviderSet>, lang: impl Into<String>, ) -> Self

from_set with an explicit language for the handles this set creates.

pub fn provider_set(&self) -> &Arc<ProviderSet>

The underlying set, for TickerBuilder::with_provider_set and friends.

pub fn ticker(&self, symbol: impl Into<String>) -> TickerBuilder

Create a TickerBuilder pre-wired to this provider set.

The returned builder accepts the same optional configuration as Ticker::builder (.cache(), .logo(), .format()) before calling .build().

The language configured via ProvidersBuilder::lang or ProvidersBuilder::region is inherited (override with .lang() on the returned builder). With the translation feature, a non-English language translates text fields automatically.

pub fn tickers<S, I>(&self, symbols: I) -> TickersBuilder

where S: Into<String>, I: IntoIterator<Item = S>,

Create a TickersBuilder pre-wired to this provider set.

The returned builder accepts the same optional configuration as Tickers::builder (.cache(), .max_concurrency(), .logo(), .format()) before calling .build().

The language configured via ProvidersBuilder::lang or ProvidersBuilder::region is inherited (override with .lang() on the returned builder). With the translation feature, a non-English language translates text fields automatically.

pub fn crypto(&self, id: impl Into<String>) -> CryptoCoin

Create a CryptoCoin handle backed by this provider set.

Compiled in unconditionally. With no built-in provider for this capability, register one with ProvidersBuilder::with_adapter or enable its feature, or these calls return NoProviderAvailable.

pub fn forex(&self, from: impl Into<String>, to: impl Into<String>) -> ForexPair

Create a ForexPair handle backed by this provider set.

Compiled in unconditionally. With no built-in provider for this capability, register one with ProvidersBuilder::with_adapter or enable its feature, or these calls return NoProviderAvailable.

pub fn economic(&self, series_id: impl Into<String>) -> EconomicIndicator

Create an EconomicIndicator handle backed by this provider set.

Compiled in unconditionally. With no built-in provider for this capability, register one with ProvidersBuilder::with_adapter or enable its feature, or these calls return NoProviderAvailable.

pub fn index(&self, symbol: impl Into<String>) -> Index

Create an Index handle backed by this provider set.

pub fn futures(&self, symbol: impl Into<String>) -> FuturesContract

Create a FuturesContract handle backed by this provider set.

pub fn commodity(&self, symbol: impl Into<String>) -> Commodity

Create a Commodity handle backed by this provider set.

pub fn discovery(&self) -> Discovery

Create a Discovery handle backed by this provider set.

Routes symbol search, reference data, and screening through Capability::DISCOVERY. Distinct from crate::finance::search, which is a Yahoo-only shortcut.

pub fn calendar(&self) -> MarketCalendar

Create a MarketCalendar handle backed by this provider set.

Routes market-wide earnings/IPO/dividend/split/economic calendars through Capability::CALENDAR.

pub fn market(&self) -> Market

Create a Market handle backed by this provider set.

Routes sector/industry performance and movers through Capability::MARKET. Movers work on the default keyless route (Yahoo screeners); the sector/industry statistics need a keyed provider (FMP).

pub fn economic_catalog(&self) -> EconomicCatalog

Create an EconomicCatalog handle backed by this provider set.

Routes series search and category/release browsing through Capability::ECONOMIC. Unlike economic it takes no series id — it is how you find one.

Compiled in unconditionally. With no built-in provider for this capability, register one with ProvidersBuilder::with_adapter or enable its feature, or these calls return NoProviderAvailable.

pub fn snapshot(&self) -> Snapshot

Create a Snapshot handle backed by this provider set.

Routes cross-market snapshots through Capability::QUOTE. Needs a provider whose snapshot endpoint spans asset classes, currently Polygon alone.

Compiled in unconditionally. With no built-in provider for this capability, register one with ProvidersBuilder::with_adapter or enable its feature, or these calls return NoProviderAvailable.

pub fn filings(&self, symbol: impl Into<String>) -> Filings

Create a Filings handle backed by this provider set.

Always available — EDGAR is auto-injected when no other FILINGS provider is configured.

pub fn health(&self) -> Vec<ProviderHealth>

Snapshot recent health for every configured provider.

Each ProviderHealth entry reflects up to the last 20 dispatch outcomes recorded in-process for that provider (recency window is internal and unspecified beyond “recent”), plus a best-effort rate-limit budget estimate where the provider exposes one. Purely observational — it does not affect routing or retries.

Example

use finance_query::Providers;

let providers = Providers::builder().build().await?;
for health in providers.health() {
    println!("{:?}: healthy={}", health.provider, health.is_healthy);
}

Trait Implementations

impl Debug for Providers

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

Formats the value using the given formatter.