Struct DividendQuery 

pub struct DividendQuery {
    pub ticker: Option<String>,
    pub ex_dividend_date: Option<NaiveDate>,
    pub ex_dividend_date_gte: Option<NaiveDate>,
    pub ex_dividend_date_lte: Option<NaiveDate>,
    pub dividend_type: Option<String>,
    pub limit: Option<u16>,
    pub order: Option<SortOrder>,
}

Filter parameters for the /v3/reference/dividends endpoint.

Fields

ticker: Option<String>

Filter by ticker symbol.

ex_dividend_date: Option<NaiveDate>

Filter by ex-dividend date (exact).

ex_dividend_date_gte: Option<NaiveDate>

Filter by ex-dividend date >= value.

ex_dividend_date_lte: Option<NaiveDate>

Filter by ex-dividend date <= value.

dividend_type: Option<String>

Filter by dividend type (CD, SC, LT, ST).

limit: Option<u16>

Results per page (max 1000).

order: Option<SortOrder>

Sort direction.

Implementations

impl DividendQuery

pub fn new() -> Self

Create a new empty query.

pub fn ticker(self, v: impl Into<String>) -> Self

Filter by ticker symbol.

pub fn ex_dividend_date(self, v: NaiveDate) -> Self

Filter by exact ex-dividend date.

pub fn ex_dividend_date_gte(self, v: NaiveDate) -> Self

Filter by ex-dividend date >= value.

pub fn ex_dividend_date_lte(self, v: NaiveDate) -> Self

Filter by ex-dividend date <= value.

pub fn dividend_type(self, v: impl Into<String>) -> Self

Filter by dividend type (CD=regular, SC=special, LT=long-term, ST=short-term).

pub fn limit(self, v: u16) -> Self

Set results per page (clamped to max 1000).

pub fn order(self, v: SortOrder) -> Self

Set sort direction.

pub fn validate(&self) -> Result<(), MassiveError>

Validate the query for conflicting filters.

Returns an error if both an exact ex_dividend_date and a range filter (ex_dividend_date_gte or ex_dividend_date_lte) are set. The API behavior when both are provided is undefined.

Trait Implementations

impl Clone for DividendQuery

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DividendQuery

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

Formats the value using the given formatter.

impl Default for DividendQuery

fn default() -> Self

Returns the “default value” for a type.