Lean  $LEAN_TAG$
QuantConnect.Brokerages.SymbolPropertiesDatabaseSymbolMapper Class Reference

Provides the mapping between Lean symbols and brokerage symbols using the symbol properties database More...

Inheritance diagram for QuantConnect.Brokerages.SymbolPropertiesDatabaseSymbolMapper:
[legend]

Public Member Functions

 SymbolPropertiesDatabaseSymbolMapper (string market)
 Creates a new instance of the SymbolPropertiesDatabaseSymbolMapper class. More...
 
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=OptionRight.Call)
 Converts a brokerage symbol to a Lean symbol instance More...
 
bool IsKnownLeanSymbol (Symbol symbol)
 Checks if the Lean symbol is supported by the brokerage More...
 
SecurityType GetBrokerageSecurityType (string brokerageSymbol)
 Returns the security type for a brokerage symbol More...
 
bool IsKnownBrokerageSymbol (string brokerageSymbol)
 Checks if the symbol is supported by the brokerage More...
 

Detailed Description

Provides the mapping between Lean symbols and brokerage symbols using the symbol properties database

Definition at line 26 of file SymbolPropertiesDatabaseSymbolMapper.cs.

Constructor & Destructor Documentation

◆ SymbolPropertiesDatabaseSymbolMapper()

QuantConnect.Brokerages.SymbolPropertiesDatabaseSymbolMapper.SymbolPropertiesDatabaseSymbolMapper ( string  market)

Creates a new instance of the SymbolPropertiesDatabaseSymbolMapper class.

Parameters
marketThe Lean market

Definition at line 40 of file SymbolPropertiesDatabaseSymbolMapper.cs.

Here is the call graph for this function:

Member Function Documentation

◆ GetBrokerageSymbol()

string QuantConnect.Brokerages.SymbolPropertiesDatabaseSymbolMapper.GetBrokerageSymbol ( Symbol  symbol)

Converts a Lean symbol instance to a brokerage symbol

Parameters
symbolA Lean symbol instance
Returns
The brokerage symbol

Implements QuantConnect.Brokerages.ISymbolMapper.

Definition at line 71 of file SymbolPropertiesDatabaseSymbolMapper.cs.

◆ GetLeanSymbol()

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

Converts a brokerage symbol to a Lean symbol instance

Parameters
brokerageSymbolThe brokerage symbol
securityTypeThe security type
marketThe market
expirationDateExpiration date of the security(if applicable)
strikeThe strike of the security (if applicable)
optionRightThe option right of the security (if applicable)
Returns
A new Lean Symbol instance

Implements QuantConnect.Brokerages.ISymbolMapper.

Definition at line 107 of file SymbolPropertiesDatabaseSymbolMapper.cs.

◆ IsKnownLeanSymbol()

bool QuantConnect.Brokerages.SymbolPropertiesDatabaseSymbolMapper.IsKnownLeanSymbol ( Symbol  symbol)

Checks if the Lean symbol is supported by the brokerage

Parameters
symbolThe Lean symbol
Returns
True if the brokerage supports the symbol

Definition at line 137 of file SymbolPropertiesDatabaseSymbolMapper.cs.

◆ GetBrokerageSecurityType()

SecurityType QuantConnect.Brokerages.SymbolPropertiesDatabaseSymbolMapper.GetBrokerageSecurityType ( string  brokerageSymbol)

Returns the security type for a brokerage symbol

Parameters
brokerageSymbolThe brokerage symbol
Returns
The security type

Definition at line 147 of file SymbolPropertiesDatabaseSymbolMapper.cs.

◆ IsKnownBrokerageSymbol()

bool QuantConnect.Brokerages.SymbolPropertiesDatabaseSymbolMapper.IsKnownBrokerageSymbol ( string  brokerageSymbol)

Checks if the symbol is supported by the brokerage

Parameters
brokerageSymbolThe brokerage symbol
Returns
True if the brokerage supports the symbol

Definition at line 177 of file SymbolPropertiesDatabaseSymbolMapper.cs.


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