Lean  $LEAN_TAG$
QuantConnect.Interfaces.IDownloadProvider Interface Reference

Wrapper on the API for downloading data for an algorithm. More...

Inheritance diagram for QuantConnect.Interfaces.IDownloadProvider:
[legend]

Public Member Functions

string Download (string address, IEnumerable< KeyValuePair< string, string >> headers, string userName, string password)
 Method for downloading data for an algorithm More...
 
byte[] DownloadBytes (string address, IEnumerable< KeyValuePair< string, string >> headers, string userName, string password)
 Method for downloading data for an algorithm that can be read from a stream More...
 

Detailed Description

Wrapper on the API for downloading data for an algorithm.

Definition at line 22 of file IDownloadProvider.cs.

Member Function Documentation

◆ Download()

string QuantConnect.Interfaces.IDownloadProvider.Download ( string  address,
IEnumerable< KeyValuePair< string, string >>  headers,
string  userName,
string  password 
)

Method for downloading data for an algorithm

Parameters
addressSource URL to download from
headersHeaders to pass to the site
userNameUsername for basic authentication
passwordPassword for basic authentication
Returns
String contents of file

Implemented in QuantConnect.Api.Api.

◆ DownloadBytes()

byte [] QuantConnect.Interfaces.IDownloadProvider.DownloadBytes ( string  address,
IEnumerable< KeyValuePair< string, string >>  headers,
string  userName,
string  password 
)

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

Parameters
addressSource URL to download from
headersHeaders to pass to the site
userNameUsername for basic authentication
passwordPassword for basic authentication
Returns
String contents of file

Implemented in QuantConnect.Api.Api.

Here is the caller graph for this function:

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