Table of Contents

Interface IFinancialDataClient

Namespace
Tudormobile.FinancialData
Assembly
Tudormobile.FinancialData.dll

Provides methods for retrieving basic company information from the FinancialData API.

public interface IFinancialDataClient

Methods

Create(string, HttpClient, IFinancialDataSerializer?)

Creates a new instance of an object that implements the IFinancialDataClient interface using the specified API key, HTTP client, and optional serializer.

public static IFinancialDataClient Create(string apiKey, HttpClient httpClient, IFinancialDataSerializer? serializer = null)

Parameters

apiKey string

The API key used to authenticate requests to the financial data service. This parameter cannot be null or empty.

httpClient HttpClient

The HttpClient instance used to send HTTP requests to the financial data service. It is recommended to reuse the same instance for multiple requests.

serializer IFinancialDataSerializer

An optional serializer used for serializing and deserializing financial data. If not specified, a default serializer is used.

Returns

IFinancialDataClient

An instance of IFinancialDataClient that can be used to interact with the financial data service.

Remarks

Ensure that the provided HttpClient is properly configured for the intended use, including any necessary headers or settings.

GetApiResultAsync<T>(string, CancellationToken) 

Task<FinancialDataResponse<T>> GetApiResultAsync<T>(string uriString, CancellationToken cancellationToken)

Parameters

uriString string
cancellationToken CancellationToken

Returns

Task<FinancialDataResponse<T>>

Type Parameters

T

GetBalanceSheetStatementsAsync(string, Period, int, CancellationToken)

Balance Sheet Statements Endpoint: Asynchronously retrieves the balance sheet statements for the specified entity identifier.

Task<FinancialDataResponse<List<BalanceSheet>>> GetBalanceSheetStatementsAsync(string identifier, Period period = Period.All, int offset = 0, CancellationToken cancellationToken = default)

Parameters

identifier string

The unique identifier of the entity whose balance sheet statements are to be retrieved. This parameter cannot be null or empty.

period Period

(Optional) The accounting period for which the entity's financial statements are prepared. By default, statements are returned for all accounting periods.

offset int

(Optional) The initial position of the record subset, which indicates how many records to skip. Defaults to 0.

cancellationToken CancellationToken

A cancellation token that can be used to cancel the asynchronous operation. The default value is None.

Returns

Task<FinancialDataResponse<List<BalanceSheet>>>

A task that represents the asynchronous operation. The task result contains the balance sheets associated with the specified identifier.

Remarks

An ArgumentException is thrown if identifier is null or empty. The operation may be canceled by passing a cancellation token.

GetCashFlowStatementsAsync(string, Period, int, CancellationToken) 

Task<FinancialDataResponse<List<CashFlow>>> GetCashFlowStatementsAsync(string identifier, Period period = Period.All, int offset = 0, CancellationToken cancellationToken = default)

Parameters

identifier string
period Period
offset int
cancellationToken CancellationToken

Returns

Task<FinancialDataResponse<List<CashFlow>>>

GetCommodityPricesAsync(string, int, CancellationToken)

Asynchronously retrieves price data for a specified commodity.

Task<FinancialDataResponse<List<CommodityPrice>>> GetCommodityPricesAsync(string identifier, int offset = 0, CancellationToken cancellationToken = default)

Parameters

identifier string

The unique identifier of the commodity for which to retrieve stock prices. This value cannot be null or empty.

offset int

The number of records to skip before starting to return results. Must be a non-negative integer. Useful for paginating large result sets.

cancellationToken CancellationToken

A token that can be used to request cancellation of the asynchronous operation.

Returns

Task<FinancialDataResponse<List<CommodityPrice>>>

A task that represents the asynchronous operation. The task result contains a response with the prices for the specified commodity.

GetCommoditySymbolsAsync(int, CancellationToken)

Retrieves a list of commodity symbols.

Task<FinancialDataResponse<List<Symbol>>> GetCommoditySymbolsAsync(int offset = 0, CancellationToken cancellationToken = default)

Parameters

offset int

The offset for pagination. Defaults to 0.

cancellationToken CancellationToken

A token to cancel the operation.

Returns

Task<FinancialDataResponse<List<Symbol>>>

A FinancialDataResponse<T> containing a list of commodity symbols.

Remarks

See: https://financialdata.net/documentation#operation/getCommoditySymbols

GetCompanyInformationAsync(string, CancellationToken) 

