FactSet.SDK.FactSetFunds
1.2.0
Prefix Reserved
dotnet add package FactSet.SDK.FactSetFunds --version 1.2.0
NuGet\Install-Package FactSet.SDK.FactSetFunds -Version 1.2.0
<PackageReference Include="FactSet.SDK.FactSetFunds" Version="1.2.0" />
paket add FactSet.SDK.FactSetFunds --version 1.2.0
#r "nuget: FactSet.SDK.FactSetFunds, 1.2.0"
// Install FactSet.SDK.FactSetFunds as a Cake Addin #addin nuget:?package=FactSet.SDK.FactSetFunds&version=1.2.0 // Install FactSet.SDK.FactSetFunds as a Cake Tool #tool nuget:?package=FactSet.SDK.FactSetFunds&version=1.2.0
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 <p>This API is rate-limited to 10 requests per second and 10 concurrent requests per user.</p>
This .NET package is automatically generated by the OpenAPI Generator project:
- API version: 1.1.0
- SDK version: 1.2.0
- 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.FactSetFunds -v 1.2.0
NuGet
nuget install FactSet.SDK.Utils
nuget install FactSet.SDK.FactSetFunds -Version 1.2.0
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.FactSetFunds.Api;
using FactSet.SDK.FactSetFunds.Client;
using FactSet.SDK.FactSetFunds.Model;
namespace Example
{
public static class GetFundsDistCurrentExample
{
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 DistributionsApi(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 currency = "\"LOCAL\""; // string | Controls the Currency conversion of the Fund. By default, the currency will use the funds local currency. For a list of currency ISO codes, visit Online Assistant Page [OA1470](https://my.apps.factset.com/oa/pages/1470). (optional) (default to "LOCAL")
try
{
// Get Most Recent Fund Distributions
DistCurrentResponse result = apiInstance.GetFundsDistCurrent(ids, currency);
Console.WriteLine(result.ToJson());
}
catch (ApiException e)
{
Console.WriteLine("Exception when calling DistributionsApi.GetFundsDistCurrent: " + 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 |
---|---|---|---|
DistributionsApi | GetFundsDistCurrent | GET /factset-funds/v1/distributions/current | Get Most Recent Fund Distributions |
DistributionsApi | GetFundsDistCurrentForList | POST /factset-funds/v1/distributions/current | Get Most Recent Fund Distributions |
DistributionsApi | GetFundsDistHistorical | GET /factset-funds/v1/distributions/historical | Get Historical Fund Distributions |
DistributionsApi | GetFundsDistHistoricalForList | POST /factset-funds/v1/distributions/historical | Get Historical Fund Distributions |
FundFlowsAUMApi | GetFundsAum | GET /factset-funds/v1/aum | Get Fund AUM for a requested date range and list of ids |
FundFlowsAUMApi | GetFundsAumForList | POST /factset-funds/v1/aum | Get Fund AUM for a requested date range and large list of ids |
FundFlowsAUMApi | GetFundsFlows | GET /factset-funds/v1/flows | Get Fund Flows for a requested date range and list of ids |
FundFlowsAUMApi | GetFundsFlowsForList | POST /factset-funds/v1/flows | Get Fund Flows for a requested date range and large list of ids |
GroupHoldingsApi | GetGroupHoldings | GET /factset-funds/v1/holdings/group | Get group holdings for a specific date and group. |
GroupHoldingsApi | GetGroupHoldingsForList | POST /factset-funds/v1/holdings/group | Get group holdings for a specific date and group. |
HelperApi | GetStatuses | GET /factset-funds/v1/status | Get Fund's current status and database availability |
HelperApi | GetStatusesForList | POST /factset-funds/v1/status | Get Fund's current status and database availability for large list of ids. |
MarketAggregatesApi | GetMarketAggregates | GET /factset-funds/v1/aggregates/market | Get market aggregates for a requested time series. |
MarketAggregatesApi | GetMarketAggregatesForList | POST /factset-funds/v1/aggregates/market | Get market aggregates for a requested time series. |
PricesReturnsApi | GetFundsPrices | GET /factset-funds/v1/prices | Get Fund Prices (NAV) for a requested time-series |
PricesReturnsApi | GetFundsPricesForList | POST /factset-funds/v1/prices | Get Fund Prices (NAV) for a requested date range and large list of ids. |
PricesReturnsApi | GetFundsReturns | GET /factset-funds/v1/returns | Get Fund Returns for a requested time-series |
PricesReturnsApi | GetFundsReturnsForList | POST /factset-funds/v1/returns | Get Fund Returns for a requested time-series and large list of ids |
PricesReturnsApi | GetFundsReturnsRange | GET /factset-funds/v1/returns-range | Get Fund Returns for a user-defined date range |
PricesReturnsApi | GetFundsReturnsRangeForList | POST /factset-funds/v1/returns-range | Get Fund Returns over pre-defined time horizons as of a specific date for large list of ids. |
PricesReturnsApi | GetFundsReturnsSnapshot | GET /factset-funds/v1/returns-snapshot | Get Fund Returns over pre-defined time horizons as of a specific date. |
PricesReturnsApi | GetFundsReturnsSnapshotForList | POST /factset-funds/v1/returns-snapshot | Get Fund Returns over pre-defined time horizons as of a specific date. |
ReferenceApi | GetFundsBenchmarkDetails | GET /factset-funds/v1/benchmark-details | Get the Fund's Primary and Segment Benchmark Details |
ReferenceApi | GetFundsBenchmarkDetailsForList | POST /factset-funds/v1/benchmark-details | Get the Fund's Primary and Segment Benchmark details for large list of ids. |
ReferenceApi | GetFundsClassifications | GET /factset-funds/v1/classifications | Get basic Fund Classifications |
ReferenceApi | GetFundsClassificationsForList | POST /factset-funds/v1/classifications | Get basic Fund Classifications for a large list of ids. |
ReferenceApi | GetFundsCostsFees | GET /factset-funds/v1/costs-fees | Get the Fund's Costs, Investment minimums and Risk, and Fees. |
ReferenceApi | GetFundsCostsFeesForList | POST /factset-funds/v1/costs-fees | Get the Fund's Costs, Investment minimums and Risk, and Fees for large list of ids. |
ReferenceApi | GetFundsManagers | GET /factset-funds/v1/managers | Get a list of Fund Managers and related details for a list of ids. |
ReferenceApi | GetFundsManagersForList | POST /factset-funds/v1/managers | Get a list of Fund Managers and related details for a large list of ids. |
ReferenceApi | GetFundsSummary | GET /factset-funds/v1/summary | Get basic reference summary data for a Fund. |
ReferenceApi | GetFundsSummaryForList | POST /factset-funds/v1/summary | Get basic reference data for a large list of Fund ids. |
ReferenceApi | GetRelatedFunds | GET /factset-funds/v1/related-funds | Get a list of Related Funds for a list of Fund ids. |
ReferenceApi | GetRelatedFundsForList | POST /factset-funds/v1/related-funds | Get a list of Related Funds for a large list of Fund ids. |
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.DistCurrent
- Model.DistCurrentRequest
- Model.DistCurrentResponse
- Model.DistHistorical
- Model.DistHistoricalRequest
- Model.DistHistoricalResponse
- 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.Group
- Model.GroupHolding
- Model.GroupHoldingsRequest
- Model.GroupHoldingsResponse
- Model.Managers
- Model.ManagersRequest
- Model.ManagersResponse
- Model.MarketAggregate
- Model.MarketAggregatesRequest
- Model.MarketAggregatesResponse
- 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.
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.2.0 | 96 | 8/30/2024 |
1.1.2 | 94 | 7/11/2024 |
1.1.1 | 113 | 4/10/2024 |
1.1.0 | 123 | 2/22/2024 |
1.0.7 | 277 | 10/25/2023 |
1.0.6 | 176 | 8/30/2023 |
1.0.5 | 163 | 8/11/2023 |
1.0.4 | 145 | 6/6/2023 |
1.0.3 | 164 | 5/11/2023 |
1.0.2 | 232 | 3/1/2023 |
1.0.1 | 268 | 2/24/2023 |
1.0.0 | 398 | 8/31/2022 |
0.21.0 | 383 | 7/21/2022 |
0.20.0 | 402 | 5/24/2022 |
0.9.1 | 422 | 2/14/2022 |
0.9.0 | 411 | 2/2/2022 |
Refer to Changelog on GitHub source repository