Struct SignalsOptions 

pub struct SignalsOptions {
    pub symbol_name: Option<String>,
    pub strategy_id: Option<String>,
    pub strategy_name: Option<String>,
    pub catalyst_name: Option<String>,
    pub catalyst_type: Option<String>,
    pub start_time: Option<OffsetDateTime>,
    pub end_time: Option<OffsetDateTime>,
    pub limit: Option<i32>,
    pub offset: Option<i32>,
}

Options for crate::SignalContext::signals

Every field is a filter; leaving one unset removes that filter.

Fields

symbol_name: Option<String>

Filter by security symbol, e.g. AAPL.US or 700.HK. If omitted, returns signals for all symbols.

strategy_id: Option<String>

Filter by strategy id, e.g. buffett-value. Preferred over the deprecated strategy_name; takes precedence when both are provided.

strategy_name: Option<String>

Filter by strategy name. If omitted, returns signals from all strategies.

Deprecated in favour of SignalsOptions::strategy_id.

catalyst_name: Option<String>

Filter by the name of the factor that triggered the signal, e.g. EARNINGS_RELEASED or macd_12_26_9 — the factors[].name of the triggering fact, not the display label a signal carries in Signal::key_catalyst. If omitted, signals with any catalyst name are returned.

catalyst_type: Option<String>

Filter by the catalyst type that triggered the signal, e.g. News, Fundamental, Technical. If omitted, signals with any catalyst type are returned.

start_time: Option<OffsetDateTime>

Only return signals created at or after this time. Sent as RFC3339; the API also accepts a Unix timestamp. If omitted, no lower bound.

end_time: Option<OffsetDateTime>

Only return signals created at or before this time. Sent as RFC3339; the API also accepts a Unix timestamp. If omitted, no upper bound.

limit: Option<i32>

Maximum number of results to return. Defaults to 20.

offset: Option<i32>

Number of results to skip for pagination. Defaults to 0.

Trait Implementations

impl Clone for SignalsOptions

fn clone(&self) -> SignalsOptions

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SignalsOptions

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

Formats the value using the given formatter.

impl Default for SignalsOptions

fn default() -> SignalsOptions

Returns the “default value” for a type.

impl Serialize for SignalsOptions

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

where __S: Serializer,

Serialize this value into the given Serde serializer.