Task<FinancialDataResponse<List<CompanyInformation>>> GetCompanyInformationAsync(string identifier, CancellationToken cancellationToken = default)

Parameters

identifier string
cancellationToken CancellationToken

Returns

Task<FinancialDataResponse<List<CompanyInformation>>>

GetCryptoInformationAsync(string, CancellationToken) 

Task<FinancialDataResponse<List<CryptoInformation>>> GetCryptoInformationAsync(string identifier, CancellationToken cancellationToken = default)

Parameters

identifier string
cancellationToken CancellationToken

Returns

Task<FinancialDataResponse<List<CryptoInformation>>>

GetCryptoMinutePricesAsync(string, DateOnly, int, CancellationToken) 

Task<FinancialDataResponse<List<CryptoMinutePrice>>> GetCryptoMinutePricesAsync(string identifier, DateOnly date, int offset = 0, CancellationToken cancellationToken = default)

Parameters

identifier string
date DateOnly
offset int
cancellationToken CancellationToken

Returns

Task<FinancialDataResponse<List<CryptoMinutePrice>>>

GetCryptoPricesAsync(string, int, CancellationToken) 

Task<FinancialDataResponse<List<CryptoPrice>>> GetCryptoPricesAsync(string identifier, int offset = 0, CancellationToken cancellationToken = default)

Parameters

identifier string
offset int
cancellationToken CancellationToken

Returns

Task<FinancialDataResponse<List<CryptoPrice>>>

GetCryptoQuotesAsync(IEnumerable<string>, CancellationToken) 

Task<FinancialDataResponse<List<CryptoQuote>>> GetCryptoQuotesAsync(IEnumerable<string> identifiers, CancellationToken cancellationToken = default)

Parameters

identifiers IEnumerable<string>
cancellationToken CancellationToken

Returns

Task<FinancialDataResponse<List<CryptoQuote>>>

GetCryptoSymbolsAsync(int, CancellationToken) 

Task<FinancialDataResponse<List<CryptoSymbol>>> GetCryptoSymbolsAsync(int offset = 0, CancellationToken cancellationToken = default)

Parameters

offset int
cancellationToken CancellationToken

Returns

Task<FinancialDataResponse<List<CryptoSymbol>>>

GetDividendsAsync(string, int, CancellationToken) 

Task<FinancialDataResponse<List<Dividend>>> GetDividendsAsync(string identifier, int offset = 0, CancellationToken cancellationToken = default)

Parameters

identifier string
offset int
cancellationToken CancellationToken

Returns

Task<FinancialDataResponse<List<Dividend>>>

GetDividendsCalendarAsync(DateOnly?, int, CancellationToken) 

Task<FinancialDataResponse<List<DividendsCalendar>>> GetDividendsCalendarAsync(DateOnly? date = null, int offset = 0, CancellationToken cancellationToken = default)

Parameters

date DateOnly?
offset int
cancellationToken CancellationToken

Returns

Task<FinancialDataResponse<List<DividendsCalendar>>>

GetEarningsCalendarAsync(DateOnly?, int, CancellationToken) 

Task<FinancialDataResponse<List<EarningsCalendar>>> GetEarningsCalendarAsync(DateOnly? date = null, int offset = 0, CancellationToken cancellationToken = default)

Parameters

date DateOnly?
offset int
cancellationToken CancellationToken

Returns

Task<FinancialDataResponse<List<EarningsCalendar>>>

GetEarningsReleasesAsync(string, int, CancellationToken) 

Task<FinancialDataResponse<List<EarningsRelease>>> GetEarningsReleasesAsync(string identifier, int offset = 0, CancellationToken cancellationToken = default)

Parameters

identifier string
offset int
cancellationToken CancellationToken

Returns

Task<FinancialDataResponse<List<EarningsRelease>>>

GetEconomicCalendarAsync(string?, int, CancellationToken) 

Task<FinancialDataResponse<List<EconomicCalendar>>> GetEconomicCalendarAsync(string? country = null, int offset = 0, CancellationToken cancellationToken = default)

Parameters

country string
offset int
cancellationToken CancellationToken

Returns

Task<FinancialDataResponse<List<EconomicCalendar>>>

GetEfficiencyRatiosAsync(string, Period, int, CancellationToken) 

Task<FinancialDataResponse<List<EfficiencyRatios>>> GetEfficiencyRatiosAsync(string identifier, Period period = Period.All, int offset = 0, CancellationToken cancellationToken = default)

Parameters

identifier string
period Period
offset int
cancellationToken CancellationToken

