Funds API for Digital Portals client library for Python

Project description

Funds API for Digital Portals client library for Python

Search for mutual funds and ETFs using one single consolidated API, including a criteria-based screener. The API provides also base data, key figures, and holdings.

A separate endpoint returns the possible values and value range for the parameters that the endpoint /fund/notation/screener/search accepts: Application developers can request the values and value range only for a restricted set of notations that match predefined parameters. This functionality may be used to pre-fill the values and value ranges of the parameters of the /fund/notation/screener/search endpoint so that performing a search always leads to a non-empty set of notations.

This API is fully integrated with the corresponding Quotes API, allowing access to detailed price and performance information of instruments, as well as basic security identifier cross-reference. For direct access to price histories, please refer to the Time Series API for Digital Portals.

Similar criteria based screener APIs exist for equity instruments and securitized derivatives: See the Stocks API and the Securitized Derivatives API for details.

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

API version: 2
Package version: 0.10.0
Build package: org.openapitools.codegen.languages.PythonClientCodegen

Requirements

Python >= 3.6

Installation

Poetry

poetry add fds.sdk.utils fds.sdk.FundsAPIforDigitalPortals

pip

pip install fds.sdk.utils fds.sdk.FundsAPIforDigitalPortals

Usage

Generate authentication credentials.
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.
Install dependencies.
Run the following:

