Struct TickerBuilder 

pub struct TickerBuilder { /* private fields */ }

Builder for Ticker

Provides a fluent API for constructing Ticker instances.

Implementations

impl TickerBuilder

pub fn region(self, region: Region) -> Self

Set the region (automatically sets correct lang and region)

This is the recommended way to configure regional settings as it ensures lang and region are correctly paired.

Example

use finance_query::{Ticker, Region};

let ticker = Ticker::builder("2330.TW")
    .region(Region::Taiwan)
    .build()
    .await?;

pub fn lang(self, lang: impl Into<String>) -> Self

Set the language code (e.g., “en-US”, “ja-JP”, “de-DE”)

For standard regions, prefer using .region() instead to ensure correct lang/region pairing.

pub fn region_code(self, region: impl Into<String>) -> Self

Set the region code (e.g., “US”, “JP”, “DE”)

For standard regions, prefer using .region() instead to ensure correct lang/region pairing.

pub fn timeout(self, timeout: Duration) -> Self

Set the HTTP request timeout

pub fn proxy(self, proxy: impl Into<String>) -> Self

Set the proxy URL

pub fn config(self, config: ClientConfig) -> Self

Set a complete ClientConfig (overrides any previously set individual config fields)

pub fn client(self, handle: ClientHandle) -> Self

Share an existing authenticated session instead of creating a new one.

This avoids redundant authentication when you need multiple Ticker instances or want to share a session between Ticker and crate::Tickers.

Obtain a ClientHandle from any existing Ticker via Ticker::client_handle().

When set, the builder’s config, timeout, proxy, lang, and region settings are ignored (the shared session’s configuration is used instead).

Example

use finance_query::Ticker;

let aapl = Ticker::new("AAPL").await?;
let handle = aapl.client_handle();

let msft = Ticker::builder("MSFT").client(handle.clone()).build().await?;
let googl = Ticker::builder("GOOGL").client(handle).build().await?;

pub fn cache(self, ttl: Duration) -> Self

Enable response caching with a time-to-live.

By default caching is disabled — every call fetches fresh data. When enabled, responses are reused until the TTL expires, then automatically re-fetched. Expired entries in map-based caches (chart, options, financials) are evicted on the next write to limit memory growth.

Example

use finance_query::Ticker;
use std::time::Duration;

let ticker = Ticker::builder("AAPL")
    .cache(Duration::from_secs(30))
    .build()
    .await?;

pub fn logo(self) -> Self

Include company logo URLs in quote responses.

When enabled, quote() will fetch logo URLs in parallel with the quote summary, adding a small extra request.

pub async fn build(self) -> Result<Ticker>

Build the Ticker instance