Returns

Task<FinancialDataResponse<List<EfficiencyRatios>>>

GetEmployeeCountAsync(string, CancellationToken) 

Task<FinancialDataResponse<List<EmployeeCount>>> GetEmployeeCountAsync(string identifier, CancellationToken cancellationToken = default)

Parameters

identifier string
cancellationToken CancellationToken

Returns

Task<FinancialDataResponse<List<EmployeeCount>>>

GetEsgRatingsAsync(string, int, CancellationToken) 

Task<FinancialDataResponse<List<EsgRating>>> GetEsgRatingsAsync(string identifier, int offset = 0, CancellationToken cancellationToken = default)

Parameters

identifier string
offset int
cancellationToken CancellationToken

Returns

Task<FinancialDataResponse<List<EsgRating>>>

GetEsgScoresAsync(string, int, CancellationToken) 

Task<FinancialDataResponse<List<EsgScore>>> GetEsgScoresAsync(string identifier, int offset = 0, CancellationToken cancellationToken = default)

Parameters

identifier string
offset int
cancellationToken CancellationToken

Returns

Task<FinancialDataResponse<List<EsgScore>>>

GetEtfHoldingsAsync(int, CancellationToken) 

Task<FinancialDataResponse<List<EtfHoldings>>> GetEtfHoldingsAsync(int offset = 0, CancellationToken cancellationToken = default)

Parameters

offset int
cancellationToken CancellationToken

Returns

Task<FinancialDataResponse<List<EtfHoldings>>>

GetEtfPricesAsync(string, int, CancellationToken) 

Task<FinancialDataResponse<List<EtfPrices>>> GetEtfPricesAsync(string identifier, int offset = 0, CancellationToken cancellationToken = default)

Parameters

identifier string
offset int
cancellationToken CancellationToken

Returns

Task<FinancialDataResponse<List<EtfPrices>>>

GetEtfQuotesAsync(string, int, CancellationToken) 

Task<FinancialDataResponse<List<EtfQuotes>>> GetEtfQuotesAsync(string identifier, int offset = 0, CancellationToken cancellationToken = default)

Parameters

identifier string
offset int
cancellationToken CancellationToken

Returns

Task<FinancialDataResponse<List<EtfQuotes>>>

GetEtfSymbolsAsync(int, CancellationToken)

Retrieves a list of ETF symbols.

Task<FinancialDataResponse<List<Symbol>>> GetEtfSymbolsAsync(int offset = 0, CancellationToken cancellationToken = default)

Parameters

offset int

The offset for pagination. Defaults to 0.

cancellationToken CancellationToken

A token to cancel the operation.

Returns

Task<FinancialDataResponse<List<Symbol>>>

A FinancialDataResponse<T> containing a list of ETF symbols.

Remarks

See: https://financialdata.net/documentation#operation/getEtfSymbols

GetExecutiveCompensationAsync(string, CancellationToken) 

Task<FinancialDataResponse<List<ExecutiveCompensation>>> GetExecutiveCompensationAsync(string identifier, CancellationToken cancellationToken = default)

Parameters

identifier string
cancellationToken CancellationToken

Returns

Task<FinancialDataResponse<List<ExecutiveCompensation>>>

GetFedPressReleasesAsync(int, CancellationToken) 

Task<FinancialDataResponse<List<FedPressRelease>>> GetFedPressReleasesAsync(int offset = 0, CancellationToken cancellationToken = default)

Parameters

offset int
cancellationToken CancellationToken

Returns

Task<FinancialDataResponse<List<FedPressRelease>>>

GetForexMinutePricesAsync(string, DateOnly, int, CancellationToken) 

Task<FinancialDataResponse<List<ForexMinutePrice>>> GetForexMinutePricesAsync(string identifier, DateOnly date, int offset = 0, CancellationToken cancellationToken = default)

Parameters

identifier string
date DateOnly
offset int
cancellationToken CancellationToken

Returns

Task<FinancialDataResponse<List<ForexMinutePrice>>>

GetForexPricesAsync(string, int, CancellationToken) 

Task<FinancialDataResponse<List<ForexPrice>>> GetForexPricesAsync(string identifier, int offset = 0, CancellationToken cancellationToken = default)

Parameters

identifier string
offset int
cancellationToken CancellationToken

Returns

Task<FinancialDataResponse<List<ForexPrice>>>

GetForexQuotesAsync(IEnumerable<string>, CancellationToken) 

