Definition of the CompanyReference class More...
Public Member Functions | |
| CompanyReference (ITimeProvider timeProvider, SecurityIdentifier securityIdentifier) | |
| Creates a new instance for the given time and security More... | |
| override FundamentalTimeDependentProperty | Clone (ITimeProvider timeProvider) |
| Clones this instance More... | |
 Public Member Functions inherited from QuantConnect.Data.Fundamental.FundamentalTimeDependentProperty | |
| FundamentalTimeDependentProperty (ITimeProvider timeProvider, SecurityIdentifier securityIdentifier) | |
| Creates a new instance for the given time and security More... | |
Public Attributes | |
| string | CompanyId => FundamentalService.Get<string>(_timeProvider.GetUtcNow(), _securityIdentifier, FundamentalProperty.CompanyReference_CompanyId) |
| 10-digit unique and unchanging Morningstar identifier assigned to every company. More... | |
| string | ShortName => FundamentalService.Get<string>(_timeProvider.GetUtcNow(), _securityIdentifier, FundamentalProperty.CompanyReference_ShortName) |
| 25-character max abbreviated name of the firm. In most cases, the short name will simply be the Legal Name less the "Corporation", "Corp.", "Inc.", "Incorporated", etc... More... | |
| string | StandardName => FundamentalService.Get<string>(_timeProvider.GetUtcNow(), _securityIdentifier, FundamentalProperty.CompanyReference_StandardName) |
| The English translation of the foreign legal name if/when applicable. More... | |
| string | LegalName => FundamentalService.Get<string>(_timeProvider.GetUtcNow(), _securityIdentifier, FundamentalProperty.CompanyReference_LegalName) |
| The full name of the registrant as specified in its charter, and most often found on the front cover of the 10K/10Q/20F filing. More... | |
| string | CountryId => FundamentalService.Get<string>(_timeProvider.GetUtcNow(), _securityIdentifier, FundamentalProperty.CompanyReference_CountryId) |
| 3 Character ISO code of the country where the firm is domiciled. See separate reference document for Country Mappings. More... | |
| string | CIK => FundamentalService.Get<string>(_timeProvider.GetUtcNow(), _securityIdentifier, FundamentalProperty.CompanyReference_CIK) |
| The Central Index Key; a corporate identifier assigned by the Securities and Exchange Commission (SEC). More... | |
| string | CompanyStatus => FundamentalService.Get<string>(_timeProvider.GetUtcNow(), _securityIdentifier, FundamentalProperty.CompanyReference_CompanyStatus) |
| At the Company level; each company is assigned to 1 of 3 possible status classifications; (U) Public, (V) Private, or (O) Obsolete: - Public-Firm is operating and currently has at least one common share class that is currently trading on a public exchange. - Private-Firm is operating but does not have any common share classes currently trading on a public exchange. - Obsolete-Firm is no longer operating because it closed its business, or was acquired. More... | |
| int | FiscalYearEnd => FundamentalService.Get<int>(_timeProvider.GetUtcNow(), _securityIdentifier, FundamentalProperty.CompanyReference_FiscalYearEnd) |
| The Month of the company's latest fiscal year. More... | |
| string | IndustryTemplateCode => FundamentalService.Get<string>(_timeProvider.GetUtcNow(), _securityIdentifier, FundamentalProperty.CompanyReference_IndustryTemplateCode) |
| This indicator will denote which one of the six industry data collection templates applies to the company. Each industry data collection template includes data elements that are commonly reported by companies in that industry. N=Normal (Manufacturing), M=Mining, U=Utility, T=Transportation, B=Bank, I=Insurance More... | |
| string | PrimaryShareClassID => FundamentalService.Get<string>(_timeProvider.GetUtcNow(), _securityIdentifier, FundamentalProperty.CompanyReference_PrimaryShareClassID) |
| The 10-digit unique and unchanging Morningstar identifier assigned to the Primary Share class of a company. The primary share of a company is defined as the first share that was traded publicly and is still actively trading. If this share is no longer trading, the primary share will be the share with the highest volume. More... | |
| string | PrimarySymbol => FundamentalService.Get<string>(_timeProvider.GetUtcNow(), _securityIdentifier, FundamentalProperty.CompanyReference_PrimarySymbol) |
| The symbol of the Primary Share of the company, composed of an arrangement of characters (often letters) representing a particular security listed on an exchange or otherwise traded publicly. The primary share of a company is defined as the first share that was traded publicly and is still actively trading. If this share is no longer trading, the primary share will be the share with the highest volume. Note: Morningstar's multi-share class symbols will often contain a "period" within the symbol; e.g. BRK.B for Berkshire Hathaway Class B. More... | |
| string | PrimaryExchangeID => FundamentalService.Get<string>(_timeProvider.GetUtcNow(), _securityIdentifier, FundamentalProperty.CompanyReference_PrimaryExchangeID) |
| The Id representing the stock exchange of the Primary Share of the company. See separate reference document for Exchange Mappings. The primary share of a company is defined as the first share that was traded publicly with and is still actively trading. If this share is no longer trading, the primary share will be the share with the highest volume. More... | |
| string | BusinessCountryID => FundamentalService.Get<string>(_timeProvider.GetUtcNow(), _securityIdentifier, FundamentalProperty.CompanyReference_BusinessCountryID) |
| In some cases, different from the country of domicile (CountryId; DataID 5). This element is a three (3) Character ISO code of the business country of the security. It is determined by a few factors, including: More... | |
| string | LegalNameLanguageCode => FundamentalService.Get<string>(_timeProvider.GetUtcNow(), _securityIdentifier, FundamentalProperty.CompanyReference_LegalNameLanguageCode) |
| The language code for the foreign legal name if/when applicable. Related to DataID 4 (LegalName). More... | |
| string | Auditor => FundamentalService.Get<string>(_timeProvider.GetUtcNow(), _securityIdentifier, FundamentalProperty.CompanyReference_Auditor) |
| The legal (registered) name of the company's current auditor. Distinct from DataID 28000 Period Auditor that identifies the Auditor related to that period's financial statements. More... | |
| string | AuditorLanguageCode => FundamentalService.Get<string>(_timeProvider.GetUtcNow(), _securityIdentifier, FundamentalProperty.CompanyReference_AuditorLanguageCode) |
| The ISO code denoting the language text for Auditor's name and contact information. More... | |
| string | Advisor => FundamentalService.Get<string>(_timeProvider.GetUtcNow(), _securityIdentifier, FundamentalProperty.CompanyReference_Advisor) |
| The legal (registered) name of the current legal Advisor of the company. More... | |
| string | AdvisorLanguageCode => FundamentalService.Get<string>(_timeProvider.GetUtcNow(), _securityIdentifier, FundamentalProperty.CompanyReference_AdvisorLanguageCode) |
| The ISO code denoting the language text for Advisor's name and contact information. More... | |
| bool | IsLimitedPartnership => FundamentalService.Get<bool>(_timeProvider.GetUtcNow(), _securityIdentifier, FundamentalProperty.CompanyReference_IsLimitedPartnership) |
| Indicator to denote if the company is a limited partnership, which is a form of business structure comprised of a general partner and limited partners. 1 denotes it is a LP; otherwise 0. More... | |
| bool | IsREIT => FundamentalService.Get<bool>(_timeProvider.GetUtcNow(), _securityIdentifier, FundamentalProperty.CompanyReference_IsREIT) |
| Indicator to denote if the company is a real estate investment trust (REIT). 1 denotes it is a REIT; otherwise 0. More... | |
| string | PrimaryMIC => FundamentalService.Get<string>(_timeProvider.GetUtcNow(), _securityIdentifier, FundamentalProperty.CompanyReference_PrimaryMIC) |
| The MIC (market identifier code) of the PrimarySymbol of the company. See Data Appendix A for the relevant MIC to exchange name mapping. More... | |
| int | ReportStyle => FundamentalService.Get<int>(_timeProvider.GetUtcNow(), _securityIdentifier, FundamentalProperty.CompanyReference_ReportStyle) |
| This refers to the financial template used to collect the company's financial statements. There are two report styles representing two different financial template structures. Report style "1" is most commonly used by US and Canadian companies, and Report style "3" is most commonly used by the rest of the universe. Contact your client manager for access to the respective templates. More... | |
| string | YearofEstablishment => FundamentalService.Get<string>(_timeProvider.GetUtcNow(), _securityIdentifier, FundamentalProperty.CompanyReference_YearofEstablishment) |
| The year a company was founded. More... | |
| bool | IsLimitedLiabilityCompany => FundamentalService.Get<bool>(_timeProvider.GetUtcNow(), _securityIdentifier, FundamentalProperty.CompanyReference_IsLimitedLiabilityCompany) |
| Indicator to denote if the company is a limited liability company. 1 denotes it is a LLC; otherwise 0. More... | |
| DateTime | ExpectedFiscalYearEnd => FundamentalService.Get<DateTime>(_timeProvider.GetUtcNow(), _securityIdentifier, FundamentalProperty.CompanyReference_ExpectedFiscalYearEnd) |
| The upcoming expected year end for the company. It is calculated based on current year end (from latest available annual report) + 1 year. More... | |
Additional Inherited Members | |
| Properties inherited from QuantConnect.Data.Fundamental.FundamentalTimeDependentProperty | |
| ITimeProvider | _timeProvider [get] |
| The time provider instance to use More... | |
| SecurityIdentifier | _securityIdentifier [get] |
| The SID instance to use More... | |
Detailed Description
Definition of the CompanyReference class
Definition at line 29 of file CompanyReference.cs.
Constructor & Destructor Documentation
◆ CompanyReference()
| QuantConnect.Data.Fundamental.CompanyReference.CompanyReference | ( | ITimeProvider | timeProvider, |
| SecurityIdentifier | securityIdentifier | ||
| ) |
Creates a new instance for the given time and security
Definition at line 259 of file CompanyReference.cs.
Member Function Documentation
◆ Clone()
|
virtual |
Clones this instance
Implements QuantConnect.Data.Fundamental.FundamentalTimeDependentProperty.
Definition at line 267 of file CompanyReference.cs.
Member Data Documentation
◆ CompanyId
| string QuantConnect.Data.Fundamental.CompanyReference.CompanyId => FundamentalService.Get<string>(_timeProvider.GetUtcNow(), _securityIdentifier, FundamentalProperty.CompanyReference_CompanyId) |
10-digit unique and unchanging Morningstar identifier assigned to every company.
Morningstar DataId: 1
Definition at line 38 of file CompanyReference.cs.
◆ ShortName
| string QuantConnect.Data.Fundamental.CompanyReference.ShortName => FundamentalService.Get<string>(_timeProvider.GetUtcNow(), _securityIdentifier, FundamentalProperty.CompanyReference_ShortName) |
25-character max abbreviated name of the firm. In most cases, the short name will simply be the Legal Name less the "Corporation", "Corp.", "Inc.", "Incorporated", etc...
Morningstar DataId: 2
Definition at line 47 of file CompanyReference.cs.
◆ StandardName
| string QuantConnect.Data.Fundamental.CompanyReference.StandardName => FundamentalService.Get<string>(_timeProvider.GetUtcNow(), _securityIdentifier, FundamentalProperty.CompanyReference_StandardName) |
The English translation of the foreign legal name if/when applicable.
Morningstar DataId: 3
Definition at line 56 of file CompanyReference.cs.
◆ LegalName
| string QuantConnect.Data.Fundamental.CompanyReference.LegalName => FundamentalService.Get<string>(_timeProvider.GetUtcNow(), _securityIdentifier, FundamentalProperty.CompanyReference_LegalName) |
The full name of the registrant as specified in its charter, and most often found on the front cover of the 10K/10Q/20F filing.
Morningstar DataId: 4
Definition at line 65 of file CompanyReference.cs.
◆ CountryId
| string QuantConnect.Data.Fundamental.CompanyReference.CountryId => FundamentalService.Get<string>(_timeProvider.GetUtcNow(), _securityIdentifier, FundamentalProperty.CompanyReference_CountryId) |
3 Character ISO code of the country where the firm is domiciled. See separate reference document for Country Mappings.
Morningstar DataId: 5
Definition at line 74 of file CompanyReference.cs.
◆ CIK
| string QuantConnect.Data.Fundamental.CompanyReference.CIK => FundamentalService.Get<string>(_timeProvider.GetUtcNow(), _securityIdentifier, FundamentalProperty.CompanyReference_CIK) |
The Central Index Key; a corporate identifier assigned by the Securities and Exchange Commission (SEC).
Morningstar DataId: 6
Definition at line 83 of file CompanyReference.cs.
◆ CompanyStatus
| string QuantConnect.Data.Fundamental.CompanyReference.CompanyStatus => FundamentalService.Get<string>(_timeProvider.GetUtcNow(), _securityIdentifier, FundamentalProperty.CompanyReference_CompanyStatus) |
At the Company level; each company is assigned to 1 of 3 possible status classifications; (U) Public, (V) Private, or (O) Obsolete: - Public-Firm is operating and currently has at least one common share class that is currently trading on a public exchange. - Private-Firm is operating but does not have any common share classes currently trading on a public exchange. - Obsolete-Firm is no longer operating because it closed its business, or was acquired.
Morningstar DataId: 9
Definition at line 92 of file CompanyReference.cs.
◆ FiscalYearEnd
| int QuantConnect.Data.Fundamental.CompanyReference.FiscalYearEnd => FundamentalService.Get<int>(_timeProvider.GetUtcNow(), _securityIdentifier, FundamentalProperty.CompanyReference_FiscalYearEnd) |
The Month of the company's latest fiscal year.
Morningstar DataId: 10
Definition at line 101 of file CompanyReference.cs.
◆ IndustryTemplateCode
| string QuantConnect.Data.Fundamental.CompanyReference.IndustryTemplateCode => FundamentalService.Get<string>(_timeProvider.GetUtcNow(), _securityIdentifier, FundamentalProperty.CompanyReference_IndustryTemplateCode) |
This indicator will denote which one of the six industry data collection templates applies to the company. Each industry data collection template includes data elements that are commonly reported by companies in that industry. N=Normal (Manufacturing), M=Mining, U=Utility, T=Transportation, B=Bank, I=Insurance
Morningstar DataId: 11
Definition at line 110 of file CompanyReference.cs.
◆ PrimaryShareClassID
| string QuantConnect.Data.Fundamental.CompanyReference.PrimaryShareClassID => FundamentalService.Get<string>(_timeProvider.GetUtcNow(), _securityIdentifier, FundamentalProperty.CompanyReference_PrimaryShareClassID) |
The 10-digit unique and unchanging Morningstar identifier assigned to the Primary Share class of a company. The primary share of a company is defined as the first share that was traded publicly and is still actively trading. If this share is no longer trading, the primary share will be the share with the highest volume.
Morningstar DataId: 12
Definition at line 119 of file CompanyReference.cs.
◆ PrimarySymbol
| string QuantConnect.Data.Fundamental.CompanyReference.PrimarySymbol => FundamentalService.Get<string>(_timeProvider.GetUtcNow(), _securityIdentifier, FundamentalProperty.CompanyReference_PrimarySymbol) |
The symbol of the Primary Share of the company, composed of an arrangement of characters (often letters) representing a particular security listed on an exchange or otherwise traded publicly. The primary share of a company is defined as the first share that was traded publicly and is still actively trading. If this share is no longer trading, the primary share will be the share with the highest volume. Note: Morningstar's multi-share class symbols will often contain a "period" within the symbol; e.g. BRK.B for Berkshire Hathaway Class B.
Morningstar DataId: 13
Definition at line 128 of file CompanyReference.cs.
◆ PrimaryExchangeID
| string QuantConnect.Data.Fundamental.CompanyReference.PrimaryExchangeID => FundamentalService.Get<string>(_timeProvider.GetUtcNow(), _securityIdentifier, FundamentalProperty.CompanyReference_PrimaryExchangeID) |
The Id representing the stock exchange of the Primary Share of the company. See separate reference document for Exchange Mappings. The primary share of a company is defined as the first share that was traded publicly with and is still actively trading. If this share is no longer trading, the primary share will be the share with the highest volume.
Morningstar DataId: 14
Definition at line 137 of file CompanyReference.cs.
◆ BusinessCountryID
| string QuantConnect.Data.Fundamental.CompanyReference.BusinessCountryID => FundamentalService.Get<string>(_timeProvider.GetUtcNow(), _securityIdentifier, FundamentalProperty.CompanyReference_BusinessCountryID) |
In some cases, different from the country of domicile (CountryId; DataID 5). This element is a three (3) Character ISO code of the business country of the security. It is determined by a few factors, including:
Morningstar DataId: 15
Definition at line 146 of file CompanyReference.cs.
◆ LegalNameLanguageCode
| string QuantConnect.Data.Fundamental.CompanyReference.LegalNameLanguageCode => FundamentalService.Get<string>(_timeProvider.GetUtcNow(), _securityIdentifier, FundamentalProperty.CompanyReference_LegalNameLanguageCode) |
The language code for the foreign legal name if/when applicable. Related to DataID 4 (LegalName).
Morningstar DataId: 16
Definition at line 155 of file CompanyReference.cs.
◆ Auditor
| string QuantConnect.Data.Fundamental.CompanyReference.Auditor => FundamentalService.Get<string>(_timeProvider.GetUtcNow(), _securityIdentifier, FundamentalProperty.CompanyReference_Auditor) |
The legal (registered) name of the company's current auditor. Distinct from DataID 28000 Period Auditor that identifies the Auditor related to that period's financial statements.
Morningstar DataId: 17
Definition at line 164 of file CompanyReference.cs.
◆ AuditorLanguageCode
| string QuantConnect.Data.Fundamental.CompanyReference.AuditorLanguageCode => FundamentalService.Get<string>(_timeProvider.GetUtcNow(), _securityIdentifier, FundamentalProperty.CompanyReference_AuditorLanguageCode) |
The ISO code denoting the language text for Auditor's name and contact information.
Morningstar DataId: 18
Definition at line 173 of file CompanyReference.cs.
◆ Advisor
| string QuantConnect.Data.Fundamental.CompanyReference.Advisor => FundamentalService.Get<string>(_timeProvider.GetUtcNow(), _securityIdentifier, FundamentalProperty.CompanyReference_Advisor) |
The legal (registered) name of the current legal Advisor of the company.
Morningstar DataId: 19
Definition at line 182 of file CompanyReference.cs.
◆ AdvisorLanguageCode
| string QuantConnect.Data.Fundamental.CompanyReference.AdvisorLanguageCode => FundamentalService.Get<string>(_timeProvider.GetUtcNow(), _securityIdentifier, FundamentalProperty.CompanyReference_AdvisorLanguageCode) |
The ISO code denoting the language text for Advisor's name and contact information.
Morningstar DataId: 20
Definition at line 191 of file CompanyReference.cs.
◆ IsLimitedPartnership
| bool QuantConnect.Data.Fundamental.CompanyReference.IsLimitedPartnership => FundamentalService.Get<bool>(_timeProvider.GetUtcNow(), _securityIdentifier, FundamentalProperty.CompanyReference_IsLimitedPartnership) |
Indicator to denote if the company is a limited partnership, which is a form of business structure comprised of a general partner and limited partners. 1 denotes it is a LP; otherwise 0.
Morningstar DataId: 21
Definition at line 200 of file CompanyReference.cs.
◆ IsREIT
| bool QuantConnect.Data.Fundamental.CompanyReference.IsREIT => FundamentalService.Get<bool>(_timeProvider.GetUtcNow(), _securityIdentifier, FundamentalProperty.CompanyReference_IsREIT) |
Indicator to denote if the company is a real estate investment trust (REIT). 1 denotes it is a REIT; otherwise 0.
Morningstar DataId: 22
Definition at line 209 of file CompanyReference.cs.
◆ PrimaryMIC
| string QuantConnect.Data.Fundamental.CompanyReference.PrimaryMIC => FundamentalService.Get<string>(_timeProvider.GetUtcNow(), _securityIdentifier, FundamentalProperty.CompanyReference_PrimaryMIC) |
The MIC (market identifier code) of the PrimarySymbol of the company. See Data Appendix A for the relevant MIC to exchange name mapping.
Morningstar DataId: 23
Definition at line 218 of file CompanyReference.cs.
◆ ReportStyle
| int QuantConnect.Data.Fundamental.CompanyReference.ReportStyle => FundamentalService.Get<int>(_timeProvider.GetUtcNow(), _securityIdentifier, FundamentalProperty.CompanyReference_ReportStyle) |
This refers to the financial template used to collect the company's financial statements. There are two report styles representing two different financial template structures. Report style "1" is most commonly used by US and Canadian companies, and Report style "3" is most commonly used by the rest of the universe. Contact your client manager for access to the respective templates.
Morningstar DataId: 24
Definition at line 227 of file CompanyReference.cs.
◆ YearofEstablishment
| string QuantConnect.Data.Fundamental.CompanyReference.YearofEstablishment => FundamentalService.Get<string>(_timeProvider.GetUtcNow(), _securityIdentifier, FundamentalProperty.CompanyReference_YearofEstablishment) |
The year a company was founded.
Morningstar DataId: 25
Definition at line 236 of file CompanyReference.cs.
◆ IsLimitedLiabilityCompany
| bool QuantConnect.Data.Fundamental.CompanyReference.IsLimitedLiabilityCompany => FundamentalService.Get<bool>(_timeProvider.GetUtcNow(), _securityIdentifier, FundamentalProperty.CompanyReference_IsLimitedLiabilityCompany) |
Indicator to denote if the company is a limited liability company. 1 denotes it is a LLC; otherwise 0.
Morningstar DataId: 26
Definition at line 245 of file CompanyReference.cs.
◆ ExpectedFiscalYearEnd
| DateTime QuantConnect.Data.Fundamental.CompanyReference.ExpectedFiscalYearEnd => FundamentalService.Get<DateTime>(_timeProvider.GetUtcNow(), _securityIdentifier, FundamentalProperty.CompanyReference_ExpectedFiscalYearEnd) |
The upcoming expected year end for the company. It is calculated based on current year end (from latest available annual report) + 1 year.
Morningstar DataId: 27
Definition at line 254 of file CompanyReference.cs.
The documentation for this class was generated from the following file:
- Common/Data/Fundamental/Generated/CompanyReference.cs
