FactSet.SDK.Cabot 0.11.0

Cabot client library for .NET

Cabot Models API

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

• API version: 0.2.0
• SDK version: 0.11.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.Cabot -v 0.11.0

NuGet

nuget install FactSet.SDK.Utils
nuget install FactSet.SDK.Cabot -Version 0.11.0

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

namespace Example
{
    public static class GetBuyContextModelAnalyticExample
    {
        public static async Task Main()
        {
            var config = new FactSet.SDK.Cabot.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 BuyingModelsApi(config);
            var accountPath = "accountPath_example";  // string | The account path of the portfolio you want to retrieve the data for.
            var benchmarkPath = "BENCH:SP50";  // string | The path of the benchmark you want to retrieve the data for.<br /><br />
            var period = "period_example";  // string | For which period you want to retrieve the data.<br />There are four options available as follows:<br /><br />1 -> YYYY (Repeating One Year)<br /><br />2 -> YYYY-YYYY (Repeating Three/Five/Ten Year)<br /><br />3 -> 1M_TRAILING, 3M_TRAILING, 1Y_TRAILING, 3Y_TRAILING, 5Y_TRAILING (Trailing Periods (If available for your portfolio))<br /><br />4 -> INCEPTION_TO_DATE<br /><br />You can only get the data for one period per request.<br /><br />
            var attribute = (Attributes) "QFL_EY";  // Attributes | The attribute represents the different factors.<br />You can choose which of them (if any) you want to see analytics for.<br /><br />If provided, the API response will contain both \"LOW\" and \"HIGH\" values for it.<br /><br />
            var sector = (Sectors) "energy";  // Sectors? | Sector represents the sector based on the company's industry breakdown.<br />You can choose which of them (if any) you want to see analytics for.<br /><br /> (optional) 
            var region = (Regions) "africa";  // Regions? | Region of domicile represents the region based on the company's primary listing.<br />You can choose which of them (if any) you want to see analytics for.<br /><br /> (optional) 

            try
            {
                // Cabot main path for Buy Context API
                BuyContextResponseRoot result = apiInstance.GetBuyContextModelAnalytic(accountPath, benchmarkPath, period, attribute, sector, region);
                Console.WriteLine(result.ToJson());
            }
            catch (ApiException e)
            {
                Console.WriteLine("Exception when calling BuyingModelsApi.GetBuyContextModelAnalytic: " + 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/analytics/cabot/v0

Documentation for Models

• Model.AddTrimModelAnalytics
• Model.AddTrimResponseOptions
• Model.AddTrimResponseRoot
• Model.Attributes
• Model.BuyContextModelAnalytics
• Model.BuyContextModelAnalyticsContext
• Model.BuyContextModelAnalyticsContextAttribute
• Model.BuyContextModelAnalyticsItem
• Model.BuyContextModelAnalyticsItemRange
• Model.BuyContextResponseOptions
• Model.BuyContextResponseRoot
• Model.BuyTimingModelAnalytics
• Model.BuyTimingResponseOptions
• Model.BuyTimingResponseRoot
• Model.ClientErrorResponse
• Model.ConstructionModelAnalytics
• Model.ConstructionModelAnalyticsActiveWeights
• Model.ConstructionModelAnalyticsActiveWeightsMaxOver
• Model.ConstructionModelAnalyticsPositionCount
• Model.ConstructionResponseOptions
• Model.ConstructionResponseRoot
• Model.Error
• Model.ErrorSource
• Model.HitRateModelAnalytics
• Model.HitRateModelAnalyticsLosers
• Model.HitRateModelAnalyticsWinners
• Model.HitRateResponseOptions
• Model.HitRateResponseRoot
• Model.RampDownModelAnalytics
• Model.RampDownResponseOptions
• Model.RampDownResponseRoot
• Model.RampUpModelAnalytics
• Model.RampUpResponseOptions
• Model.RampUpResponseRoot
• Model.Regions
• Model.ResultsModelAnalytics
• Model.ResultsModelAnalyticsCaptures
• Model.ResultsModelAnalyticsRatios
• Model.ResultsModelAnalyticsReturns
• Model.ResultsModelAnalyticsRisk
• Model.ResultsModelAnalyticsStatistics
• Model.ResultsResponseOptions
• Model.ResultsResponseRoot
• Model.Sectors
• Model.SellTimingModelAnalytics
• Model.SellTimingResponseOptions
• Model.SellTimingResponseRoot
• Model.SkillsModelAnalytics
• Model.SkillsResponseOptions
• Model.SkillsResponseRoot
• Model.StopLossModelAnalytics
• Model.StopLossResponseOptions
• Model.StopLossResponseRoot

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.