Task<FinancialDataResponse<List<ForexQuote>>> GetForexQuotesAsync(IEnumerable<string> identifiers, CancellationToken cancellationToken = default)

Parameters

identifiers IEnumerable<string>
cancellationToken CancellationToken

Returns

Task<FinancialDataResponse<List<ForexQuote>>>

GetForexSymbolsAsync(int, CancellationToken) 

Task<FinancialDataResponse<List<ForexSymbol>>> GetForexSymbolsAsync(int offset = 0, CancellationToken cancellationToken = default)

Parameters

offset int
cancellationToken CancellationToken

Returns

Task<FinancialDataResponse<List<ForexSymbol>>>

GetFuturesPricesAsync(string, int, CancellationToken) 

Task<FinancialDataResponse<List<FuturesPrice>>> GetFuturesPricesAsync(string identifier, int offset = 0, CancellationToken cancellationToken = default)

Parameters

identifier string
offset int
cancellationToken CancellationToken

Returns

Task<FinancialDataResponse<List<FuturesPrice>>>

GetFuturesSymbolsAsync(int, CancellationToken) 

Task<FinancialDataResponse<List<FuturesSymbol>>> GetFuturesSymbolsAsync(int offset = 0, CancellationToken cancellationToken = default)

Parameters

offset int
cancellationToken CancellationToken

Returns

Task<FinancialDataResponse<List<FuturesSymbol>>>

GetHouseTradingAsync(string?, int, CancellationToken) 

Task<FinancialDataResponse<List<HouseTrading>>> GetHouseTradingAsync(string? identifier = null, int offset = 0, CancellationToken cancellationToken = default)

Parameters

identifier string
offset int
cancellationToken CancellationToken

Returns

Task<FinancialDataResponse<List<HouseTrading>>>

GetIncomeStatementsAsync(string, Period, int, CancellationToken) 

Task<FinancialDataResponse<List<Income>>> GetIncomeStatementsAsync(string identifier, Period period = Period.All, int offset = 0, CancellationToken cancellationToken = default)

Parameters

identifier string
period Period
offset int
cancellationToken CancellationToken

Returns

Task<FinancialDataResponse<List<Income>>>

GetIndexConstituentsAsync(string, int, CancellationToken) 

Task<FinancialDataResponse<List<IndexConstituent>>> GetIndexConstituentsAsync(string identifier, int offset = 0, CancellationToken cancellationToken = default)

Parameters

identifier string
offset int
cancellationToken CancellationToken

Returns

Task<FinancialDataResponse<List<IndexConstituent>>>

GetIndexPricesAsync(string, int, CancellationToken) 

Task<FinancialDataResponse<List<IndexPrice>>> GetIndexPricesAsync(string identifier, int offset = 0, CancellationToken cancellationToken = default)

Parameters

identifier string
offset int
cancellationToken CancellationToken

Returns

Task<FinancialDataResponse<List<IndexPrice>>>

GetIndexQuotesAsync(IEnumerable<string>, CancellationToken) 

Task<FinancialDataResponse<List<IndexQuote>>> GetIndexQuotesAsync(IEnumerable<string> identifiers, CancellationToken cancellationToken = default)

Parameters

identifiers IEnumerable<string>
cancellationToken CancellationToken

Returns

Task<FinancialDataResponse<List<IndexQuote>>>

GetIndexSymbolsAsync(CancellationToken) 

Task<FinancialDataResponse<List<IndexSymbol>>> GetIndexSymbolsAsync(CancellationToken cancellationToken = default)

Parameters

cancellationToken CancellationToken

Returns

Task<FinancialDataResponse<List<IndexSymbol>>>

GetIndustryEsgScoresAsync(string, int, CancellationToken) 

Task<FinancialDataResponse<List<IndustryEsgScore>>> GetIndustryEsgScoresAsync(string industry, int offset = 0, CancellationToken cancellationToken = default)

Parameters

industry string
offset int
cancellationToken CancellationToken

Returns

Task<FinancialDataResponse<List<IndustryEsgScore>>>

GetInitialPublicOfferingsAsync(int, CancellationToken) 

Task<FinancialDataResponse<List<InitialPublicOffering>>> GetInitialPublicOfferingsAsync(int offset = 0, CancellationToken cancellationToken = default)

Parameters

offset int
cancellationToken CancellationToken

Returns

Task<FinancialDataResponse<List<InitialPublicOffering>>>

GetInsiderTransactionsAsync(string, int, CancellationToken) 

