fds.sdk.DocumentsDistributorCallStreetEvents 0.21.0

Documents Distributor - CallStreet Events client library for Python

Documents Distributor - CallStreet Events client library for Python

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 Python package is automatically generated by the OpenAPI Generator project:

• API version: 1.0.0
• Package version: 0.21.0
• Build package: org.openapitools.codegen.languages.PythonClientCodegen

Requirements

• Python >= 3.7

Installation

Poetry

poetry add fds.sdk.utils fds.sdk.DocumentsDistributorCallStreetEvents

pip

pip install fds.sdk.utils fds.sdk.DocumentsDistributorCallStreetEvents

Usage

1. Generate authentication credentials.
2. Setup Python environment.

   1. Install and activate python 3.7+. If you're using pyenv:

      pyenv install 3.9.7
      pyenv shell 3.9.7
      

   2. (optional) Install poetry.

3. Install dependencies.
4. Run the following:

from fds.sdk.utils.authentication import ConfidentialClient
import fds.sdk.DocumentsDistributorCallStreetEvents
from fds.sdk.DocumentsDistributorCallStreetEvents.api import events_audio_api
from fds.sdk.DocumentsDistributorCallStreetEvents.models import *
from dateutil.parser import parse as dateutil_parser
from pprint import pprint

# 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
# See https://github.com/FactSet/enterprise-sdk-utils-python#authentication
# for more information on using the ConfidentialClient class
configuration = 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 client
with fds.sdk.DocumentsDistributorCallStreetEvents.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = events_audio_api.EventsAudioApi(api_client)
    sort = "-startDate" # str | Sorts results in chronological order, reverse chronological order and by uploadTime(latest uploaded first). Results are in reverse chronological order by default. (optional) if omitted the server will use the default value of "-startDate"
    pagination_limit = 0 # int | Specifies the number of results to return per page. [ Min=0 ; Max=500 ] (optional)
    start_date = dateutil_parser('1970-01-01').date() # date | 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)
    pagination_offset = 1 # int | Specifies the starting point for pagination. This parameter is used to identify the beginning of next set of results (optional)
    end_date = dateutil_parser('1970-01-01').date() # date | 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)
    report_id = 1 # int | Unique identifier for fetching the audio file for an event. The same ID is used for the transcript of the same event (optional)
    audio_source_id = 1 # 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)
    ids = "ids_example" # str | 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)
    source_code = "P" # str | 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)
    file_name = "fileName_example" # str | This parameter is used to filter the data on based on the file name. (optional)
    trimmed = True # bool | This parameters helps to search trimmed audio files (optional)
    upload_time = -168 # 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
        api_response = api_instance.get_docs_distributor_audio_v1_list_files(sort=sort, pagination_limit=pagination_limit, start_date=start_date, pagination_offset=pagination_offset, end_date=end_date, report_id=report_id, audio_source_id=audio_source_id, ids=ids, source_code=source_code, file_name=file_name, trimmed=trimmed, upload_time=upload_time)
        pprint(api_response)
    except fds.sdk.DocumentsDistributorCallStreetEvents.ApiException as e:
        print("Exception when calling EventsAudioApi->get_docs_distributor_audio_v1_list_files: %s\n" % e)

    # Get response, http status code and response headers
    # try:
    #     # Retrieve audio recordings and metadata within FactSet coverage
    #     api_response, http_status_code, response_headers = api_instance.get_docs_distributor_audio_v1_list_files_with_http_info(sort=sort, pagination_limit=pagination_limit, start_date=start_date, pagination_offset=pagination_offset, end_date=end_date, report_id=report_id, audio_source_id=audio_source_id, ids=ids, source_code=source_code, file_name=file_name, trimmed=trimmed, upload_time=upload_time)
    #     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_list_files: %s\n" % e)

    # Get response asynchronous
    # try:
    #     # Retrieve audio recordings and metadata within FactSet coverage
    #     async_result = api_instance.get_docs_distributor_audio_v1_list_files_async(sort=sort, pagination_limit=pagination_limit, start_date=start_date, pagination_offset=pagination_offset, end_date=end_date, report_id=report_id, audio_source_id=audio_source_id, ids=ids, source_code=source_code, file_name=file_name, trimmed=trimmed, upload_time=upload_time)
    #     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_list_files: %s\n" % e)

    # Get response, http status code and response headers asynchronous
    # try:
    #     # Retrieve audio recordings and metadata within FactSet coverage
    #     async_result = api_instance.get_docs_distributor_audio_v1_list_files_with_http_info_async(sort=sort, pagination_limit=pagination_limit, start_date=start_date, pagination_offset=pagination_offset, end_date=end_date, report_id=report_id, audio_source_id=audio_source_id, ids=ids, source_code=source_code, file_name=file_name, trimmed=trimmed, upload_time=upload_time)
    #     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_list_files: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to https://api.factset.com

Class	Method	HTTP request	Description
EventsAudioApi	get_docs_distributor_audio_v1_list_files	GET /docs-distributor/audio/v1/list-files	Retrieve audio recordings and metadata within FactSet coverage
NearRealTimeTranscriptsApi	get_bulk_documents_nrt_v1_calls	GET /bulk-documents/nrt/v1/calls	Returns the active calls happening at the moment
NearRealTimeTranscriptsApi	get_bulk_documents_nrt_v1_indexed_nrt	GET /bulk-documents/nrt/v1/indexed-nrt	Returns the indexed transcript data in small increments throughout the duration of an active call.
NearRealTimeTranscriptsApi	get_bulk_documents_nrt_v1_list_snippets	GET /bulk-documents/nrt/v1/list-snippets	Returns the latest transcript snippets from an active call
NearRealTimeTranscriptsApi	get_bulk_documents_nrt_v1_speakerids	GET /bulk-documents/nrt/v1/speakerids	Returns the latest speakerIds with the confidence scores generated for an active call.

Documentation For Models

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

Documentation For Authorization

FactSetApiKey

• Type: HTTP basic authentication

FactSetOAuth2

• Type: OAuth
• Flow: application
• Authorization URL:
• Scopes: N/A

Notes for Large OpenAPI documents

If 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 DefaultApi
• from fds.sdk.DocumentsDistributorCallStreetEvents.model.pet import Pet

Solution 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 *

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.