Crate fin_model

A comprehensive data model for various financial data.

The purpose of this API is to construct a comprehensive data model for company and market financial information in a coherent and idiomatic manner, not of a specific service provider’s API.

This model can then be populated using requests described with traits and implemented by a given service provider. Thus, clients can use the common data model with Rust-native types and idioms but switch in different providers for different data types, markets, or qualities of service.

This library only provides types and traits that can be implemented by a Provider that executes requests for financial data such as price quotes, analyst data, or company information. In the model we use the term request trait to indicate a trait that contains functions that make a request for data and which use the common RequestResult response.

Modules

analysis

Provides structs and traits that represent common market analysis.

classification

Structures for a registry of classification codes.

company

market

Structures for a registry of market identifiers.

news

Provides structs and traits that retrieve news.

prelude

Re-exports base types required to use request traits.

provider

Provides the trait required by service provider implementations.

quote

Provides structs and traits that represent quotes for market prices.

registry

A trait to act as a registry of data concerning some classification scheme.

reporting

Provides common types for reporting data.

request

Provides the common Result type and error enum used by request traits.

symbol

Provides types and functions for market symbols.

Macros

assert_is_valid

Short-cut to test whether a Symbol is valid, and if not to return a RequestResult containing the error RequestError::BadSymbolError.