Task<FinancialDataResponse<List<InsiderTransaction>>> GetInsiderTransactionsAsync(string identifier, int offset = 0, CancellationToken cancellationToken = default)

Parameters

identifier string
offset int
cancellationToken CancellationToken

Returns

Task<FinancialDataResponse<List<InsiderTransaction>>>

GetInstitutionalHoldingsAsync(string, int, CancellationToken) 

Task<FinancialDataResponse<List<InstitutionalHolding>>> GetInstitutionalHoldingsAsync(string identifier, int offset = 0, CancellationToken cancellationToken = default)

Parameters

identifier string
offset int
cancellationToken CancellationToken

Returns

Task<FinancialDataResponse<List<InstitutionalHolding>>>

GetInstitutionalInvestorsAsync(int, CancellationToken) 

Task<FinancialDataResponse<List<InstitutionalInvestor>>> GetInstitutionalInvestorsAsync(int offset = 0, CancellationToken cancellationToken = default)

Parameters

offset int
cancellationToken CancellationToken

Returns

Task<FinancialDataResponse<List<InstitutionalInvestor>>>

GetInstitutionalPortfolioStatisticsAsync(string, int, CancellationToken) 

Task<FinancialDataResponse<List<InstitutionalPortfolioStatistics>>> GetInstitutionalPortfolioStatisticsAsync(string investorCik, int offset = 0, CancellationToken cancellationToken = default)

Parameters

investorCik string
offset int
cancellationToken CancellationToken

Returns

Task<FinancialDataResponse<List<InstitutionalPortfolioStatistics>>>

GetInternationalBalanceSheetStatementsAsync(string, Period, int, CancellationToken) 

Task<FinancialDataResponse<List<InternationalBalanceSheet>>> GetInternationalBalanceSheetStatementsAsync(string identifier, Period period = Period.All, int offset = 0, CancellationToken cancellationToken = default)

Parameters

identifier string
period Period
offset int
cancellationToken CancellationToken

Returns

Task<FinancialDataResponse<List<InternationalBalanceSheet>>>

GetInternationalCashFlowStatementsAsync(string, Period, int, CancellationToken) 

Task<FinancialDataResponse<List<InternationalCashFlow>>> GetInternationalCashFlowStatementsAsync(string identifier, Period period = Period.All, int offset = 0, CancellationToken cancellationToken = default)

Parameters

identifier string
period Period
offset int
cancellationToken CancellationToken

Returns

Task<FinancialDataResponse<List<InternationalCashFlow>>>

GetInternationalCompanyInformationAsync(string, CancellationToken) 

Task<FinancialDataResponse<List<InternationalCompanyInformation>>> GetInternationalCompanyInformationAsync(string identifier, CancellationToken cancellationToken = default)

Parameters

identifier string
cancellationToken CancellationToken

Returns

Task<FinancialDataResponse<List<InternationalCompanyInformation>>>

GetInternationalIncomeStatementsAsync(string, Period, int, CancellationToken) 

Task<FinancialDataResponse<List<InternationalIncome>>> GetInternationalIncomeStatementsAsync(string identifier, Period period = Period.All, int offset = 0, CancellationToken cancellationToken = default)

Parameters

identifier string
period Period
offset int
cancellationToken CancellationToken

Returns

Task<FinancialDataResponse<List<InternationalIncome>>>

GetInternationalStockPricesAsync(string, CancellationToken) 

Task<FinancialDataResponse<List<StockQuote>>> GetInternationalStockPricesAsync(string identifier, CancellationToken cancellationToken = default)

Parameters

identifier string
cancellationToken CancellationToken

Returns

Task<FinancialDataResponse<List<StockQuote>>>

GetInternationalStockSymbolsAsync(int, CancellationToken)

Retrieves a list of international stock symbols.

Task<FinancialDataResponse<List<Symbol>>> GetInternationalStockSymbolsAsync(int offset = 0, CancellationToken cancellationToken = default)

Parameters

offset int

The offset for pagination. Defaults to 0.

cancellationToken CancellationToken

A token to cancel the operation.

Returns

Task<FinancialDataResponse<List<Symbol>>>

A FinancialDataResponse<T> containing a list of international stock symbols.

Remarks

See: https://financialdata.net/documentation#operation/getInternationalStockSymbols

GetInvestmentAdviserInformationAsync(string, CancellationToken) 

Task<FinancialDataResponse<List<InvestmentAdviserInformation>>> GetInvestmentAdviserInformationAsync(string crdNumber, CancellationToken cancellationToken = default)

