IDownloadProvider

QuantConnect.Interfaces.IDownloadProvider

Wrapper on the API for downloading data for an algorithm.

download

download(
    address: str,
    headers: List[KeyValuePair[str, str]],
    user_name: str,
    password: str,
) -> str

Method for downloading data for an algorithm

Parameters:

Name	Type	Description	Default
address	str	Source URL to download from	required
headers	List[KeyValuePair[str, str]]	Headers to pass to the site	required
user_name	str	Username for basic authentication	required
password	str	Password for basic authentication	required

Returns:

Type	Description
str	String contents of file.

download_bytes

download_bytes(
    address: str,
    headers: List[KeyValuePair[str, str]],
    user_name: str,
    password: str,
) -> List[int]

Method for downloading data for an algorithm that can be read from a stream

Parameters:

Name	Type	Description	Default
address	str	Source URL to download from	required
headers	List[KeyValuePair[str, str]]	Headers to pass to the site	required
user_name	str	Username for basic authentication	required
password	str	Password for basic authentication	required

Returns:

Type	Description
List[int]	String contents of file.