GetTimeSeriesMinParamsBuilder

Struct GetTimeSeriesMinParamsBuilder 

Source
pub struct GetTimeSeriesMinParamsBuilder { /* private fields */ }
Expand description

Implementations§

Source§

impl GetTimeSeriesMinParamsBuilder

Source

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

Interval between two consecutive points in time series

Source

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

Symbol ticker of the instrument. E.g. AAPL, EUR/USD, ETH/BTC, …

Source

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

Filter by international securities identification number (ISIN)

Source

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

The FIGI of an instrument for which data is requested

Source

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

The CUSIP of an instrument for which data is requested. CUSIP access is activating in the <a href="https://twelvedata.com/account/add-ons">Add-ons section

Source

pub fn outputsize(self, outputsize: i64) -> Self

Number of data points to retrieve. Supports values in the range from 1 to 5000. Default 30 when no date parameters are set, otherwise set to maximum

Source

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

Exchange where instrument is traded

Source

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

Market Identifier Code (MIC) under ISO 10383 standard

Source

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

The country where the instrument is traded, e.g., United States or US

Source

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

The asset class to which the instrument belongs

Source

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

Timezone at which output datetime will be displayed. Supports:

  • 1. Exchange for local exchange time
  • 2. UTC for datetime at universal UTC standard
  • 3. Timezone name according to the IANA Time Zone Database. E.g. America/New_York, Asia/Singapore. Full list of timezones can be found <a href="https://en.wikipedia.org/wiki/List_of_tz_database_time_zones" target="blank">here
Take note that the IANA Timezone name is case-sensitive

Source

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

Can be used separately and together with end_date. Format 2006-01-02 or 2006-01-02T15:04:05 Default location:

  • Forex and Cryptocurrencies - UTC
  • Stocks - where exchange is located (e.g. for AAPL it will be America/New_York)
Both parameters take into account if timezone parameter is provided.
If timezone is given then, start_date and end_date will be used in the specified location Examples:
  • 1. &symbol=AAPL&start_date=2019-08-09T15:50:00&…
    Returns all records starting from 2019-08-09T15:50:00 New York time up to current date
  • 2. &symbol=EUR/USD&timezone=Asia/Singapore&start_date=2019-08-09T15:50:00&…
    Returns all records starting from 2019-08-09T15:50:00 Singapore time up to current date
  • 3. &symbol=ETH/BTC&timezone=Europe/Zurich&start_date=2019-08-09T15:50:00&end_date=2019-08-09T15:55:00&…
    Returns all records starting from 2019-08-09T15:50:00 Zurich time up to 2019-08-09T15:55:00

Source

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

The ending date and time for data selection, see start_date description for details.

Source

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

Specifies the exact date to get the data for. Could be the exact date, e.g. 2021-10-27, or in human language today or yesterday

Source

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

Sorting order of the output

Source

pub fn prepost(self, prepost: bool) -> Self

Returns quotes that include pre-market and post-market data. Only for Pro and above plans. Available at the 1min, 5min, 15min, and 30min intervals for US equities. Open, high, low, close values are supplied without volume

Source

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

The format of the response data

Source

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

The separator used in the CSV response data

Source

pub fn dp(self, dp: i64) -> Self

Specifies the number of decimal places for floating values. Should be in range [0, 11] inclusive. By default, the number of decimal places is automatically determined based on the values provided

Source

pub fn previous_close(self, previous_close: bool) -> Self

A boolean parameter to include the previous closing price in the time_series data. If true, adds previous bar close price value to the current object

Source

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

Adjusting mode for prices

Source

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

Price type on which technical indicator is calculated

Source

pub fn time_period(self, time_period: i64) -> Self

Number of periods to average over. Takes values in the range from 1 to 800

Source

pub fn include_ohlc(self, include_ohlc: bool) -> Self

Specify if OHLC values should be added in the output

Source

pub fn build(self) -> GetTimeSeriesMinParams

Build the parameter struct

Trait Implementations§

Source§

impl Clone for GetTimeSeriesMinParamsBuilder

Source§

fn clone(&self) -> GetTimeSeriesMinParamsBuilder

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for GetTimeSeriesMinParamsBuilder

Source§

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

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

impl Default for GetTimeSeriesMinParamsBuilder

Source§

fn default() -> GetTimeSeriesMinParamsBuilder

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> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
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.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more