FactSet.SDK.EventsandTranscripts
0.21.5
Prefix Reserved
dotnet add package FactSet.SDK.EventsandTranscripts --version 0.21.5
NuGet\Install-Package FactSet.SDK.EventsandTranscripts -Version 0.21.5
<PackageReference Include="FactSet.SDK.EventsandTranscripts" Version="0.21.5" />
paket add FactSet.SDK.EventsandTranscripts --version 0.21.5
#r "nuget: FactSet.SDK.EventsandTranscripts, 0.21.5"
// Install FactSet.SDK.EventsandTranscripts as a Cake Addin #addin nuget:?package=FactSet.SDK.EventsandTranscripts&version=0.21.5 // Install FactSet.SDK.EventsandTranscripts as a Cake Tool #tool nuget:?package=FactSet.SDK.EventsandTranscripts&version=0.21.5
Events and Transcripts client library for .NET
<p>The Calendar Events API provides access to FactSet’s Event Calendar data alongside business logic that allows users to replicate views and functionality consistent with the experience provided by the Workstation. This API provides the ability to pull Event Calendar data based on specific filters.</p> <p>Events Audio API provides access to historical as well as the latest audio recordings of various company events covered by FactSet. The events include, but are not limited to: earnings calls, conferences, and investor days. This API also provides relevant metadata such as timestamps and identifiers around each audio file.</p> <p>The Near Real-time Transcripts API enables access to Near Real-time Transcripts provided by CallStreet to time-sensitive clients. This API also provides the relevant speaker metadata along with their confidence scores. This data caters to quant clients interested in building machine learning models. Clients can leverage this API to perform sentiment analysis through natural language processing or machine learning. It can also be used to complement analysis using FactSet's transcripts service.</p> <p>Transcripts API provides conference call transcripts for companies' publicly held conference calls and a wealth of information regarding upcoming corporate events, such as conference call date and time, phone number and password, type of conference call, and important company investor relations contact information.</p>
This .NET package is automatically generated by the OpenAPI Generator project:
- API version: 1.1.0
- SDK version: 0.21.5
- 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.EventsandTranscripts -v 0.21.5
NuGet
nuget install FactSet.SDK.Utils
nuget install FactSet.SDK.EventsandTranscripts -Version 0.21.5
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.EventsandTranscripts.Api;
using FactSet.SDK.EventsandTranscripts.Client;
using FactSet.SDK.EventsandTranscripts.Model;
namespace Example
{
public static class GetCompanyEventExample
{
public static async Task Main()
{
var config = new FactSet.SDK.EventsandTranscripts.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 CalendarEventsApi(config);
var companyEventRequest = new CompanyEventRequest(); // CompanyEventRequest | Company Event request body
try
{
// Retrieve Company Event data
CompanyEventResponse result = apiInstance.GetCompanyEvent(companyEventRequest);
Console.WriteLine(result.ToJson());
}
catch (ApiException e)
{
Console.WriteLine("Exception when calling CalendarEventsApi.GetCompanyEvent: " + 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/events/v1
Class | Method | HTTP request | Description |
---|---|---|---|
CalendarEventsApi | GetCompanyEvent | POST /calendar/events | Retrieve Company Event data |
EventsAudioApi | GetDocsDistributorAudioV1HistoryFiles | GET /audio/history | Retrieve historical audio recordings and related metadata within FactSet coverage. |
EventsAudioApi | GetDocsDistributorAudioV1ListFilesDate | GET /audio/by-date | Retrieve latest audio recordings and related metadata within FactSet coverage based on a specific date ranges. |
EventsAudioApi | GetDocsDistributorAudioV1ListFilesFileName | GET /audio/by-file-name | Retrieve latest audio recordings and related metadata within FactSet coverage based on file name. |
EventsAudioApi | GetDocsDistributorAudioV1ListFilesIds | GET /audio/by-ids | Retrieve the latest audio recordings along with their corresponding metadata from the FactSet coverage based on specific IDs. |
EventsAudioApi | GetDocsDistributorAudioV1ListFilesUploadTime | GET /audio/by-upload-time | Retrieve latest audio recordings and related metadata within FactSet coverage based on upload time. |
NearRealTimeTranscriptsApi | GetBulkDocumentsNrtV1Calls | GET /nrt/by-ticker | Returns the active calls happening at the moment based on ticker,call status and entity ID. |
NearRealTimeTranscriptsApi | GetBulkDocumentsNrtV1CallsByAudioSourceId | GET /nrt/by-ids | Returns the active calls happening at the moment based on audio source ID and report ID. |
NearRealTimeTranscriptsApi | GetBulkDocumentsNrtV1Indexedrt | GET /nrt/indexed | Returns the indexed transcript data in small increments throughout the duration of an active call. |
NearRealTimeTranscriptsApi | GetBulkDocumentsNrtV1SpeakerIds | GET /nrt/speakerids | Returns the latest speakerIds with the confidence scores generated for an active call. |
TranscriptsApi | GetTimezone | GET /reference/time-zones | Returns the time zones. |
TranscriptsApi | GetTranscripts | GET /transcripts/search | Returns the transcript documents in XML format and related metadata within FactSet coverage based on search text. |
TranscriptsApi | GetTranscriptsDates | GET /transcripts/dates | Returns the transcript documents in XML format and related metadata within FactSet coverage based on specific date range and time zones. |
TranscriptsApi | GetTranscriptsEvents | GET /transcripts/events | Returns the transcript documents in XML format and related metadata within FactSet coverage based on eventIds and eventType. |
TranscriptsApi | GetTranscriptsIds | GET /transcripts/ids | Returns the transcript documents in XML format and related metadata within FactSet coverage based on specific IDs. |
TranscriptsApi | GetTranscriptsTime | GET /transcripts/times | Returns the transcript documents in XML format and related metadata within FactSet coverage based on specific time. |
TranscriptsApi | Getcategories | GET /reference/categories | Returns the categories. |
Documentation for Models
- Model.CompanyEventRequest
- Model.CompanyEventRequestData
- Model.CompanyEventRequestDataDateTime
- Model.CompanyEventRequestDataUniverse
- Model.CompanyEventResponse
- Model.CompanyEventResponseObject
- Model.Error
- Model.ErrorExample
- Model.EventsAudioDaily
- Model.EventsAudioDailyFileName
- Model.EventsAudioDailyIds
- Model.EventsAudioDailyMeta
- Model.EventsAudioDailyMetaPagination
- Model.EventsAudioDailyObject
- Model.EventsAudioDailyObjectOne
- Model.EventsAudioHistory
- Model.EventsAudioIdsObject
- Model.IndexedNrt
- Model.IndexedObject
- Model.ListFileObject
- Model.NrtCalls
- Model.NrtCallsMeta
- Model.NrtCallsMetaPagination
- Model.NrtCallsObject
- Model.NrtSpeakerIdObject
- Model.NrtSpeakerIds
- Model.NrtSpeakerIdsMeta
- Model.NrtSpeakerIdsMetaPagination
- Model.ResponseCategories
- Model.ResponseCategoriesObject
- Model.ResponseTime
- Model.ResponseTimeObject
- Model.TranscriptObject
- Model.TranscriptObjectOne
- Model.TranscriptObjectTimes
- Model.Transcripts
- Model.TranscriptsMeta
- Model.TranscriptsMetaPagination
- Model.TranscriptsOne
- Model.TranscriptsOneMeta
- Model.TranscriptsOneMetaPagination
- Model.TranscriptsTimes
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.
Refer to Changelog on GitHub source repository