Skip to main content

FactSet Private Equity and Venture Capital client library for Python

Project description

FactSet

FactSet Private Equity and Venture Capital client library for Python

API Version PyPi Apache-2 license

Comprehensive API for accessing private equity and venture capital data including funds, general partners, transactions, and portfolio companies.

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

  • API version: 1.0.0
  • SDK version: 1.0.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.FactSetPrivateEquityandVentureCapital==1.0.0

pip

pip install fds.sdk.utils fds.sdk.FactSetPrivateEquityandVentureCapital==1.0.0

Usage

  1. Generate authentication credentials.
  2. Setup Python environment.
    1. Install and activate python 3.10+. If you're using pyenv:

      pyenv install 3.10.0
      pyenv shell 3.10.0
      
    2. (optional) Install poetry.

  3. Install dependencies.
  4. Run the following:

[!IMPORTANT] The parameter variables defined below are just examples and may potentially contain non valid values. Please replace them with valid values.

Example Code

from fds.sdk.utils.authentication import ConfidentialClient

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

# Enter a context with an instance of the API client
with fds.sdk.FactSetPrivateEquityandVentureCapital.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = funds_api.FundsApi(api_client)
    ids = ["001JYM-E","005GEM-E"] # [str] | A list of FactSet Permanent Entity Identifiers (FactSet IDs) for **Private Equity and Venture Capital Funds**. These IDs are in the format 'XXXXXX-E' and are the primary input for most fund-related endpoints. These IDs can be retrieved from the /universe endpoint

    try:
        # Retrieve core profile and summary data for specified Private Equity or Venture Capital Funds.
        # example passing only required values which don't have defaults set
        api_response = api_instance.get_fund(ids)

        pprint(api_response)
    except fds.sdk.FactSetPrivateEquityandVentureCapital.ApiException as e:
        print("Exception when calling FundsApi->get_fund: %s\n" % e)

    # # Get response, http status code and response headers
    # try:
    #     # Retrieve core profile and summary data for specified Private Equity or Venture Capital Funds.
    #     api_response, http_status_code, response_headers = api_instance.get_fund_with_http_info(ids)


    #     pprint(api_response)
    #     pprint(http_status_code)
    #     pprint(response_headers)
    # except fds.sdk.FactSetPrivateEquityandVentureCapital.ApiException as e:
    #     print("Exception when calling FundsApi->get_fund: %s\n" % e)

    # # Get response asynchronous
    # try:
    #     # Retrieve core profile and summary data for specified Private Equity or Venture Capital Funds.
    #     async_result = api_instance.get_fund_async(ids)
    #     api_response = async_result.get()


    #     pprint(api_response)
    # except fds.sdk.FactSetPrivateEquityandVentureCapital.ApiException as e:
    #     print("Exception when calling FundsApi->get_fund: %s\n" % e)

    # # Get response, http status code and response headers asynchronous
    # try:
    #     # Retrieve core profile and summary data for specified Private Equity or Venture Capital Funds.
    #     async_result = api_instance.get_fund_with_http_info_async(ids)
    #     api_response, http_status_code, response_headers = async_result.get()


    #     pprint(api_response)
    #     pprint(http_status_code)
    #     pprint(response_headers)
    # except fds.sdk.FactSetPrivateEquityandVentureCapital.ApiException as e:
    #     print("Exception when calling FundsApi->get_fund: %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.FactSetPrivateEquityandVentureCapital

logging.basicConfig(level=logging.DEBUG)

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

Configure a Proxy

You 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).
import fds.sdk.FactSetPrivateEquityandVentureCapital

configuration = fds.sdk.FactSetPrivateEquityandVentureCapital.Configuration(
    # ...
    proxy="http://secret:password@localhost:5050",
    proxy_headers={
        "Custom-Proxy-Header": "Custom-Proxy-Header-Value"
    }
)

Custom SSL Certificate

TLS/SSL certificate verification can be configured with the following Configuration parameters:

  • ssl_ca_cert: a path to the certificate to use for verification in PEM format.
  • verify_ssl: setting this to False disables the verification of certificates. Disabling the verification is not recommended, but it might be useful during local development or testing.
