SecurityReference.cs

/*
 * QUANTCONNECT.COM - Democratizing Finance, Empowering Individuals.
 * Lean Algorithmic Trading Engine v2.0. Copyright 2023 QuantConnect Corporation.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
*/
 
using System;
using System.Linq;
using Python.Runtime;
using Newtonsoft.Json;
using System.Collections.Generic;
using QuantConnect.Data.UniverseSelection;
 
namespace QuantConnect.Data.Fundamental
{
    /// <summary>
    /// Definition of the SecurityReference class
    /// </summary>
    public class SecurityReference : FundamentalTimeDependentProperty
    {
        /// <summary>
        /// An arrangement of characters (often letters) representing a particular security listed on an exchange or otherwise traded publicly. Note: Morningstar's multi-share class symbols will often contain a "period" within the symbol; e.g. BRK.B for Berkshire Hathaway Class B.
        /// </summary>
        /// <remarks>
        /// Morningstar DataId: 1001
        /// </remarks>
        [JsonProperty("1001")]
        public string SecuritySymbol => FundamentalService.Get<string>(_timeProvider.GetUtcNow(), _securityIdentifier, FundamentalProperty.SecurityReference_SecuritySymbol);
 
        /// <summary>
        /// The Id representing the stock exchange that the particular share class is trading. See separate reference document for Exchange Mappings.
        /// </summary>
        /// <remarks>
        /// Morningstar DataId: 1002
        /// </remarks>
        [JsonProperty("1002")]
        public string ExchangeId => FundamentalService.Get<string>(_timeProvider.GetUtcNow(), _securityIdentifier, FundamentalProperty.SecurityReference_ExchangeId);
 
        /// <summary>
        /// 3 Character ISO code of the currency that the exchange price is denominated in; i.e. the trading currency of the security. See separate reference document for Currency Mappings.
        /// </summary>
        /// <remarks>
        /// Morningstar DataId: 1004
        /// </remarks>
        [JsonProperty("1004")]
        public string CurrencyId => FundamentalService.Get<string>(_timeProvider.GetUtcNow(), _securityIdentifier, FundamentalProperty.SecurityReference_CurrencyId);
 
        /// <summary>
        /// The initial day that the share begins trading on a public exchange.
        /// </summary>
        /// <remarks>
        /// Morningstar DataId: 1009
        /// </remarks>
        [JsonProperty("1009")]
        public DateTime IPODate => FundamentalService.Get<DateTime>(_timeProvider.GetUtcNow(), _securityIdentifier, FundamentalProperty.SecurityReference_IPODate);
 
        /// <summary>
        /// Indicator to denote if the share class is a depository receipt. 1 denotes it is an ADR or GDR; otherwise 0.
        /// </summary>
        /// <remarks>
        /// Morningstar DataId: 1010
        /// </remarks>
        [JsonProperty("1010")]
        public bool IsDepositaryReceipt => FundamentalService.Get<bool>(_timeProvider.GetUtcNow(), _securityIdentifier, FundamentalProperty.SecurityReference_IsDepositaryReceipt);
 
        /// <summary>
        /// The number of underlying common shares backing each American Depository Receipt traded.
        /// </summary>
        /// <remarks>
        /// Morningstar DataId: 1011
        /// </remarks>
        [JsonProperty("1011")]
        public double DepositaryReceiptRatio => FundamentalService.Get<double>(_timeProvider.GetUtcNow(), _securityIdentifier, FundamentalProperty.SecurityReference_DepositaryReceiptRatio);
 
        /// <summary>
        /// Each security will be assigned to one of the below security type classifications; - Common Stock (ST00000001) - Preferred Stock (ST00000002) - Units (ST000000A1)
        /// </summary>
        /// <remarks>
        /// Morningstar DataId: 1012
        /// </remarks>
        [JsonProperty("1012")]
        public string SecurityType => FundamentalService.Get<string>(_timeProvider.GetUtcNow(), _securityIdentifier, FundamentalProperty.SecurityReference_SecurityType);
 
        /// <summary>
        /// Provides information when applicable such as whether the share class is Class A or Class B, an ADR, GDR, or a business development company (BDC). For preferred stocks, this field provides more detail about the preferred share class.
        /// </summary>
        /// <remarks>
        /// Morningstar DataId: 1013
        /// </remarks>
        [JsonProperty("1013")]
        public string ShareClassDescription => FundamentalService.Get<string>(_timeProvider.GetUtcNow(), _securityIdentifier, FundamentalProperty.SecurityReference_ShareClassDescription);
 
