pkg
FactSet/FactSet.SDK.QuantitativeResearchEnvironmentv0.21.5
✓ Verified.NET Std2.0
Quantitative Research Environment client library for .NET
Get Started
$ dotnet add package FactSet.SDK.QuantitativeResearchEnvironmentReadme
Quantitative Research Environment client library for .NET
TBD
This .NET package is automatically generated by the OpenAPI Generator project:
- API version: 0.0.0
- Package version: 0.21.5
- 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.QuantitativeResearchEnvironment
NuGet
nuget install FactSet.SDK.Utils
nuget install FactSet.SDK.QuantitativeResearchEnvironment
Usage
- Generate authentication credentials.
- Setup .NET Standard 2.0 compatible environment.
- Install dependencies.
- Run the following:
using System;
using System.Threading.Tasks;
using FactSet.SDK.Utils.Authentication;
using FactSet.SDK.QuantitativeResearchEnvironment.Api;
using FactSet.SDK.QuantitativeResearchEnvironment.Client;
using FactSet.SDK.QuantitativeResearchEnvironment.Model;
namespace Example
{
public static class AnalyticsQuantQreV1CalculationsIdGetExample
{
public static async Task Main()
{
var config = new FactSet.SDK.QuantitativeResearchEnvironment.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
// 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 CalculationsApi(config);
var id = "id_example"; // string | From url, provided by location header or response body in the calculation start endpoint
try
{
// Get calculation status by id
CalculationStatus result = apiInstance.AnalyticsQuantQreV1CalculationsIdGet(id);
Console.WriteLine(result.ToJson());
}
catch (ApiException e)
{
Console.WriteLine("Exception when calling CalculationsApi.AnalyticsQuantQreV1CalculationsIdGet: " + 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
| Class | Method | HTTP request | Description |
|---|---|---|---|
| CalculationsApi | AnalyticsQuantQreV1CalculationsIdGet | GET /analytics/quant/qre/v1/calculations/{id} | Get calculation status by id |
| CalculationsApi | AnalyticsQuantQreV1CalculationsIdLogGet | GET /analytics/quant/qre/v1/calculations/{id}/log | Get calculation log for a specific calculation |
| CalculationsApi | AnalyticsQuantQreV1CalculationsIdOutputGet | GET /analytics/quant/qre/v1/calculations/{id}/output | Get calculation output for a specific calculation |
| CalculationsApi | AnalyticsQuantQreV1CalculationsPost | POST /analytics/quant/qre/v1/calculations | Starts a new script calculation |
| FilesApi | AnalyticsQuantQreV1FilesServerFilePost | POST /analytics/quant/qre/v1/files/{server}/{file} | Starts a file upload |
| FilesApi | AnalyticsQuantQreV1FilesUploadsIdGet | GET /analytics/quant/qre/v1/files/uploads/{id} | Get upload status by id |
Documentation for Models
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.