fds.sdk.FactSetFunds

Name	fds.sdk.FactSetFunds JSON
Version	1.1.2 JSON
	download
home_page	https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetFunds/v1
Summary	FactSet Funds client library for Python
upload_time	2024-05-02 12:42:33
maintainer	None
docs_url	None
author	FactSet Research Systems
requires_python	>=3.7
license	Apache License, Version 2.0
keywords	factset api sdk
VCS
bugtrack_url
requirements	No requirements were recorded.
Travis-CI	No Travis.
coveralls test coverage	No coveralls.

            [![FactSet](https://raw.githubusercontent.com/factset/enterprise-sdk/main/docs/images/factset-logo.svg)](https://www.factset.com)

# FactSet Funds client library for Python

[![API Version](https://img.shields.io/badge/api-v1.0.1-blue)]()
[![PyPi](https://img.shields.io/pypi/v/fds.sdk.FactSetFunds)](https://pypi.org/project/fds.sdk.FactSetFunds/)
[![Apache-2 license](https://img.shields.io/badge/license-Apache2-brightgreen.svg)](https://www.apache.org/licenses/LICENSE-2.0)

FactSet Mutual Funds data offers over 50 fund- and share class-specific data points for mutual funds listed in the United States. <p>FactSet Mutual Funds Reference provides fund-specific reference information as well as FactSet's proprietary classification system. It includes but is not limited to the following coverage 
  * Fund descriptions 
  * A seven-tier classification system
  * Leverage information
  * Fees and expenses 
  * Portfolio managers 
  
  FactSet Mutual Funds Time Series provides quantitative data items on a historical basis. It includes but is not limited to the following coverage 
  * Net asset value
  * Fund flows 
  * Assets under management
  * Total return 


This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:

- API version: 1.0.1
- SDK version: 1.1.2
- Build package: org.openapitools.codegen.languages.PythonClientCodegen

## Requirements

* Python >= 3.7

## Installation

### Poetry

```shell
poetry add fds.sdk.utils fds.sdk.FactSetFunds==1.1.2
```

### pip

```shell
pip install fds.sdk.utils fds.sdk.FactSetFunds==1.1.2
```

## Usage

1. [Generate authentication credentials](../../../../README.md#authentication).
2. Setup Python environment.
   1. Install and activate python 3.7+. If you're using [pyenv](https://github.com/pyenv/pyenv):

      ```sh
      pyenv install 3.9.7
      pyenv shell 3.9.7
      ```

   2. (optional) [Install poetry](https://python-poetry.org/docs/#installation).
3. [Install dependencies](#installation).
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

```python
from fds.sdk.utils.authentication import ConfidentialClient

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

# Enter a context with an instance of the API client
with fds.sdk.FactSetFunds.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = fund_flows__aum_api.FundFlowsAUMApi(api_client)
    ids = ["MABAX-US"] # [str] | The requested fund identifier. FactSet Identifiers, tickers, CUSIP, SEDOL, and ISIN are accepted inputs. <p>***ids limit** =  1000 per request*</p> *<p>Make note, GET Method URL request lines are also limited to a total length of 8192 bytes (8KB). In cases where the service allows for thousands of ids, which may lead to exceeding this request line limit of 8KB, its advised for any requests with large request lines to be requested through the respective \"POST\" method.</p>* 
    start_date = "2018-12-31" # str | The start date requested for a given date range in **YYYY-MM-DD** format. If left blank, the API will default to latest available completed period.  (optional)
    end_date = "2019-12-31" # str | The end date requested for a given date range in **YYYY-MM-DD** format. If left blank, the API will default to latest available completed period.  (optional)
    frequency = "M" # str | Controls the display frequency of the data returned.   * **MTD** = Month-To-Date   * **M** = Monthly, based on the last trading day of the month.   * **CQTD** = Calendar Quarter-to-Date   * **CQ** = Calendar Quarterly   * **CYTD** = Calendar Year-to-Date   * **CY** = Calendar Yearly  (optional) if omitted the server will use the default value of "M"
    currency = "USD" # str | Controls the Currency conversion of the Fund. By default, the currency will use the funds local currency. (optional) if omitted the server will use the default value of "LOCAL"
    data_type = "ROLL" # str | The Data Type of the NAV expressed as Raw or Rolled values. (optional) if omitted the server will use the default value of "ROLL"

    try:
        # Get Fund AUM for a requested date range and list of ids
        # example passing only required values which don't have defaults set
        # and optional values
        api_response = api_instance.get_funds_aum(ids, start_date=start_date, end_date=end_date, frequency=frequency, currency=currency, data_type=data_type)

        pprint(api_response)
    except fds.sdk.FactSetFunds.ApiException as e:
        print("Exception when calling FundFlowsAUMApi->get_funds_aum: %s\n" % e)

    # # Get response, http status code and response headers
    # try:
    #     # Get Fund AUM for a requested date range and list of ids
    #     api_response, http_status_code, response_headers = api_instance.get_funds_aum_with_http_info(ids, start_date=start_date, end_date=end_date, frequency=frequency, currency=currency, data_type=data_type)


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

    # # Get response asynchronous
    # try:
    #     # Get Fund AUM for a requested date range and list of ids
    #     async_result = api_instance.get_funds_aum_async(ids, start_date=start_date, end_date=end_date, frequency=frequency, currency=currency, data_type=data_type)
    #     api_response = async_result.get()


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

    # # Get response, http status code and response headers asynchronous
    # try:
    #     # Get Fund AUM for a requested date range and list of ids
    #     async_result = api_instance.get_funds_aum_with_http_info_async(ids, start_date=start_date, end_date=end_date, frequency=frequency, currency=currency, data_type=data_type)
    #     api_response, http_status_code, response_headers = async_result.get()


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

```

### Using Pandas

To convert an API response to a Pandas DataFrame, it is necessary to transform it first to a dictionary.
```python
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`](https://docs.python.org/3/library/logging.html#module-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](https://docs.python.org/3/library/http.client.html).

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

```python
import logging
import fds.sdk.FactSetFunds

logging.basicConfig(level=logging.DEBUG)

configuration = fds.sdk.FactSetFunds.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`).

```python
import fds.sdk.FactSetFunds

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

```python
import fds.sdk.FactSetFunds

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

```python
from urllib3 import Retry
import fds.sdk.FactSetFunds

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

Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*FundFlowsAUMApi* | [**get_funds_aum**](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetFunds/v1/docs/FundFlowsAUMApi.md#get_funds_aum) | **GET** /factset-funds/v1/aum | Get Fund AUM for a requested date range and list of ids
*FundFlowsAUMApi* | [**get_funds_aum_for_list**](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetFunds/v1/docs/FundFlowsAUMApi.md#get_funds_aum_for_list) | **POST** /factset-funds/v1/aum | Get Fund AUM for a requested date range and large list of ids
*FundFlowsAUMApi* | [**get_funds_flows**](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetFunds/v1/docs/FundFlowsAUMApi.md#get_funds_flows) | **GET** /factset-funds/v1/flows | Get Fund Flows for a requested date range and list of ids
*FundFlowsAUMApi* | [**get_funds_flows_for_list**](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetFunds/v1/docs/FundFlowsAUMApi.md#get_funds_flows_for_list) | **POST** /factset-funds/v1/flows | Get Fund Flows for a requested date range and large list of ids
*HelperApi* | [**get_statuses**](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetFunds/v1/docs/HelperApi.md#get_statuses) | **GET** /factset-funds/v1/status | Get Fund&#39;s current status and database availability
*HelperApi* | [**get_statuses_for_list**](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetFunds/v1/docs/HelperApi.md#get_statuses_for_list) | **POST** /factset-funds/v1/status | Get Fund&#39;s current status and database availability for large list of ids.
*PricesReturnsApi* | [**get_funds_prices**](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetFunds/v1/docs/PricesReturnsApi.md#get_funds_prices) | **GET** /factset-funds/v1/prices | Get Fund Prices (NAV) for a requested time-series
*PricesReturnsApi* | [**get_funds_prices_for_list**](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetFunds/v1/docs/PricesReturnsApi.md#get_funds_prices_for_list) | **POST** /factset-funds/v1/prices | Get Fund Prices (NAV) for a requested date range and large list of ids.
*PricesReturnsApi* | [**get_funds_returns**](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetFunds/v1/docs/PricesReturnsApi.md#get_funds_returns) | **GET** /factset-funds/v1/returns | Get Fund Returns for a requested time-series
*PricesReturnsApi* | [**get_funds_returns_for_list**](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetFunds/v1/docs/PricesReturnsApi.md#get_funds_returns_for_list) | **POST** /factset-funds/v1/returns | Get Fund Returns for a requested time-series and large list of ids
*PricesReturnsApi* | [**get_funds_returns_range**](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetFunds/v1/docs/PricesReturnsApi.md#get_funds_returns_range) | **GET** /factset-funds/v1/returns-range | Get Fund Returns for a user-defined date range
*PricesReturnsApi* | [**get_funds_returns_range_for_list**](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetFunds/v1/docs/PricesReturnsApi.md#get_funds_returns_range_for_list) | **POST** /factset-funds/v1/returns-range | Get Fund Returns over pre-defined time horizons as of a specific date for large list of ids.
*PricesReturnsApi* | [**get_funds_returns_snapshot**](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetFunds/v1/docs/PricesReturnsApi.md#get_funds_returns_snapshot) | **GET** /factset-funds/v1/returns-snapshot | Get Fund Returns over pre-defined time horizons as of a specific date.
*PricesReturnsApi* | [**get_funds_returns_snapshot_for_list**](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetFunds/v1/docs/PricesReturnsApi.md#get_funds_returns_snapshot_for_list) | **POST** /factset-funds/v1/returns-snapshot | Get Fund Returns over pre-defined time horizons as of a specific date.
*ReferenceApi* | [**get_funds_benchmark_details**](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetFunds/v1/docs/ReferenceApi.md#get_funds_benchmark_details) | **GET** /factset-funds/v1/benchmark-details | Get the Fund&#39;s Primary and Segment Benchmark Details
*ReferenceApi* | [**get_funds_benchmark_details_for_list**](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetFunds/v1/docs/ReferenceApi.md#get_funds_benchmark_details_for_list) | **POST** /factset-funds/v1/benchmark-details | Get the Fund&#39;s Primary and Segment Benchmark details for large list of ids.
*ReferenceApi* | [**get_funds_classifications**](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetFunds/v1/docs/ReferenceApi.md#get_funds_classifications) | **GET** /factset-funds/v1/classifications | Get basic Fund Classifications
*ReferenceApi* | [**get_funds_classifications_for_list**](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetFunds/v1/docs/ReferenceApi.md#get_funds_classifications_for_list) | **POST** /factset-funds/v1/classifications | Get basic Fund Classifications for a large list of ids.
*ReferenceApi* | [**get_funds_costs_fees**](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetFunds/v1/docs/ReferenceApi.md#get_funds_costs_fees) | **GET** /factset-funds/v1/costs-fees | Get the Fund&#39;s Costs, Investment minimums and Risk, and Fees.
*ReferenceApi* | [**get_funds_costs_fees_for_list**](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetFunds/v1/docs/ReferenceApi.md#get_funds_costs_fees_for_list) | **POST** /factset-funds/v1/costs-fees | Get the Fund&#39;s Costs, Investment minimums and Risk, and Fees for large list of ids.
*ReferenceApi* | [**get_funds_managers**](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetFunds/v1/docs/ReferenceApi.md#get_funds_managers) | **GET** /factset-funds/v1/managers | Get a list of Fund Managers and related details for a list of ids.
*ReferenceApi* | [**get_funds_managers_for_list**](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetFunds/v1/docs/ReferenceApi.md#get_funds_managers_for_list) | **POST** /factset-funds/v1/managers | Get a list of Fund Managers and related details for a large list of ids.
*ReferenceApi* | [**get_funds_summary**](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetFunds/v1/docs/ReferenceApi.md#get_funds_summary) | **GET** /factset-funds/v1/summary | Get basic reference summary data for a Fund.
*ReferenceApi* | [**get_funds_summary_for_list**](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetFunds/v1/docs/ReferenceApi.md#get_funds_summary_for_list) | **POST** /factset-funds/v1/summary | Get basic reference data for a large list of Fund ids.
*ReferenceApi* | [**get_related_funds**](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetFunds/v1/docs/ReferenceApi.md#get_related_funds) | **GET** /factset-funds/v1/related-funds | Get a list of Related Funds for a list of Fund ids.
*ReferenceApi* | [**get_related_funds_for_list**](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetFunds/v1/docs/ReferenceApi.md#get_related_funds_for_list) | **POST** /factset-funds/v1/related-funds | Get a list of Related Funds for a large list of Fund ids.


## Documentation For Models

 - [Aum](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetFunds/v1/docs/Aum.md)
 - [AumRequest](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetFunds/v1/docs/AumRequest.md)
 - [AumResponse](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetFunds/v1/docs/AumResponse.md)
 - [BenchmarkDetails](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetFunds/v1/docs/BenchmarkDetails.md)
 - [BenchmarkDetailsRequest](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetFunds/v1/docs/BenchmarkDetailsRequest.md)
 - [BenchmarkDetailsResponse](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetFunds/v1/docs/BenchmarkDetailsResponse.md)
 - [Classifications](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetFunds/v1/docs/Classifications.md)
 - [ClassificationsRequest](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetFunds/v1/docs/ClassificationsRequest.md)
 - [ClassificationsResponse](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetFunds/v1/docs/ClassificationsResponse.md)
 - [CostsFees](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetFunds/v1/docs/CostsFees.md)
 - [CostsFeesIds](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetFunds/v1/docs/CostsFeesIds.md)
 - [CostsFeesRequest](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetFunds/v1/docs/CostsFeesRequest.md)
 - [CostsFeesResponse](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetFunds/v1/docs/CostsFeesResponse.md)
 - [DataType](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetFunds/v1/docs/DataType.md)
 - [DividendAdjust](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetFunds/v1/docs/DividendAdjust.md)
 - [ErrorResponse](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetFunds/v1/docs/ErrorResponse.md)
 - [ErrorResponseSubErrors](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetFunds/v1/docs/ErrorResponseSubErrors.md)
 - [Flows](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetFunds/v1/docs/Flows.md)
 - [FlowsRequest](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetFunds/v1/docs/FlowsRequest.md)
 - [FlowsResponse](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetFunds/v1/docs/FlowsResponse.md)
 - [Frequency](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetFunds/v1/docs/Frequency.md)
 - [FrequencyAum](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetFunds/v1/docs/FrequencyAum.md)
 - [FundsPricesRequest](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetFunds/v1/docs/FundsPricesRequest.md)
 - [FundsPricesResponse](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetFunds/v1/docs/FundsPricesResponse.md)
 - [FundsReturnsRequest](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetFunds/v1/docs/FundsReturnsRequest.md)
 - [FundsReturnsResponse](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetFunds/v1/docs/FundsReturnsResponse.md)
 - [FundsReturnsSnapshotRequest](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetFunds/v1/docs/FundsReturnsSnapshotRequest.md)
 - [FundsReturnsSnapshotResponse](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetFunds/v1/docs/FundsReturnsSnapshotResponse.md)
 - [Ids](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetFunds/v1/docs/Ids.md)
 - [Managers](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetFunds/v1/docs/Managers.md)
 - [ManagersRequest](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetFunds/v1/docs/ManagersRequest.md)
 - [ManagersResponse](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetFunds/v1/docs/ManagersResponse.md)
 - [Prices](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetFunds/v1/docs/Prices.md)
 - [RelatedFunds](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetFunds/v1/docs/RelatedFunds.md)
 - [RelatedFundsRequest](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetFunds/v1/docs/RelatedFundsRequest.md)
 - [RelatedFundsResponse](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetFunds/v1/docs/RelatedFundsResponse.md)
 - [Returns](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetFunds/v1/docs/Returns.md)
 - [ReturnsRange](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetFunds/v1/docs/ReturnsRange.md)
 - [ReturnsRangeRequest](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetFunds/v1/docs/ReturnsRangeRequest.md)
 - [ReturnsRangeResponse](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetFunds/v1/docs/ReturnsRangeResponse.md)
 - [ReturnsSnapshot](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetFunds/v1/docs/ReturnsSnapshot.md)
 - [SplitAdjust](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetFunds/v1/docs/SplitAdjust.md)
 - [Statuses](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetFunds/v1/docs/Statuses.md)
 - [StatusesRequest](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetFunds/v1/docs/StatusesRequest.md)
 - [StatusesResponse](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetFunds/v1/docs/StatusesResponse.md)
 - [Summaries](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetFunds/v1/docs/Summaries.md)
 - [SummariesRequest](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetFunds/v1/docs/SummariesRequest.md)
 - [SummariesResponse](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetFunds/v1/docs/SummariesResponse.md)


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

## Contributing

Please refer to the [contributing guide](../../../../CONTRIBUTING.md).

## 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.




            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetFunds/v1",
    "name": "fds.sdk.FactSetFunds",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.7",
    "maintainer_email": null,
    "keywords": "FactSet, API, SDK",
    "author": "FactSet Research Systems",
    "author_email": null,
    "download_url": null,
    "platform": null,
    "description": "[![FactSet](https://raw.githubusercontent.com/factset/enterprise-sdk/main/docs/images/factset-logo.svg)](https://www.factset.com)\n\n# FactSet Funds client library for Python\n\n[![API Version](https://img.shields.io/badge/api-v1.0.1-blue)]()\n[![PyPi](https://img.shields.io/pypi/v/fds.sdk.FactSetFunds)](https://pypi.org/project/fds.sdk.FactSetFunds/)\n[![Apache-2 license](https://img.shields.io/badge/license-Apache2-brightgreen.svg)](https://www.apache.org/licenses/LICENSE-2.0)\n\nFactSet Mutual Funds data offers over 50 fund- and share class-specific data points for mutual funds listed in the United States. <p>FactSet Mutual Funds Reference provides fund-specific reference information as well as FactSet's proprietary classification system. It includes but is not limited to the following coverage \n  * Fund descriptions \n  * A seven-tier classification system\n  * Leverage information\n  * Fees and expenses \n  * Portfolio managers \n  \n  FactSet Mutual Funds Time Series provides quantitative data items on a historical basis. It includes but is not limited to the following coverage \n  * Net asset value\n  * Fund flows \n  * Assets under management\n  * Total return \n\n\nThis Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:\n\n- API version: 1.0.1\n- SDK version: 1.1.2\n- Build package: org.openapitools.codegen.languages.PythonClientCodegen\n\n## Requirements\n\n* Python >= 3.7\n\n## Installation\n\n### Poetry\n\n```shell\npoetry add fds.sdk.utils fds.sdk.FactSetFunds==1.1.2\n```\n\n### pip\n\n```shell\npip install fds.sdk.utils fds.sdk.FactSetFunds==1.1.2\n```\n\n## Usage\n\n1. [Generate authentication credentials](../../../../README.md#authentication).\n2. Setup Python environment.\n   1. Install and activate python 3.7+. If you're using [pyenv](https://github.com/pyenv/pyenv):\n\n      ```sh\n      pyenv install 3.9.7\n      pyenv shell 3.9.7\n      ```\n\n   2. (optional) [Install poetry](https://python-poetry.org/docs/#installation).\n3. [Install dependencies](#installation).\n4. Run the following:\n\n> [!IMPORTANT]\n> The parameter variables defined below are just examples and may potentially contain non valid values. Please replace them with valid values.\n\n### Example Code\n\n```python\nfrom fds.sdk.utils.authentication import ConfidentialClient\n\nimport fds.sdk.FactSetFunds\nfrom fds.sdk.FactSetFunds.api import fund_flows__aum_api\nfrom fds.sdk.FactSetFunds.models import *\nfrom dateutil.parser import parse as dateutil_parser\nfrom pprint import pprint\n\n# See configuration.py for a list of all supported configuration parameters.\n\n# Examples for each supported authentication method are below,\n# choose one that satisfies your use case.\n\n# (Preferred) OAuth 2.0: FactSetOAuth2\n# See https://github.com/FactSet/enterprise-sdk#oauth-20\n# for information on how to create the app-config.json file\n#\n# The confidential client instance should be reused in production environments.\n# See https://github.com/FactSet/enterprise-sdk-utils-python#authentication\n# for more information on using the ConfidentialClient class\nconfiguration = fds.sdk.FactSetFunds.Configuration(\n    fds_oauth_client=ConfidentialClient('/path/to/app-config.json')\n)\n\n# Basic authentication: FactSetApiKey\n# See https://github.com/FactSet/enterprise-sdk#api-key\n# for information how to create an API key\n# configuration = fds.sdk.FactSetFunds.Configuration(\n#     username='USERNAME-SERIAL',\n#     password='API-KEY'\n# )\n\n# Enter a context with an instance of the API client\nwith fds.sdk.FactSetFunds.ApiClient(configuration) as api_client:\n    # Create an instance of the API class\n    api_instance = fund_flows__aum_api.FundFlowsAUMApi(api_client)\n    ids = [\"MABAX-US\"] # [str] | The requested fund identifier. FactSet Identifiers, tickers, CUSIP, SEDOL, and ISIN are accepted inputs. <p>***ids limit** =  1000 per request*</p> *<p>Make note, GET Method URL request lines are also limited to a total length of 8192 bytes (8KB). In cases where the service allows for thousands of ids, which may lead to exceeding this request line limit of 8KB, its advised for any requests with large request lines to be requested through the respective \\\"POST\\\" method.</p>* \n    start_date = \"2018-12-31\" # str | The start date requested for a given date range in **YYYY-MM-DD** format. If left blank, the API will default to latest available completed period.  (optional)\n    end_date = \"2019-12-31\" # str | The end date requested for a given date range in **YYYY-MM-DD** format. If left blank, the API will default to latest available completed period.  (optional)\n    frequency = \"M\" # str | Controls the display frequency of the data returned.   * **MTD** = Month-To-Date   * **M** = Monthly, based on the last trading day of the month.   * **CQTD** = Calendar Quarter-to-Date   * **CQ** = Calendar Quarterly   * **CYTD** = Calendar Year-to-Date   * **CY** = Calendar Yearly  (optional) if omitted the server will use the default value of \"M\"\n    currency = \"USD\" # str | Controls the Currency conversion of the Fund. By default, the currency will use the funds local currency. (optional) if omitted the server will use the default value of \"LOCAL\"\n    data_type = \"ROLL\" # str | The Data Type of the NAV expressed as Raw or Rolled values. (optional) if omitted the server will use the default value of \"ROLL\"\n\n    try:\n        # Get Fund AUM for a requested date range and list of ids\n        # example passing only required values which don't have defaults set\n        # and optional values\n        api_response = api_instance.get_funds_aum(ids, start_date=start_date, end_date=end_date, frequency=frequency, currency=currency, data_type=data_type)\n\n        pprint(api_response)\n    except fds.sdk.FactSetFunds.ApiException as e:\n        print(\"Exception when calling FundFlowsAUMApi->get_funds_aum: %s\\n\" % e)\n\n    # # Get response, http status code and response headers\n    # try:\n    #     # Get Fund AUM for a requested date range and list of ids\n    #     api_response, http_status_code, response_headers = api_instance.get_funds_aum_with_http_info(ids, start_date=start_date, end_date=end_date, frequency=frequency, currency=currency, data_type=data_type)\n\n\n    #     pprint(api_response)\n    #     pprint(http_status_code)\n    #     pprint(response_headers)\n    # except fds.sdk.FactSetFunds.ApiException as e:\n    #     print(\"Exception when calling FundFlowsAUMApi->get_funds_aum: %s\\n\" % e)\n\n    # # Get response asynchronous\n    # try:\n    #     # Get Fund AUM for a requested date range and list of ids\n    #     async_result = api_instance.get_funds_aum_async(ids, start_date=start_date, end_date=end_date, frequency=frequency, currency=currency, data_type=data_type)\n    #     api_response = async_result.get()\n\n\n    #     pprint(api_response)\n    # except fds.sdk.FactSetFunds.ApiException as e:\n    #     print(\"Exception when calling FundFlowsAUMApi->get_funds_aum: %s\\n\" % e)\n\n    # # Get response, http status code and response headers asynchronous\n    # try:\n    #     # Get Fund AUM for a requested date range and list of ids\n    #     async_result = api_instance.get_funds_aum_with_http_info_async(ids, start_date=start_date, end_date=end_date, frequency=frequency, currency=currency, data_type=data_type)\n    #     api_response, http_status_code, response_headers = async_result.get()\n\n\n    #     pprint(api_response)\n    #     pprint(http_status_code)\n    #     pprint(response_headers)\n    # except fds.sdk.FactSetFunds.ApiException as e:\n    #     print(\"Exception when calling FundFlowsAUMApi->get_funds_aum: %s\\n\" % e)\n\n```\n\n### Using Pandas\n\nTo convert an API response to a Pandas DataFrame, it is necessary to transform it first to a dictionary.\n```python\nimport pandas as pd\n\nresponse_dict = api_response.to_dict()['data']\n\nsimple_json_response = pd.DataFrame(response_dict)\nnested_json_response = pd.json_normalize(response_dict)\n```\n\n### Debugging\n\nThe SDK uses the standard library [`logging`](https://docs.python.org/3/library/logging.html#module-logging) module.\n\nSetting `debug` to `True` on an instance of the `Configuration` class sets the log-level of related packages to `DEBUG`\nand enables additional logging in Pythons [HTTP Client](https://docs.python.org/3/library/http.client.html).\n\n**Note**: This prints out sensitive information (e.g. the full request and response). Use with care.\n\n```python\nimport logging\nimport fds.sdk.FactSetFunds\n\nlogging.basicConfig(level=logging.DEBUG)\n\nconfiguration = fds.sdk.FactSetFunds.Configuration(...)\nconfiguration.debug = True\n```\n\n### Configure a Proxy\n\nYou can pass proxy settings to the Configuration class:\n\n* `proxy`: The URL of the proxy to use.\n* `proxy_headers`: a dictionary to pass additional headers to the proxy (e.g. `Proxy-Authorization`).\n\n```python\nimport fds.sdk.FactSetFunds\n\nconfiguration = fds.sdk.FactSetFunds.Configuration(\n    # ...\n    proxy=\"http://secret:password@localhost:5050\",\n    proxy_headers={\n        \"Custom-Proxy-Header\": \"Custom-Proxy-Header-Value\"\n    }\n)\n```\n\n### Custom SSL Certificate\n\nTLS/SSL certificate verification can be configured with the following Configuration parameters:\n\n* `ssl_ca_cert`: a path to the certificate to use for verification in `PEM` format.\n* `verify_ssl`: setting this to `False` disables the verification of certificates.\n  Disabling the verification is not recommended, but it might be useful during\n  local development or testing.\n\n```python\nimport fds.sdk.FactSetFunds\n\nconfiguration = fds.sdk.FactSetFunds.Configuration(\n    # ...\n    ssl_ca_cert='/path/to/ca.pem'\n)\n```\n\n### Request Retries\n\nIn case the request retry behaviour should be customized, it is possible to pass a `urllib3.Retry` object to the `retry` property of the Configuration.\n\n```python\nfrom urllib3 import Retry\nimport fds.sdk.FactSetFunds\n\nconfiguration = fds.sdk.FactSetFunds.Configuration(\n    # ...\n)\n\nconfiguration.retries = Retry(total=3, status_forcelist=[500, 502, 503, 504])\n```\n\n\n## Documentation for API Endpoints\n\nAll URIs are relative to *https://api.factset.com/content*\n\nClass | Method | HTTP request | Description\n------------ | ------------- | ------------- | -------------\n*FundFlowsAUMApi* | [**get_funds_aum**](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetFunds/v1/docs/FundFlowsAUMApi.md#get_funds_aum) | **GET** /factset-funds/v1/aum | Get Fund AUM for a requested date range and list of ids\n*FundFlowsAUMApi* | [**get_funds_aum_for_list**](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetFunds/v1/docs/FundFlowsAUMApi.md#get_funds_aum_for_list) | **POST** /factset-funds/v1/aum | Get Fund AUM for a requested date range and large list of ids\n*FundFlowsAUMApi* | [**get_funds_flows**](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetFunds/v1/docs/FundFlowsAUMApi.md#get_funds_flows) | **GET** /factset-funds/v1/flows | Get Fund Flows for a requested date range and list of ids\n*FundFlowsAUMApi* | [**get_funds_flows_for_list**](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetFunds/v1/docs/FundFlowsAUMApi.md#get_funds_flows_for_list) | **POST** /factset-funds/v1/flows | Get Fund Flows for a requested date range and large list of ids\n*HelperApi* | [**get_statuses**](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetFunds/v1/docs/HelperApi.md#get_statuses) | **GET** /factset-funds/v1/status | Get Fund&#39;s current status and database availability\n*HelperApi* | [**get_statuses_for_list**](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetFunds/v1/docs/HelperApi.md#get_statuses_for_list) | **POST** /factset-funds/v1/status | Get Fund&#39;s current status and database availability for large list of ids.\n*PricesReturnsApi* | [**get_funds_prices**](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetFunds/v1/docs/PricesReturnsApi.md#get_funds_prices) | **GET** /factset-funds/v1/prices | Get Fund Prices (NAV) for a requested time-series\n*PricesReturnsApi* | [**get_funds_prices_for_list**](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetFunds/v1/docs/PricesReturnsApi.md#get_funds_prices_for_list) | **POST** /factset-funds/v1/prices | Get Fund Prices (NAV) for a requested date range and large list of ids.\n*PricesReturnsApi* | [**get_funds_returns**](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetFunds/v1/docs/PricesReturnsApi.md#get_funds_returns) | **GET** /factset-funds/v1/returns | Get Fund Returns for a requested time-series\n*PricesReturnsApi* | [**get_funds_returns_for_list**](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetFunds/v1/docs/PricesReturnsApi.md#get_funds_returns_for_list) | **POST** /factset-funds/v1/returns | Get Fund Returns for a requested time-series and large list of ids\n*PricesReturnsApi* | [**get_funds_returns_range**](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetFunds/v1/docs/PricesReturnsApi.md#get_funds_returns_range) | **GET** /factset-funds/v1/returns-range | Get Fund Returns for a user-defined date range\n*PricesReturnsApi* | [**get_funds_returns_range_for_list**](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetFunds/v1/docs/PricesReturnsApi.md#get_funds_returns_range_for_list) | **POST** /factset-funds/v1/returns-range | Get Fund Returns over pre-defined time horizons as of a specific date for large list of ids.\n*PricesReturnsApi* | [**get_funds_returns_snapshot**](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetFunds/v1/docs/PricesReturnsApi.md#get_funds_returns_snapshot) | **GET** /factset-funds/v1/returns-snapshot | Get Fund Returns over pre-defined time horizons as of a specific date.\n*PricesReturnsApi* | [**get_funds_returns_snapshot_for_list**](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetFunds/v1/docs/PricesReturnsApi.md#get_funds_returns_snapshot_for_list) | **POST** /factset-funds/v1/returns-snapshot | Get Fund Returns over pre-defined time horizons as of a specific date.\n*ReferenceApi* | [**get_funds_benchmark_details**](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetFunds/v1/docs/ReferenceApi.md#get_funds_benchmark_details) | **GET** /factset-funds/v1/benchmark-details | Get the Fund&#39;s Primary and Segment Benchmark Details\n*ReferenceApi* | [**get_funds_benchmark_details_for_list**](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetFunds/v1/docs/ReferenceApi.md#get_funds_benchmark_details_for_list) | **POST** /factset-funds/v1/benchmark-details | Get the Fund&#39;s Primary and Segment Benchmark details for large list of ids.\n*ReferenceApi* | [**get_funds_classifications**](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetFunds/v1/docs/ReferenceApi.md#get_funds_classifications) | **GET** /factset-funds/v1/classifications | Get basic Fund Classifications\n*ReferenceApi* | [**get_funds_classifications_for_list**](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetFunds/v1/docs/ReferenceApi.md#get_funds_classifications_for_list) | **POST** /factset-funds/v1/classifications | Get basic Fund Classifications for a large list of ids.\n*ReferenceApi* | [**get_funds_costs_fees**](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetFunds/v1/docs/ReferenceApi.md#get_funds_costs_fees) | **GET** /factset-funds/v1/costs-fees | Get the Fund&#39;s Costs, Investment minimums and Risk, and Fees.\n*ReferenceApi* | [**get_funds_costs_fees_for_list**](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetFunds/v1/docs/ReferenceApi.md#get_funds_costs_fees_for_list) | **POST** /factset-funds/v1/costs-fees | Get the Fund&#39;s Costs, Investment minimums and Risk, and Fees for large list of ids.\n*ReferenceApi* | [**get_funds_managers**](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetFunds/v1/docs/ReferenceApi.md#get_funds_managers) | **GET** /factset-funds/v1/managers | Get a list of Fund Managers and related details for a list of ids.\n*ReferenceApi* | [**get_funds_managers_for_list**](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetFunds/v1/docs/ReferenceApi.md#get_funds_managers_for_list) | **POST** /factset-funds/v1/managers | Get a list of Fund Managers and related details for a large list of ids.\n*ReferenceApi* | [**get_funds_summary**](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetFunds/v1/docs/ReferenceApi.md#get_funds_summary) | **GET** /factset-funds/v1/summary | Get basic reference summary data for a Fund.\n*ReferenceApi* | [**get_funds_summary_for_list**](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetFunds/v1/docs/ReferenceApi.md#get_funds_summary_for_list) | **POST** /factset-funds/v1/summary | Get basic reference data for a large list of Fund ids.\n*ReferenceApi* | [**get_related_funds**](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetFunds/v1/docs/ReferenceApi.md#get_related_funds) | **GET** /factset-funds/v1/related-funds | Get a list of Related Funds for a list of Fund ids.\n*ReferenceApi* | [**get_related_funds_for_list**](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetFunds/v1/docs/ReferenceApi.md#get_related_funds_for_list) | **POST** /factset-funds/v1/related-funds | Get a list of Related Funds for a large list of Fund ids.\n\n\n## Documentation For Models\n\n - [Aum](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetFunds/v1/docs/Aum.md)\n - [AumRequest](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetFunds/v1/docs/AumRequest.md)\n - [AumResponse](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetFunds/v1/docs/AumResponse.md)\n - [BenchmarkDetails](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetFunds/v1/docs/BenchmarkDetails.md)\n - [BenchmarkDetailsRequest](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetFunds/v1/docs/BenchmarkDetailsRequest.md)\n - [BenchmarkDetailsResponse](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetFunds/v1/docs/BenchmarkDetailsResponse.md)\n - [Classifications](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetFunds/v1/docs/Classifications.md)\n - [ClassificationsRequest](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetFunds/v1/docs/ClassificationsRequest.md)\n - [ClassificationsResponse](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetFunds/v1/docs/ClassificationsResponse.md)\n - [CostsFees](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetFunds/v1/docs/CostsFees.md)\n - [CostsFeesIds](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetFunds/v1/docs/CostsFeesIds.md)\n - [CostsFeesRequest](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetFunds/v1/docs/CostsFeesRequest.md)\n - [CostsFeesResponse](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetFunds/v1/docs/CostsFeesResponse.md)\n - [DataType](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetFunds/v1/docs/DataType.md)\n - [DividendAdjust](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetFunds/v1/docs/DividendAdjust.md)\n - [ErrorResponse](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetFunds/v1/docs/ErrorResponse.md)\n - [ErrorResponseSubErrors](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetFunds/v1/docs/ErrorResponseSubErrors.md)\n - [Flows](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetFunds/v1/docs/Flows.md)\n - [FlowsRequest](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetFunds/v1/docs/FlowsRequest.md)\n - [FlowsResponse](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetFunds/v1/docs/FlowsResponse.md)\n - [Frequency](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetFunds/v1/docs/Frequency.md)\n - [FrequencyAum](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetFunds/v1/docs/FrequencyAum.md)\n - [FundsPricesRequest](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetFunds/v1/docs/FundsPricesRequest.md)\n - [FundsPricesResponse](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetFunds/v1/docs/FundsPricesResponse.md)\n - [FundsReturnsRequest](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetFunds/v1/docs/FundsReturnsRequest.md)\n - [FundsReturnsResponse](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetFunds/v1/docs/FundsReturnsResponse.md)\n - [FundsReturnsSnapshotRequest](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetFunds/v1/docs/FundsReturnsSnapshotRequest.md)\n - [FundsReturnsSnapshotResponse](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetFunds/v1/docs/FundsReturnsSnapshotResponse.md)\n - [Ids](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetFunds/v1/docs/Ids.md)\n - [Managers](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetFunds/v1/docs/Managers.md)\n - [ManagersRequest](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetFunds/v1/docs/ManagersRequest.md)\n - [ManagersResponse](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetFunds/v1/docs/ManagersResponse.md)\n - [Prices](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetFunds/v1/docs/Prices.md)\n - [RelatedFunds](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetFunds/v1/docs/RelatedFunds.md)\n - [RelatedFundsRequest](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetFunds/v1/docs/RelatedFundsRequest.md)\n - [RelatedFundsResponse](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetFunds/v1/docs/RelatedFundsResponse.md)\n - [Returns](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetFunds/v1/docs/Returns.md)\n - [ReturnsRange](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetFunds/v1/docs/ReturnsRange.md)\n - [ReturnsRangeRequest](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetFunds/v1/docs/ReturnsRangeRequest.md)\n - [ReturnsRangeResponse](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetFunds/v1/docs/ReturnsRangeResponse.md)\n - [ReturnsSnapshot](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetFunds/v1/docs/ReturnsSnapshot.md)\n - [SplitAdjust](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetFunds/v1/docs/SplitAdjust.md)\n - [Statuses](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetFunds/v1/docs/Statuses.md)\n - [StatusesRequest](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetFunds/v1/docs/StatusesRequest.md)\n - [StatusesResponse](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetFunds/v1/docs/StatusesResponse.md)\n - [Summaries](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetFunds/v1/docs/Summaries.md)\n - [SummariesRequest](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetFunds/v1/docs/SummariesRequest.md)\n - [SummariesResponse](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetFunds/v1/docs/SummariesResponse.md)\n\n\n## Documentation For Authorization\n\n\n## FactSetApiKey\n\n- **Type**: HTTP basic authentication\n\n\n## FactSetOAuth2\n\n- **Type**: OAuth\n- **Flow**: application\n- **Authorization URL**: \n- **Scopes**: N/A\n\n\n## Notes for Large OpenAPI documents\nIf the OpenAPI document is large, imports in fds.sdk.FactSetFunds.apis and fds.sdk.FactSetFunds.models may fail with a\nRecursionError indicating the maximum recursion limit has been exceeded. In that case, there are a couple of solutions:\n\nSolution 1:\nUse specific imports for apis and models like:\n- `from fds.sdk.FactSetFunds.api.default_api import DefaultApi`\n- `from fds.sdk.FactSetFunds.model.pet import Pet`\n\nSolution 2:\nBefore importing the package, adjust the maximum recursion limit as shown below:\n```\nimport sys\nsys.setrecursionlimit(1500)\nimport fds.sdk.FactSetFunds\nfrom fds.sdk.FactSetFunds.apis import *\nfrom fds.sdk.FactSetFunds.models import *\n```\n\n## Contributing\n\nPlease refer to the [contributing guide](../../../../CONTRIBUTING.md).\n\n## Copyright\n\nCopyright 2022 FactSet Research Systems Inc\n\nLicensed under the Apache License, Version 2.0 (the \"License\");\nyou may not use this file except in compliance with the License.\nYou may obtain a copy of the License at\n\n    http://www.apache.org/licenses/LICENSE-2.0\n\nUnless required by applicable law or agreed to in writing, software\ndistributed under the License is distributed on an \"AS IS\" BASIS,\nWITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\nSee the License for the specific language governing permissions and\nlimitations under the License.\n\n\n\n",
    "bugtrack_url": null,
    "license": "Apache License, Version 2.0",
    "summary": "FactSet Funds client library for Python",
    "version": "1.1.2",
    "project_urls": {
        "Homepage": "https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetFunds/v1"
    },
    "split_keywords": [
        "factset",
        " api",
        " sdk"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "d803d7bd2f6a172b090a71a93a4293fdbb96e4aa13f6845e787b11a80ead17fa",
                "md5": "f58c2c53844f91b843a84f23c17c9601",
                "sha256": "dd78e3df268bc361c2333cdf7d0cd8d40b4f9208d21d7ee36dbdd8e70f03aad6"
            },
            "downloads": -1,
            "filename": "fds.sdk.FactSetFunds-1.1.2-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "f58c2c53844f91b843a84f23c17c9601",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.7",
            "size": 215470,
            "upload_time": "2024-05-02T12:42:33",
            "upload_time_iso_8601": "2024-05-02T12:42:33.153199Z",
            "url": "https://files.pythonhosted.org/packages/d8/03/d7bd2f6a172b090a71a93a4293fdbb96e4aa13f6845e787b11a80ead17fa/fds.sdk.FactSetFunds-1.1.2-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-05-02 12:42:33",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "FactSet",
    "github_project": "enterprise-sdk",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": false,
    "lcname": "fds.sdk.factsetfunds"
}