Package: fds.sdk.StreetAccountNews
StreetAccount News client library for PythonThe StreetAccount News API provides access to FactSet's proprietary news provider, StreetAccount. StreetAccount, is a premium real-time market intelligence news service that delivers comprehensive U.S., Canadian, and European coverage (and expanding Asia coverage). All possible sources for corporate news are scanned and key story facts are highlighted and presented in an easy-to-read format.StreetAccount Filters, Headlines, and Views:These endpoints allow for the retrieval of news headlines using filters such as Watchlists/Indices/Tickers, Company Filters, Market Topics, Regions, and Sectors.  Headlines can also be retrieved based on saved views within the Workstation.StreetAccount Historical Stories:These endpoints provide access to historical StreetAccount (SA) news. The API delivers SA stories in XML format based on user-specified date input parameters. Output files are securely available to users through a URL. This API has three endpoints: Request Files, Check Status, and Get Files.Please note that this API only supports adhoc requests for historical files and does not support real-time files. If real-time push is required, consider using other methods such as SFTP, QNT account, or Azure Storage. Both historical and real-time Street Account news can be delivered via SFTP, QNT account, or Azure Storage.The files delivered contain both metadata and content body, eliminating the need for multiple requests through multiple services to retrieve all the information.This Python package is automatically generated by theOpenAPI Generatorproject:API version: 0.1.0Package version: 0.20.2Build package: org.openapitools.codegen.languages.PythonClientCodegenFor more information, please visithttps://developer.factset.com/contactRequirementsPython >= 3.7InstallationPoetrypoetryaddfds.sdk.utilsfds.sdk.StreetAccountNews==0.20.2pippipinstallfds.sdk.utilsfds.sdk.StreetAccountNews==0.20.2UsageGenerate 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.StreetAccountNewsfromfds.sdk.StreetAccountNews.apiimportfilters_apifromfds.sdk.StreetAccountNews.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.StreetAccountNews.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.StreetAccountNews.Configuration(#     username='USERNAME-SERIAL',#     password='API-KEY'# )# Enter a context with an instance of the API clientwithfds.sdk.StreetAccountNews.ApiClient(configuration)asapi_client:# Create an instance of the API classapi_instance=filters_api.FiltersApi(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.structured=True# bool | Pass structured to generate a structured view of the available filters. (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.flattened=True# bool | Pass flattened to generate a structured view of the available filters. (optional)try:# Retrieve all StreetAccount filters# example passing only required values which don't have defaults set# and optional valuesapi_response=api_instance.get_street_account_filters(structured=structured,flattened=flattened)pprint(api_response)exceptfds.sdk.StreetAccountNews.ApiExceptionase:print("Exception when calling FiltersApi->get_street_account_filters:%s\n"%e)# # Get response, http status code and response headers# try:#     # Retrieve all StreetAccount filters#     api_response, http_status_code, response_headers = api_instance.get_street_account_filters_with_http_info(structured=structured, flattened=flattened)#     pprint(api_response)#     pprint(http_status_code)#     pprint(response_headers)# except fds.sdk.StreetAccountNews.ApiException as e:#     print("Exception when calling FiltersApi->get_street_account_filters: %s\n" % e)# # Get response asynchronous# try:#     # Retrieve all StreetAccount filters#     async_result = api_instance.get_street_account_filters_async(structured=structured, flattened=flattened)#     api_response = async_result.get()#     pprint(api_response)# except fds.sdk.StreetAccountNews.ApiException as e:#     print("Exception when calling FiltersApi->get_street_account_filters: %s\n" % e)# # Get response, http status code and response headers asynchronous# try:#     # Retrieve all StreetAccount filters#     async_result = api_instance.get_street_account_filters_with_http_info_async(structured=structured, flattened=flattened)#     api_response, http_status_code, response_headers = async_result.get()#     pprint(api_response)#     pprint(http_status_code)#     pprint(response_headers)# except fds.sdk.StreetAccountNews.ApiException as e:#     print("Exception when calling FiltersApi->get_street_account_filters: %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.StreetAccountNewslogging.basicConfig(level=logging.DEBUG)configuration=fds.sdk.StreetAccountNews.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.StreetAccountNewsconfiguration=fds.sdk.StreetAccountNews.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.StreetAccountNewsconfiguration=fds.sdk.StreetAccountNews.Configuration(# ...ssl_ca_cert='/path/to/ca.pem')Documentation for API EndpointsAll URIs are relative tohttps://api.factset.com/research/news/v0ClassMethodHTTP requestDescriptionFiltersApiget_street_account_filtersGET/streetaccount/filtersRetrieve all StreetAccount filtersHeadlinesApiget_street_account_headlinesPOST/streetaccount/headlinesRetrieve StreetAccount headlines for given filtersHeadlinesApiget_street_account_headlines_by_viewPOST/streetaccount/views/{id}/headlinesRetrieve StreetAccount headlines for given viewStreetAccountHistoricalStoriesApistreetaccount_historical_check_status_getGET/streetaccount/historical/check-statusReturns the status and percentage of completion for the requested jobIDStreetAccountHistoricalStoriesApistreetaccount_historical_get_files_getGET/streetaccount/historical/get-filesReturns the StreetAccount XML files for the specified date rangeStreetAccountHistoricalStoriesApistreetaccount_historical_request_files_getGET/streetaccount/historical/request-filesReturns the jobIDViewsApicreate_street_account_viewPOST/streetaccount/views/{id}Creates and saves a StreetAccount viewViewsApidelete_street_account_viewDELETE/streetaccount/views/{id}Deletes an existing StreetAccount viewViewsApiedit_street_account_viewPUT/streetaccount/views/{id}Edits and saves an existing StreetAccount viewViewsApiget_street_account_viewsGET/streetaccount/viewsRetrieves StreetAccount search viewsDocumentation For ModelsCheckstatusCheckstatusResponseCreateEditDeleteViewResponseCreateEditDeleteViewResponseDataCreateEditDeleteViewResponseDataMessageCreateOrEditViewBodyCreateOrEditViewBodyDataCreateOrEditViewTickersErrorErrorObjectFilterResponseFilterResponseDataFlattenedFiltersFlattenedFiltersCategoriesObjectFlattenedFiltersRegionsObjectFlattenedFiltersSectorsObjectFlattenedFiltersTopicsObjectFlattenedFiltersWatchlistsObjectGetfilesGetfilesResponseIsPartialOneMetaOnePaginationOneRequestfilesResponseSaHeadlinesRequestSaHeadlinesRequestByViewSaHeadlinesRequestByViewDataSaHeadlinesRequestDataSaHeadlinesRequestDataSearchDateSaHeadlinesRequestMetaSaHeadlinesRequestMetaPaginationSaHeadlinesRequestTickersObjectSearchResponseSearchResponseArrayObjectSearchResponseDataSearchResponseMetaSearchResponseMetaPaginationStreetAccountStatusStructuredFiltersStructuredFiltersCategoriesObjectStructuredFiltersChildrenObjectStructuredFiltersRegionsObjectStructuredFiltersSectorsObjectStructuredFiltersTopicsObjectStructuredFiltersWatchlistsObjectViewsViewsObjectDocumentation For AuthorizationFactSetApiKeyType: HTTP basic authenticationFactSetOAuth2Type: OAuthFlow: applicationAuthorization URL:Scopes: N/ANotes for Large OpenAPI documentsIf the OpenAPI document is large, imports in fds.sdk.StreetAccountNews.apis and fds.sdk.StreetAccountNews.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.StreetAccountNews.api.default_api import DefaultApifrom fds.sdk.StreetAccountNews.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.StreetAccountNews
from fds.sdk.StreetAccountNews.apis import *
from fds.sdk.StreetAccountNews.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.