fds.sdk.FactSetOwnershipReportBuilder 1.0.4

FactSet Ownership Report Builder client library for Python

FactSet Ownership Report Builder client library for Python

No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)

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

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

Requirements

• Python >= 3.7

Installation

Poetry

poetry add fds.sdk.utils fds.sdk.FactSetOwnershipReportBuilder

pip

pip install fds.sdk.utils fds.sdk.FactSetOwnershipReportBuilder

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

# Enter a context with an instance of the API client
with fds.sdk.FactSetOwnershipReportBuilder.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = ownership_api.OwnershipApi(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.
    id = "FDS" # str | Company or Fund Identifier
    # NOTE: The parameter variable defined below is just an example and may potentially contain non valid values. So please replace this with valid values.
    asset_type = "EQUITY" # str | Controls the Asset Type of the data returned (optional) if omitted the server will use the default value of "EQUITY"
    # NOTE: The parameter variable defined below is just an example and may potentially contain non valid values. So please replace this with valid values.
    holder_type = "INSTITUTIONS" # str | Controls the Holder Type of the data returned (optional) if omitted the server will use the default value of "INSTITUTIONS"
    # NOTE: The parameter variable defined below is just an example and may potentially contain non valid values. So please replace this with valid values.
    topn = "ALL" # str | Limits the number of holders returned based on their Market Value position in the security.   Default is ALL, otherwise use a valid number above 0.  (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.
    date = "2019-12-31" # str | Top Holders as of date expressed in YYYY-MM-DD format. Defaults to latest month-end close; non-month-end dates are converted to month-end dates. (optional)

    try:
        # Holders of a company or fund
        api_response = api_instance.get_ownership_holders(id, asset_type=asset_type, holder_type=holder_type, topn=topn, date=date)
        pprint(api_response)
    except fds.sdk.FactSetOwnershipReportBuilder.ApiException as e:
        print("Exception when calling OwnershipApi->get_ownership_holders: %s\n" % e)

    # Get response, http status code and response headers
    # try:
    #     # Holders of a company or fund
    #     api_response, http_status_code, response_headers = api_instance.get_ownership_holders_with_http_info(id, asset_type=asset_type, holder_type=holder_type, topn=topn, date=date)
    #     pprint(api_response)
    #     pprint(http_status_code)
    #     pprint(response_headers)
    # except fds.sdk.FactSetOwnershipReportBuilder.ApiException as e:
    #     print("Exception when calling OwnershipApi->get_ownership_holders: %s\n" % e)

    # Get response asynchronous
    # try:
    #     # Holders of a company or fund
    #     async_result = api_instance.get_ownership_holders_async(id, asset_type=asset_type, holder_type=holder_type, topn=topn, date=date)
    #     api_response = async_result.get()
    #     pprint(api_response)
    # except fds.sdk.FactSetOwnershipReportBuilder.ApiException as e:
    #     print("Exception when calling OwnershipApi->get_ownership_holders: %s\n" % e)

    # Get response, http status code and response headers asynchronous
    # try:
    #     # Holders of a company or fund
    #     async_result = api_instance.get_ownership_holders_with_http_info_async(id, asset_type=asset_type, holder_type=holder_type, topn=topn, date=date)
    #     api_response, http_status_code, response_headers = async_result.get()
    #     pprint(api_response)
    #     pprint(http_status_code)
    #     pprint(response_headers)
    # except fds.sdk.FactSetOwnershipReportBuilder.ApiException as e:
    #     print("Exception when calling OwnershipApi->get_ownership_holders: %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.FactSetOwnershipReportBuilder

logging.basicConfig(level=logging.DEBUG)

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

Documentation for API Endpoints

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

Class	Method	HTTP request	Description
OwnershipApi	get_ownership_holders	GET /holders	Holders of a company or fund

Documentation For Models

• Category
• CategoryCategory
• CurrencyCode
• CurrencyCodeCurrencyCode
• CurrencySymbol
• CurrencySymbolCurrencySymbol
• Description
• DescriptionDescription
• ErrorObject
• ErrorObjectLinks
• ErrorObjectSource
• ErrorResponse
• Frequency
• FrequencyFrequency
• FsymId
• FsymIdFsymId
• Meta
• MetadataEntry
• Response
• Scale
• ScaleScale
• ValueType
• ValueTypeValueType

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