QuantConnect.Brokerages.ISymbolMapper Interface Reference

Provides the mapping between Lean symbols and brokerage specific symbols. More...

Inheritance diagram for QuantConnect.Brokerages.ISymbolMapper:

Public Member Functions
string	GetBrokerageSymbol (Symbol symbol)
	Converts a Lean symbol instance to a brokerage symbol More...
Symbol	GetLeanSymbol (string brokerageSymbol, SecurityType securityType, string market, DateTime expirationDate=default(DateTime), decimal strike=0, OptionRight optionRight=0)
	Converts a brokerage symbol to a Lean symbol instance More...

Detailed Description

Provides the mapping between Lean symbols and brokerage specific symbols.

Definition at line 23 of file ISymbolMapper.cs.

Member Function Documentation

GetBrokerageSymbol()

string QuantConnect.Brokerages.ISymbolMapper.GetBrokerageSymbol

(

Symbol

symbol

)

Converts a Lean symbol instance to a brokerage symbol

Parameters

symbol

A Lean symbol instance

Returns

The brokerage symbol

Implemented in QuantConnect.Brokerages.SymbolPropertiesDatabaseSymbolMapper.

GetLeanSymbol()

Symbol QuantConnect.Brokerages.ISymbolMapper.GetLeanSymbol	(	string	brokerageSymbol,
		SecurityType	securityType,
		string	market,
		DateTime	expirationDate = default(DateTime),
		decimal	strike = 0,
		OptionRight	optionRight = 0
	)

Converts a brokerage symbol to a Lean symbol instance

Parameters

brokerageSymbol	The brokerage symbol
securityType	The security type
market	The market
expirationDate	Expiration date of the security(if applicable)
strike	The strike of the security (if applicable)
optionRight	The option right of the security (if applicable)

Returns

A new Lean Symbol instance

Implemented in QuantConnect.Brokerages.SymbolPropertiesDatabaseSymbolMapper.

---

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

• Brokerages/ISymbolMapper.cs