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
Meta
  • License: Apache-2.0
  • Author: FactSet Research Systems
  • Tags FactSet, API, SDK
  • Requires: Python >=3.6

Project description

FactSet

ETF Profile and Prices client library for Python

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
  • Package version: 0.9.1
  • Build package: org.openapitools.codegen.languages.PythonClientCodegen

Requirements

  • Python >= 3.6

Installation

Poetry

poetry add fds.sdk.utils fds.sdk.ETFProfileandPrices

pip

pip install fds.sdk.utils fds.sdk.ETFProfileandPrices

Usage

  1. Generate authentication credentials.
  2. 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.

  3. Install dependencies.
  4. Run the following:
from fds.sdk.utils.authentication import ConfidentialClient
import fds.sdk.ETFProfileandPrices
from fds.sdk.ETFProfileandPrices.api import factset_api
from fds.sdk.ETFProfileandPrices.model.inline_response200 import InlineResponse200
from fds.sdk.ETFProfileandPrices.model.inline_response2001 import InlineResponse2001
from fds.sdk.ETFProfileandPrices.model.inline_response20010 import InlineResponse20010
from fds.sdk.ETFProfileandPrices.model.inline_response20011 import InlineResponse20011
from fds.sdk.ETFProfileandPrices.model.inline_response20012 import InlineResponse20012
from fds.sdk.ETFProfileandPrices.model.inline_response20013 import InlineResponse20013
from fds.sdk.ETFProfileandPrices.model.inline_response20014 import InlineResponse20014
from fds.sdk.ETFProfileandPrices.model.inline_response20015 import InlineResponse20015
from fds.sdk.ETFProfileandPrices.model.inline_response20016 import InlineResponse20016
from fds.sdk.ETFProfileandPrices.model.inline_response20017 import InlineResponse20017
from fds.sdk.ETFProfileandPrices.model.inline_response20018 import InlineResponse20018
from fds.sdk.ETFProfileandPrices.model.inline_response20019 import InlineResponse20019
from fds.sdk.ETFProfileandPrices.model.inline_response2002 import InlineResponse2002
from fds.sdk.ETFProfileandPrices.model.inline_response20020 import InlineResponse20020
from fds.sdk.ETFProfileandPrices.model.inline_response20021 import InlineResponse20021
from fds.sdk.ETFProfileandPrices.model.inline_response20022 import InlineResponse20022
from fds.sdk.ETFProfileandPrices.model.inline_response2003 import InlineResponse2003
from fds.sdk.ETFProfileandPrices.model.inline_response2004 import InlineResponse2004
from fds.sdk.ETFProfileandPrices.model.inline_response2005 import InlineResponse2005
from fds.sdk.ETFProfileandPrices.model.inline_response2006 import InlineResponse2006
from fds.sdk.ETFProfileandPrices.model.inline_response2007 import InlineResponse2007
from fds.sdk.ETFProfileandPrices.model.inline_response2008 import InlineResponse2008
from fds.sdk.ETFProfileandPrices.model.inline_response2009 import InlineResponse2009
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.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) (default to 0.0)
pagination_limit = 20.0 # float | Non-negative maximum number of entries to return. (optional) (default to 20.0)

    try:
        # This endpoint returns selected ETP's asset allocations.
        api_response = api_instance.factset_etf_allocation_asset_list_by_symbol_get(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->factset_etf_allocation_asset_list_by_symbol_get: %s\n" % e)

Documentation for API Endpoints

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

Class Method HTTP request Description
FactsetApi factset_etf_allocation_asset_list_by_symbol_get GET /factset/etf/allocation/asset/listBySymbol This endpoint returns selected ETP's asset allocations.
FactsetApi factset_etf_allocation_country_list_by_symbol_get GET /factset/etf/allocation/country/listBySymbol This endpoint returns selected ETP's country allocations.
FactsetApi factset_etf_allocation_exchange_list_by_symbol_get GET /factset/etf/allocation/exchange/listBySymbol This endpoint returns selected ETP's exchange allocations.
FactsetApi factset_etf_allocation_region_list_by_symbol_get GET /factset/etf/allocation/region/listBySymbol This endpoint returns selected ETP's region allocations.
FactsetApi factset_etf_allocation_sector_list_by_symbol_get GET /factset/etf/allocation/sector/listBySymbol This endpoint returns selected ETP's sector allocations.
FactsetApi factset_etf_characteristics_get_by_symbol_get GET /factset/etf/characteristics/getBySymbol Retrieve basic characteristic information for a specified ETP.
FactsetApi factset_etf_class_category_broad_list_get GET /factset/etf/class/category/broad/list List of ETP class broad categories.
FactsetApi factset_etf_class_category_focus_list_get GET /factset/etf/class/category/focus/list List of ETP class focus categories.
FactsetApi factset_etf_class_category_niche_list_get GET /factset/etf/class/category/niche/list List of ETP class niche categories.
FactsetApi factset_etf_class_geography_list_get GET /factset/etf/class/geography/list List of ETP class geographies.
FactsetApi factset_etf_class_get_by_symbol_get GET /factset/etf/class/getBySymbol Retrieve an ETP's classification specific to asset class, geography, or investment strategy.
FactsetApi factset_etf_distribution_get_by_symbol_get GET /factset/etf/distribution/getBySymbol Retrieve an ETP's current distribution details.
FactsetApi factset_etf_fund_flows_get_by_symbol_get GET /factset/etf/fundFlows/getBySymbol Retrieve an ETP's cash inflow/outflows for various time periods.
FactsetApi factset_etf_get_by_symbol_get GET /factset/etf/getBySymbol Retrieve basic profile information for a specified ETP.
FactsetApi factset_etf_growth_of_ten_k_list_by_symbol_get GET /factset/etf/growthOfTenK/listBySymbol This endpoint returns selected ETP's Growth of 10K calculated values.
FactsetApi factset_etf_holdings_list_by_symbol_get GET /factset/etf/holdings/listBySymbol Holdings details for an individual ETP.
FactsetApi factset_etf_price_get_by_symbol_get GET /factset/etf/price/getBySymbol Retrieve historical ETP NAV values.
FactsetApi factset_etf_returns_get_by_symbol_get GET /factset/etf/returns/getBySymbol Retrieve total return data for a specified ETP.
FactsetApi factset_etf_strategy_get_by_symbol_get GET /factset/etf/strategy/getBySymbol Retrieve various classification details for a specified ETP.
FactsetApi factset_etf_strategy_segment_list_get GET /factset/etf/strategy/segment/list Retrieve a list of ETP strategy segments.
FactsetApi factset_etf_structure_get_by_symbol_get GET /factset/etf/structure/getBySymbol Retrieve the basic structure information for a specified ETP.
FactsetApi factset_etf_taxes_and_fees_us_get_by_symbol_get GET /factset/etf/taxesAndFees/us/getBySymbol Retrieve the tax and fee related information for a specified ETP.
FactsetApi factset_etf_time_series_list_by_symbol_get 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
Meta
  • License: Apache-2.0
  • Author: FactSet Research Systems
  • Tags FactSet, API, SDK
  • Requires: Python >=3.6

Release history Release notifications | RSS feed

0.10.14

0.10.13

0.10.12

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

This version

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.9.1-py3-none-any.whl (299.5 kB view details)

Uploaded Python 3

File details

Details for the file fds.sdk.ETFProfileandPrices-0.9.1-py3-none-any.whl.

File metadata

  • Download URL: fds.sdk.ETFProfileandPrices-0.9.1-py3-none-any.whl
  • Upload date:
  • Size: 299.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.8.0 pkginfo/1.8.2 readme-renderer/32.0 requests/2.27.1 requests-toolbelt/0.9.1 urllib3/1.26.8 tqdm/4.62.3 importlib-metadata/4.8.3 keyring/23.4.1 rfc3986/1.5.0 colorama/0.4.4 CPython/3.6.15

File hashes

Hashes for fds.sdk.ETFProfileandPrices-0.9.1-py3-none-any.whl
Algorithm Hash digest
SHA256 7c1178206808a9b5beccc82a9b43449049f4098910b69fcadf180a883e5cd54d
MD5 371ad464c689e8a68975dc70e1b8f026
BLAKE2b-256 67090386d8b4e8423c01c48741edf07898e1738a9135e20f75464c844c23a639

See more details on using hashes here.

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