FactSet.SDK.Classifications
1.0.9
Prefix Reserved
dotnet add package FactSet.SDK.Classifications --version 1.0.9
NuGet\Install-Package FactSet.SDK.Classifications -Version 1.0.9
<PackageReference Include="FactSet.SDK.Classifications" Version="1.0.9" />
paket add FactSet.SDK.Classifications --version 1.0.9
#r "nuget: FactSet.SDK.Classifications, 1.0.9"
// Install FactSet.SDK.Classifications as a Cake Addin #addin nuget:?package=FactSet.SDK.Classifications&version=1.0.9 // Install FactSet.SDK.Classifications as a Cake Tool #tool nuget:?package=FactSet.SDK.Classifications&version=1.0.9
Classifications client library for .NET
The Classifications API gives access to various Industry Classifications for a given list of securities. Beginning first with GICS Direct, the service will then expand to offering NAICS, SIC, RBICS, and more.
This .NET package is automatically generated by the OpenAPI Generator project:
- API version: 1.0.1
- SDK version: 1.0.9
- 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.Classifications -v 1.0.9
NuGet
nuget install FactSet.SDK.Utils
nuget install FactSet.SDK.Classifications -Version 1.0.9
Usage
- Generate authentication credentials.
- Setup .NET Standard 2.0 compatible environment.
- Install dependencies.
- Run the following:
[!IMPORTANT] The parameter variables defined below are just examples and may potentially contain non valid values. Please replace them with valid values.
Example Code
using System;
using System.Threading.Tasks;
using FactSet.SDK.Utils.Authentication;
using FactSet.SDK.Classifications.Api;
using FactSet.SDK.Classifications.Client;
using FactSet.SDK.Classifications.Model;
namespace Example
{
public static class GetGicsExample
{
public static async Task Main()
{
var config = new FactSet.SDK.Classifications.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
//
// The confidential client instance should be reused in production environments.
// 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 GICSApi(config);
var ids = new List<string>(); // List<string> | The requested list of security identifiers. Accepted ID types include Market Tickers, SEDOL, ISINs, CUSIPs, or FactSet Permanent Ids. <p>***ids limit** = 1000 per request*</p> *<p>Make note, GET Method URL request lines are also limited to a total length of 8192 bytes (8KB). In cases where the service allows for thousands of ids, which may lead to exceeding this request line limit of 8KB, its advised for any requests with large request lines to be requested through the respective \"POST\" method.</p>*
var startDate = "startDate_example"; // string | Requested start date expressed in YYYY-MM-DD format. (optional)
var endDate = "endDate_example"; // string | Requested End Date for Range expressed in YYYY-MM-DD format. (optional)
var frequency = "D"; // string | Controls the display frequency of the data returned. * **D** = Daily * **W** = Weekly, based on the last day of the week of the start date. * **M** = Monthly, based on the last trading day of the month. * **AM** = Monthly, based on the start date (e.g., if the start date is June 16, data is displayed for June 16, May 16, April 16 etc.). * **CQ** = Quarterly based on the last trading day of the calendar quarter (March, June, September, or December). * **AY** = Actual Annual, based on the start date. * **CY** = Calendar Annual, based on the last trading day of the calendar year. (optional) (default to M)
var calendar = "FIVEDAY"; // string | Calendar of data returned. SEVENDAY includes weekends. (optional) (default to FIVEDAY)
try
{
// Gets the GICS Direct Classifications
GicsResponse result = apiInstance.GetGics(ids, startDate, endDate, frequency, calendar);
Console.WriteLine(result.ToJson());
}
catch (ApiException e)
{
Console.WriteLine("Exception when calling GICSApi.GetGics: " + 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 |
---|---|---|---|
GICSApi | GetGics | GET /classifications/v1/gics | Gets the GICS Direct Classifications |
GICSApi | PostGics | POST /classifications/v1/gics | Returns the GICS classifications for the requested 'ids' and date range. |
Documentation for Models
- Model.Calendar
- Model.ErrorResponse
- Model.ErrorResponseSubErrors
- Model.Frequency
- Model.Gics
- Model.GicsRequest
- Model.GicsResponse
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.3)
- 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 |
---|---|---|
1.0.9 | 92 | 7/11/2024 |
1.0.8 | 133 | 4/10/2024 |
1.0.7 | 272 | 10/25/2023 |
1.0.6 | 180 | 8/30/2023 |
1.0.5 | 164 | 8/11/2023 |
1.0.4 | 168 | 6/6/2023 |
1.0.3 | 162 | 5/11/2023 |
1.0.2 | 245 | 3/1/2023 |
1.0.1 | 249 | 2/24/2023 |
1.0.0 | 382 | 8/31/2022 |
0.21.0 | 416 | 7/21/2022 |
0.20.0 | 437 | 5/24/2022 |
0.9.1 | 456 | 2/14/2022 |
0.9.0 | 445 | 2/2/2022 |
Refer to Changelog on GitHub source repository