Skip to main content

Overview Report Builder client library for Python

Project description

FactSet

Overview Report Builder client library for Python

PyPi Apache-2 license

Get relevant industry-specific data for high level analysis of public and private companies

This Python package is automatically generated by the OpenAPI Generator project:

  • API version: 1.2.0
  • Package version: 1.1.0
  • Build package: org.openapitools.codegen.languages.PythonClientCodegen

For more information, please visit https://developer.factset.com/contact

Requirements

  • Python >= 3.7

Installation

Poetry

poetry add fds.sdk.utils fds.sdk.OverviewReportBuilder

pip

pip install fds.sdk.utils fds.sdk.OverviewReportBuilder

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.OverviewReportBuilder
from fds.sdk.OverviewReportBuilder.api import company_api
from fds.sdk.OverviewReportBuilder.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.OverviewReportBuilder.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.OverviewReportBuilder.Configuration(
#     username='USERNAME-SERIAL',
#     password='API-KEY'
# )

# Enter a context with an instance of the API client
with fds.sdk.OverviewReportBuilder.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = company_api.CompanyApi(api_client)
    id = "FDS" # str | Company ticker

    try:
        # Current Capitalization
        api_response = api_instance.current_cap_get(id)
        pprint(api_response)
    except fds.sdk.OverviewReportBuilder.ApiException as e:
        print("Exception when calling CompanyApi->current_cap_get: %s\n" % e)

    # Get response, http status code and response headers
    # try:
    #     # Current Capitalization
    #     api_response, http_status_code, response_headers = api_instance.current_cap_get_with_http_info(id)
    #     pprint(api_response)
    #     pprint(http_status_code)
    #     pprint(response_headers)
    # except fds.sdk.OverviewReportBuilder.ApiException as e:
    #     print("Exception when calling CompanyApi->current_cap_get: %s\n" % e)

    # Get response asynchronous
    # try:
    #     # Current Capitalization
    #     async_result = api_instance.current_cap_get_async(id)
    #     api_response = async_result.get()
    #     pprint(api_response)
    # except fds.sdk.OverviewReportBuilder.ApiException as e:
    #     print("Exception when calling CompanyApi->current_cap_get: %s\n" % e)

    # Get response, http status code and response headers asynchronous
    # try:
    #     # Current Capitalization
    #     async_result = api_instance.current_cap_get_with_http_info_async(id)
    #     api_response, http_status_code, response_headers = async_result.get()
    #     pprint(api_response)
    #     pprint(http_status_code)
    #     pprint(response_headers)
    # except fds.sdk.OverviewReportBuilder.ApiException as e:
    #     print("Exception when calling CompanyApi->current_cap_get: %s\n" % e)

Using Pandas

To convert an API response to a Pandas DataFrame, it is necessary to transform it first to a dictionary.

import pandas as pd

response_dict = api_response.to_dict()['data']

simple_json_response = pd.DataFrame(response_dict)
nested_json_response = pd.json_normalize(response_dict)

Debugging

The SDK uses the standard library logging module.

Setting debug to True on an instance of the Configuration class sets the log-level of related packages to DEBUG and enables additional logging in Pythons HTTP Client.

Note: This prints out sensitive information (e.g. the full request and response). Use with care.

import logging
import fds.sdk.OverviewReportBuilder

logging.basicConfig(level=logging.DEBUG)

configuration = fds.sdk.OverviewReportBuilder.Configuration(...)
configuration.debug = True

Documentation for API Endpoints

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

Class Method HTTP request Description
CompanyApi current_cap_get GET /current-cap Current Capitalization
CompanyApi financial_highlights_get GET /financial-highlights Financial / Estimate Highlights
CompanyApi get_profile_profile GET /profile Overview Profile
CompanyApi key_stats_get GET /key-stats Key Stats
CompanyApi peer_list_get GET /peer-list Peer List
CompanyApi transactions_get GET /transactions Transactions

Documentation For Models

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.OverviewReportBuilder.apis and fds.sdk.OverviewReportBuilder.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.OverviewReportBuilder.api.default_api import DefaultApi
  • from fds.sdk.OverviewReportBuilder.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.OverviewReportBuilder
from fds.sdk.OverviewReportBuilder.apis import *
from fds.sdk.OverviewReportBuilder.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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distribution

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page