Skip to main content

SymInfo

Struct SymInfo 

Source
pub struct SymInfo {
Show 40 fields pub ticker: String, pub tickerid: String, pub description: String, pub prefix: String, pub currency: String, pub basecurrency: String, pub type_: String, pub mintick: f64, pub pointvalue: f64, pub timezone: String, pub session: String, pub root: String, pub current_contract: String, pub main_tickerid: String, pub isin: String, pub country: String, pub sector: String, pub industry: String, pub volumetype: String, pub minmove: f64, pub pricescale: f64, pub mincontract: f64, pub expiration_date: f64, pub employees: f64, pub shareholders: f64, pub shares_outstanding_total: f64, pub shares_outstanding_float: f64, pub recommendations_buy: f64, pub recommendations_buy_strong: f64, pub recommendations_hold: f64, pub recommendations_sell: f64, pub recommendations_sell_strong: f64, pub recommendations_total: f64, pub recommendations_date: f64, pub target_price_average: f64, pub target_price_high: f64, pub target_price_low: f64, pub target_price_median: f64, pub target_price_estimates: f64, pub target_price_date: f64,
}
Expand description

Symbol information the host supplies for a script run.

Mirrors PineScript’s syminfo.* namespace: the instrument’s identity and trading conventions. A script may read any of these; the host fills in what it knows and leaves the rest at their defaults.

Fields§

§ticker: String

Symbol without exchange prefix, e.g. "AAPL" (syminfo.ticker).

§tickerid: String

Fully qualified symbol including exchange, e.g. "NASDAQ:AAPL" (syminfo.tickerid).

§description: String

Human-readable description of the symbol (syminfo.description).

§prefix: String

Exchange/data-source prefix, e.g. "NASDAQ" (syminfo.prefix).

§currency: String

Currency the symbol is quoted in, e.g. "USD" (syminfo.currency).

§basecurrency: String

Base currency for forex pairs, e.g. "EUR" in EURUSD (syminfo.basecurrency).

§type_: String

Instrument type, e.g. "stock", "forex", "crypto" (syminfo.type).

§mintick: f64

Smallest price increment, e.g. 0.01 (syminfo.mintick).

§pointvalue: f64

Currency value of one point of price movement (syminfo.pointvalue).

§timezone: String

Exchange timezone, e.g. "America/New_York" (syminfo.timezone).

§session: String

Trading session specification (syminfo.session).

§root: String

Root of a futures contract, e.g. "ES" (syminfo.root).

§current_contract: String

The current standard contract of a continuous futures symbol (syminfo.current_contract).

§main_tickerid: String

Symbol of the main pair for a spread/derived symbol (syminfo.main_tickerid).

§isin: String

ISIN of the symbol (syminfo.isin).

§country: String

Country the symbol is traded in, e.g. "US" (syminfo.country).

§sector: String

Economic sector, e.g. "Technology" (syminfo.sector).

§industry: String

Industry, e.g. "Semiconductors" (syminfo.industry).

§volumetype: String

How volume is reported, e.g. "base"/"quote" (syminfo.volumetype).

§minmove: f64

Number of mintick increments in the minimum price move (syminfo.minmove).

§pricescale: f64

Price scale, the denominator of a fractional price (syminfo.pricescale).

§mincontract: f64

Minimum tradable contract size (syminfo.mincontract).

§expiration_date: f64

Expiration date of a derivative, as a UNIX timestamp (syminfo.expiration_date).

§employees: f64

Number of employees (syminfo.employees).

§shareholders: f64

Number of shareholders (syminfo.shareholders).

§shares_outstanding_total: f64

Total shares outstanding (syminfo.shares_outstanding_total).

§shares_outstanding_float: f64

Float shares outstanding (syminfo.shares_outstanding_float).

§recommendations_buy: f64

Analyst recommendation totals (syminfo.recommendations_*).

§recommendations_buy_strong: f64§recommendations_hold: f64§recommendations_sell: f64§recommendations_sell_strong: f64§recommendations_total: f64§recommendations_date: f64

Date the recommendations were issued, as a UNIX timestamp (syminfo.recommendations_date).

§target_price_average: f64

Analyst price targets (syminfo.target_price_*).

§target_price_high: f64§target_price_low: f64§target_price_median: f64§target_price_estimates: f64§target_price_date: f64

Date the price targets were issued, as a UNIX timestamp (syminfo.target_price_date).

Trait Implementations§

Source§

impl Clone for SymInfo

Source§

fn clone(&self) -> SymInfo

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for SymInfo

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for SymInfo

Source§

fn default() -> SymInfo

Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.