FactSet.SDK.FactSetFundamentals
0.21.0
Prefix Reserved
See the version list below for details.
dotnet add package FactSet.SDK.FactSetFundamentals --version 0.21.0
NuGet\Install-Package FactSet.SDK.FactSetFundamentals -Version 0.21.0
<PackageReference Include="FactSet.SDK.FactSetFundamentals" Version="0.21.0" />
paket add FactSet.SDK.FactSetFundamentals --version 0.21.0
#r "nuget: FactSet.SDK.FactSetFundamentals, 0.21.0"
// Install FactSet.SDK.FactSetFundamentals as a Cake Addin #addin nuget:?package=FactSet.SDK.FactSetFundamentals&version=0.21.0 // Install FactSet.SDK.FactSetFundamentals as a Cake Tool #tool nuget:?package=FactSet.SDK.FactSetFundamentals&version=0.21.0
<img alt="FactSet" src="https://www.factset.com/hubfs/Assets/images/factset-logo.svg" height="56" width="290">
FactSet Fundamentals client library for .NET
Gain access to current, comprehensive, and comparative information on securities in worldwide developed and emerging markets. Composed of annual and interim/quarterly data, detailed historical financial statement content, per share data, and calculated ratios, FactSet Fundamentals provides you with the information you need for a global investment perspective.
This .NET package is automatically generated by the OpenAPI Generator project:
- API version: 1.1.0
- Package version: 0.21.0
- Build package: com.factset.sdk.codegen.FactSetCSharpNetCoreClientCodegen
Requirements
- .NET Standard >= 2.0
Installation
.NET CLI
dotnet add package FactSet.SDK.Utils
dotnet add package FactSet.SDK.FactSetFundamentals
NuGet
nuget install FactSet.SDK.Utils
nuget install FactSet.SDK.FactSetFundamentals
Usage
- Generate authentication credentials.
- Setup .NET Standard 2.0 compatible environment.
- Install dependencies.
- Run the following:
using System;
using System.Threading.Tasks;
using FactSet.SDK.Utils.Authentication;
using FactSet.SDK.FactSetFundamentals.Api;
using FactSet.SDK.FactSetFundamentals.Client;
using FactSet.SDK.FactSetFundamentals.Model;
namespace Example
{
public static class GetFdsFundamentalsMetricsExample
{
public static async Task Main()
{
var config = new FactSet.SDK.FactSetFundamentals.Client.Configuration();
// Examples for each supported authentication method are below,
// choose one that satisfies your use case.
/* (Preferred) OAuth 2.0: FactSetOAuth2 */
// See https://github.com/FactSet/enterprise-sdk#oauth-20
// for information on how to create the app-config.json file
// See https://github.com/FactSet/enterprise-sdk-utils-dotnet#authentication
// for more information on using the ConfidentialClient class
ConfidentialClient confidentialClient = await ConfidentialClient.CreateAsync("/path/to/app-config.json");
config.OAuth2Client = confidentialClient;
/* Basic authentication: FactSetApiKey */
// See https://github.com/FactSet/enterprise-sdk#api-key
// for information how to create an API key
// config.Username = "USERNAME-SERIAL";
// config.Password = "API-KEY";
var apiInstance = new DataItemsApi(config);
var category = INCOME_STATEMENT; // string | Filters the list of FF_* metrics by major category - * **INCOME_STATEMENT** = Income Statement line items, such as Sales, Gross Profit, Net Income. * **BALANCE_SHEET** = Balance Sheet line items, such as Assets, Liabilities, and Shareholders Equity. * **CASH_FLOW** = Cash Flow Statement line items, such as Financing activities, Operation, and Per Share. * **RATIOS** = Pre-calculated Ratios, including Financial, Growth Rates, Profitability, Liquidity, Size, and Valuation. * **FINANCIAL_SERVICES** = Financial Statement Items modified for Financial Services companies. * **INDUSTRY_METRICS** = Industry Specific Line Items or Modifications. View subcategory for list of Industries. * **PENSION_AND_POSTRETIREMENT** = Accumulated Pension Benefit Obligations and related data. * **MARKET_DATA** = General Market Data, such as Shares Outstanding. *Note - /factset-prices/prices/ endpoints may be better suited for pricing related market data.* * **MISCELLANEOUS** = Corporation Data, Financial Records details, Indicators. * **DATES** = Relevant Dates (optional)
var subcategory = INCOME_STATEMENT; // string | Sub-Category Filter for the Primary Category Requested. Choose a related sub-category for the Category requested- * **INCOME_STATEMENT** - INCOME_STATEMENT, NON-OPERATING, PER_SHARE, SUPPLEMENTAL, OTHER * **BALANCE_SHEET** - ASSETS, BALANCE_SHEET, HEALTHCARE, LIABILITIES, PER_SHARE, SHAREHOLDERS_EQUITY, SUPPLEMENTAL * **CASH_FLOW** - CASH_FLOW, CHANGE_IN_CASH, FINANCING, INVESTING, OPERATING, PER_SHARE, SUPPLEMENTAL * **RATIOS** - FINANCIAL, GROWTH_RATE, LIQUIDITY, PROFITABILITY, SIZE, VALUATION * **FINANCIAL_SERVICES** - BALANCE_SHEET, INCOME_STATEMENT, SUPPLEMENTAL * **INDUSTRY_METRICS** - AIRLINES, BANKING, HOTELS_AND_GAMING, METALS_AND_MINING, OIL_AND_GAS, PHARMACEUTICAL, REIT, RETAIL, BANK, INSURANCE, UTILITY * **PENSION_AND_POSTRETIREMENT** - PENSION_AND_POSTRETIREMENT * **MARKET_DATA** - MARKET_DATA * **MISCELLANEOUS** - CLASSIFICATION, CORPORATE_DATA, FINANCIAL_RECORDS, INDICATOR, EMPLOYEES_AND_MANAGEMENT * **DATES** - DATES (optional)
try
{
// Available fundamental metrics or ratios.
MetricsResponse result = apiInstance.GetFdsFundamentalsMetrics(category, subcategory);
Console.WriteLine(result.ToJson());
}
catch (ApiException e)
{
Console.WriteLine("Exception when calling DataItemsApi.GetFdsFundamentalsMetrics: " + e.Message );
Console.WriteLine("Status Code: "+ e.ErrorCode);
Console.WriteLine(e.StackTrace);
}
}
}
}
Using a Proxy
To use the API client with a HTTP proxy, setup a System.Net.WebProxy
Configuration c = new Configuration();
System.Net.WebProxy webProxy = new System.Net.WebProxy("http://myProxyUrl:80/");
webProxy.Credentials = System.Net.CredentialCache.DefaultCredentials;
c.Proxy = webProxy;
Documentation for API Endpoints
All URIs are relative to https://api.factset.com/content
Class | Method | HTTP request | Description |
---|---|---|---|
DataItemsApi | GetFdsFundamentalsMetrics | GET /factset-fundamentals/v1/metrics | Available fundamental metrics or ratios. |
DataItemsApi | GetFdsFundamentalsMetricsForList | POST /factset-fundamentals/v1/metrics | Available fundamental metrics or ratios. |
FactSetFundamentalsApi | GetFdsFundamentals | GET /factset-fundamentals/v1/fundamentals | Returns the Company Fundamental Data. |
FactSetFundamentalsApi | GetFdsFundamentalsForList | POST /factset-fundamentals/v1/fundamentals | Returns the Company Fundamental Data. |
Documentation for Models
- Model.Category
- Model.ErrorResponse
- Model.ErrorResponseSubErrors
- Model.Fundamental
- Model.FundamentalsRequest
- Model.FundamentalsResponse
- Model.Metric
- Model.MetricsRequest
- Model.MetricsResponse
- Model.Periodicity
- Model.Restated
- Model.Subcategory
Documentation for Authorization
FactSetApiKey
- Type: HTTP basic authentication
FactSetOAuth2
- Type: OAuth
- Flow: application
- Authorization URL:
- Scopes: N/A
Contributing
Please refer to the contributing guide.
Copyright
Copyright 2022 FactSet Research Systems Inc
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.
Product | Versions Compatible and additional computed target framework versions. |
---|---|
.NET | net5.0 was computed. net5.0-windows was computed. net6.0 was computed. net6.0-android was computed. net6.0-ios was computed. net6.0-maccatalyst was computed. net6.0-macos was computed. net6.0-tvos was computed. net6.0-windows was computed. net7.0 was computed. net7.0-android was computed. net7.0-ios was computed. net7.0-maccatalyst was computed. net7.0-macos was computed. net7.0-tvos was computed. net7.0-windows was computed. net8.0 was computed. net8.0-android was computed. net8.0-browser was computed. net8.0-ios was computed. net8.0-maccatalyst was computed. net8.0-macos was computed. net8.0-tvos was computed. net8.0-windows was computed. |
.NET Core | netcoreapp2.0 was computed. netcoreapp2.1 was computed. netcoreapp2.2 was computed. netcoreapp3.0 was computed. netcoreapp3.1 was computed. |
.NET Standard | netstandard2.0 is compatible. netstandard2.1 was computed. |
.NET Framework | net461 was computed. net462 was computed. net463 was computed. net47 was computed. net471 was computed. net472 was computed. net48 was computed. net481 was computed. |
MonoAndroid | monoandroid was computed. |
MonoMac | monomac was computed. |
MonoTouch | monotouch was computed. |
Tizen | tizen40 was computed. tizen60 was computed. |
Xamarin.iOS | xamarinios was computed. |
Xamarin.Mac | xamarinmac was computed. |
Xamarin.TVOS | xamarintvos was computed. |
Xamarin.WatchOS | xamarinwatchos was computed. |
-
.NETStandard 2.0
- FactSet.SDK.Utils (>= 1.0.0)
- JsonSubTypes (>= 1.8.0)
- Newtonsoft.Json (>= 13.0.1)
- Polly (>= 7.2.2)
- RestSharp (>= 106.15.0)
- System.ComponentModel.Annotations (>= 5.0.0)
NuGet packages
This package is not used by any NuGet packages.
GitHub repositories
This package is not used by any popular GitHub repositories.
Version | Downloads | Last updated |
---|---|---|
2.3.1 | 127 | 8/22/2024 |
2.3.0 | 90 | 7/18/2024 |
2.2.2 | 85 | 7/11/2024 |
2.2.1 | 109 | 4/10/2024 |
2.2.0 | 235 | 11/20/2023 |
2.1.1 | 141 | 10/25/2023 |
2.1.0 | 140 | 9/12/2023 |
2.0.2 | 121 | 8/30/2023 |
2.0.1 | 143 | 8/11/2023 |
2.0.0 | 133 | 6/13/2023 |
1.0.9 | 84 | 7/11/2024 |
1.0.8 | 94 | 4/10/2024 |
1.0.7 | 130 | 10/25/2023 |
1.0.6 | 128 | 8/30/2023 |
1.0.5 | 136 | 8/11/2023 |
1.0.4 | 137 | 6/6/2023 |
1.0.3 | 136 | 5/11/2023 |
1.0.2 | 227 | 3/1/2023 |
1.0.1 | 222 | 2/24/2023 |
1.0.0 | 365 | 8/31/2022 |
0.21.0 | 392 | 7/21/2022 |
0.20.0 | 400 | 5/24/2022 |
0.9.1 | 411 | 2/14/2022 |
0.9.0 | 405 | 2/2/2022 |
Refer to Changelog on GitHub source repository