Helper class to put BaseLiveAlgorithmSettings in proper format. More...

Public Member Functions
	LiveAlgorithmApiSettingsWrapper (int projectId, string compileId, string nodeId, Dictionary< string, object > settings, string version="-1", Dictionary< string, object > dataProviders=null, Dictionary< string, string > parameters=null, Dictionary< string, List< string >> notification=null)
	Constructor for LiveAlgorithmApiSettingsWrapper More...

Properties
string	VersionId `[get, set]`
	-1 is master More...

int	ProjectId `[get]`
	Project id for the live instance More...

string	CompileId `[get]`
	Compile Id for the live algorithm More...

string	NodeId `[get]`
	Id of the node being used to run live algorithm More...

string	Signature `[get]`
	Signature of the live algorithm More...

bool	AutomaticRedeploy `[get]`
	True to enable Automatic Re-Deploy of the live algorithm, false otherwise More...

Dictionary< string, object >	Brokerage `[get]`
	The API expects the settings as part of a brokerage object More...

Dictionary< string, object >	DataProviders `[get]`
	Dictionary with the data providers and their corresponding credentials More...

Dictionary< string, string >	Parameters `[get]`
	Dictionary with the parameters to be used in the live algorithm More...

Dictionary< string, List< string > >	Notification `[get]`
	Dictionary with the lists of events and targets More...

Detailed Description

Helper class to put BaseLiveAlgorithmSettings in proper format.

Definition at line 27 of file LiveAlgorithmSettings.cs.

Constructor & Destructor Documentation

◆ LiveAlgorithmApiSettingsWrapper()

QuantConnect.Api.LiveAlgorithmApiSettingsWrapper.LiveAlgorithmApiSettingsWrapper	(	int	projectId,
		string	compileId,
		string	nodeId,
		Dictionary< string, object >	settings,
		string	version = `"-1"`,
		Dictionary< string, object >	dataProviders = `null`,
		Dictionary< string, string >	parameters = `null`,
		Dictionary< string, List< string >>	notification = `null`
	)

Constructor for LiveAlgorithmApiSettingsWrapper

Parameters

projectId	Id of project from QuantConnect
compileId	Id of compilation of project from QuantConnect
nodeId	Server type to run live Algorithm
settings	Dictionary with brokerage specific settings. Each brokerage requires certain specific credentials in order to process the given orders. Each key in this dictionary represents a required field/credential to provide to the brokerage API and its value represents the value of that field. For example: "brokerageSettings: { "id": "Binance", "binance-api-secret": "123ABC", "binance-api-key": "ABC123"}. It is worth saying, that this dictionary must always contain an entry whose key is "id" and its value is the name of the brokerage (see <see cref="Brokerages.BrokerageName"/>)</param> <param name="version">The version identifier</param> <param name="dataProviders">Dictionary with data providers credentials. Each data provider requires certain credentials in order to retrieve data from their API. Each key in this dictionary describes a data provider name and its corresponding value is another dictionary with the required key-value pairs of credential names and values. For example: "dataProviders: {InteractiveBrokersBrokerage : { "id": 12345, "environement" : "paper", "username": "testUsername", "password": "testPassword"}}"
parameters	Dictionary to specify the parameters for the live algorithm
notification	Dictionary with the lists of events and targets

Definition at line 49 of file LiveAlgorithmSettings.cs.

Property Documentation

◆ VersionId

string QuantConnect.Api.LiveAlgorithmApiSettingsWrapper.VersionId

getset

-1 is master

Definition at line 84 of file LiveAlgorithmSettings.cs.

◆ ProjectId

int QuantConnect.Api.LiveAlgorithmApiSettingsWrapper.ProjectId

get

Project id for the live instance

Definition at line 90 of file LiveAlgorithmSettings.cs.

◆ CompileId

string QuantConnect.Api.LiveAlgorithmApiSettingsWrapper.CompileId

get

Compile Id for the live algorithm

Definition at line 96 of file LiveAlgorithmSettings.cs.

◆ NodeId

string QuantConnect.Api.LiveAlgorithmApiSettingsWrapper.NodeId

get

Id of the node being used to run live algorithm

Definition at line 102 of file LiveAlgorithmSettings.cs.

◆ Signature

string QuantConnect.Api.LiveAlgorithmApiSettingsWrapper.Signature

get

Signature of the live algorithm

Definition at line 108 of file LiveAlgorithmSettings.cs.

◆ AutomaticRedeploy

bool QuantConnect.Api.LiveAlgorithmApiSettingsWrapper.AutomaticRedeploy

get

True to enable Automatic Re-Deploy of the live algorithm, false otherwise

Definition at line 115 of file LiveAlgorithmSettings.cs.

◆ Brokerage

Dictionary<string, object> QuantConnect.Api.LiveAlgorithmApiSettingsWrapper.Brokerage

get

The API expects the settings as part of a brokerage object

Definition at line 121 of file LiveAlgorithmSettings.cs.

◆ DataProviders

Dictionary<string, object> QuantConnect.Api.LiveAlgorithmApiSettingsWrapper.DataProviders

get

Dictionary with the data providers and their corresponding credentials

Definition at line 127 of file LiveAlgorithmSettings.cs.

◆ Parameters

Dictionary<string, string> QuantConnect.Api.LiveAlgorithmApiSettingsWrapper.Parameters

get

Dictionary with the parameters to be used in the live algorithm

Definition at line 133 of file LiveAlgorithmSettings.cs.

◆ Notification

Dictionary<string, List<string> > QuantConnect.Api.LiveAlgorithmApiSettingsWrapper.Notification

get

Dictionary with the lists of events and targets

Definition at line 139 of file LiveAlgorithmSettings.cs.

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

Common/Api/LiveAlgorithmSettings.cs

Public Member Functions

Properties