fds.sdk.FactSetPrivateMarkets 0.20.0

FactSet Private Markets client library for Python

FactSet Private Markets client library for Python

FactSet Private Markets API encompasses Private Company Financials data to start. Private Company firmographics can be found in the FactSet Entity API. The future plans of this service will include additional Private Markets data, such as Private Equity/Venture Capital.

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

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

Requirements

• Python >= 3.6

Installation

Poetry

poetry add fds.sdk.utils fds.sdk.FactSetPrivateMarkets

pip

pip install fds.sdk.utils fds.sdk.FactSetPrivateMarkets

Usage

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

   1. Install and activate python 3.6+. 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.FactSetPrivateMarkets
from fds.sdk.FactSetPrivateMarkets.api import data_items_api
from fds.sdk.FactSetPrivateMarkets.model.error_response import ErrorResponse
from fds.sdk.FactSetPrivateMarkets.model.fields_response import FieldsResponse
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.FactSetPrivateMarkets.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.FactSetPrivateMarkets.Configuration(
#     username='USERNAME-SERIAL',
#     password='API-KEY'
# )

# Enter a context with an instance of the API client
with fds.sdk.FactSetPrivateMarkets.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = data_items_api.DataItemsApi(api_client)
    category = "FINANCIALS" # str | Filters the list of available fields per endpoint  -   * **FINANCIALS** = Financials endpoint data items, such as Assets, Liabilities, and EBITDA.   * **NON_PERIODIC** = Non-Periodic endpoint data items, such as ISO Currency, Current CEO, and Investor List.  (optional)

    # Get response
    try:
        # Available private company fields, metrics, and ratios.
        api_response = api_instance.get_fields(category=category)
        pprint(api_response)
    except fds.sdk.FactSetPrivateMarkets.ApiException as e:
        print("Exception when calling DataItemsApi->get_fields: %s\n" % e)

    # Get response, http status code and response headers
    # try:
    #     # Available private company fields, metrics, and ratios.
    #     api_response, http_status_code, response_headers = api_instance.get_fields_with_http_info(category=category)
    #     pprint(api_response)
    #     pprint(http_status_code)
    #     pprint(response_headers)
    # except fds.sdk.FactSetPrivateMarkets.ApiException as e:
    #     print("Exception when calling DataItemsApi->get_fields: %s\n" % e)

    # Get response asynchronous
    # try:
    #     # Available private company fields, metrics, and ratios.
    #     async_result = api_instance.get_fields_async(category=category)
    #     api_response = async_result.get()
    #     pprint(api_response)
    # except fds.sdk.FactSetPrivateMarkets.ApiException as e:
    #     print("Exception when calling DataItemsApi->get_fields: %s\n" % e)

    # Get response, http status code and response headers asynchronous
    # try:
    #     # Available private company fields, metrics, and ratios.
    #     async_result = api_instance.get_fields_with_http_info_async(category=category)
    #     api_response, http_status_code, response_headers = async_result.get()
    #     pprint(api_response)
    #     pprint(http_status_code)
    #     pprint(response_headers)
    # except fds.sdk.FactSetPrivateMarkets.ApiException as e:
    #     print("Exception when calling DataItemsApi->get_fields: %s\n" % e)

Documentation for API Endpoints

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

Class	Method	HTTP request	Description
DataItemsApi	get_fields	GET /factset-private-markets/v1/fields	Available private company fields, metrics, and ratios.
FinancialsApi	get_financials	GET /factset-private-markets/v1/financials	Returns Private Company Financials for a list of ids.
FinancialsApi	get_financials_for_list	POST /factset-private-markets/v1/financials	Returns Private Company Financials for a list of ids.
NonPeriodicApi	get_non_periodic	GET /factset-private-markets/v1/non-periodic	Returns Private Company reference data for a list of ids.
NonPeriodicApi	get_non_periodic_for_list	POST /factset-private-markets/v1/non-periodic	Returns Private Company reference data for a list of ids.

Documentation For Models

• ErrorResponse
• ErrorResponseSubErrors
• Field
• FieldsResponse
• Financials
• FinancialsFields
• FinancialsRequest
• FinancialsResponse
• NonPeriodic
• NonPeriodicFields
• NonPeriodicRequest
• NonPeriodicResponse
• PrivateMarketIds

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