Parameters

crdNumber string
cancellationToken CancellationToken

Returns

Task<FinancialDataResponse<List<InvestmentAdviserInformation>>>

GetInvestmentAdviserNamesAsync(int, CancellationToken) 

Task<FinancialDataResponse<List<InvestmentAdviserName>>> GetInvestmentAdviserNamesAsync(int offset = 0, CancellationToken cancellationToken = default)

Parameters

offset int
cancellationToken CancellationToken

Returns

Task<FinancialDataResponse<List<InvestmentAdviserName>>>

GetIpoCalendarAsync(DateOnly?, int, CancellationToken) 

Task<FinancialDataResponse<List<IpoCalendar>>> GetIpoCalendarAsync(DateOnly? date = null, int offset = 0, CancellationToken cancellationToken = default)

Parameters

date DateOnly?
offset int
cancellationToken CancellationToken

Returns

Task<FinancialDataResponse<List<IpoCalendar>>>

GetKeyMetricsAsync(string, CancellationToken) 

Task<FinancialDataResponse<List<KeyMetrics>>> GetKeyMetricsAsync(string identifier, CancellationToken cancellationToken = default)

Parameters

identifier string
cancellationToken CancellationToken

Returns

Task<FinancialDataResponse<List<KeyMetrics>>>

GetLatestPricesAsync(string, int, CancellationToken) 

Task<FinancialDataResponse<List<StockPrice>>> GetLatestPricesAsync(string identifier, int offset = 0, CancellationToken cancellationToken = default)

Parameters

identifier string
offset int
cancellationToken CancellationToken

Returns

Task<FinancialDataResponse<List<StockPrice>>>

GetLiquidityRatiosAsync(string, Period, int, CancellationToken) 

Task<FinancialDataResponse<List<LiquidityRatios>>> GetLiquidityRatiosAsync(string identifier, Period period = Period.All, int offset = 0, CancellationToken cancellationToken = default)

Parameters

identifier string
period Period
offset int
cancellationToken CancellationToken

Returns

Task<FinancialDataResponse<List<LiquidityRatios>>>

GetMarketCapAsync(string, int, CancellationToken) 

Task<FinancialDataResponse<List<MarketCap>>> GetMarketCapAsync(string identifier, int offset = 0, CancellationToken cancellationToken = default)

Parameters

identifier string
offset int
cancellationToken CancellationToken

Returns

Task<FinancialDataResponse<List<MarketCap>>>

GetMinutePricesAsync(string, DateTimeOffset, int, CancellationToken) 

Task<FinancialDataResponse<List<StockPrice>>> GetMinutePricesAsync(string identifier, DateTimeOffset date, int offset = 0, CancellationToken cancellationToken = default)

Parameters

identifier string
date DateTimeOffset
offset int
cancellationToken CancellationToken

Returns

Task<FinancialDataResponse<List<StockPrice>>>

GetMutualFundHoldingsAsync(string, int, CancellationToken) 

Task<FinancialDataResponse<List<MutualFundHoldings>>> GetMutualFundHoldingsAsync(string identifier, int offset = 0, CancellationToken cancellationToken = default)

Parameters

identifier string
offset int
cancellationToken CancellationToken

Returns

Task<FinancialDataResponse<List<MutualFundHoldings>>>

GetMutualFundStatisticsAsync(string, int, CancellationToken) 

Task<FinancialDataResponse<List<MutualFundStatistics>>> GetMutualFundStatisticsAsync(string identifier, int offset = 0, CancellationToken cancellationToken = default)

Parameters

identifier string
offset int
cancellationToken CancellationToken

Returns

Task<FinancialDataResponse<List<MutualFundStatistics>>>

GetMutualFundSymbolsAsync(int, CancellationToken) 

Task<FinancialDataResponse<List<MutualFundSymbol>>> GetMutualFundSymbolsAsync(int offset = 0, CancellationToken cancellationToken = default)

Parameters

offset int
cancellationToken CancellationToken

Returns

Task<FinancialDataResponse<List<MutualFundSymbol>>>

GetOptionChainAsync(string, DateOnly?, CancellationToken) 

Task<FinancialDataResponse<List<OptionChain>>> GetOptionChainAsync(string identifier, DateOnly? expirationDate = null, CancellationToken cancellationToken = default)

Parameters

identifier string
expirationDate DateOnly?
cancellationToken CancellationToken

Returns