import fds.sdk.FactSetPrivateEquityandVentureCapital

configuration = fds.sdk.FactSetPrivateEquityandVentureCapital.Configuration(
    # ...
    ssl_ca_cert='/path/to/ca.pem'
)

Request Retries

In case the request retry behaviour should be customized, it is possible to pass a urllib3.Retry object to the retry property of the Configuration.

from urllib3 import Retry
import fds.sdk.FactSetPrivateEquityandVentureCapital

configuration = fds.sdk.FactSetPrivateEquityandVentureCapital.Configuration(
    # ...
)

configuration.retries = Retry(total=3, status_forcelist=[500, 502, 503, 504])

Documentation for API Endpoints

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

Class Method HTTP request Description
FundsApi get_fund GET /funds Retrieve core profile and summary data for specified Private Equity or Venture Capital Funds.
FundsApi get_fund_cashflows POST /funds/cashflows Retrieve time-series cash flow data (contributions and distributions) for specified funds.
FundsApi get_fund_fundraising GET /funds/fundraising Retrieve the complete fundraising history for specified Private Equity or Venture Capital Funds.
FundsApi get_fund_portfolio_companies GET /funds/portfolio-companies Retrieve the list of portfolio companies held by specified Private Equity or Venture Capital Funds.
GeneralAndLimitedPartnersApi get_fund_limited_partners GET /limited-partners/funds Retrieve the Limited Partners (LPs) and their capital commitments to specific funds.
GeneralAndLimitedPartnersApi get_gp GET /general-partners Retrieve core profile and summary data for specified General Partner (GP) firms.
GeneralAndLimitedPartnersApi get_gp_funds GET /general-partners/funds Retrieve the list of all Private Equity and Venture Capital Funds managed by specified General Partners.
IPOsApi get_ipo GET /ipos Retrieve details of an Initial Public Offering (IPO) related to a portfolio company exit.
IPOsApi search_ipos POST /ipos/search Search and filter the universe of portfolio company IPOs by status, size, and date range.
StrategiesApi get_entity_strategies GET /entities/strategies Retrieve detailed investment strategy mandates for a specified fund or General Partner.
TransactionsApi get_transaction GET /transactions Retrieve comprehensive details for a list of Private Equity or Venture Capital transactions.
TransactionsApi get_transaction_ma_activity GET /transactions/ma-activity Retrieve detailed M&A advisory and investment information for specified transactions.
TransactionsApi search_transactions POST /transactions/search Search and filter the universe of transactions by deal size, date range, stage, and portfolio company.
UniverseApi get_universe GET /universe Returns Entity Candidates and Matches for a single name and attributes.

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

Contributing

Please refer to the contributing guide.

Copyright

Copyright 2026 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 Distribution

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

File details

Details for the file fds_sdk_factsetprivateequityandventurecapital-1.0.0.tar.gz.

File metadata

File hashes

Hashes for fds_sdk_factsetprivateequityandventurecapital-1.0.0.tar.gz
Algorithm Hash digest
SHA256 725dda3d615953806e99b6f666f33fd3fd9d410afeca9674e8675c233a9b71f7
MD5 787b7b020da44c6b7b4a896bcf4d999e
BLAKE2b-256 9e73ed8ac8802a42fd8c7d6896ef944082c06adf757266b833eb1e2bf9f2daf2

See more details on using hashes here.

File details

Details for the file fds_sdk_factsetprivateequityandventurecapital-1.0.0-py3-none-any.whl.

File metadata

File hashes

Hashes for fds_sdk_factsetprivateequityandventurecapital-1.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 2c1c31a6c48139bb6638623f28d0c35f168e796813bb9b0fc1c2b07bba363280
MD5 add6980927873cfc8bb68e413372671c
BLAKE2b-256 272b2e0eccce2bd8038372abeeb98516c0cfcdb35e8117433037ba39b270f300

See more details on using hashes here.

Supported by

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