        /// <summary>
        /// At the ShareClass level; each share is assigned to 1 of 4 possible status classifications; (A) Active, (D) Deactive, (I) Inactive, or (O) Obsolete: - Active-Share class is currently trading in a public market, and we have fundamental data available. - Deactive-Share class was once Active, but is no longer trading due to share being delisted from the exchange. - Inactive-Share class is currently trading in a public market, but no fundamental data is available. - Obsolete-Share class was once Inactive, but is no longer trading due to share being delisted from the exchange.
        /// </summary>
        /// <remarks>
        /// Morningstar DataId: 1014
        /// </remarks>
        [JsonProperty("1014")]
        public string ShareClassStatus => FundamentalService.Get<string>(_timeProvider.GetUtcNow(), _securityIdentifier, FundamentalProperty.SecurityReference_ShareClassStatus);
 
        /// <summary>
        /// This indicator will denote if the indicated share is the primary share for the company. A "1" denotes the primary share, a "0" denotes a share that is not the primary share. The primary share is defined as the first share that a company IPO'd with and is still actively trading. If this share is no longer trading, we will denote the primary share as the share with the highest volume.
        /// </summary>
        /// <remarks>
        /// Morningstar DataId: 1015
        /// </remarks>
        [JsonProperty("1015")]
        public bool IsPrimaryShare => FundamentalService.Get<bool>(_timeProvider.GetUtcNow(), _securityIdentifier, FundamentalProperty.SecurityReference_IsPrimaryShare);
 
        /// <summary>
        /// Shareholder election plan to re-invest cash dividend into additional shares.
        /// </summary>
        /// <remarks>
        /// Morningstar DataId: 1016
        /// </remarks>
        [JsonProperty("1016")]
        public bool IsDividendReinvest => FundamentalService.Get<bool>(_timeProvider.GetUtcNow(), _securityIdentifier, FundamentalProperty.SecurityReference_IsDividendReinvest);
 
        /// <summary>
        /// A plan to make it possible for individual investors to invest in public companies without going through a stock broker.
        /// </summary>
        /// <remarks>
        /// Morningstar DataId: 1017
        /// </remarks>
        [JsonProperty("1017")]
        public bool IsDirectInvest => FundamentalService.Get<bool>(_timeProvider.GetUtcNow(), _securityIdentifier, FundamentalProperty.SecurityReference_IsDirectInvest);
 
        /// <summary>
        /// Identifier assigned to each security Morningstar covers.
        /// </summary>
        /// <remarks>
        /// Morningstar DataId: 1018
        /// </remarks>
        [JsonProperty("1018")]
        public string InvestmentId => FundamentalService.Get<string>(_timeProvider.GetUtcNow(), _securityIdentifier, FundamentalProperty.SecurityReference_InvestmentId);
 
        /// <summary>
        /// IPO offer price indicates the price at which an issuer sells its shares under an initial public offering (IPO). The offer price is set by issuer and its underwriters.
        /// </summary>
        /// <remarks>
        /// Morningstar DataId: 1019
        /// </remarks>
        [JsonProperty("1019")]
        public double IPOOfferPrice => FundamentalService.Get<double>(_timeProvider.GetUtcNow(), _securityIdentifier, FundamentalProperty.SecurityReference_IPOOfferPrice);
 
        /// <summary>
        /// The date on which an inactive security was delisted from an exchange.
        /// </summary>
        /// <remarks>
        /// Morningstar DataId: 1020
        /// </remarks>
        [JsonProperty("1020")]
        public DateTime DelistingDate => FundamentalService.Get<DateTime>(_timeProvider.GetUtcNow(), _securityIdentifier, FundamentalProperty.SecurityReference_DelistingDate);
 
        /// <summary>
        /// The reason for an inactive security's delisting from an exchange. The full list of Delisting Reason codes can be found within the Data Definitions- Appendix A DelistingReason Codes tab.
        /// </summary>
        /// <remarks>
        /// Morningstar DataId: 1021
        /// </remarks>
        [JsonProperty("1021")]
        public string DelistingReason => FundamentalService.Get<string>(_timeProvider.GetUtcNow(), _securityIdentifier, FundamentalProperty.SecurityReference_DelistingReason);
 
