FactSet.SDK.FactSetOwnership
1.0.10
Prefix Reserved
dotnet add package FactSet.SDK.FactSetOwnership --version 1.0.10
NuGet\Install-Package FactSet.SDK.FactSetOwnership -Version 1.0.10
<PackageReference Include="FactSet.SDK.FactSetOwnership" Version="1.0.10" />
paket add FactSet.SDK.FactSetOwnership --version 1.0.10
#r "nuget: FactSet.SDK.FactSetOwnership, 1.0.10"
// Install FactSet.SDK.FactSetOwnership as a Cake Addin #addin nuget:?package=FactSet.SDK.FactSetOwnership&version=1.0.10 // Install FactSet.SDK.FactSetOwnership as a Cake Tool #tool nuget:?package=FactSet.SDK.FactSetOwnership&version=1.0.10
FactSet Ownership client library for .NET
FactSet's Fund Ownership API gives access to both Holdings and Holders data.<p> Factset's Holdings endpoints gives access to all the underlying securities and their position detils held within a given fund. Fund Types supported include Open-End Mutual Funds, Closed-end Mutual Funds, and Exchange Traded Funds. Security Holders information retrieves all "holder types" and their positions across institutions, funds, insiders, and stakeholders.</p><p>The FactSet Ownership and Mutual Funds database collects global equity ownership data for approximately 50,000 institutions, 60,000 unique Mutual Fund portfolios, and 400,000 Insider/Stake holders from around 110 countries. For more details review our Data Collection methodology. </p>
This .NET package is automatically generated by the OpenAPI Generator project:
- API version: 1.1.0
- SDK version: 1.0.10
- 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.FactSetOwnership -v 1.0.10
NuGet
nuget install FactSet.SDK.Utils
nuget install FactSet.SDK.FactSetOwnership -Version 1.0.10
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.FactSetOwnership.Api;
using FactSet.SDK.FactSetOwnership.Client;
using FactSet.SDK.FactSetOwnership.Model;
namespace Example
{
public static class GetOwnershipHoldingsExample
{
public static async Task Main()
{
var config = new FactSet.SDK.FactSetOwnership.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 FundHoldingsApi(config);
var ids = new List<string>(); // List<string> | List of requested fund identifiers. <p>***ids limit** = 10 per request*</p>
var date = "2019-12-31"; // string | Date of holdings expressed in YYYY-MM-DD format. The fund-holdings endpoint will default to latest month-end close. (optional)
var topn = "\"ALL\""; // string | Limits number of holdings or holders displayed by the top *n* securities based on positions Market Value. Default is ALL, otherwise use number to limit number. (optional) (default to "ALL")
var assetType = "ALL"; // string | Filter holdings by the following major asset classes - * **EQ** = Equity * **FI** = Fixed Income * **ALL** = ALL (optional) (default to EQ)
var currency = "USD"; // string | Currency code for adjusting prices. Default is Local. For a list of currency ISO codes, visit [Online Assistant Page 1470](https://oa.apps.factset.com/pages/1470). (optional)
try
{
// Get underlying holdings information for a requested fund identifer.
FundHoldingsResponse result = apiInstance.GetOwnershipHoldings(ids, date, topn, assetType, currency);
Console.WriteLine(result.ToJson());
}
catch (ApiException e)
{
Console.WriteLine("Exception when calling FundHoldingsApi.GetOwnershipHoldings: " + 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 |
---|---|---|---|
FundHoldingsApi | GetOwnershipHoldings | GET /factset-ownership/v1/fund-holdings | Get underlying holdings information for a requested fund identifer. |
FundHoldingsApi | PostOwnershipHoldings | POST /factset-ownership/v1/fund-holdings | Get holdings for a list of funds. |
SecurityHoldersApi | GetSecurityHolders | GET /factset-ownership/v1/security-holders | Get security ownership data for requested security identifers. |
SecurityHoldersApi | PostSecurityHolders | POST /factset-ownership/v1/security-holders | Get security ownership data for a list of requested securities. |
Documentation for Models
- Model.AssetType
- Model.ErrorResponse
- Model.ErrorResponseSubErrors
- Model.FundHolding
- Model.FundHoldingsRequest
- Model.FundHoldingsResponse
- Model.HolderType
- Model.SecurityHolders
- Model.SecurityHoldersRequest
- Model.SecurityHoldersResponse
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.10 | 83 | 7/11/2024 |
1.0.9 | 109 | 4/10/2024 |
1.0.8 | 261 | 10/25/2023 |
1.0.7 | 147 | 9/12/2023 |
1.0.6 | 153 | 8/30/2023 |
1.0.5 | 136 | 8/11/2023 |
1.0.4 | 150 | 6/6/2023 |
1.0.3 | 139 | 5/11/2023 |
1.0.2 | 231 | 3/1/2023 |
1.0.1 | 247 | 2/24/2023 |
1.0.0 | 388 | 8/31/2022 |
0.21.0 | 411 | 7/21/2022 |
0.20.0 | 401 | 5/24/2022 |
0.9.1 | 422 | 2/14/2022 |
0.9.0 | 405 | 2/2/2022 |
Refer to Changelog on GitHub source repository