Task<FinancialDataResponse<List<OptionChain>>>

GetOptionGreeksAsync(string, int, CancellationToken) 

Task<FinancialDataResponse<List<OptionGreeks>>> GetOptionGreeksAsync(string contractName, int offset = 0, CancellationToken cancellationToken = default)

Parameters

contractName string
offset int
cancellationToken CancellationToken

Returns

Task<FinancialDataResponse<List<OptionGreeks>>>

GetOptionPricesAsync(string, int, CancellationToken) 

Task<FinancialDataResponse<List<OptionPrice>>> GetOptionPricesAsync(string contractName, int offset = 0, CancellationToken cancellationToken = default)

Parameters

contractName string
offset int
cancellationToken CancellationToken

Returns

Task<FinancialDataResponse<List<OptionPrice>>>

GetOtcPricesAsync(string, int, CancellationToken)

Asynchronously retrieves over-the-counter (OTC) price data for the specified financial instrument.

Task<FinancialDataResponse<List<OtcPrice>>> GetOtcPricesAsync(string identifier, int offset = 0, CancellationToken cancellationToken = default)

Parameters

identifier string

The unique identifier of the financial instrument for which to retrieve OTC prices. This value cannot be null or empty.

offset int

The number of records to skip before starting to return results. Must be greater than or equal to 0. Defaults to 0.

cancellationToken CancellationToken

A cancellation token that can be used to cancel the asynchronous operation.

Returns

Task<FinancialDataResponse<List<OtcPrice>>>

A task that represents the asynchronous operation. The task result contains a response with the OTC prices for the specified instrument.

GetOtcSymbolsAsync(int, CancellationToken)

Retrieves a list of OTC symbols.

Task<FinancialDataResponse<List<Symbol>>> GetOtcSymbolsAsync(int offset = 0, CancellationToken cancellationToken = default)

Parameters

offset int

The offset for pagination. Defaults to 0.

cancellationToken CancellationToken

A token to cancel the operation.

Returns

Task<FinancialDataResponse<List<Symbol>>>

A FinancialDataResponse<T> containing a list of OTC symbols.

Remarks

See: https://financialdata.net/documentation#operation/getOtcSymbols

GetOtcVolumesAsync(string, CancellationToken)

Asynchronously retrieves over-the-counter (OTC) volume data for the specified identifier.

Task<FinancialDataResponse<List<OtcVolume>>> GetOtcVolumesAsync(string identifier, CancellationToken cancellationToken = default)

Parameters

identifier string

The unique identifier for which to retrieve OTC volume data. This parameter cannot be null or empty.

cancellationToken CancellationToken

A cancellation token that can be used to cancel the asynchronous operation. The default value is None.

Returns

Task<FinancialDataResponse<List<OtcVolume>>>

A task that represents the asynchronous operation. The task result contains a FinancialDataResponse<T> with the OTC volume data for the specified identifier.

GetPressReleasesAsync(string, int, CancellationToken) 

Task<FinancialDataResponse<List<PressRelease>>> GetPressReleasesAsync(string identifier, int offset = 0, CancellationToken cancellationToken = default)

Parameters

identifier string
offset int
cancellationToken CancellationToken

Returns

Task<FinancialDataResponse<List<PressRelease>>>

GetProfitabilityRatiosAsync(string, Period, int, CancellationToken) 

Task<FinancialDataResponse<List<ProfitabilityRatios>>> GetProfitabilityRatiosAsync(string identifier, Period period = Period.All, int offset = 0, CancellationToken cancellationToken = default)

Parameters

identifier string
period Period
offset int
cancellationToken CancellationToken

Returns

Task<FinancialDataResponse<List<ProfitabilityRatios>>>

GetProposedSalesAsync(string, int, CancellationToken) 

Task<FinancialDataResponse<List<ProposedSale>>> GetProposedSalesAsync(string identifier, int offset = 0, CancellationToken cancellationToken = default)

Parameters

identifier string
offset int
cancellationToken CancellationToken

Returns

Task<FinancialDataResponse<List<ProposedSale>>>

GetSecPressReleasesAsync(int, CancellationToken) 

Task<FinancialDataResponse<List<SecPressRelease>>> GetSecPressReleasesAsync(int offset = 0, CancellationToken cancellationToken = default)

Parameters

offset int
cancellationToken CancellationToken

Returns

Task<FinancialDataResponse<List<SecPressRelease>>>

GetSecuritiesInformationAsync(string, CancellationToken) 

