Intrinio.SDK 7.5.2

Intrinio C# SDK

To get an API key, sign up here.

Welcome to the Intrinio API! Through our Financial Data Marketplace, we offer a wide selection of financial data feed APIs sourced by our own proprietary processes as well as from many data vendors. For a complete API request / response reference please view the Intrinio API documentation. If you need additional help in using the API, please visit the Intrinio website and click on the chat icon in the lower right corner.

• API version: 2.56.6
• Package version: 7.5.2

<a name="frameworks-supported"></a>

Frameworks supported

• .NET >=6.0

<a name="installation"></a>

Installation

Use NuGet to include the client DLL in your project.

Install-Package Intrinio.SDK

Alternatively, you can download the required DLLs from the Releases page.

<a name="dependencies"></a>

Dependencies

• RestSharp - 108.0.1 or later
• Json.NET - 7.0.0 or later
• JsonSubTypes - 1.9.0 or later
• Polly - 7.2.3 or later

The DLLs included in the package may not be the latest version. We recommend using [NuGet] (https://docs.nuget.org/consume/installing-nuget) to obtain the latest version of the packages:

Install-Package RestSharp
Install-Package Newtonsoft.Json
Install-Package JsonSubTypes
Install-Package Polly

<a name="installation manual build"></a>

Installation Manual Build

Run the following command to generate the DLL

• [Windows] build.bat

Then include the DLL (under the bin folder) in the C# project, and use the namespaces:

using Intrinio.SDK.Api;
using Intrinio.SDK.Client;
using Intrinio.SDK.Model;

<a name="packaging"></a>

Packaging

A .nuspec is included with the project.

This .nuspec uses placeholders from the .csproj, so build the .csproj directly:

nuget pack -Build -OutputDirectory out Intrinio.SDK.csproj

Then, publish to a local feed or other host and consume the new package via Nuget as usual.

<a name="getting-started"></a>

Getting Started

using System;
using System.Diagnostics;
using Intrinio.SDK.Api;
using Intrinio.SDK.Client;
using Intrinio.SDK.Model;

namespace Example
{
  public class GetAllCompaniesExample
  {
    public static void Main()
    {
      Configuration.Default.AddApiKey("api_key", "YOUR_API_KEY");
      Configuration.Default.AllowRetries = true;
      
      var companyApi = new CompanyApi();
      var latestFilingDate = "";  // DateTime? | Last filing date (optional) 
      var sic = "";  // string | Standard Industrial Classification code (optional) 
      var template = "";  // string | Template (optional) 
      var sector = "";  // string | Industry sector (optional) 
      var industryCategory = "";  // string | Industry category (optional) 
      var industryGroup = "";  // string | Industry group (optional) 
      var pageSize = 100;  // int? | The number of results to return (optional)  (default to 100)
      var nextPage = "";  // string | Gets the next page of data from a previous API call (optional) 

      try
      {
        ApiResponseCompanies result = companyApi.GetAllCompanies(latestFilingDate, sic, template, sector, industryCategory, industryGroup, pageSize, nextPage);
        Debug.WriteLine(result.ToJson());
      }
      catch (Exception e)
      {
        Debug.Print("Exception when calling CompanyApi.GetAllCompanies: " + e.Message );
      }
    }
  }
}

Retries

By default, automatic retries are enabled for the C# SDK. Retries can be enabled/disabled by setting AllowRetries on the default configuration to true/false as seen in the code example above.

If set to true, all calls to the API will attempt a successful completion up to 5 times with exponential backoff before failing. If set to false, calls to the API will attempt one successful call.

<a name="documentation-for-api-endpoints"></a>

Documentation for API Endpoints

Complete documentation for the Intrinio C# SDK is available on the Intrinio website.

View Intrinio C# SDK Documentation

A listing of classes and methods is also provided below:

<a name="documentation-for-models"></a>

Documentation for Models

• Model.AccumulationDistributionIndexTechnicalValue
• Model.ApiResponseBulkDownloadLinks
• Model.ApiResponseCompanies
• Model.ApiResponseCompaniesSearch
• Model.ApiResponseCompanyAnswers
• Model.ApiResponseCompanyDailyMetrics
• Model.ApiResponseCompanyFilings
• Model.ApiResponseCompanyFundamentals
• Model.ApiResponseCompanyHistoricalData
• Model.ApiResponseCompanyInsiderTransactionFilings
• Model.ApiResponseCompanyNews
• Model.ApiResponseCompanyPublicFloatResult
• Model.ApiResponseCompanyRecognize
• Model.ApiResponseCompanySecurities
• Model.ApiResponseCompanySharesOutstanding
• Model.ApiResponseDataTags
• Model.ApiResponseDataTagsSearch
• Model.ApiResponseESGCompanies
• Model.ApiResponseESGCompanyComprehensiveRatingHistory
• Model.ApiResponseESGCompanyRatingHistory
• Model.ApiResponseESGLatest
• Model.ApiResponseESGLatestComprehensive
• Model.ApiResponseETFHoldings
• Model.ApiResponseETFs
• Model.ApiResponseEconomicIndexHistoricalData
• Model.ApiResponseEconomicIndices
• Model.ApiResponseEconomicIndicesSearch
• Model.ApiResponseFilingAnswers
• Model.ApiResponseFilingFundamentals
• Model.ApiResponseFilingNotes
• Model.ApiResponseFilingNotesSearch
• Model.ApiResponseFilings
• Model.ApiResponseForexCurrencies
• Model.ApiResponseForexPairs
• Model.ApiResponseForexPrices
• Model.ApiResponseHistoricalData
• Model.ApiResponseInitialPublicOfferings
• Model.ApiResponseInsiderTransactionFilings
• Model.ApiResponseMunicipalities
• Model.ApiResponseMunicipalitiyFinancials
• Model.ApiResponseNews
• Model.ApiResponseOptionPrices
• Model.ApiResponseOptions
• Model.ApiResponseOptionsChain
• Model.ApiResponseOptionsChainEod
• Model.ApiResponseOptionsChainRealtime
• Model.ApiResponseOptionsExpirations
• Model.ApiResponseOptionsPriceRealtime
• Model.ApiResponseOptionsPricesBatchRealtime
• Model.ApiResponseOptionsPricesEod
• Model.ApiResponseOptionsRealtime
• Model.ApiResponseOptionsStatsRealtime
• Model.ApiResponseOptionsTickers
• Model.ApiResponseOptionsUnusualActivity
• Model.ApiResponseOwnerInsiderTransactionFilings
• Model.ApiResponseOwnerInstitutionalHoldings
• Model.ApiResponseOwners
• Model.ApiResponseReportedFinancials
• Model.ApiResponseSICIndexHistoricalData
• Model.ApiResponseSICIndices
• Model.ApiResponseSICIndicesSearch
• Model.ApiResponseSecurities
• Model.ApiResponseSecuritiesSearch
• Model.ApiResponseSecurityAccumulationDistributionIndex
• Model.ApiResponseSecurityAverageDailyTradingVolume
• Model.ApiResponseSecurityAverageDirectionalIndex
• Model.ApiResponseSecurityAverageTrueRange
• Model.ApiResponseSecurityAwesomeOscillator
• Model.ApiResponseSecurityBollingerBands
• Model.ApiResponseSecurityChaikinMoneyFlow
• Model.ApiResponseSecurityCommodityChannelIndex
• Model.ApiResponseSecurityDetrendedPriceOscillator
• Model.ApiResponseSecurityDonchianChannel
• Model.ApiResponseSecurityEaseOfMovement
• Model.ApiResponseSecurityForceIndex
• Model.ApiResponseSecurityHistoricalData
• Model.ApiResponseSecurityIchimokuKinkoHyo
• Model.ApiResponseSecurityInstitutionalOwnership
• Model.ApiResponseSecurityIntervalPrices
• Model.ApiResponseSecurityIntradayPrices
• Model.ApiResponseSecurityKeltnerChannel
• Model.ApiResponseSecurityKnowSureThing
• Model.ApiResponseSecurityMassIndex
• Model.ApiResponseSecurityMoneyFlowIndex
• Model.ApiResponseSecurityMovingAverageConvergenceDivergence
• Model.ApiResponseSecurityNegativeVolumeIndex
• Model.ApiResponseSecurityOnBalanceVolume
• Model.ApiResponseSecurityOnBalanceVolumeMean
• Model.ApiResponseSecurityRelativeStrengthIndex
• Model.ApiResponseSecuritySimpleMovingAverage
• Model.ApiResponseSecurityStochasticOscillator
• Model.ApiResponseSecurityStockPriceAdjustments
• Model.ApiResponseSecurityStockPrices
• Model.ApiResponseSecurityTripleExponentialAverage
• Model.ApiResponseSecurityTrueStrengthIndex
• Model.ApiResponseSecurityUltimateOscillator
• Model.ApiResponseSecurityVolumePriceTrend
• Model.ApiResponseSecurityVolumeWeightedAveragePrice
• Model.ApiResponseSecurityVortexIndicator
• Model.ApiResponseSecurityWilliamsR
• Model.ApiResponseSecurityZacksAnalystRatings
• Model.ApiResponseSecurityZacksAnalystRatingsSnapshot
• Model.ApiResponseSecurityZacksEPSSurprises
• Model.ApiResponseSecurityZacksSalesSurprises
• Model.ApiResponseStandardizedFinancials
• Model.ApiResponseStandardizedFinancialsDimensions
• Model.ApiResponseStockExchangeRealtimeStockPrices
• Model.ApiResponseStockExchangeSecurities
• Model.ApiResponseStockExchangeStockPriceAdjustments
• Model.ApiResponseStockExchangeStockPrices
• Model.ApiResponseStockExchanges
• Model.ApiResponseStockMarketIndexHistoricalData
• Model.ApiResponseStockMarketIndices
• Model.ApiResponseStockMarketIndicesSearch
• Model.ApiResponseZacksAnalystRatings
• Model.ApiResponseZacksEPSEstimates
• Model.ApiResponseZacksEPSGrowthRates
• Model.ApiResponseZacksEPSSurprises
• Model.ApiResponseZacksETFHoldings
• Model.ApiResponseZacksInstitutionalHoldingCompanies
• Model.ApiResponseZacksInstitutionalHoldingOwners
• Model.ApiResponseZacksInstitutionalHoldings
• Model.ApiResponseZacksLongTermGrowthRates
• Model.ApiResponseZacksSalesEstimates
• Model.ApiResponseZacksSalesSurprises
• Model.ApiResponseZacksTargetPriceConsensuses
• Model.AverageDailyTradingVolumeTechnicalValue
• Model.AverageDirectionalIndexTechnicalValue
• Model.AverageTrueRangeTechnicalValue
• Model.AwesomeOscillatorTechnicalValue
• Model.BollingerBandsTechnicalValue
• Model.BulkDownloadLinks
• Model.BulkDownloadSummary
• Model.ChaikinMoneyFlowTechnicalValue
• Model.CommodityChannelIndexTechnicalValue
• Model.Company
• Model.CompanyDailyMetric
• Model.CompanyFiling
• Model.CompanyInitialPublicOffering
• Model.CompanyNews
• Model.CompanyNewsSummary
• Model.CompanyPublicFloat
• Model.CompanySharesOutstanding
• Model.CompanySummary
• Model.DataTag
• Model.DataTagSummary
• Model.DetrendedPriceOscillatorTechnicalValue
• Model.DividendRecord
• Model.DonchianChannelTechnicalValue
• Model.ESGCompanySummary
• Model.ESGComprehensiveRating
• Model.ESGComprehensiveRatingWithCompany
• Model.ESGRating
• Model.ESGRatingWithCompany
• Model.ETF
• Model.ETFAnalytics
• Model.ETFHolding
• Model.ETFStats
• Model.ETFSummary
• Model.EarningsRecord
• Model.EaseOfMovementTechnicalValue
• Model.EconomicIndex
• Model.EconomicIndexSummary
• Model.Filing
• Model.FilingNote
• Model.FilingNoteFiling
• Model.FilingNoteSummary
• Model.FilingSummary
• Model.ForceIndexTechnicalValue
• Model.ForexCurrency
• Model.ForexPair
• Model.ForexPrice
• Model.Fundamental
• Model.FundamentalSummary
• Model.HistoricalData
• Model.IchimokuKinkoHyoTechnicalValue
• Model.InsiderTransaction
• Model.InsiderTransactionFiling
• Model.InstitutionalHolding
• Model.InstitutionalOwnership
• Model.IntradayStockPrice
• Model.KeltnerChannelTechnicalValue
• Model.KnowSureThingTechnicalValue
• Model.MarketStatusResult
• Model.MassIndexTechnicalValue
• Model.MoneyFlowIndexTechnicalValue
• Model.MovingAverageConvergenceDivergenceTechnicalValue
• Model.Municipality
• Model.MunicipalityFinancial
• Model.NegativeVolumeIndexTechnicalValue
• Model.NewsTopic
• Model.OnBalanceVolumeMeanTechnicalValue
• Model.OnBalanceVolumeTechnicalValue
• Model.Option
• Model.OptionChain
• Model.OptionChainEod
• Model.OptionChainRealtime
• Model.OptionContractsList
• Model.OptionEod
• Model.OptionFactorsRealtime
• Model.OptionInterval
• Model.OptionIntervalMover
• Model.OptionIntervalsMoversResult
• Model.OptionIntervalsResult
• Model.OptionPrice
• Model.OptionPriceBatchRealtime
• Model.OptionPriceEod
• Model.OptionPriceRealtime
• Model.OptionPriceRealtimeExtended
• Model.OptionRealtime
• Model.OptionSnapshotGroup
• Model.OptionSnapshotsResult
• Model.OptionStatsRealtime
• Model.OptionUnusualTrade
• Model.Owner
• Model.OwnerSummary
• Model.RealtimeIndexPrice
• Model.RealtimeIndexPriceIndex
• Model.RealtimeStockPrice
• Model.RealtimeStockPriceSecurity
• Model.RelativeStrengthIndexTechnicalValue
• Model.ReportedFinancial
• Model.ReportedFinancialDimension
• Model.ReportedTag
• Model.SICIndex
• Model.Security
• Model.SecurityHistory
• Model.SecurityHistoryListResult
• Model.SecurityIntervalMover
• Model.SecurityIntervalsMoversResult
• Model.SecurityReplayFileResult
• Model.SecurityScreenClause
• Model.SecurityScreenGroup
• Model.SecurityScreenResult
• Model.SecurityScreenResultData
• Model.SecuritySnapshotGroup
• Model.SecuritySnapshotsResult
• Model.SecuritySummary
• Model.SecurityTrades
• Model.SecurityTradesResult
• Model.SimpleMovingAverageTechnicalValue
• Model.StandardizedFinancial
• Model.StandardizedFinancialsDimension
• Model.StochasticOscillatorTechnicalValue
• Model.StockExchange
• Model.StockMarketIndex
• Model.StockMarketIndexSummary
• Model.StockPrice
• Model.StockPriceAdjustment
• Model.StockPriceAdjustmentSummary
• Model.StockPriceInterval
• Model.StockPriceSummary
• Model.TechnicalIndicator
• Model.TheaEntityAnswer
• Model.TheaSourceDocument
• Model.TripleExponentialAverageTechnicalValue
• Model.TrueStrengthIndexTechnicalValue
• Model.UltimateOscillatorTechnicalValue
• Model.VolumePriceTrendTechnicalValue
• Model.VolumeWeightedAveragePriceValue
• Model.VortexIndicatorTechnicalValue
• Model.WilliamsRTechnicalValue
• Model.ZacksAnalystRating
• Model.ZacksAnalystRatingSnapshot
• Model.ZacksAnalystRatingSummary
• Model.ZacksEPSEstimate
• Model.ZacksEPSGrowthRate
• Model.ZacksEPSSurprise
• Model.ZacksEPSSurpriseSummary
• Model.ZacksETFHolding
• Model.ZacksInstitutionalHolding
• Model.ZacksInstitutionalHoldingCompanyDetail
• Model.ZacksInstitutionalHoldingCompanySummary
• Model.ZacksInstitutionalHoldingHistoricalSummary
• Model.ZacksInstitutionalHoldingOwnerDetail
• Model.ZacksInstitutionalHoldingOwnerSummary
• Model.ZacksLongTermGrowthRate
• Model.ZacksSalesEstimate
• Model.ZacksSalesSurprise
• Model.ZacksSalesSurpriseSummary
• Model.ZacksTargetPriceConsensus