Struct SymbolInfo

pub struct SymbolInfo { /* private fields */ }

Symbol metadata used by syminfo.* builtins.

Implementations

impl SymbolInfo

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

Sets the description of the symbol.

pub fn with_type(self, type_: SymbolType) -> Self

Sets the type of the symbol.

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

Sets the country of the symbol.

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

Sets the ISIN of the symbol.

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

Sets the root of the symbol.

pub fn with_min_move(self, min_move: i32) -> Self

Sets the min move of the symbol.

pub fn with_price_scale(self, price_scale: i32) -> Self

Sets the price scale of the symbol.

pub fn with_point_value(self, point_value: f64) -> Self

Sets the point value of the symbol.

pub fn with_currency(self, currency: Currency) -> Self

Sets the currency of the symbol.

pub fn with_expiration_date(self, expiration_date: OffsetDateTime) -> Self

Sets the expiration date of the symbol.

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

Sets the current contract of the symbol.

pub fn with_base_currency(self, base_currency: Currency) -> Self

Sets the base currency of the symbol.

pub fn with_employees(self, employees: i64) -> Self

Sets the number of employees of the symbol.

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

Sets the industry of the symbol.

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

Sets the sector of the symbol.

pub fn with_min_contract(self, min_contract: f64) -> Self

Sets the minimum contract size of the symbol.

pub fn with_volume_type(self, volume_type: VolumeType) -> Self

Sets the volume type of the symbol.

pub fn market(&self) -> &Market

Returns the market the symbol belongs to.

pub fn description(&self) -> Option<&String>

Returns the description of the symbol.

pub fn type_(&self) -> Option<SymbolType>

Returns the type of market the symbol belongs to.

pub fn country(&self) -> Option<&String>

Returns the two-letter code of the country where the symbol is traded, in the ISO 3166-1 alpha-2 format, or None if the exchange is not directly tied to a specific country.

For example:

• “NASDAQ:AAPL” returns “US”
• “LSE:AAPL” returns “GB”
• “BITSTAMP:BTCUSD” returns None

pub fn isin(&self) -> Option<&String>

Returns the International Securities Identification Number (ISIN) of the symbol.

An ISIN is a 12-character alphanumeric code that uniquely identifies a security globally.

For example:

• The ISIN for Apple Inc. is “US0378331005”.

pub fn root(&self) -> Option<&String>

Returns the root for derivatives like futures contracts.

For example:

• For the futures contract “ESZ4” (E-mini S&P 500 December 2024), the root is “ES”.

pub fn min_move(&self) -> i32

Returns the smallest increment between a symbol’s price movements (syminfo.mintick).

This is the numerator in the syminfo.mintick formula: syminfo.min_move / syminfo.price_scale = syminfo.mintick.

pub fn price_scale(&self) -> i32

Returns the denominator used to calculate the smallest increment between a symbol’s price movements (syminfo.mintick).

This is the denominator in the syminfo.mintick formula: syminfo.min_move / syminfo.price_scale = syminfo.mintick.

pub fn point_value(&self) -> f64

Returns the point value of the symbol.

The chart price of a security multiplied by the point value equals the actual price of the traded security.

For all types of security except futures, the point value is usually equal to 1 and can therefore be ignored.

pub fn currency(&self) -> Currency

Returns the currency of the symbol’s prices.

For example:

• “NASDAQ:AAPL” returns “USD”
• “EURJPY” returns “JPY”

pub fn timezone(&self) -> TimeZone

Returns the timezone of the exchange of the chart’s main series.

pub fn expiration_date(&self) -> Option<&OffsetDateTime>

Returns the start of the last day of the current futures contract.

pub fn current_contract(&self) -> Option<&String>

Returns the ticker identifier of the underlying contract.

pub fn base_currency(&self) -> Option<&Currency>

Returns the base currency of the symbol.

For example:

• In the pair “EURUSD”, the base currency is “EUR”.
• In the pair “BTCUSDT”, the base currency is “BTC”.

pub fn employees(&self) -> Option<i64>

Returns the number of employees in the company (for stocks).

pub fn industry(&self) -> Option<&String>

Returns the industry of the company (for stocks).

pub fn sector(&self) -> Option<&String>

Returns the sector of the company (for stocks).

pub fn min_contract(&self) -> Option<f64>

Returns the minimum contract size for the symbol.

pub fn volume_type(&self) -> Option<VolumeType>

Returns the volume type of the current symbol.

pub fn recommendations_buy(&self) -> Option<i32>

Returns the number of buy recommendations from analysts covering this stock.

pub fn recommendations_buy_strong(&self) -> Option<i32>

Returns the number of strong buy recommendations from analysts covering this stock.

pub fn recommendations_hold(&self) -> Option<i32>

Returns the number of hold recommendations from analysts covering this stock.

pub fn recommendations_sell(&self) -> Option<i32>

Returns the number of sell recommendations from analysts covering this stock.

pub fn recommendations_sell_strong(&self) -> Option<i32>

Returns the number of strong sell recommendations from analysts covering this stock.

pub fn recommendations_date(&self) -> Option<&OffsetDateTime>

Returns the date of the latest recommendations update.

pub fn recommendations_total(&self) -> Option<i32>

Returns the total number of recommendations from analysts covering this stock.

pub fn shareholders(&self) -> Option<i64>

Returns the number of shareholders the company has.

pub fn shares_outstanding_float(&self) -> Option<f64>

Returns the total number of shares outstanding a company has available, excluding any of its restricted shares.

pub fn shares_outstanding_total(&self) -> Option<f64>

Returns the total number of shares outstanding a company has available, including restricted shares held by insiders, major shareholders, and employees.

pub fn target_price_average(&self) -> Option<f64>

Returns the latest average yearly price target for the symbol predicted by analysts.

pub fn target_price_date(&self) -> Option<&OffsetDateTime>

Returns the date of the latest target price update.

pub fn target_price_estimates(&self) -> Option<f64>

Returns the total number of price target predictions for the current symbol.

pub fn target_price_high(&self) -> Option<f64>

Returns the last highest yearly price target for the symbol predicted by analysts.

pub fn target_price_low(&self) -> Option<f64>

Returns the last lowest yearly price target for the symbol predicted by analysts.

pub fn target_price_median(&self) -> Option<f64>

Returns the median of the last yearly price targets for the symbol predicted by analysts.

pub fn min_tick(&self) -> f64

Returns the min tick value for the current symbol.

Trait Implementations

impl Clone for SymbolInfo

fn clone(&self) -> SymbolInfo

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SymbolInfo

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for SymbolInfo

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for SymbolInfo

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.