ETF Profile and Prices client library for Python

Navigation

Verified details

These details have been verified by PyPI
Maintainers
Avatar for factset from gravatar.com factset

Unverified details

These details have not been verified by PyPI
Project links
GitHub Statistics

View statistics for this project via Libraries.io, or by using our public dataset on Google BigQuery

Meta

License: Apache License, Version 2.0

Author: FactSet Research Systems

Tags FactSet, API, SDK

Requires: Python >=3.7

Project description

FactSet

ETF Profile and Prices client library for Python

API Version PyPi Apache-2 license

No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)

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

  • API version: v1
  • SDK version: 0.10.11
  • Build package: org.openapitools.codegen.languages.PythonClientCodegen

Requirements

  • Python >= 3.7

Installation

Poetry

poetry add fds.sdk.utils fds.sdk.ETFProfileandPrices==0.10.11

pip

pip install fds.sdk.utils fds.sdk.ETFProfileandPrices==0.10.11

Usage

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

    1. Install and activate python 3.7+. If you're using pyenv:

      pyenv install 3.9.7
pyenv shell 3.9.7

    2. (optional) Install poetry.

  3. Install dependencies.
  4. Run the following:

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

# Enter a context with an instance of the API client
with fds.sdk.ETFProfileandPrices.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = factset_api.FactsetApi(api_client)
    symbol = "symbol_example" # str | Market symbol of ETP defined by FactSet.
    attributes = [
        "_attributes_example",
    ] # [str] | Limit the attributes returned in the response to the specified set. (optional)
    pagination_offset = 0.0 # float | Non-negative number of entries to skip, or 0 (default). (optional) if omitted the server will use the default value of 0.0
    pagination_limit = 20.0 # float | Non-negative maximum number of entries to return. (optional) if omitted the server will use the default value of 20.0

    try:
        # This endpoint returns selected ETP's asset allocations.
        # example passing only required values which don't have defaults set
        # and optional values
        api_response = api_instance.get_factset_etf_allocation_asset_list_by_symbol(symbol, attributes=attributes, pagination_offset=pagination_offset, pagination_limit=pagination_limit)

        pprint(api_response)
    except fds.sdk.ETFProfileandPrices.ApiException as e:
        print("Exception when calling FactsetApi->get_factset_etf_allocation_asset_list_by_symbol: %s\n" % e)

    # # Get response, http status code and response headers
    # try:
    #     # This endpoint returns selected ETP's asset allocations.
    #     api_response, http_status_code, response_headers = api_instance.get_factset_etf_allocation_asset_list_by_symbol_with_http_info(symbol, attributes=attributes, pagination_offset=pagination_offset, pagination_limit=pagination_limit)


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

    # # Get response asynchronous
    # try:
    #     # This endpoint returns selected ETP's asset allocations.
    #     async_result = api_instance.get_factset_etf_allocation_asset_list_by_symbol_async(symbol, attributes=attributes, pagination_offset=pagination_offset, pagination_limit=pagination_limit)
    #     api_response = async_result.get()


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

    # # Get response, http status code and response headers asynchronous
    # try:
    #     # This endpoint returns selected ETP's asset allocations.
    #     async_result = api_instance.get_factset_etf_allocation_asset_list_by_symbol_with_http_info_async(symbol, attributes=attributes, pagination_offset=pagination_offset, pagination_limit=pagination_limit)
    #     api_response, http_status_code, response_headers = async_result.get()


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

logging.basicConfig(level=logging.DEBUG)

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

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

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

configuration = fds.sdk.ETFProfileandPrices.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/wealth/v1

