CustomSymbols.Add

method · CustomSymbols · cAlgo.API Since 5.3

DesktopCLICloud

Adds a new custom symbol.

Environment behaviour

CLI — not supported. Available to plugins only, and plugins cannot run in the CLI.

Cloud — not supported. Available to plugins only, and plugins cannot run in the cloud.

Overloads

Signature	Description
`Add(string name, Asset baseAsset, Asset quoteAsset)`	Adds a new custom symbol.
`Add(string name, Symbol baseSymbol)`	Adds a new custom symbol based on existing symbol.

Add(string name, Asset baseAsset, Asset quoteAsset)

Adds a new custom symbol.

C#Python

CustomSymbol Add(string name, Asset baseAsset, Asset quoteAsset)

api.CustomSymbols.Add(name: str, baseAsset: Asset, quoteAsset: Asset) -> CustomSymbol

Parameters

Name	C# type	Python type	Description
`name`	`string`	`str`	Custom symbol unique name.
`baseAsset`	`Asset`	`Asset`	Symbol base asset.
`quoteAsset`	`Asset`	`Asset`	Symbol quote asset.

Returns CustomSymbol — CustomSymbol

Examples

C#Python

var customSymbol = CustomSymbols.Add("BTCEUR.custom", Assets.GetAsset("BTC"), Assets.GetAsset("EUR"));
customSymbol.Description = "Bitcoin vs Euro with quotes from my data feed";
Print("Added custom symbol {0} ({1}/{2})", customSymbol.Name, customSymbol.BaseAsset.Name, customSymbol.QuoteAsset.Name);

customSymbol = api.CustomSymbols.Add("BTCEUR.custom", api.Assets.GetAsset("BTC"), api.Assets.GetAsset("EUR"))
customSymbol.Description = "Bitcoin vs Euro with quotes from my data feed"
api.Print(f"Added custom symbol {customSymbol.Name} ({customSymbol.BaseAsset.Name}/{customSymbol.QuoteAsset.Name})")

Add(string name, Symbol baseSymbol)

Adds a new custom symbol based on existing symbol.

C#Python

CustomSymbol Add(string name, Symbol baseSymbol)

api.CustomSymbols.Add(name: str, baseSymbol: Symbol) -> CustomSymbol

Parameters

Name	C# type	Python type	Description
`name`	`string`	`str`	Custom symbol unique name.
`baseSymbol`	`Symbol`	`Symbol`	Base symbol.

Returns CustomSymbol — CustomSymbol

Examples

C#Python

var customSymbol = CustomSymbols.Add("MYEURUSD", Symbols.GetSymbol("EURUSD"));
Print("Custom symbol {0} copies the settings of EURUSD, lot size {1}", customSymbol.Name, customSymbol.LotSize);

customSymbol = api.CustomSymbols.Add("MYEURUSD", api.Symbols.GetSymbol("EURUSD"))
api.Print(f"Custom symbol {customSymbol.Name} copies the settings of EURUSD, lot size {customSymbol.LotSize}")