Struct ScannerSubscription 

pub struct ScannerSubscription {

    pub number_of_rows: i32,
    pub instrument: Option<String>,
    pub location_code: Option<String>,
    pub scan_code: Option<String>,
    pub above_price: Option<f64>,
    pub below_price: Option<f64>,
    pub above_volume: Option<i32>,
    pub average_option_volume_above: Option<i32>,
    pub market_cap_above: Option<f64>,
    pub market_cap_below: Option<f64>,
    pub moody_rating_above: Option<String>,
    pub moody_rating_below: Option<String>,
    pub sp_rating_above: Option<String>,
    pub sp_rating_below: Option<String>,
    pub maturity_date_above: Option<String>,
    pub maturity_date_below: Option<String>,
    pub coupon_rate_above: Option<f64>,
    pub coupon_rate_below: Option<f64>,
    pub exclude_convertible: bool,
    pub scanner_setting_pairs: Option<String>,
    pub stock_type_filter: Option<String>,
}

Scanner subscription parameters.

Fields

number_of_rows: i32

The number of rows to be returned for the query

instrument: Option<String>

The instrument’s type for the scan. I.e. STK, FUT.HK, etc.

location_code: Option<String>

The request’s location (STK.US, STK.US.MAJOR, etc).

scan_code: Option<String>

Same as TWS Market Scanner’s “parameters” field, for example: TOP_PERC_GAIN

above_price: Option<f64>

Filters out Contracts which price is below this value

below_price: Option<f64>

Filters out contracts which price is above this value.

above_volume: Option<i32>

Filters out Contracts which volume is above this value.

average_option_volume_above: Option<i32>

Filters out Contracts which option volume is above this value.

market_cap_above: Option<f64>

Filters out Contracts which market cap is above this value.

market_cap_below: Option<f64>

Filters out Contracts which market cap is below this value.

moody_rating_above: Option<String>

Filters out Contracts which Moody’s rating is below this value.

moody_rating_below: Option<String>

Filters out Contracts which Moody’s rating is above this value.

sp_rating_above: Option<String>

Filters out Contracts with a S&P rating below this value.

sp_rating_below: Option<String>

Filters out Contracts with a S&P rating above this value.

maturity_date_above: Option<String>

Filter out Contracts with a maturity date earlier than this value.

maturity_date_below: Option<String>

Filter out Contracts with a maturity date older than this value.

coupon_rate_above: Option<f64>

Filter out Contracts with a coupon rate lower than this value.

coupon_rate_below: Option<f64>

Filter out Contracts with a coupon rate higher than this value.

exclude_convertible: bool

Filters out Convertible bonds

scanner_setting_pairs: Option<String>

For example, a pairing “Annual, true” used on the “top Option Implied Vol % Gainers” scan would return annualized volatilities.

stock_type_filter: Option<String>

CORP = Corporation, ADR = American Depositary Receipt, ETF = Exchange Traded Fund, REIT = Real Estate Investment Trust, CEF = Closed End Fund

Trait Implementations

impl Clone for ScannerSubscription

fn clone(&self) -> ScannerSubscription

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ScannerSubscription

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

Formats the value using the given formatter.

impl Default for ScannerSubscription

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ScannerSubscription

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for ScannerSubscription

fn eq(&self, other: &ScannerSubscription) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for ScannerSubscription

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for ScannerSubscription