FactSet.SDK.FactSetFunds 1.1.1

FactSet Funds client library for .NET

FactSet Mutual Funds data offers over 50 fund- and share class-specific data points for mutual funds listed in the United States. <p>FactSet Mutual Funds Reference provides fund-specific reference information as well as FactSet's proprietary classification system. It includes but is not limited to the following coverage

• Fund descriptions
• A seven-tier classification system
• Leverage information
• Fees and expenses
• Portfolio managers

FactSet Mutual Funds Time Series provides quantitative data items on a historical basis. It includes but is not limited to the following coverage

• Net asset value
• Fund flows
• Assets under management
• Total return

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

• API version: 1.0.1
• Package version: 1.1.1
• 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.FactSetFunds -v 1.1.1

NuGet

nuget install FactSet.SDK.Utils
nuget install FactSet.SDK.FactSetFunds -Version 1.1.1

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.FactSetFunds.Api;
using FactSet.SDK.FactSetFunds.Client;
using FactSet.SDK.FactSetFunds.Model;

namespace Example
{
    public static class GetFundsAumExample
    {
        public static async Task Main()
        {
            var config = new FactSet.SDK.FactSetFunds.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 FundFlowsAUMApi(config);
            var ids = new List<string>(); // List<string> | The requested fund identifier. FactSet Identifiers, tickers, CUSIP, SEDOL, and ISIN are accepted inputs. <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 = "2018-12-31";  // string | The start date requested for a given date range in **YYYY-MM-DD** format. If left blank, the API will default to latest available completed period.  (optional) 
            var endDate = "2019-12-31";  // string | The end date requested for a given date range in **YYYY-MM-DD** format. If left blank, the API will default to latest available completed period.  (optional) 
            var frequency = "MTD";  // string | Controls the display frequency of the data returned.   * **MTD** = Month-To-Date   * **M** = Monthly, based on the last trading day of the month.   * **CQTD** = Calendar Quarter-to-Date   * **CQ** = Calendar Quarterly   * **CYTD** = Calendar Year-to-Date   * **CY** = Calendar Yearly  (optional)  (default to M)
            var currency = "\"LOCAL\"";  // string | Controls the Currency conversion of the Fund. By default, the currency will use the funds local currency. (optional)  (default to "LOCAL")
            var dataType = "ROLL";  // string | The Data Type of the NAV expressed as Raw or Rolled values. (optional)  (default to ROLL)

            try
            {
                // Get Fund AUM for a requested date range and list of ids
                AumResponse result = apiInstance.GetFundsAum(ids, startDate, endDate, frequency, currency, dataType);
                Console.WriteLine(result.ToJson());
            }
            catch (ApiException e)
            {
                Console.WriteLine("Exception when calling FundFlowsAUMApi.GetFundsAum: " + 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

Documentation for Models

• Model.Aum
• Model.AumRequest
• Model.AumResponse
• Model.BenchmarkDetails
• Model.BenchmarkDetailsRequest
• Model.BenchmarkDetailsResponse
• Model.Classifications
• Model.ClassificationsRequest
• Model.ClassificationsResponse
• Model.CostsFees
• Model.CostsFeesRequest
• Model.CostsFeesResponse
• Model.DataType
• Model.DividendAdjust
• Model.ErrorResponse
• Model.ErrorResponseSubErrors
• Model.Flows
• Model.FlowsRequest
• Model.FlowsResponse
• Model.Frequency
• Model.FrequencyAum
• Model.FundsPricesRequest
• Model.FundsPricesResponse
• Model.FundsReturnsRequest
• Model.FundsReturnsResponse
• Model.FundsReturnsSnapshotRequest
• Model.FundsReturnsSnapshotResponse
• Model.Managers
• Model.ManagersRequest
• Model.ManagersResponse
• Model.Prices
• Model.RelatedFunds
• Model.RelatedFundsRequest
• Model.RelatedFundsResponse
• Model.Returns
• Model.ReturnsRange
• Model.ReturnsRangeRequest
• Model.ReturnsRangeResponse
• Model.ReturnsSnapshot
• Model.SplitAdjust
• Model.Statuses
• Model.StatusesRequest
• Model.StatusesResponse
• Model.Summaries
• Model.SummariesRequest
• Model.SummariesResponse

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.