Class Method HTTP request Description
FactsetApi get_factset_etf_allocation_asset_list_by_symbol GET /factset/etf/allocation/asset/listBySymbol This endpoint returns selected ETP's asset allocations.
FactsetApi get_factset_etf_allocation_country_list_by_symbol GET /factset/etf/allocation/country/listBySymbol This endpoint returns selected ETP's country allocations.
FactsetApi get_factset_etf_allocation_currency_list_by_symbol GET /factset/etf/allocation/currency/listBySymbol This endpoint returns selected ETP's currency allocations.
FactsetApi get_factset_etf_allocation_economic_development_list_by_symbol GET /factset/etf/allocation/economicDevelopment/listBySymbol List of allocations classified by a holding's economic development status.
FactsetApi get_factset_etf_allocation_exchange_list_by_symbol GET /factset/etf/allocation/exchange/listBySymbol This endpoint returns selected ETP's exchange allocations.
FactsetApi get_factset_etf_allocation_industry_list_by_symbol GET /factset/etf/allocation/industry/listBySymbol This endpoint returns selected ETP's industry allocations.
FactsetApi get_factset_etf_allocation_market_capitalization_list_by_symbol GET /factset/etf/allocation/marketCapitalization/listBySymbol List of allocations classified by a holding's total market capitalization.
FactsetApi get_factset_etf_allocation_region_list_by_symbol GET /factset/etf/allocation/region/listBySymbol This endpoint returns selected ETP's region allocations.
FactsetApi get_factset_etf_allocation_sector_list_by_symbol GET /factset/etf/allocation/sector/listBySymbol This endpoint returns selected ETP's sector allocations.
FactsetApi get_factset_etf_analytics_get_by_symbol GET /factset/etf/analytics/getBySymbol FactSet proprietary analytics datapoints for ETPs.
FactsetApi get_factset_etf_analytics_holdings_statistics_get_by_symbol GET /factset/etf/analytics/holdings/statistics/getBySymbol FactSet's portfolio statistics for ETPs.
FactsetApi get_factset_etf_analytics_score_get_by_symbol GET /factset/etf/analytics/score/getBySymbol FactSet proprietary ETP rankings.
FactsetApi get_factset_etf_analytics_trade_get_by_symbol GET /factset/etf/analytics/trade/getBySymbol Trade statistics for specific ETP.
FactsetApi get_factset_etf_characteristics_get_by_symbol GET /factset/etf/characteristics/getBySymbol Retrieve basic characteristic information for a specified ETP.
FactsetApi get_factset_etf_class_category_broad_list GET /factset/etf/class/category/broad/list List of ETP class broad categories.
FactsetApi get_factset_etf_class_category_focus_list GET /factset/etf/class/category/focus/list List of ETP class focus categories.
FactsetApi get_factset_etf_class_category_niche_list GET /factset/etf/class/category/niche/list List of ETP class niche categories.
FactsetApi get_factset_etf_class_geography_list GET /factset/etf/class/geography/list List of ETP class geographies.
FactsetApi get_factset_etf_class_get_by_symbol GET /factset/etf/class/getBySymbol Retrieve an ETP's classification specific to asset class, geography, or investment strategy.
FactsetApi get_factset_etf_competitors_list_by_symbol GET /factset/etf/competitors/listBySymbol FactSet's proprietary list of competing companies.
FactsetApi get_factset_etf_distribution_get_by_symbol GET /factset/etf/distribution/getBySymbol Retrieve an ETP's current distribution details.
FactsetApi get_factset_etf_fund_flows_get_by_symbol GET /factset/etf/fundFlows/getBySymbol Retrieve an ETP's cash inflow/outflows for various time periods.
FactsetApi get_factset_etf_get_by_symbol GET /factset/etf/getBySymbol Retrieve basic profile information for a specified ETP.
FactsetApi get_factset_etf_growth_of_ten_k_list_by_symbol GET /factset/etf/growthOfTenK/listBySymbol This endpoint returns selected ETP's Growth of 10K calculated values.
FactsetApi get_factset_etf_holdings_list_by_symbol GET /factset/etf/holdings/listBySymbol Holdings details for an individual ETP.
FactsetApi get_factset_etf_market_aggregates_get_by_symbol GET /factset/etf/marketAggregates/getBySymbol Market aggregate data for ETPs.
FactsetApi get_factset_etf_premium_discount_summary_list_by_symbol GET /factset/etf/premiumDiscount/summary/listBySymbol Summary of ETP premium discount data.
FactsetApi get_factset_etf_price_get_by_symbol GET /factset/etf/price/getBySymbol Retrieve historical ETP NAV values.
FactsetApi get_factset_etf_returns_get_by_symbol GET /factset/etf/returns/getBySymbol Retrieve total return data for a specified ETP.
FactsetApi get_factset_etf_strategy_get_by_symbol GET /factset/etf/strategy/getBySymbol Retrieve various classification details for a specified ETP.
FactsetApi get_factset_etf_strategy_segment_list GET /factset/etf/strategy/segment/list Retrieve a list of ETP strategy segments.
FactsetApi get_factset_etf_structure_get_by_symbol GET /factset/etf/structure/getBySymbol Retrieve the basic structure information for a specified ETP.
FactsetApi get_factset_etf_taxes_and_fees_us_get_by_symbol GET /factset/etf/taxesAndFees/us/getBySymbol Retrieve the tax and fee related information for a specified ETP.
FactsetApi get_factset_etf_time_series_list_by_symbol GET /factset/etf/timeSeries/listBySymbol Retrieve historical NAV data for a specified ETP.

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

Contributing

Please refer to the contributing guide.

Copyright

Copyright 2022 FactSet Research Systems Inc

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Project details

Verified details

These details have been verified by PyPI
Maintainers
Avatar for factset from gravatar.com factset

Unverified details

These details have not been verified by PyPI
Project links
GitHub Statistics

View statistics for this project via Libraries.io, or by using our public dataset on Google BigQuery

Meta

License: Apache License, Version 2.0

Author: FactSet Research Systems

Tags FactSet, API, SDK

Requires: Python >=3.7


Release history Release notifications | RSS feed

This version

0.10.11

0.10.10

0.10.9

0.10.8

0.10.7

0.10.6

0.10.5

0.10.4

0.10.3

0.10.2

0.10.1

0.10.0

0.9.1

0.9.0

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.ETFProfileandPrices-0.10.11-py3-none-any.whl (425.2 kB view hashes)

Uploaded Python 3

Supported by

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