from fds.sdk.utils.authentication import ConfidentialClient
import fds.sdk.FundsAPIforDigitalPortals
from fds.sdk.FundsAPIforDigitalPortals.api import fund_api
from fds.sdk.FundsAPIforDigitalPortals.model.inline_object import InlineObject
from fds.sdk.FundsAPIforDigitalPortals.model.inline_object1 import InlineObject1
from fds.sdk.FundsAPIforDigitalPortals.model.inline_object2 import InlineObject2
from fds.sdk.FundsAPIforDigitalPortals.model.inline_response200 import InlineResponse200
from fds.sdk.FundsAPIforDigitalPortals.model.inline_response2001 import InlineResponse2001
from fds.sdk.FundsAPIforDigitalPortals.model.inline_response2002 import InlineResponse2002
from fds.sdk.FundsAPIforDigitalPortals.model.inline_response2003 import InlineResponse2003
from fds.sdk.FundsAPIforDigitalPortals.model.inline_response2004 import InlineResponse2004
from fds.sdk.FundsAPIforDigitalPortals.model.inline_response2005 import InlineResponse2005
from fds.sdk.FundsAPIforDigitalPortals.model.inline_response2006 import InlineResponse2006
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.FundsAPIforDigitalPortals.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.FundsAPIforDigitalPortals.Configuration(
#     username='USERNAME-SERIAL',
#     password='API-KEY'
# )

# Enter a context with an instance of the API client
with fds.sdk.FundsAPIforDigitalPortals.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = fund_api.FundApi(api_client)
    id = "id_example" # str | Identifier of an instrument of a fund share class.
    attributes = [
        "_attributes_example",
    ] # [str] | Limit the attributes returned in the response to the specified set. (optional)
    sort = [
        "["-holdings.weight"]",
    ] # [str] | Sortable attributes. The sort order is ascending unless it is prefixed with a minus sign, in which case it is descending. A list of at most 2 (possibly prefixed) attribute name(s) is allowed. (optional) (default to ["-holdings.weight"])

    # Get response
    try:
        # Holdings of a fund.
        api_response = api_instance.get_fund_holding_list_by_instrument(id, attributes=attributes, sort=sort)
        pprint(api_response)
    except fds.sdk.FundsAPIforDigitalPortals.ApiException as e:
        print("Exception when calling FundApi->get_fund_holding_list_by_instrument: %s\n" % e)

    # Get response, http status code and response headers
    # try:
    #     # Holdings of a fund.
    #     api_response, http_status_code, response_headers = api_instance.get_fund_holding_list_by_instrument_with_http_info(id, attributes=attributes, sort=sort)
    #     pprint(api_response)
    #     pprint(http_status_code)
    #     pprint(response_headers)
    # except fds.sdk.FundsAPIforDigitalPortals.ApiException as e:
    #     print("Exception when calling FundApi->get_fund_holding_list_by_instrument: %s\n" % e)

    # Get response asynchronous
    # try:
    #     # Holdings of a fund.
    #     async_result = api_instance.get_fund_holding_list_by_instrument_async(id, attributes=attributes, sort=sort)
    #     api_response = async_result.get()
    #     pprint(api_response)
    # except fds.sdk.FundsAPIforDigitalPortals.ApiException as e:
    #     print("Exception when calling FundApi->get_fund_holding_list_by_instrument: %s\n" % e)

    # Get response, http status code and response headers asynchronous
    # try:
    #     # Holdings of a fund.
    #     async_result = api_instance.get_fund_holding_list_by_instrument_with_http_info_async(id, attributes=attributes, sort=sort)
    #     api_response, http_status_code, response_headers = async_result.get()
    #     pprint(api_response)
    #     pprint(http_status_code)
    #     pprint(response_headers)
    # except fds.sdk.FundsAPIforDigitalPortals.ApiException as e:
    #     print("Exception when calling FundApi->get_fund_holding_list_by_instrument: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to http://api.factset.com/wealth/v1

Class	Method	HTTP request	Description
FundApi	get_fund_holding_list_by_instrument	GET /fund/holding/listByInstrument	Holdings of a fund.
FundApi	get_fund_notation_key_figures_benchmark_month_1_get	GET /fund/notation/keyFigures/benchmark/month/1/get	End-of-day (EOD) benchmark key figures of a fund for the time range of one month.
FundApi	get_fund_notation_key_figures_benchmark_month_3_get	GET /fund/notation/keyFigures/benchmark/month/3/get	End-of-day (EOD) benchmark key figures of a fund for the time range of three months.
FundApi	get_fund_notation_key_figures_benchmark_week_1_get	GET /fund/notation/keyFigures/benchmark/week/1/get	End-of-day (EOD) benchmark key figures of a fund for the time range of one week.
FundApi	get_fund_notation_key_figures_benchmark_year_1_get	GET /fund/notation/keyFigures/benchmark/year/1/get	End-of-day (EOD) benchmark key figures of a fund for the time range of one year.
FundApi	get_fund_notation_key_figures_benchmark_year_3_get	GET /fund/notation/keyFigures/benchmark/year/3/get	End-of-day (EOD) benchmark key figures of a fund for the time range of three years.
FundApi	get_fund_notation_key_figures_benchmark_year_5_get	GET /fund/notation/keyFigures/benchmark/year/5/get	End-of-day (EOD) benchmark key figures of a fund for the time range of five years.
FundApi	get_fund_share_class_get	GET /fund/shareClass/get	Fundamental data for a share class of a fund.
FundApi	post_fund_issuer_search	POST /fund/issuer/search	Search for issuers of funds.
FundApi	post_fund_notation_screener_search	POST /fund/notation/screener/search	Screener for notations of share classes of mutual and exchange traded funds based on fund-specific parameters.
FundApi	post_fund_notation_screener_value_ranges_get	POST /fund/notation/screener/valueRanges/get	Possible values and value ranges for the parameters used in the endpoint `/fund/notation/screener/search`.

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

Contributing

Please refer to the contributing guide.

Copyright

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

Release history Release notifications | RSS feed

This version

0.10.0

May 24, 2022

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distribution

fds.sdk.FundsAPIforDigitalPortals-0.10.0-py3-none-any.whl (1.0 MB view hashes)

Uploaded May 24, 2022 Python 3

Hashes for fds.sdk.FundsAPIforDigitalPortals-0.10.0-py3-none-any.whl

Hashes for fds.sdk.FundsAPIforDigitalPortals-0.10.0-py3-none-any.whl
Algorithm	Hash digest
SHA256	`9918c005257e8406daec41e6e354a93334671906b934a063121f34cb61b72a39`
MD5	`04d862daa99d9a9856fa04d771d93c0b`
BLAKE2b-256	`d9500b017b5c88643f7656e365a872f8c4ace3a6fd0375efbf00dbd03f7aa598`