FactSet.SDK.FactSetOwnershipReportBuilder 2.0.2

FactSet Ownership Report Builder client library for .NET

description.md

This .NET package is automatically generated by the OpenAPI Generator project:

• API version: 1.1.0
• SDK version: 2.0.2
• Build package: com.factset.sdk.codegen.FactSetCSharpNetCoreClientCodegen

For more information, please visit https://developer.factset.com/contact

Requirements

• .NET Standard >= 2.0

Installation

.NET CLI

dotnet add package FactSet.SDK.Utils
dotnet add package FactSet.SDK.FactSetOwnershipReportBuilder -v 2.0.2

NuGet

nuget install FactSet.SDK.Utils
nuget install FactSet.SDK.FactSetOwnershipReportBuilder -Version 2.0.2

Usage

1. Generate authentication credentials.
2. Setup .NET Standard 2.0 compatible environment.
3. Install dependencies.
4. 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.FactSetOwnershipReportBuilder.Api;
using FactSet.SDK.FactSetOwnershipReportBuilder.Client;
using FactSet.SDK.FactSetOwnershipReportBuilder.Model;

namespace Example
{
    public static class GetOwnershipHoldersExample
    {
        public static async Task Main()
        {
            var config = new FactSet.SDK.FactSetOwnershipReportBuilder.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 OwnershipApi(config);
            var id = "FDS-US";  // string | Company or Fund Identifier
            var assetType = "EQUITY";  // string | Controls the Asset Type of the data returned (optional)  (default to EQUITY)
            var holderType = "ALL_HOLDERS";  // string | Controls the Holder Type of the data returned (optional)  (default to INSTITUTIONS)
            var entityType = "SECURITY";  // string | Controls the type of Entity data returned. Defaults to Security data, but can also be used to display Company data. (optional)  (default to SECURITY)
            var topn = "ALL";  // string | Limits the number of holders returned based on their Market Value position in the security. Default is ALL, otherwise use a valid number above 0.  (optional) 
            var date = DateTime.Parse("Tue Dec 31 00:00:00 UTC 2019");  // DateTime? | Top Holders as of date expressed in YYYY-MM-DD format. Defaults to latest month-end close; non-month-end dates are converted to month-end dates. (optional) 

            try
            {
                // Holders of a company or fund
                ResponseHolders result = apiInstance.GetOwnershipHolders(id, assetType, holderType, entityType, topn, date);
                Console.WriteLine(result.ToJson());
            }
            catch (ApiException e)
            {
                Console.WriteLine("Exception when calling OwnershipApi.GetOwnershipHolders: " + 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/report/ownership/v1

Documentation for Models

• Model.ErrorObject
• Model.ErrorObjectLinks
• Model.ErrorObjectSource
• Model.ErrorResponse
• Model.ErrorWithMetaResponse
• Model.Meta
• Model.ResponseHolders
• Model.ResponseUltimateParent

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.