        /// <summary>
        /// The MIC (market identifier code) of the related shareclass of the company. See Data Appendix A for the relevant MIC to exchange name mapping.
        /// </summary>
        /// <remarks>
        /// Morningstar DataId: 1022
        /// </remarks>
        [JsonProperty("1022")]
        public string MIC => FundamentalService.Get<string>(_timeProvider.GetUtcNow(), _securityIdentifier, FundamentalProperty.SecurityReference_MIC);
 
        /// <summary>
        /// Refers to the type of securities that can be found within the equity database. For the vast majority, this value will populate as null for regular common shares. For a minority of shareclasses, this will populate as either "Participating Preferred", "Closed-End Fund", "Foreign Share", or "Foreign Participated Preferred" which reflects our limited coverage of these types of securities within our equity database.
        /// </summary>
        /// <remarks>
        /// Morningstar DataId: 1023
        /// </remarks>
        [JsonProperty("1023")]
        public string CommonShareSubType => FundamentalService.Get<string>(_timeProvider.GetUtcNow(), _securityIdentifier, FundamentalProperty.SecurityReference_CommonShareSubType);
 
        /// <summary>
        /// The estimated offer price range (low-high) for a new IPO. The field should be used until the final IPO price becomes available, as populated in the data field "IPOPrice".
        /// </summary>
        /// <remarks>
        /// Morningstar DataId: 1024
        /// </remarks>
        [JsonProperty("1024")]
        public string IPOOfferPriceRange => FundamentalService.Get<string>(_timeProvider.GetUtcNow(), _securityIdentifier, FundamentalProperty.SecurityReference_IPOOfferPriceRange);
 
        /// <summary>
        /// Classification to denote different Marketplace or Market tiers within a stock exchange.
        /// </summary>
        /// <remarks>
        /// Morningstar DataId: 1025
        /// </remarks>
        [JsonProperty("1025")]
        public string ExchangeSubMarketGlobalId => FundamentalService.Get<string>(_timeProvider.GetUtcNow(), _securityIdentifier, FundamentalProperty.SecurityReference_ExchangeSubMarketGlobalId);
 
        /// <summary>
        /// The relationship between the chosen share class and the primary share class.
        /// </summary>
        /// <remarks>
        /// Morningstar DataId: 1026
        /// </remarks>
        [JsonProperty("1026")]
        public double ConversionRatio => FundamentalService.Get<double>(_timeProvider.GetUtcNow(), _securityIdentifier, FundamentalProperty.SecurityReference_ConversionRatio);
 
        /// <summary>
        /// Nominal value of a security determined by the issuing company.
        /// </summary>
        /// <remarks>
        /// Morningstar DataId: 1027
        /// </remarks>
        [JsonProperty("1027")]
        public double ParValue => FundamentalService.Get<double>(_timeProvider.GetUtcNow(), _securityIdentifier, FundamentalProperty.SecurityReference_ParValue);
 
        /// <summary>
        /// <remarks> Morningstar DataId: 1028 </remarks>
        /// </summary>
        /// <remarks>
        /// Morningstar DataId: 1028
        /// </remarks>
        [JsonProperty("1028")]
        public bool TradingStatus => FundamentalService.Get<bool>(_timeProvider.GetUtcNow(), _securityIdentifier, FundamentalProperty.SecurityReference_TradingStatus);
 
        /// <summary>
        /// <remarks> Morningstar DataId: 1029 </remarks>
        /// </summary>
        /// <remarks>
        /// Morningstar DataId: 1029
        /// </remarks>
        [JsonProperty("1029")]
        public string MarketDataID => FundamentalService.Get<string>(_timeProvider.GetUtcNow(), _securityIdentifier, FundamentalProperty.SecurityReference_MarketDataID);
 
        /// <summary>
        /// Creates a new instance for the given time and security
        /// </summary>
        public SecurityReference(ITimeProvider timeProvider, SecurityIdentifier securityIdentifier)
            : base(timeProvider, securityIdentifier)
        {
        }
 
        /// <summary>
        /// Clones this instance
        /// </summary>
        public override FundamentalTimeDependentProperty Clone(ITimeProvider timeProvider)
        {
            return new SecurityReference(timeProvider, _securityIdentifier);
        }
    }
}