Skip to main content

FactSet

FactSet Ownership client library for Python

API Version PyPi Apache-2 license

FactSet's Fund Ownership API gives access to both Holdings, Holders, Transactions, Short Interest, and Company Reports data.

Factset's Holdings endpoints gives access to all the underlying securities and their position details held within a given fund. Fund Types supported include Open-End Mutual Funds, Closed-end Mutual Funds, and Exchange Traded Funds. Security Holders information retrieves all "holder types" and their positions across institutions, funds, insiders, and stakeholders. FactSet also provides extensive insider and institutional transactions data for multiple countries including the United States, China, and Canada.

The FactSet Ownership and Mutual Funds database collects global equity ownership data for approximately 50,000 institutions, 60,000 unique Mutual Fund portfolios, and 400,000 Insider/Stakeholders from around 110 countries. For more details review our Data Collection methodology.

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

  • API version: 1.4.0
  • SDK version: 3.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.FactSetOwnership==3.0.0

pip

pip install fds.sdk.utils fds.sdk.FactSetOwnership==3.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.FactSetOwnership
from fds.sdk.FactSetOwnership.api import batch_processing_api
from fds.sdk.FactSetOwnership.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.FactSetOwnership.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.FactSetOwnership.Configuration(
#     username='USERNAME-SERIAL',
#     password='API-KEY'
# )

# Enter a context with an instance of the API client
with fds.sdk.FactSetOwnership.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = batch_processing_api.BatchProcessingApi(api_client)
    id = "id_example" # str | The Batch Request identifier. This value is returned in the response to a request with `batch=Y`, and is used to check the status and retrieve the results of the request.

    try:
        # Returns the response for the Batch Request
        # example passing only required values which don't have defaults set
        api_response_wrapper = api_instance.get_batch_data(id)

        # This endpoint returns a response wrapper that contains different types of responses depending on the query.
        # To access the correct response type, you need to perform one additional step, as shown below.
        if api_response_wrapper.get_status_code() == 200:
            api_response = api_response_wrapper.get_response_200()
        if api_response_wrapper.get_status_code() == 202:
            api_response = api_response_wrapper.get_response_202()

        pprint(api_response)
    except fds.sdk.FactSetOwnership.ApiException as e:
        print("Exception when calling BatchProcessingApi->get_batch_data: %s\n" % e)

    # # Get response, http status code and response headers
    # try:
    #     # Returns the response for the Batch Request
    #     api_response_wrapper, http_status_code, response_headers = api_instance.get_batch_data_with_http_info(id)

    #     # This endpoint returns a response wrapper that contains different types of responses depending on the query.
    #     # To access the correct response type, you need to perform one additional step, as shown below.
    #     if api_response_wrapper.get_status_code() == 200:
    #         api_response = api_response_wrapper.get_response_200()
    #     if api_response_wrapper.get_status_code() == 202:
    #         api_response = api_response_wrapper.get_response_202()

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

    # # Get response asynchronous
    # try:
    #     # Returns the response for the Batch Request
    #     async_result = api_instance.get_batch_data_async(id)
    #     api_response_wrapper = async_result.get()

    #     # This endpoint returns a response wrapper that contains different types of responses depending on the query.
    #     # To access the correct response type, you need to perform one additional step, as shown below.
    #     if api_response_wrapper.get_status_code() == 200:
    #         api_response = api_response_wrapper.get_response_200()
    #     if api_response_wrapper.get_status_code() == 202:
    #         api_response = api_response_wrapper.get_response_202()

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

    # # Get response, http status code and response headers asynchronous
    # try:
    #     # Returns the response for the Batch Request
    #     async_result = api_instance.get_batch_data_with_http_info_async(id)
    #     api_response_wrapper, http_status_code, response_headers = async_result.get()

    #     # This endpoint returns a response wrapper that contains different types of responses depending on the query.
    #     # To access the correct response type, you need to perform one additional step, as shown below.
    #     if api_response_wrapper.get_status_code() == 200:
    #         api_response = api_response_wrapper.get_response_200()
    #     if api_response_wrapper.get_status_code() == 202:
    #         api_response = api_response_wrapper.get_response_202()

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

logging.basicConfig(level=logging.DEBUG)

configuration = fds.sdk.FactSetOwnership.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.FactSetOwnership

configuration = fds.sdk.FactSetOwnership.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.FactSetOwnership

configuration = fds.sdk.FactSetOwnership.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.FactSetOwnership

configuration = fds.sdk.FactSetOwnership.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-ownership/v1

Class Method HTTP request Description
BatchProcessingApi get_batch_data GET /batch-result Returns the response for the Batch Request
BatchProcessingApi get_batch_status GET /batch-status Returns the latest status and metadata for the Batch Request.
CompanyReportsApi get_ownership_company_reports_summary GET /company-reports/summary Get current only ownership summary data for a list of requested identifiers.
CompanyReportsApi post_ownership_company_reports_summary POST /company-reports/summary Get current only ownership summary data for a list of requested identifiers.
FundHoldingsApi get_ownership_holdings GET /fund-holdings Get underlying holdings information for a requested fund identifer.
FundHoldingsApi post_ownership_holdings POST /fund-holdings Get holdings for a list of funds.
SecurityHoldersApi get_security_holders GET /security-holders Get security ownership data for requested security identifers.
SecurityHoldersApi post_security_holders POST /security-holders Get security ownership data for a list of requested securities.
ShortInterestApi get_short_interest GET /short-interest Gets short interest data for a requested identifier.
ShortInterestApi post_short_interest POST /short-interest Gets short interest data for a requested identifier.
TransactionsApi get_ownership_insider_transactions GET /transactions/insider Get insider transactions details for a list of requested identifiers.
TransactionsApi get_ownership_institutional_transactions GET /transactions/institutional Get institutional transaction details for a list of requested identifiers.
TransactionsApi post_ownership_insider_transactions POST /transactions/insider Get insider transactions details for a list of requested identifiers.
TransactionsApi post_ownership_institutional_transactions POST /transactions/institutional Gets institutional transaction details for a list of requested identifiers.

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

Metadata

Release files for fds.sdk.FactSetOwnership 3.0.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for fds.sdk.FactSetOwnership 3.0.0
File Size Uploaded
fds_sdk_factsetownership-3.0.0.tar.gz 95.4 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for fds.sdk.FactSetOwnership 3.0.0
File Interpreter ABI Platform
fds_sdk_factsetownership-3.0.0-py3-none-any.whl Python 3 none any Details

Total release size: 318.7 kB

Release files / fds_sdk_factsetownership-3.0.0.tar.gz

Download URL fds_sdk_factsetownership-3.0.0.tar.gz
Size 95.4 kB
Tags Source
SHA-256 checksum
How to use checksums
7ee8d362031ce2ac129694177b0bb160b6eff6cbc3fa7f8f383bd739de0e504a
BLAKE2b-256 checksum
How to use checksums
5e6325650fd70df6522110e32e364174a94622d43c7f7512343e37b31211e22b
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.14.7

Release files / fds_sdk_factsetownership-3.0.0-py3-none-any.whl

Download URL fds_sdk_factsetownership-3.0.0-py3-none-any.whl
Size 223.3 kB
Tags Python 3
SHA-256 checksum
How to use checksums
1379d346ad5051aa4ec4604f45bccc447dd93f5d58152e54d76b5addf6514134
BLAKE2b-256 checksum
How to use checksums
f3d62b9b35cf2f34caf88331bec138dbe4a84445829df2b1bd45b45945b9734c
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.14.7

Release history Release notifications | RSS feed

This release

3.0.0 This release

2 release files

2.0.0

2 release files

1.4.0

2 release files

1.3.0

2 release files

1.2.0

2 release files

1.1.0

2 release files

1.0.15

2 release files

1.0.14

2 release files

1.0.12

1 release file

1.0.11

1 release file

1.0.10

1 release file

1.0.9

1 release file

1.0.8

1 release file

1.0.7

1 release file

1.0.6

1 release file

1.0.5

1 release file

1.0.4

1 release file

1.0.3

1 release file

1.0.2

1 release file

1.0.1

1 release file

1.0.0

1 release file

0.21.0

1 release file

0.20.0

1 release file

0.9.1

1 release file

0.9.0

1 release file

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page