DataUniverseDownloaderGetParameters

QuantConnect.DataUniverseDownloaderGetParameters

DataUniverseDownloaderGetParameters(
    canonical_symbol: Union[Symbol, str, BaseContract],
    start_date: Union[datetime, date],
    end_date: Union[datetime, date],
    security_exchange_hours: SecurityExchangeHours = ...,
)

Bases: DataDownloaderGetParameters

Represents the parameters required for downloading universe data.

Initializes a new instance of the DataUniverseDownloaderGetParameters class.

Parameters:

Name	Type	Description	Default
canonical_symbol	Union[Symbol, str, BaseContract]	The canonical symbol for the data request.	required
start_date	Union[datetime, date]	The start date for the data request.	required
end_date	Union[datetime, date]	The end date for the data request.	required
security_exchange_hours	SecurityExchangeHours	The security exchange hours for this symbol	...

underlying_symbol

underlying_symbol: Symbol

Gets the underlying symbol associated with the universe.

symbol

symbol: Symbol

Symbol for the data we're looking for.

resolution

resolution: Resolution

Resolution of the data request

start_utc

start_utc: datetime

Start time of the data in UTC

end_utc

end_utc: datetime

End time of the data in UTC

tick_type

tick_type: TickType

The type of tick to get

create_data_downloader_get_parameters

create_data_downloader_get_parameters() -> (
    Iterable[
        ValueTuple[
            datetime, Iterable[DataDownloaderGetParameters]
        ]
    ]
)

Creates data download parameters for each day in the range.

get_universe_file_name

get_universe_file_name(
    processing_date: Union[datetime, date],
) -> str

Gets the file name where the universe data will be saved.

Parameters:

Name	Type	Description	Default
processing_date	Union[datetime, date]	The date for which the file name is generated.	required

Returns:

Type	Description
str	The universe file name.

to_string

to_string() -> str

Returns a string representation of the DataDownloaderGetParameters object.

Returns:

Type	Description
str	A string representing the object's properties.