FactSet.SDK.DocumentsDistributorCallStreetEvents 0.21.0

<img alt="FactSet" src="https://www.factset.com/hubfs/Assets/images/factset-logo.svg" height="56" width="290">

Documents Distributor - CallStreet Events client library for .NET

CallStreet Events contains all the Documents Distributor APIs that provide events data such as Events Audio and Near Real-Time Transcripts

The Events Audio API provides access to all audio recordings to 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.

The Documents Distributor - 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.

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

• API version: 1.0.0
• Package version: 0.21.0
• 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.DocumentsDistributorCallStreetEvents

NuGet

nuget install FactSet.SDK.Utils
nuget install FactSet.SDK.DocumentsDistributorCallStreetEvents

Usage

1. Generate authentication credentials.
2. Setup .NET Standard 2.0 compatible environment.
3. Install dependencies.
4. Run the following:

using System;
using System.Threading.Tasks;
using FactSet.SDK.Utils.Authentication;
using FactSet.SDK.DocumentsDistributorCallStreetEvents.Api;
using FactSet.SDK.DocumentsDistributorCallStreetEvents.Client;
using FactSet.SDK.DocumentsDistributorCallStreetEvents.Model;

namespace Example
{
    public static class GetDocsDistributorAudioV1ListFilesExample
    {
        public static async Task Main()
        {
            var config = new FactSet.SDK.DocumentsDistributorCallStreetEvents.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 EventsAudioApi(config);
            var sort = "-startDate";  // string | Sorts results in chronological order, reverse chronological order and by uploadTime(latest uploaded first). Results are in reverse chronological order by default. (optional)  (default to -startDate)
            var paginationLimit = 56;  // int? | Specifies the number of results to return per page. [ Min=0 ; Max=500 ] (optional) 
            var startDate = DateTime.Parse("2013-10-20");  // DateTime? | Used in conjuction with endDate. The earliest date of the audio file the API should fetch for (can be in absolute: YYYY-MM-DD or relative date: -1 for yesterday)' (optional) 
            var paginationOffset = 56;  // int? | Specifies the starting point for pagination. This parameter is used to identify the beginning of next set of results (optional) 
            var endDate = DateTime.Parse("2013-10-20");  // DateTime? | Used in conjuction with startDate. The latest date of the audio file the API should fetch for (can be in absolute: YYYY-MM-DD or relative date: 0 for today) (optional) 
            var reportId = 56;  // int? | Unique identifier for fetching the audio file for an event. The same ID is used for the transcript of the same event (optional) 
            var audioSourceId = 56;  // int? | Unique ID for an Internal recording specific to reportID. For example, ReportID X would have multiple recordings from different source (phone or webcast or vendor or replay). One ReportID can have multiple AudioSource ids. (optional) 
            var ids = "ids_example";  // string | This parameter filters the results based on ticker-region or Entity ID or the combination of both. A comma is used to separate each identifier (optional) 
            var sourceCode = "P";  // string | This parameter filters the results based on Source of the Audio file. Below are the descriptions for each Source Code - * P = Phone * W = Webcast * V = Vendor * I = Webcast Replay * F = Flash - identical to webcast; can merge with \"W\" in the future * R = Replay (Phone Replay) (optional) 
            var fileName = "fileName_example";  // string | This parameter is used to filter the data on based on the file name. (optional) 
            var trimmed = true;  // bool? | This parameters helps to search trimmed audio files (optional) 
            var uploadTime = 56;  // int? | This parameter filters data based on uploadTime relative to the current time, in hours. For example:- uploadTime = -15 (fetches audio files between 15 hours ago and now)  Minimum is 1 hour i.e., uploadTime= -1  Maximum is 1 week/168 hours i.e., uploadTime=-168  While using uploadTime, the startDate and endDate parameters will be ignored (optional) 

            try
            {
                // Retrieve audio recordings and metadata within FactSet coverage
                EventsAudio result = apiInstance.GetDocsDistributorAudioV1ListFiles(sort, paginationLimit, startDate, paginationOffset, endDate, reportId, audioSourceId, ids, sourceCode, fileName, trimmed, uploadTime);
                Console.WriteLine(result.ToJson());
            }
            catch (ApiException e)
            {
                Console.WriteLine("Exception when calling EventsAudioApi.GetDocsDistributorAudioV1ListFiles: " + 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

Documentation for Models

• Model.Error
• Model.EventsAudio
• Model.EventsAudio400Response
• Model.EventsAudio400ResponseDetails
• Model.EventsAudio400ResponseDetailsValidParameters
• Model.EventsAudioData
• Model.EventsAudioMeta
• Model.EventsAudioMetaPagination
• Model.IndexedNRT
• Model.NRTCalls
• Model.NRTCalls400Response
• Model.NRTCalls400ResponseDetails
• Model.NRTCalls400ResponseDetailsValidParameters
• Model.NRTCallsData
• Model.NRTCallsMeta
• Model.NRTSnippets
• Model.NRTSnippets400Response
• Model.NRTSnippets400ResponseDetails
• Model.NRTSnippets400ResponseDetailsValidParameters
• Model.NRTSnippetsData
• Model.NRTSnippetsMeta
• Model.NRTSnippetsMetaPagination
• Model.NRTSnippetsMetaPartial
• Model.NRTSnippetsSnippetData
• Model.NRTSnippetsTranscriptData
• Model.NRTSpeakerids
• Model.NRTSpeakerids400Response
• Model.NRTSpeakerids400ResponseDetails
• Model.NRTSpeakerids400ResponseDetailsValidParameters
• Model.NRTSpeakeridsData
• Model.NRTSpeakeridsMeta
• Model.NRTSpeakeridsMetaPagination

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.