Struct FmpClient 

pub struct FmpClient { /* private fields */ }

Async client for Financial Modeling Prep stable API endpoints.

Implementations

impl FmpClient

pub fn new(api_key: impl Into<String>) -> Result<Self>

Builds a client using the default stable FMP base URL.

Errors

Returns Error::InvalidBaseUrl only if the compiled-in default URL is invalid.

pub fn with_base_url( api_key: impl Into<String>, base_url: impl AsRef<str>, ) -> Result<Self>

Builds a client using a custom base URL, primarily for tests.

Errors

Returns Error::InvalidBaseUrl if base_url cannot be parsed, uses an unsupported scheme, contains credentials, or contains query or fragment components.

pub async fn endpoint(&self, endpoint: Endpoint) -> Result<Value>

Calls endpoint without endpoint-specific query parameters.

Errors

See module-level errors.

pub async fn query(&self, endpoint: Endpoint, query: &str) -> Result<Value>

Calls endpoint with a free-text query parameter (?query=...).

Errors

See module-level errors.

pub async fn by_symbol(&self, endpoint: Endpoint, symbol: &str) -> Result<Value>

Calls endpoint with a ?symbol=... parameter.

Errors

See module-level errors.

pub async fn by_symbol_list( &self, endpoint: Endpoint, symbols: &[String], ) -> Result<Value>

Calls endpoint with a ?symbol=... parameter (comma-joined).

Errors

See module-level errors.

pub async fn by_symbols( &self, endpoint: Endpoint, symbols: &[String], ) -> Result<Value>

Calls endpoint with a ?symbols=... parameter (comma-joined).

Errors

See module-level errors.

pub async fn by_symbol_limit( &self, endpoint: Endpoint, symbol: &str, limit: Option<u16>, ) -> Result<Value>

Calls endpoint with ?symbol=...&limit=... (limit defaults to NEWS_LIMIT).

Errors

See module-level errors.

pub async fn by_symbol_date_range( &self, endpoint: Endpoint, symbol: &str, from: Option<&str>, to: Option<&str>, ) -> Result<Value>

Calls endpoint with ?symbol=... plus optional from and to dates.

Errors

See module-level errors.

pub async fn by_date_range( &self, endpoint: Endpoint, from: Option<&str>, to: Option<&str>, ) -> Result<Value>

Calls endpoint with optional from and to dates.

Errors

See module-level errors.

pub async fn by_name_date_range( &self, endpoint: Endpoint, name: &str, from: Option<&str>, to: Option<&str>, ) -> Result<Value>

Calls endpoint with a required name plus optional from and to dates.

Errors

See module-level errors.

pub async fn annual( &self, endpoint: Endpoint, symbol: &str, limit: Option<u16>, ) -> Result<Value>

Calls an annual endpoint with symbol and limit (defaulting to ANNUAL_LIMIT).

Errors

See module-level errors.

pub async fn annual_report_form( &self, endpoint: Endpoint, symbol: &str, year: u16, period: &str, ) -> Result<Value>

Calls an annual report form endpoint with symbol, year, and fiscal period.

Errors

See module-level errors.

pub async fn technical( &self, endpoint: Endpoint, symbol: &str, period_length: u16, timeframe: &str, ) -> Result<Value>

Calls a technical indicator endpoint with symbol, periodLength, and timeframe.

Errors

See module-level errors.

pub async fn news( &self, endpoint: Endpoint, symbol: &str, limit: Option<u16>, ) -> Result<Value>

Calls a news endpoint with ?symbols=...&limit=... (limit defaults to NEWS_LIMIT).

Errors

See module-level errors.

pub async fn paged( &self, endpoint: Endpoint, page: Option<u16>, limit: Option<u16>, ) -> Result<Value>

Calls a paginated endpoint with ?page=...&limit=... (page defaults to PAGE and limit defaults to NEWS_LIMIT).

Errors

See module-level errors.

Trait Implementations

impl Clone for FmpClient

fn clone(&self) -> FmpClient

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FmpClient

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

Formats the value using the given formatter.