Lean  $LEAN_TAG$
QuantConnect.DataDownloaderGetParameters Class Reference

Model class for passing in parameters for historical data More...

Public Member Functions

 DataDownloaderGetParameters (Symbol symbol, Resolution resolution, DateTime startUtc, DateTime endUtc, TickType? tickType=null)
 Initialize model class for passing in parameters for historical data More...
 
override string ToString ()
 Returns a string representation of the DataDownloaderGetParameters object. More...
 

Properties

Symbol Symbol [get, set]
 Symbol for the data we're looking for. More...
 
Resolution Resolution [get, set]
 Resolution of the data request More...
 
DateTime StartUtc [get, set]
 Start time of the data in UTC More...
 
DateTime EndUtc [get, set]
 End time of the data in UTC More...
 
TickType TickType [get, set]
 The type of tick to get More...
 

Detailed Description

Model class for passing in parameters for historical data

Definition at line 23 of file DataDownloaderGetParameters.cs.

Constructor & Destructor Documentation

◆ DataDownloaderGetParameters()

QuantConnect.DataDownloaderGetParameters.DataDownloaderGetParameters ( Symbol  symbol,
Resolution  resolution,
DateTime  startUtc,
DateTime  endUtc,
TickType tickType = null 
)

Initialize model class for passing in parameters for historical data

Parameters
symbolSymbol for the data we're looking for.
resolutionResolution of the data request
startUtcStart time of the data in UTC
endUtcEnd time of the data in UTC
tickType[Optional] The type of tick to get. Defaults to QuantConnect.TickType.Trade

Definition at line 58 of file DataDownloaderGetParameters.cs.

Member Function Documentation

◆ ToString()

override string QuantConnect.DataDownloaderGetParameters.ToString ( )

Returns a string representation of the DataDownloaderGetParameters object.

Returns
A string representing the object's properties.

Property Documentation

◆ Symbol

Symbol QuantConnect.DataDownloaderGetParameters.Symbol
getset

Symbol for the data we're looking for.

Definition at line 28 of file DataDownloaderGetParameters.cs.

◆ Resolution

Resolution QuantConnect.DataDownloaderGetParameters.Resolution
getset

Resolution of the data request

Definition at line 33 of file DataDownloaderGetParameters.cs.

◆ StartUtc

DateTime QuantConnect.DataDownloaderGetParameters.StartUtc
getset

Start time of the data in UTC

Definition at line 38 of file DataDownloaderGetParameters.cs.

◆ EndUtc

DateTime QuantConnect.DataDownloaderGetParameters.EndUtc
getset

End time of the data in UTC

Definition at line 43 of file DataDownloaderGetParameters.cs.

◆ TickType

TickType QuantConnect.DataDownloaderGetParameters.TickType
getset

The type of tick to get

Definition at line 48 of file DataDownloaderGetParameters.cs.


The documentation for this class was generated from the following file: