Lean
$LEAN_TAG$
|
Definition of the CompanyProfile class More...
Public Member Functions | |
CompanyProfile (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 | HeadquarterAddressLine1 => FundamentalService.Get<string>(_timeProvider.GetUtcNow(), _securityIdentifier, FundamentalProperty.CompanyProfile_HeadquarterAddressLine1) |
The headquarter address as given in the latest report More... | |
string | HeadquarterAddressLine2 => FundamentalService.Get<string>(_timeProvider.GetUtcNow(), _securityIdentifier, FundamentalProperty.CompanyProfile_HeadquarterAddressLine2) |
The headquarter address as given in the latest report More... | |
string | HeadquarterAddressLine3 => FundamentalService.Get<string>(_timeProvider.GetUtcNow(), _securityIdentifier, FundamentalProperty.CompanyProfile_HeadquarterAddressLine3) |
The headquarter address as given in the latest report More... | |
string | HeadquarterAddressLine4 => FundamentalService.Get<string>(_timeProvider.GetUtcNow(), _securityIdentifier, FundamentalProperty.CompanyProfile_HeadquarterAddressLine4) |
The headquarter address as given in the latest report More... | |
string | HeadquarterAddressLine5 => FundamentalService.Get<string>(_timeProvider.GetUtcNow(), _securityIdentifier, FundamentalProperty.CompanyProfile_HeadquarterAddressLine5) |
The headquarter address as given in the latest report More... | |
string | HeadquarterCity => FundamentalService.Get<string>(_timeProvider.GetUtcNow(), _securityIdentifier, FundamentalProperty.CompanyProfile_HeadquarterCity) |
The headquarter city as given in the latest report More... | |
string | HeadquarterProvince => FundamentalService.Get<string>(_timeProvider.GetUtcNow(), _securityIdentifier, FundamentalProperty.CompanyProfile_HeadquarterProvince) |
The headquarter state or province as given in the latest report More... | |
string | HeadquarterCountry => FundamentalService.Get<string>(_timeProvider.GetUtcNow(), _securityIdentifier, FundamentalProperty.CompanyProfile_HeadquarterCountry) |
The headquarter country as given in the latest report More... | |
string | HeadquarterPostalCode => FundamentalService.Get<string>(_timeProvider.GetUtcNow(), _securityIdentifier, FundamentalProperty.CompanyProfile_HeadquarterPostalCode) |
The headquarter postal code as given in the latest report More... | |
string | HeadquarterPhone => FundamentalService.Get<string>(_timeProvider.GetUtcNow(), _securityIdentifier, FundamentalProperty.CompanyProfile_HeadquarterPhone) |
The headquarter phone number as given in the latest report More... | |
string | HeadquarterFax => FundamentalService.Get<string>(_timeProvider.GetUtcNow(), _securityIdentifier, FundamentalProperty.CompanyProfile_HeadquarterFax) |
The headquarter fax number as given in the latest report More... | |
string | HeadquarterHomepage => FundamentalService.Get<string>(_timeProvider.GetUtcNow(), _securityIdentifier, FundamentalProperty.CompanyProfile_HeadquarterHomepage) |
The headquarters' website address as given in the latest report More... | |
int | TotalEmployeeNumber => FundamentalService.Get<int>(_timeProvider.GetUtcNow(), _securityIdentifier, FundamentalProperty.CompanyProfile_TotalEmployeeNumber) |
The number of employees as indicated on the latest Annual Report, 10-K filing, Form 20-F or equivalent report indicating the employee count at the end of latest fiscal year. More... | |
string | ContactEmail => FundamentalService.Get<string>(_timeProvider.GetUtcNow(), _securityIdentifier, FundamentalProperty.CompanyProfile_ContactEmail) |
Company's contact email address More... | |
int | AverageEmployeeNumber => FundamentalService.Get<int>(_timeProvider.GetUtcNow(), _securityIdentifier, FundamentalProperty.CompanyProfile_AverageEmployeeNumber) |
Average number of employees from Annual Report More... | |
string | RegisteredAddressLine1 => FundamentalService.Get<string>(_timeProvider.GetUtcNow(), _securityIdentifier, FundamentalProperty.CompanyProfile_RegisteredAddressLine1) |
Details for registered office contact information including address full details, phone and More... | |
string | RegisteredAddressLine2 => FundamentalService.Get<string>(_timeProvider.GetUtcNow(), _securityIdentifier, FundamentalProperty.CompanyProfile_RegisteredAddressLine2) |
Address for registered office More... | |
string | RegisteredAddressLine3 => FundamentalService.Get<string>(_timeProvider.GetUtcNow(), _securityIdentifier, FundamentalProperty.CompanyProfile_RegisteredAddressLine3) |
Address for registered office More... | |
string | RegisteredAddressLine4 => FundamentalService.Get<string>(_timeProvider.GetUtcNow(), _securityIdentifier, FundamentalProperty.CompanyProfile_RegisteredAddressLine4) |
Address for registered office More... | |
string | RegisteredCity => FundamentalService.Get<string>(_timeProvider.GetUtcNow(), _securityIdentifier, FundamentalProperty.CompanyProfile_RegisteredCity) |
City for registered office More... | |
string | RegisteredProvince => FundamentalService.Get<string>(_timeProvider.GetUtcNow(), _securityIdentifier, FundamentalProperty.CompanyProfile_RegisteredProvince) |
Province for registered office More... | |
string | RegisteredCountry => FundamentalService.Get<string>(_timeProvider.GetUtcNow(), _securityIdentifier, FundamentalProperty.CompanyProfile_RegisteredCountry) |
Country for registered office More... | |
string | RegisteredPostalCode => FundamentalService.Get<string>(_timeProvider.GetUtcNow(), _securityIdentifier, FundamentalProperty.CompanyProfile_RegisteredPostalCode) |
Postal Code for registered office More... | |
string | RegisteredPhone => FundamentalService.Get<string>(_timeProvider.GetUtcNow(), _securityIdentifier, FundamentalProperty.CompanyProfile_RegisteredPhone) |
Phone number for registered office More... | |
string | RegisteredFax => FundamentalService.Get<string>(_timeProvider.GetUtcNow(), _securityIdentifier, FundamentalProperty.CompanyProfile_RegisteredFax) |
Fax number for registered office More... | |
bool | IsHeadOfficeSameWithRegisteredOfficeFlag => FundamentalService.Get<bool>(_timeProvider.GetUtcNow(), _securityIdentifier, FundamentalProperty.CompanyProfile_IsHeadOfficeSameWithRegisteredOfficeFlag) |
Flag to denote whether head and registered offices are the same More... | |
long | SharesOutstanding => FundamentalService.Get<long>(_timeProvider.GetUtcNow(), _securityIdentifier, FundamentalProperty.CompanyProfile_SharesOutstanding) |
The latest total shares outstanding reported by the company; most common source of this information is from the cover of the 10K, 10Q, or 20F filing. This figure is an aggregated shares outstanding number for a company. It can be used to calculate the most accurate market cap, based on each individual share's trading price and the total aggregated shares outstanding figure. More... | |
long | MarketCap => FundamentalService.Get<long>(_timeProvider.GetUtcNow(), _securityIdentifier, FundamentalProperty.CompanyProfile_MarketCap) |
Price * Total SharesOutstanding. The most current market cap for example, would be the most recent closing price x the most recent reported shares outstanding. For ADR share classes, market cap is price * (ordinary shares outstanding / adr ratio). More... | |
long | EnterpriseValue => FundamentalService.Get<long>(_timeProvider.GetUtcNow(), _securityIdentifier, FundamentalProperty.CompanyProfile_EnterpriseValue) |
This number tells you what cash return you would get if you bought the entire company, including its debt. Enterprise Value = Market Cap + Preferred stock + Long-Term Debt And Capital Lease + Short Term Debt And Capital Lease + Securities Sold But Not Yet Repurchased - Cash, Cash Equivalent And Market Securities - Securities Purchased with Agreement to Resell - Securities Borrowed. More... | |
long | ShareClassLevelSharesOutstanding => FundamentalService.Get<long>(_timeProvider.GetUtcNow(), _securityIdentifier, FundamentalProperty.CompanyProfile_ShareClassLevelSharesOutstanding) |
The latest shares outstanding reported by the company of a particular share class; most common source of this information is from the cover of the 10K, 10Q, or 20F filing. This figure is an aggregated shares outstanding number for a particular share class of the company. More... | |
long | SharesOutstandingWithBalanceSheetEndingDate => FundamentalService.Get<long>(_timeProvider.GetUtcNow(), _securityIdentifier, FundamentalProperty.CompanyProfile_SharesOutstandingWithBalanceSheetEndingDate) |
Total shares outstanding reported by the company as of the balance sheet period ended date. The most common source of this information is from the 10K, 10Q, or 20F filing. This figure is an aggregated shares outstanding number for a company. More... | |
string | ReasonofSharesChange => FundamentalService.Get<string>(_timeProvider.GetUtcNow(), _securityIdentifier, FundamentalProperty.CompanyProfile_ReasonofSharesChange) |
The reason for the change in a company's total shares outstanding from the previous record. Examples could be share issuances or share buy-back. This field will only be populated when total shares outstanding is collected from a press release. 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... | |
Definition of the CompanyProfile class
Definition at line 29 of file CompanyProfile.cs.
QuantConnect.Data.Fundamental.CompanyProfile.CompanyProfile | ( | ITimeProvider | timeProvider, |
SecurityIdentifier | securityIdentifier | ||
) |
Creates a new instance for the given time and security
Definition at line 322 of file CompanyProfile.cs.
|
virtual |
Clones this instance
Implements QuantConnect.Data.Fundamental.FundamentalTimeDependentProperty.
Definition at line 330 of file CompanyProfile.cs.
string QuantConnect.Data.Fundamental.CompanyProfile.HeadquarterAddressLine1 => FundamentalService.Get<string>(_timeProvider.GetUtcNow(), _securityIdentifier, FundamentalProperty.CompanyProfile_HeadquarterAddressLine1) |
The headquarter address as given in the latest report
Morningstar DataId: 2100
Definition at line 38 of file CompanyProfile.cs.
string QuantConnect.Data.Fundamental.CompanyProfile.HeadquarterAddressLine2 => FundamentalService.Get<string>(_timeProvider.GetUtcNow(), _securityIdentifier, FundamentalProperty.CompanyProfile_HeadquarterAddressLine2) |
The headquarter address as given in the latest report
Morningstar DataId: 2101
Definition at line 47 of file CompanyProfile.cs.
string QuantConnect.Data.Fundamental.CompanyProfile.HeadquarterAddressLine3 => FundamentalService.Get<string>(_timeProvider.GetUtcNow(), _securityIdentifier, FundamentalProperty.CompanyProfile_HeadquarterAddressLine3) |
The headquarter address as given in the latest report
Morningstar DataId: 2102
Definition at line 56 of file CompanyProfile.cs.
string QuantConnect.Data.Fundamental.CompanyProfile.HeadquarterAddressLine4 => FundamentalService.Get<string>(_timeProvider.GetUtcNow(), _securityIdentifier, FundamentalProperty.CompanyProfile_HeadquarterAddressLine4) |
The headquarter address as given in the latest report
Morningstar DataId: 2103
Definition at line 65 of file CompanyProfile.cs.
string QuantConnect.Data.Fundamental.CompanyProfile.HeadquarterAddressLine5 => FundamentalService.Get<string>(_timeProvider.GetUtcNow(), _securityIdentifier, FundamentalProperty.CompanyProfile_HeadquarterAddressLine5) |
The headquarter address as given in the latest report
Morningstar DataId: 2104
Definition at line 74 of file CompanyProfile.cs.
string QuantConnect.Data.Fundamental.CompanyProfile.HeadquarterCity => FundamentalService.Get<string>(_timeProvider.GetUtcNow(), _securityIdentifier, FundamentalProperty.CompanyProfile_HeadquarterCity) |
The headquarter city as given in the latest report
Morningstar DataId: 2105
Definition at line 83 of file CompanyProfile.cs.
string QuantConnect.Data.Fundamental.CompanyProfile.HeadquarterProvince => FundamentalService.Get<string>(_timeProvider.GetUtcNow(), _securityIdentifier, FundamentalProperty.CompanyProfile_HeadquarterProvince) |
The headquarter state or province as given in the latest report
Morningstar DataId: 2106
Definition at line 92 of file CompanyProfile.cs.
string QuantConnect.Data.Fundamental.CompanyProfile.HeadquarterCountry => FundamentalService.Get<string>(_timeProvider.GetUtcNow(), _securityIdentifier, FundamentalProperty.CompanyProfile_HeadquarterCountry) |
The headquarter country as given in the latest report
Morningstar DataId: 2107
Definition at line 101 of file CompanyProfile.cs.
string QuantConnect.Data.Fundamental.CompanyProfile.HeadquarterPostalCode => FundamentalService.Get<string>(_timeProvider.GetUtcNow(), _securityIdentifier, FundamentalProperty.CompanyProfile_HeadquarterPostalCode) |
The headquarter postal code as given in the latest report
Morningstar DataId: 2108
Definition at line 110 of file CompanyProfile.cs.
string QuantConnect.Data.Fundamental.CompanyProfile.HeadquarterPhone => FundamentalService.Get<string>(_timeProvider.GetUtcNow(), _securityIdentifier, FundamentalProperty.CompanyProfile_HeadquarterPhone) |
The headquarter phone number as given in the latest report
Morningstar DataId: 2109
Definition at line 119 of file CompanyProfile.cs.
string QuantConnect.Data.Fundamental.CompanyProfile.HeadquarterFax => FundamentalService.Get<string>(_timeProvider.GetUtcNow(), _securityIdentifier, FundamentalProperty.CompanyProfile_HeadquarterFax) |
The headquarter fax number as given in the latest report
Morningstar DataId: 2110
Definition at line 128 of file CompanyProfile.cs.
string QuantConnect.Data.Fundamental.CompanyProfile.HeadquarterHomepage => FundamentalService.Get<string>(_timeProvider.GetUtcNow(), _securityIdentifier, FundamentalProperty.CompanyProfile_HeadquarterHomepage) |
The headquarters' website address as given in the latest report
Morningstar DataId: 2111
Definition at line 137 of file CompanyProfile.cs.
int QuantConnect.Data.Fundamental.CompanyProfile.TotalEmployeeNumber => FundamentalService.Get<int>(_timeProvider.GetUtcNow(), _securityIdentifier, FundamentalProperty.CompanyProfile_TotalEmployeeNumber) |
The number of employees as indicated on the latest Annual Report, 10-K filing, Form 20-F or equivalent report indicating the employee count at the end of latest fiscal year.
Morningstar DataId: 2113
Definition at line 146 of file CompanyProfile.cs.
string QuantConnect.Data.Fundamental.CompanyProfile.ContactEmail => FundamentalService.Get<string>(_timeProvider.GetUtcNow(), _securityIdentifier, FundamentalProperty.CompanyProfile_ContactEmail) |
Company's contact email address
Morningstar DataId: 2114
Definition at line 155 of file CompanyProfile.cs.
int QuantConnect.Data.Fundamental.CompanyProfile.AverageEmployeeNumber => FundamentalService.Get<int>(_timeProvider.GetUtcNow(), _securityIdentifier, FundamentalProperty.CompanyProfile_AverageEmployeeNumber) |
Average number of employees from Annual Report
Morningstar DataId: 2115
Definition at line 164 of file CompanyProfile.cs.
string QuantConnect.Data.Fundamental.CompanyProfile.RegisteredAddressLine1 => FundamentalService.Get<string>(_timeProvider.GetUtcNow(), _securityIdentifier, FundamentalProperty.CompanyProfile_RegisteredAddressLine1) |
Details for registered office contact information including address full details, phone and
Morningstar DataId: 2116
Definition at line 173 of file CompanyProfile.cs.
string QuantConnect.Data.Fundamental.CompanyProfile.RegisteredAddressLine2 => FundamentalService.Get<string>(_timeProvider.GetUtcNow(), _securityIdentifier, FundamentalProperty.CompanyProfile_RegisteredAddressLine2) |
Address for registered office
Morningstar DataId: 2117
Definition at line 182 of file CompanyProfile.cs.
string QuantConnect.Data.Fundamental.CompanyProfile.RegisteredAddressLine3 => FundamentalService.Get<string>(_timeProvider.GetUtcNow(), _securityIdentifier, FundamentalProperty.CompanyProfile_RegisteredAddressLine3) |
Address for registered office
Morningstar DataId: 2118
Definition at line 191 of file CompanyProfile.cs.
string QuantConnect.Data.Fundamental.CompanyProfile.RegisteredAddressLine4 => FundamentalService.Get<string>(_timeProvider.GetUtcNow(), _securityIdentifier, FundamentalProperty.CompanyProfile_RegisteredAddressLine4) |
Address for registered office
Morningstar DataId: 2119
Definition at line 200 of file CompanyProfile.cs.
string QuantConnect.Data.Fundamental.CompanyProfile.RegisteredCity => FundamentalService.Get<string>(_timeProvider.GetUtcNow(), _securityIdentifier, FundamentalProperty.CompanyProfile_RegisteredCity) |
City for registered office
Morningstar DataId: 2120
Definition at line 209 of file CompanyProfile.cs.
string QuantConnect.Data.Fundamental.CompanyProfile.RegisteredProvince => FundamentalService.Get<string>(_timeProvider.GetUtcNow(), _securityIdentifier, FundamentalProperty.CompanyProfile_RegisteredProvince) |
Province for registered office
Morningstar DataId: 2121
Definition at line 218 of file CompanyProfile.cs.
string QuantConnect.Data.Fundamental.CompanyProfile.RegisteredCountry => FundamentalService.Get<string>(_timeProvider.GetUtcNow(), _securityIdentifier, FundamentalProperty.CompanyProfile_RegisteredCountry) |
Country for registered office
Morningstar DataId: 2122
Definition at line 227 of file CompanyProfile.cs.
string QuantConnect.Data.Fundamental.CompanyProfile.RegisteredPostalCode => FundamentalService.Get<string>(_timeProvider.GetUtcNow(), _securityIdentifier, FundamentalProperty.CompanyProfile_RegisteredPostalCode) |
Postal Code for registered office
Morningstar DataId: 2123
Definition at line 236 of file CompanyProfile.cs.
string QuantConnect.Data.Fundamental.CompanyProfile.RegisteredPhone => FundamentalService.Get<string>(_timeProvider.GetUtcNow(), _securityIdentifier, FundamentalProperty.CompanyProfile_RegisteredPhone) |
Phone number for registered office
Morningstar DataId: 2124
Definition at line 245 of file CompanyProfile.cs.
string QuantConnect.Data.Fundamental.CompanyProfile.RegisteredFax => FundamentalService.Get<string>(_timeProvider.GetUtcNow(), _securityIdentifier, FundamentalProperty.CompanyProfile_RegisteredFax) |
Fax number for registered office
Morningstar DataId: 2125
Definition at line 254 of file CompanyProfile.cs.
bool QuantConnect.Data.Fundamental.CompanyProfile.IsHeadOfficeSameWithRegisteredOfficeFlag => FundamentalService.Get<bool>(_timeProvider.GetUtcNow(), _securityIdentifier, FundamentalProperty.CompanyProfile_IsHeadOfficeSameWithRegisteredOfficeFlag) |
Flag to denote whether head and registered offices are the same
Morningstar DataId: 2126
Definition at line 263 of file CompanyProfile.cs.
long QuantConnect.Data.Fundamental.CompanyProfile.SharesOutstanding => FundamentalService.Get<long>(_timeProvider.GetUtcNow(), _securityIdentifier, FundamentalProperty.CompanyProfile_SharesOutstanding) |
The latest total shares outstanding reported by the company; most common source of this information is from the cover of the 10K, 10Q, or 20F filing. This figure is an aggregated shares outstanding number for a company. It can be used to calculate the most accurate market cap, based on each individual share's trading price and the total aggregated shares outstanding figure.
Morningstar DataId: 40000
Definition at line 272 of file CompanyProfile.cs.
long QuantConnect.Data.Fundamental.CompanyProfile.MarketCap => FundamentalService.Get<long>(_timeProvider.GetUtcNow(), _securityIdentifier, FundamentalProperty.CompanyProfile_MarketCap) |
Price * Total SharesOutstanding. The most current market cap for example, would be the most recent closing price x the most recent reported shares outstanding. For ADR share classes, market cap is price * (ordinary shares outstanding / adr ratio).
Morningstar DataId: 40001
Definition at line 281 of file CompanyProfile.cs.
long QuantConnect.Data.Fundamental.CompanyProfile.EnterpriseValue => FundamentalService.Get<long>(_timeProvider.GetUtcNow(), _securityIdentifier, FundamentalProperty.CompanyProfile_EnterpriseValue) |
This number tells you what cash return you would get if you bought the entire company, including its debt. Enterprise Value = Market Cap + Preferred stock + Long-Term Debt And Capital Lease + Short Term Debt And Capital Lease + Securities Sold But Not Yet Repurchased - Cash, Cash Equivalent And Market Securities - Securities Purchased with Agreement to Resell - Securities Borrowed.
Morningstar DataId: 40002
Definition at line 290 of file CompanyProfile.cs.
long QuantConnect.Data.Fundamental.CompanyProfile.ShareClassLevelSharesOutstanding => FundamentalService.Get<long>(_timeProvider.GetUtcNow(), _securityIdentifier, FundamentalProperty.CompanyProfile_ShareClassLevelSharesOutstanding) |
The latest shares outstanding reported by the company of a particular share class; most common source of this information is from the cover of the 10K, 10Q, or 20F filing. This figure is an aggregated shares outstanding number for a particular share class of the company.
Morningstar DataId: 40003
Definition at line 299 of file CompanyProfile.cs.
long QuantConnect.Data.Fundamental.CompanyProfile.SharesOutstandingWithBalanceSheetEndingDate => FundamentalService.Get<long>(_timeProvider.GetUtcNow(), _securityIdentifier, FundamentalProperty.CompanyProfile_SharesOutstandingWithBalanceSheetEndingDate) |
Total shares outstanding reported by the company as of the balance sheet period ended date. The most common source of this information is from the 10K, 10Q, or 20F filing. This figure is an aggregated shares outstanding number for a company.
Morningstar DataId: 40007
Definition at line 308 of file CompanyProfile.cs.
string QuantConnect.Data.Fundamental.CompanyProfile.ReasonofSharesChange => FundamentalService.Get<string>(_timeProvider.GetUtcNow(), _securityIdentifier, FundamentalProperty.CompanyProfile_ReasonofSharesChange) |
The reason for the change in a company's total shares outstanding from the previous record. Examples could be share issuances or share buy-back. This field will only be populated when total shares outstanding is collected from a press release.
Morningstar DataId: 40010
Definition at line 317 of file CompanyProfile.cs.