Task<FinancialDataResponse<List<SecuritiesInformation>>> GetSecuritiesInformationAsync(string identifier, CancellationToken cancellationToken = default)

Parameters

identifier string
cancellationToken CancellationToken

Returns

Task<FinancialDataResponse<List<SecuritiesInformation>>>

GetSenateTradingAsync(string?, int, CancellationToken) 

Task<FinancialDataResponse<List<SenateTrading>>> GetSenateTradingAsync(string? identifier = null, int offset = 0, CancellationToken cancellationToken = default)

Parameters

identifier string
offset int
cancellationToken CancellationToken

Returns

Task<FinancialDataResponse<List<SenateTrading>>>

GetShortInterestAsync(string, int, CancellationToken) 

Task<FinancialDataResponse<List<ShortInterest>>> GetShortInterestAsync(string identifier, int offset = 0, CancellationToken cancellationToken = default)

Parameters

identifier string
offset int
cancellationToken CancellationToken

Returns

Task<FinancialDataResponse<List<ShortInterest>>>

GetSolvencyRatiosAsync(string, Period, int, CancellationToken) 

Task<FinancialDataResponse<List<SolvencyRatios>>> GetSolvencyRatiosAsync(string identifier, Period period = Period.All, int offset = 0, CancellationToken cancellationToken = default)

Parameters

identifier string
period Period
offset int
cancellationToken CancellationToken

Returns

Task<FinancialDataResponse<List<SolvencyRatios>>>

GetSplitsCalendarAsync(DateOnly?, int, CancellationToken) 

Task<FinancialDataResponse<List<SplitsCalendar>>> GetSplitsCalendarAsync(DateOnly? date = null, int offset = 0, CancellationToken cancellationToken = default)

Parameters

date DateOnly?
offset int
cancellationToken CancellationToken

Returns

Task<FinancialDataResponse<List<SplitsCalendar>>>

GetStockPricesAsync(string, int, CancellationToken)

Stock Prices Endpoint: Asynchronously retrieves historical stock price data for a specified stock identifier (e.g., ticker symbol) over a given time period. The response includes details such as opening price, closing price, high, low, and trading volume for each day within the specified range.

Task<FinancialDataResponse<List<StockPrice>>> GetStockPricesAsync(string identifier, int offset = 0, CancellationToken cancellationToken = default)

Parameters

identifier string

The stock identifier (e.g., ticker symbol) for which to retrieve historical price data.

offset int

(Optional) The initial position of the record subset, which indicates how many records to skip. Defaults to 0.

cancellationToken CancellationToken

A token to monitor for cancellation requests.

Returns

Task<FinancialDataResponse<List<StockPrice>>>

A task that represents the asynchronous operation. The task result contains a collection of historical stock prices.

GetStockQuotesAsync(IEnumerable<string>, CancellationToken) 

Task<FinancialDataResponse<List<StockQuote>>> GetStockQuotesAsync(IEnumerable<string> identifiers, CancellationToken cancellationToken = default)

Parameters

identifiers IEnumerable<string>
cancellationToken CancellationToken

Returns

Task<FinancialDataResponse<List<StockQuote>>>

GetStockSplitsAsync(string, int, CancellationToken) 

Task<FinancialDataResponse<List<StockSplit>>> GetStockSplitsAsync(string identifier, int offset = 0, CancellationToken cancellationToken = default)

Parameters

identifier string
offset int
cancellationToken CancellationToken

Returns

Task<FinancialDataResponse<List<StockSplit>>>

GetStockSymbolsAsync(int, CancellationToken)

Retrieves a list of stock symbols.

Task<FinancialDataResponse<List<Symbol>>> GetStockSymbolsAsync(int offset = 0, CancellationToken cancellationToken = default)

Parameters

offset int

The offset for pagination. Defaults to 0.

cancellationToken CancellationToken

A token to cancel the operation.

Returns

Task<FinancialDataResponse<List<Symbol>>>

A FinancialDataResponse<T> containing a list of stock symbols.

Remarks

See: https://financialdata.net/documentation#operation/getStockSymbols

GetValuationRatiosAsync(string, Period, int, CancellationToken) 

Task<FinancialDataResponse<List<ValuationRatios>>> GetValuationRatiosAsync(string identifier, Period period = Period.All, int offset = 0, CancellationToken cancellationToken = default)

Parameters

identifier string
period Period
offset int
cancellationToken CancellationToken

Returns

Task<FinancialDataResponse<List<ValuationRatios>>>