Package: fds.sdk.DocumentsDistributorCallStreetEvents
Documents Distributor - CallStreet Events client library for PythonCallStreet Events contains all the Documents Distributor APIs that offer events data such as Events Audio and Near Real-Time Transcripts.The  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.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 Python package is automatically generated by theOpenAPI Generatorproject:API version: 1.8.3Package version: 0.21.14Build package: org.openapitools.codegen.languages.PythonClientCodegenFor more information, please visithttps://developer.factset.com/contactRequirementsPython >= 3.7InstallationPoetrypoetryaddfds.sdk.utilsfds.sdk.DocumentsDistributorCallStreetEvents==0.21.14pippipinstallfds.sdk.utilsfds.sdk.DocumentsDistributorCallStreetEvents==0.21.14UsageGenerate authentication credentials.Setup Python environment.Install and activate python 3.7+. If you're usingpyenv:pyenvinstall3.9.7
pyenvshell3.9.7(optional)Install poetry.Install dependencies.Run the following:fromfds.sdk.utils.authenticationimportConfidentialClientimportfds.sdk.DocumentsDistributorCallStreetEventsfromfds.sdk.DocumentsDistributorCallStreetEvents.apiimportevents_audio_apifromfds.sdk.DocumentsDistributorCallStreetEvents.modelsimport*fromdateutil.parserimportparseasdateutil_parserfrompprintimportpprint# See configuration.py for a list of all supported configuration parameters.# 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-python#authentication# for more information on using the ConfidentialClient classconfiguration=fds.sdk.DocumentsDistributorCallStreetEvents.Configuration(fds_oauth_client=ConfidentialClient('/path/to/app-config.json'))# Basic authentication: FactSetApiKey# See https://github.com/FactSet/enterprise-sdk#api-key# for information how to create an API key# configuration = fds.sdk.DocumentsDistributorCallStreetEvents.Configuration(#     username='USERNAME-SERIAL',#     password='API-KEY'# )# Enter a context with an instance of the API clientwithfds.sdk.DocumentsDistributorCallStreetEvents.ApiClient(configuration)asapi_client:# Create an instance of the API classapi_instance=events_audio_api.EventsAudioApi(api_client)# NOTE: The parameter variable defined below is just an example and may potentially contain non valid values. So please replace this with valid values.pagination_limit=25# int | Specifies the number of results to return per page. [ Min=0 ; Max=500 ] (optional) if omitted the server will use the default value of 25# NOTE: The parameter variable defined below is just an example and may potentially contain non valid values. So please replace this with valid values.pagination_offset=0# int | Specifies the starting point for pagination. This parameter is used to identify the beginning of next set of results. (optional) if omitted the server will use the default value of 0# NOTE: The parameter variable defined below is just an example and may potentially contain non valid values. So please replace this with valid values.year=2021# int | Specifies the year for which the historical audio recordings and related metadata are to be retrieved. (optional)# NOTE: The parameter variable defined below is just an example and may potentially contain non valid values. So please replace this with valid values.trimmed=True# bool | Specifies if trimmed/untrimmed historical audio recordings should be returned. (optional) if omitted the server will use the default value of Falsetry:# Retrieve historical audio recordings and related metadata within FactSet coverage.# example passing only required values which don't have defaults set# and optional valuesapi_response=api_instance.get_docs_distributor_audio_v1_history_files(pagination_limit=pagination_limit,pagination_offset=pagination_offset,year=year,trimmed=trimmed)pprint(api_response)exceptfds.sdk.DocumentsDistributorCallStreetEvents.ApiExceptionase:print("Exception when calling EventsAudioApi->get_docs_distributor_audio_v1_history_files:%s\n"%e)# # Get response, http status code and response headers# try:#     # Retrieve historical audio recordings and related metadata within FactSet coverage.#     api_response, http_status_code, response_headers = api_instance.get_docs_distributor_audio_v1_history_files_with_http_info(pagination_limit=pagination_limit, pagination_offset=pagination_offset, year=year, trimmed=trimmed)#     pprint(api_response)#     pprint(http_status_code)#     pprint(response_headers)# except fds.sdk.DocumentsDistributorCallStreetEvents.ApiException as e:#     print("Exception when calling EventsAudioApi->get_docs_distributor_audio_v1_history_files: %s\n" % e)# # Get response asynchronous# try:#     # Retrieve historical audio recordings and related metadata within FactSet coverage.#     async_result = api_instance.get_docs_distributor_audio_v1_history_files_async(pagination_limit=pagination_limit, pagination_offset=pagination_offset, year=year, trimmed=trimmed)#     api_response = async_result.get()#     pprint(api_response)# except fds.sdk.DocumentsDistributorCallStreetEvents.ApiException as e:#     print("Exception when calling EventsAudioApi->get_docs_distributor_audio_v1_history_files: %s\n" % e)# # Get response, http status code and response headers asynchronous# try:#     # Retrieve historical audio recordings and related metadata within FactSet coverage.#     async_result = api_instance.get_docs_distributor_audio_v1_history_files_with_http_info_async(pagination_limit=pagination_limit, pagination_offset=pagination_offset, year=year, trimmed=trimmed)#     api_response, http_status_code, response_headers = async_result.get()#     pprint(api_response)#     pprint(http_status_code)#     pprint(response_headers)# except fds.sdk.DocumentsDistributorCallStreetEvents.ApiException as e:#     print("Exception when calling EventsAudioApi->get_docs_distributor_audio_v1_history_files: %s\n" % e)Using PandasTo convert an API response to a Pandas DataFrame, it is necessary to transform it first to a dictionary.importpandasaspdresponse_dict=api_response.to_dict()['data']simple_json_response=pd.DataFrame(response_dict)nested_json_response=pd.json_normalize(response_dict)DebuggingThe SDK uses the standard libraryloggingmodule.SettingdebugtoTrueon an instance of theConfigurationclass sets the log-level of related packages toDEBUGand enables additional logging in PythonsHTTP Client.Note: This prints out sensitive information (e.g. the full request and response). Use with care.importloggingimportfds.sdk.DocumentsDistributorCallStreetEventslogging.basicConfig(level=logging.DEBUG)configuration=fds.sdk.DocumentsDistributorCallStreetEvents.Configuration(...)configuration.debug=TrueConfigure a ProxyYou can pass proxy settings to the Configuration class:proxy: The URL of the proxy to use.proxy_headers: a dictionary to pass additional headers to the proxy (e.g.Proxy-Authorization).importfds.sdk.DocumentsDistributorCallStreetEventsconfiguration=fds.sdk.DocumentsDistributorCallStreetEvents.Configuration(# ...proxy="http://secret:password@localhost:5050",proxy_headers={"Custom-Proxy-Header":"Custom-Proxy-Header-Value"})Custom SSL CertificateTLS/SSL certificate verification can be configured with the following Configuration parameters:ssl_ca_cert: a path to the certificate to use for verification inPEMformat.verify_ssl: setting this toFalsedisables the verification of certificates.
Disabling the verification is not recommended, but it might be useful during
local development or testing.importfds.sdk.DocumentsDistributorCallStreetEventsconfiguration=fds.sdk.DocumentsDistributorCallStreetEvents.Configuration(# ...ssl_ca_cert='/path/to/ca.pem')Documentation for API EndpointsAll URIs are relative tohttps://api.factset.comClassMethodHTTP requestDescriptionEventsAudioApiget_docs_distributor_audio_v1_history_filesGET/docs-distributor/audio/v1/history-filesRetrieve historical audio recordings and related metadata within FactSet coverage.EventsAudioApiget_docs_distributor_audio_v1_list_filesGET/docs-distributor/audio/v1/list-filesRetrieve latest audio recordings and related metadata within FactSet coverage.NearRealTimeTranscriptsApiget_bulk_documents_nrt_v1_callsGET/bulk-documents/nrt/v1/callsReturns the active calls happening at the moment.NearRealTimeTranscriptsApiget_bulk_documents_nrt_v1_indexed_nrtGET/bulk-documents/nrt/v1/indexed-nrtReturns the  indexed transcript data  in small increments throughout the duration of an active call.NearRealTimeTranscriptsApiget_bulk_documents_nrt_v1_list_snippetsGET/bulk-documents/nrt/v1/list-snippetsReturns the latest transcript snippets from an active call.NearRealTimeTranscriptsApiget_bulk_documents_nrt_v1_speakeridsGET/bulk-documents/nrt/v1/speakeridsReturns the latest speakerIds with the confidence scores generated for an active call.Documentation For ModelsErrorEventsAudioEventsAudio400ResponseEventsAudio400ResponseDetailsEventsAudio400ResponseDetailsValidParametersEventsAudioDataEventsAudioHistoryEventsAudioHistory400ResponseEventsAudioHistory400ResponseDetailsEventsAudioHistory400ResponseDetailsValidParametersEventsAudioHistoryDataEventsAudioHistoryMetaEventsAudioMetaEventsAudioMetaPaginationIndexedNRTIndexedNRTMetaIndexedNRTMetaPaginationNRTCallsNRTCalls400ResponseNRTCalls400ResponseDetailsNRTCalls400ResponseDetailsValidParametersNRTCallsDataNRTCallsMetaNRTSnippetsNRTSnippets400ResponseNRTSnippets400ResponseDetailsNRTSnippets400ResponseDetailsValidParametersNRTSnippetsDataNRTSnippetsMetaNRTSnippetsMetaPaginationNRTSnippetsMetaPartialNRTSnippetsSnippetDataNRTSnippetsTranscriptDataNRTSpeakeridsNRTSpeakerids400ResponseNRTSpeakerids400ResponseDetailsNRTSpeakerids400ResponseDetailsValidParametersNRTSpeakeridsDataNRTSpeakeridsMetaNRTSpeakeridsMetaPaginationDocumentation For AuthorizationFactSetApiKeyType: HTTP basic authenticationFactSetOAuth2Type: OAuthFlow: applicationAuthorization URL:Scopes: N/ANotes for Large OpenAPI documentsIf the OpenAPI document is large, imports in fds.sdk.DocumentsDistributorCallStreetEvents.apis and fds.sdk.DocumentsDistributorCallStreetEvents.models may fail with a
RecursionError indicating the maximum recursion limit has been exceeded. In that case, there are a couple of solutions:Solution 1:
Use specific imports for apis and models like:from fds.sdk.DocumentsDistributorCallStreetEvents.api.default_api import DefaultApifrom fds.sdk.DocumentsDistributorCallStreetEvents.model.pet import PetSolution 2:
Before importing the package, adjust the maximum recursion limit as shown below:import sys
sys.setrecursionlimit(1500)
import fds.sdk.DocumentsDistributorCallStreetEvents
from fds.sdk.DocumentsDistributorCallStreetEvents.apis import *
from fds.sdk.DocumentsDistributorCallStreetEvents.models import *ContributingPlease refer to thecontributing guide.CopyrightCopyright 2022 FactSet Research Systems IncLicensed 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 athttp://www.apache.org/licenses/LICENSE-2.0Unless 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.