ETF Profile and Prices client library for Python
Project description
ETF Profile and Prices client library for Python
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.10.0
- 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
- Generate authentication credentials.
- Setup Python environment.
-
Install and activate python 3.6+. If you're using pyenv:
pyenv install 3.9.7 pyenv shell 3.9.7
-
(optional) Install poetry.
-
- Install dependencies.
- 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_response20023 import InlineResponse20023
from fds.sdk.ETFProfileandPrices.model.inline_response20024 import InlineResponse20024
from fds.sdk.ETFProfileandPrices.model.inline_response20025 import InlineResponse20025
from fds.sdk.ETFProfileandPrices.model.inline_response20026 import InlineResponse20026
from fds.sdk.ETFProfileandPrices.model.inline_response20027 import InlineResponse20027
from fds.sdk.ETFProfileandPrices.model.inline_response20028 import InlineResponse20028
from fds.sdk.ETFProfileandPrices.model.inline_response20029 import InlineResponse20029
from fds.sdk.ETFProfileandPrices.model.inline_response2003 import InlineResponse2003
from fds.sdk.ETFProfileandPrices.model.inline_response20030 import InlineResponse20030
from fds.sdk.ETFProfileandPrices.model.inline_response20031 import InlineResponse20031
from fds.sdk.ETFProfileandPrices.model.inline_response20032 import InlineResponse20032
from fds.sdk.ETFProfileandPrices.model.inline_response20033 import InlineResponse20033
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)
# Get response
try:
# This endpoint returns selected ETP's asset allocations.
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)
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
- AttributesMember
- CursorBasedPaginationOutputObject
- CursorBasedPaginationOutputObjectWithoutTotal
- ErrorMetaObject
- ErrorObject
- InlineResponse200
- InlineResponse2001
- InlineResponse20010
- InlineResponse20010Data
- InlineResponse20010DataIndexChange
- InlineResponse20010DataRisk
- InlineResponse20010DataSecurityLending
- InlineResponse20011
- InlineResponse20011Data
- InlineResponse20012
- InlineResponse20012Data
- InlineResponse20012DataBeta
- InlineResponse20012DataEfficiency
- InlineResponse20012DataFit
- InlineResponse20012DataTradability
- InlineResponse20013
- InlineResponse20013Data
- InlineResponse20013DataBlockTrade
- InlineResponse20013DataImpedimentsToCreation
- InlineResponse20013DataPremiumDiscount
- InlineResponse20013DataSpread
- InlineResponse20013DataTrackingDifference
- InlineResponse20014
- InlineResponse20014Data
- InlineResponse20014DataCounterParty
- InlineResponse20014DataGearing
- InlineResponse20014DataGearingLeverage
- InlineResponse20014DataHedge
- InlineResponse20014DataServiceProvider
- InlineResponse20015
- InlineResponse20015Data
- InlineResponse20015DataCategory
- InlineResponse20015DataGeography
- InlineResponse20016
- InlineResponse20016Data
- InlineResponse20017
- InlineResponse20017Data
- InlineResponse20018
- InlineResponse20018Data
- InlineResponse20019
- InlineResponse20019Data
- InlineResponse2001Data
- InlineResponse2001DataAssets
- InlineResponse2001Meta
- InlineResponse2002
- InlineResponse20020
- InlineResponse20020Data
- InlineResponse20021
- InlineResponse20021Data
- InlineResponse20021DataCapitalGains
- InlineResponse20021DataDividend
- InlineResponse20022
- InlineResponse20022Data
- InlineResponse20023
- InlineResponse20023Data
- InlineResponse20024
- InlineResponse20024Data
- InlineResponse20024Exchange
- InlineResponse20025
- InlineResponse20025Data
- InlineResponse20025DataAverageLife
- InlineResponse20025DataOptionAdjustedSpread
- InlineResponse20026
- InlineResponse20026Data
- InlineResponse20026DataCount
- InlineResponse20026DataSummary
- InlineResponse20027
- InlineResponse20027Data
- InlineResponse20027DataNav
- InlineResponse20027DataNavLast
- InlineResponse20027DataSharesOutstanding
- InlineResponse20028
- InlineResponse20028Data
- InlineResponse20029
- InlineResponse20029Data
- InlineResponse2002Data
- InlineResponse2002DataCountries
- InlineResponse2003
- InlineResponse20030
- InlineResponse20030Data
- InlineResponse20031
- InlineResponse20031Data
- InlineResponse20032
- InlineResponse20032Data
- InlineResponse20032DataExpenseRatio
- InlineResponse20032DataMaxCapitalGainsRate
- InlineResponse20033
- InlineResponse20033Data
- InlineResponse2003Data
- InlineResponse2003DataCurrencies
- InlineResponse2004
- InlineResponse2004Data
- InlineResponse2004DataClassifications
- InlineResponse2005
- InlineResponse2005Data
- InlineResponse2005DataExchanges
- InlineResponse2006
- InlineResponse2006Data
- InlineResponse2006DataIndustries
- InlineResponse2007
- InlineResponse2007Data
- InlineResponse2007DataClassifications
- InlineResponse2008
- InlineResponse2008Data
- InlineResponse2008DataRegions
- InlineResponse2009
- InlineResponse2009Data
- InlineResponse2009DataSectors
- InlineResponse200Data
- InlineResponse200DataBrand
- InlineResponse200DataCreateRedeem
- InlineResponse200DataCurrency
- InlineResponse200DataDocumentation
- InlineResponse200DataExchange
- InlineResponse200DataFinancialReport
- InlineResponse200DataFinancialReportAnnual
- InlineResponse200DataFinancialReportSemiAnnual
- InlineResponse200DataIndex
- InlineResponse200DataInsight
- InlineResponse200DataIssuer
- InlineResponse200DataTrading
- InlineResponse200DataTradingAverage
- InlineResponse200DataTradingMedian
- InlineResponse200Meta
- LanguageMember
- OffsetBasedPaginationOutputObject
- OffsetBasedPaginationOutputObjectWithoutTotal
- PartialOutputObject
- StatusObject
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
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distributions
Built Distribution
Hashes for fds.sdk.ETFProfileandPrices-0.10.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | bbedd98fe0c3676f47758b863983f11b5aae32e988e294c73b638304c16a8519 |
|
MD5 | 611c84a4b95efb3874296a66dd2df474 |
|
BLAKE2b-256 | 66c69cb9bb245769d838b79a9e6567615948f5941ab7c2b7fd02d611f9757872 |