fds.sdk.FactSetQuantFactorLibrary 1.0.13__tar.gz → 1.1.0__tar.gz
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- {fds.sdk.FactSetQuantFactorLibrary-1.0.13 → fds.sdk.FactSetQuantFactorLibrary-1.1.0}/PKG-INFO +15 -13
- {fds.sdk.FactSetQuantFactorLibrary-1.0.13 → fds.sdk.FactSetQuantFactorLibrary-1.1.0}/README.md +14 -12
- {fds.sdk.FactSetQuantFactorLibrary-1.0.13 → fds.sdk.FactSetQuantFactorLibrary-1.1.0}/fds/sdk/FactSetQuantFactorLibrary/__init__.py +2 -2
- {fds.sdk.FactSetQuantFactorLibrary-1.0.13 → fds.sdk.FactSetQuantFactorLibrary-1.1.0}/fds/sdk/FactSetQuantFactorLibrary/api/factors_api.py +10 -23
- {fds.sdk.FactSetQuantFactorLibrary-1.0.13 → fds.sdk.FactSetQuantFactorLibrary-1.1.0}/fds/sdk/FactSetQuantFactorLibrary/api/helper_api.py +1 -1
- {fds.sdk.FactSetQuantFactorLibrary-1.0.13 → fds.sdk.FactSetQuantFactorLibrary-1.1.0}/fds/sdk/FactSetQuantFactorLibrary/api_client.py +2 -2
- {fds.sdk.FactSetQuantFactorLibrary-1.0.13 → fds.sdk.FactSetQuantFactorLibrary-1.1.0}/fds/sdk/FactSetQuantFactorLibrary/configuration.py +3 -3
- {fds.sdk.FactSetQuantFactorLibrary-1.0.13 → fds.sdk.FactSetQuantFactorLibrary-1.1.0}/fds/sdk/FactSetQuantFactorLibrary/exceptions.py +1 -1
- {fds.sdk.FactSetQuantFactorLibrary-1.0.13 → fds.sdk.FactSetQuantFactorLibrary-1.1.0}/fds/sdk/FactSetQuantFactorLibrary/model/error_response.py +1 -1
- {fds.sdk.FactSetQuantFactorLibrary-1.0.13 → fds.sdk.FactSetQuantFactorLibrary-1.1.0}/fds/sdk/FactSetQuantFactorLibrary/model/error_response_sub_errors.py +1 -1
- {fds.sdk.FactSetQuantFactorLibrary-1.0.13 → fds.sdk.FactSetQuantFactorLibrary-1.1.0}/fds/sdk/FactSetQuantFactorLibrary/model/factor_groups_param.py +1 -1
- {fds.sdk.FactSetQuantFactorLibrary-1.0.13 → fds.sdk.FactSetQuantFactorLibrary-1.1.0}/fds/sdk/FactSetQuantFactorLibrary/model/factors.py +1 -1
- {fds.sdk.FactSetQuantFactorLibrary-1.0.13 → fds.sdk.FactSetQuantFactorLibrary-1.1.0}/fds/sdk/FactSetQuantFactorLibrary/model/factors_param.py +1 -1
- {fds.sdk.FactSetQuantFactorLibrary-1.0.13 → fds.sdk.FactSetQuantFactorLibrary-1.1.0}/fds/sdk/FactSetQuantFactorLibrary/model/factors_request.py +7 -9
- {fds.sdk.FactSetQuantFactorLibrary-1.0.13 → fds.sdk.FactSetQuantFactorLibrary-1.1.0}/fds/sdk/FactSetQuantFactorLibrary/model/factors_response.py +1 -1
- {fds.sdk.FactSetQuantFactorLibrary-1.0.13 → fds.sdk.FactSetQuantFactorLibrary-1.1.0}/fds/sdk/FactSetQuantFactorLibrary/model/frequency.py +1 -1
- {fds.sdk.FactSetQuantFactorLibrary-1.0.13 → fds.sdk.FactSetQuantFactorLibrary-1.1.0}/fds/sdk/FactSetQuantFactorLibrary/model/ids.py +1 -1
- {fds.sdk.FactSetQuantFactorLibrary-1.0.13 → fds.sdk.FactSetQuantFactorLibrary-1.1.0}/fds/sdk/FactSetQuantFactorLibrary/model/library.py +1 -1
- {fds.sdk.FactSetQuantFactorLibrary-1.0.13 → fds.sdk.FactSetQuantFactorLibrary-1.1.0}/fds/sdk/FactSetQuantFactorLibrary/model/library_request.py +1 -1
- {fds.sdk.FactSetQuantFactorLibrary-1.0.13 → fds.sdk.FactSetQuantFactorLibrary-1.1.0}/fds/sdk/FactSetQuantFactorLibrary/model/library_response.py +1 -1
- {fds.sdk.FactSetQuantFactorLibrary-1.0.13 → fds.sdk.FactSetQuantFactorLibrary-1.1.0}/fds/sdk/FactSetQuantFactorLibrary/model_utils.py +1 -1
- {fds.sdk.FactSetQuantFactorLibrary-1.0.13 → fds.sdk.FactSetQuantFactorLibrary-1.1.0}/fds/sdk/FactSetQuantFactorLibrary/rest.py +1 -1
- {fds.sdk.FactSetQuantFactorLibrary-1.0.13 → fds.sdk.FactSetQuantFactorLibrary-1.1.0}/fds.sdk.FactSetQuantFactorLibrary.egg-info/PKG-INFO +15 -13
- {fds.sdk.FactSetQuantFactorLibrary-1.0.13 → fds.sdk.FactSetQuantFactorLibrary-1.1.0}/setup.py +2 -2
- {fds.sdk.FactSetQuantFactorLibrary-1.0.13 → fds.sdk.FactSetQuantFactorLibrary-1.1.0}/LICENSE +0 -0
- {fds.sdk.FactSetQuantFactorLibrary-1.0.13 → fds.sdk.FactSetQuantFactorLibrary-1.1.0}/fds/__init__.py +0 -0
- {fds.sdk.FactSetQuantFactorLibrary-1.0.13 → fds.sdk.FactSetQuantFactorLibrary-1.1.0}/fds/sdk/FactSetQuantFactorLibrary/api/__init__.py +0 -0
- {fds.sdk.FactSetQuantFactorLibrary-1.0.13 → fds.sdk.FactSetQuantFactorLibrary-1.1.0}/fds/sdk/FactSetQuantFactorLibrary/apis/__init__.py +0 -0
- {fds.sdk.FactSetQuantFactorLibrary-1.0.13 → fds.sdk.FactSetQuantFactorLibrary-1.1.0}/fds/sdk/FactSetQuantFactorLibrary/model/__init__.py +0 -0
- {fds.sdk.FactSetQuantFactorLibrary-1.0.13 → fds.sdk.FactSetQuantFactorLibrary-1.1.0}/fds/sdk/FactSetQuantFactorLibrary/models/__init__.py +0 -0
- {fds.sdk.FactSetQuantFactorLibrary-1.0.13 → fds.sdk.FactSetQuantFactorLibrary-1.1.0}/fds/sdk/__init__.py +0 -0
- {fds.sdk.FactSetQuantFactorLibrary-1.0.13 → fds.sdk.FactSetQuantFactorLibrary-1.1.0}/fds.sdk.FactSetQuantFactorLibrary.egg-info/SOURCES.txt +0 -0
- {fds.sdk.FactSetQuantFactorLibrary-1.0.13 → fds.sdk.FactSetQuantFactorLibrary-1.1.0}/fds.sdk.FactSetQuantFactorLibrary.egg-info/dependency_links.txt +0 -0
- {fds.sdk.FactSetQuantFactorLibrary-1.0.13 → fds.sdk.FactSetQuantFactorLibrary-1.1.0}/fds.sdk.FactSetQuantFactorLibrary.egg-info/requires.txt +0 -0
- {fds.sdk.FactSetQuantFactorLibrary-1.0.13 → fds.sdk.FactSetQuantFactorLibrary-1.1.0}/fds.sdk.FactSetQuantFactorLibrary.egg-info/top_level.txt +0 -0
- {fds.sdk.FactSetQuantFactorLibrary-1.0.13 → fds.sdk.FactSetQuantFactorLibrary-1.1.0}/setup.cfg +0 -0
{fds.sdk.FactSetQuantFactorLibrary-1.0.13 → fds.sdk.FactSetQuantFactorLibrary-1.1.0}/PKG-INFO
RENAMED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
Metadata-Version: 2.1
|
|
2
2
|
Name: fds.sdk.FactSetQuantFactorLibrary
|
|
3
|
-
Version: 1.0
|
|
3
|
+
Version: 1.1.0
|
|
4
4
|
Summary: FactSet Quant Factor Library client library for Python
|
|
5
5
|
Home-page: https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetQuantFactorLibrary/v1
|
|
6
6
|
Author: FactSet Research Systems
|
|
@@ -15,8 +15,8 @@ License-File: LICENSE
|
|
|
15
15
|
|
|
16
16
|
# FactSet Quant Factor Library client library for Python
|
|
17
17
|
|
|
18
|
-
[](https://pypi.org/project/fds.sdk.FactSetQuantFactorLibrary/)
|
|
18
|
+
[]()
|
|
19
|
+
[](https://pypi.org/project/fds.sdk.FactSetQuantFactorLibrary/v/1.1.0)
|
|
20
20
|
[](https://www.apache.org/licenses/LICENSE-2.0)
|
|
21
21
|
|
|
22
22
|
The FactSet FactSet Quant Factor Library (QFL) API helps to detect investment themes across global equity markets, incorporate ideas into your portfolio construction process, and transform raw data into actionable intelligence. Over 2000+ items spanning Factor Groups in-
|
|
@@ -29,8 +29,8 @@ The FactSet FactSet Quant Factor Library (QFL) API helps to detect investment th
|
|
|
29
29
|
|
|
30
30
|
This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
|
|
31
31
|
|
|
32
|
-
- API version: 1.0.
|
|
33
|
-
- SDK version: 1.0
|
|
32
|
+
- API version: 1.0.2
|
|
33
|
+
- SDK version: 1.1.0
|
|
34
34
|
- Build package: org.openapitools.codegen.languages.PythonClientCodegen
|
|
35
35
|
|
|
36
36
|
For more information, please visit [http://www.factset.com/api](http://www.factset.com/api)
|
|
@@ -44,13 +44,13 @@ For more information, please visit [http://www.factset.com/api](http://www.facts
|
|
|
44
44
|
### Poetry
|
|
45
45
|
|
|
46
46
|
```shell
|
|
47
|
-
poetry add fds.sdk.utils fds.sdk.FactSetQuantFactorLibrary==1.0
|
|
47
|
+
poetry add fds.sdk.utils fds.sdk.FactSetQuantFactorLibrary==1.1.0
|
|
48
48
|
```
|
|
49
49
|
|
|
50
50
|
### pip
|
|
51
51
|
|
|
52
52
|
```shell
|
|
53
|
-
pip install fds.sdk.utils fds.sdk.FactSetQuantFactorLibrary==1.0
|
|
53
|
+
pip install fds.sdk.utils fds.sdk.FactSetQuantFactorLibrary==1.1.0
|
|
54
54
|
```
|
|
55
55
|
|
|
56
56
|
## Usage
|
|
@@ -110,10 +110,12 @@ configuration = fds.sdk.FactSetQuantFactorLibrary.Configuration(
|
|
|
110
110
|
with fds.sdk.FactSetQuantFactorLibrary.ApiClient(configuration) as api_client:
|
|
111
111
|
# Create an instance of the API class
|
|
112
112
|
api_instance = factors_api.FactorsApi(api_client)
|
|
113
|
-
ids = ["
|
|
114
|
-
factors = ["rsi21D","ulcer252D","turbulence21D"] # [str] | Array of individual Factor Items requested. For a list of all available factors and descriptions use the `/library` endpoint.***<p>factors limit** = 20 individual factors per request*
|
|
113
|
+
ids = ["TSLA-US"] # [str] | Security or Entity identifiers. FactSet Identifiers, tickers, CUSIP and SEDOL are accepted as inputs. **NOTE:** Fixed Income identifiers, ETFs, and Options are not accepted in this endpoint. <p>***Maximum possible ids limit** = 3500 per request*</p> `NOTE:` *The maximum possible ids limit for a request will **decrease** based on the size of the historical date range, the number of factors or factorGroups requested.* *<p> 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>*
|
|
115
114
|
start_date = "2020-11-30" # str | The start date requested for a given date range in **YYYY-MM-DD** format. Future dates (T+1) are not accepted in this endpoint.
|
|
116
115
|
end_date = "2021-11-30" # str | The end date requested for a given date range in **YYYY-MM-DD** format. Future dates (T+1) are not accepted in this endpoint. **NOTE:** The input endDate must come AFTER the input startDate.
|
|
116
|
+
factors = [
|
|
117
|
+
"factors_example",
|
|
118
|
+
] # [str] | Array of individual Factor Items requested. For a list of all available factors and descriptions use the `/library` endpoint.***<p>factors limit** = 20 individual factors per request* (optional)
|
|
117
119
|
factor_groups = ["Momentum","Technical","Volatility"] # [str] | Fetch a collection of Factors that fall within one of the below \"groups\". For example, resting factorGroup=Momentum will return all factors under the momentum group. To know which items are available in each group use the /library endpoint.***<p>factor groups limit** = 5 factor groups per request* ### Classification and Reference |Group|Descriptions| |---|---| |Asset_Data|Easily input security-level metadata into your quantitative research process. Common metrics used include Days Since Report, Days to Report, ADR Flag, and Minimum Lot Size. Integrate variables from FactSet Reference, FactSet Fundamentals, and FactSet Estimates databases to impose portfolio constraints and access general reference data.| |Country|Evaluate securities based on the countries in which they have the highest exposure. Analyze company-level exposures across various countries and measure how concentrated a firm’s business is within their countries of operation. Metrics are derived from FactSet Reference and FactSet Geographic Revenue Exposure (GeoRev) databases and include Country Exposure, Country of Incorporation, and Country of Risk.| |Industry|Classify securities based on the industries in which they generate the majority of their revenues. Incorporate variables from the FactSet Revere Business and Industry Classification System (RBICS) database to measure how concentrated a firm’s business is within the industries they operate and across various sub-sectors. Common metrics include Industry Classifications, Industry Exposures, and Industry Concentration.| |Size|Assess how large or small a company is relative to industry peers. Create size buckets and clarify the systematic portion of company returns using variables from FactSet Prices, FactSet RBICS, FactSet Fundamentals, and FactSet Estimates. Common metrics include Size Classification, Enterprise Value, and Market Share.| ### Market Factors |Group|Descriptions| |---|---| |Liquidity|Assess how investible a security is, as well as the potential market impact of a trade using signals built off pricing and volume data from FactSet Prices. Integrate factors as components into your alpha models to evaluate systematic risk or input them into your portfolio construction models to dictate how much of an asset can be bought or sold based on liquidity levels. Common metrics include Average Dollars Traded, Share Turnover, and Bid Ask Spread.| |Market Sensitivity|Clarify the common variations in stock returns attributable to the performance of their local market indices. Leverage regressions performed between security-level and market-index returns across different return horizons and methodologies. Metrics are derived from FactSet Prices and include Beta R-Squared, Up Market Beta, and Down Market Beta.| |Momentum|Analyze the historical momentum of a security and uncover how each underlying data item, calculation, and horizon can be meaningful in different situations. Metrics are derived from FactSet Prices and include 52W Position, Return Momentum, and Velocity.| |Technical|Forecast the direction of future price movements based on historical market data and leverage heuristic or pattern-based signals from FactSet Prices. Common metrics include Average True Range, Ulcer Performance Index, and Money Flow Volume.| |Volatility|Measure the uncertainty in asset price movements with indicators from the FactSet Prices database. Capture various forms of uncertainty by employing statistical calculations on security performance data. Common metrics include Return Volatility, Semivariance, and Turbulence.| ### Core Fundamentals |Group|Descriptions| |---|---| |Efficiency|Leverage core financial data to determine how effectively a company uses its assets, collects payments, and operates its business. Most variables are measured as turnover ratios and include changes over time to provide transparency into the efficiency of each business process. Metrics are derived from FactSet Fundamentals and FactSet Estimates and include Asset Turnover, Receivables Turnover, and Cash Conversion Cycle| |Growth|Measure a company’s ability to grow faster than its peers. Compare the future expected growth of a company with its historical growth and view growth rates adjusted for stability. Integrate variables from FactSet RBICS, FactSet Fundamentals, and FactSet Estimates to analyze growth rates over multiple horizons including Market Share, Sales, and EPS Growth| |Management|Gain insight into how management finances their business and the decisions they make that impact the core financial statements. These choices are reflected in changes to total debt or equity, the overall size of the balance sheet, and decisions around the accounting methods used. Metrics are derived from FactSet Fundamentals and FactSet Estimates and include Capital Expenditures (CAPEX) Growth, Equity Buyback Ratio, and Depreciation & Amortization Variability| |Profitability|Evaluate a company’s ability to generate income relative to its revenue or balance sheet metrics. Identify lucrative businesses relative to their industry, region, and size profile. Metrics are derived from FactSet Fundamentals and FactSet Estimates and include Return on Assets, Return on Invested Capital Change, and Return on Total Equity |Quality|Understand the overall financial health and quality of a company’s business. Use historical data from FactSet Fundamentals to analyze balance sheet health, stability of earnings and profit margins, variability in cash flows, and trends that look beyond headline financial metrics. Common metrics include Cash Earnings Ratio Variability, Revenue Stability, and Accruals Ratios. Composite quality scores (i.e., the Piotroski F-Score, Beneish M-Score, and Altman Z-Score) and their underlying components are also available as individual metrics.| |Solvency|Measure a company’s ability to meet their short- and long-term financial obligations and determine the degree of leverage employed to run their business. Incorporate financial ratios from FactSet Fundamentals and FactSet Estimates to quantify liability or debt obligation relative to earnings, cash flows, equities, or items from the asset side of the balance sheet. Common metrics include Current Ratio, Current Asset Liquidity, and Debt to Equity Change.| |Value|Quickly determine how cheap or expensive a company is based on common security-level characteristics from FactSet Prices, FactSet Fundamentals, and FactSet Estimates. Apply factors as an intersection between other factors for a more customized analysis, such as finding the cheapest stocks among the highest quality companies. Common metrics include Earnings Yield, Book to Price, and Revenue to Enterprise Value.| ### Macro and Cross-Asset |Group|Descriptions| |---|---| |Commodity|Quantify the impact movements in the commodity markets have on equity prices. Metrics are derived from FactSet Prices and allow you to measure company-level exposure to commodities such as Gold, Crude Oil, Coffee, and Live Cattle.| |FX_Sensitivity| Analyze security-level sensitivity to fluctuations in the currency markets. Metrics are derived from FactSet Prices and allow you to identify company exposures to currencies such as USD, EUR, JPY, and CNY. |Debt|Uncover details related to company debt through issuer-level factor exposures. Use the FactSet Fixed Income Prices & Derived Analytics database to aggregate metrics at the company level. Common metrics include Effective Duration, Option Adjusted Spread, and Yield to Worst.| |Economic|Capture daily security exposures to leading economic indicator forecasts. Leverage the Quant Factor Library’s detailed country exposure model to attribute economic measures to individual companies. Metrics are derived from FactSet Economic Estimates and include Real GPD Growth, Industrial Production Growth, Core CPI Inflation, and Policy Rates. ### Alternative |Group|Descriptions| |---|---| |Analyst_Sentiment|Analyze a security’s outlook from the perspective of a sell-side research analyst. Leverage consensus estimates data from the FactSet Estimates database to analyze the directional change in estimate revisions for various financial statement items and time periods. Common metrics include Sales Estimate Revisions, Free Cash Flow Estimate Revisions, and Robust Estimate Revisions.| |Corporate_Governance|Identify companies with strong corporate governance. Analyze the profile of a company’s management and board based on tenure, diversity, compensation incentives, and more factors from the FactSet People database. Common metrics include Management - Average Age, Board - Activist Member, and Executives - Average Bonus.| |Crowding|Understand the degree to which investors own, purchase, or sell a security. View characteristics of each investor’s profile and characterize crowding from passive, active, institutional, ETF, and hedge fund investors. Use metrics from FactSet Ownership, FactSet Prices, and FactSet Fundamentals to help identify potential effects of crowding such as whether certain investor types are acquiring or divesting from a given security. Common metrics include Active Buyer Percent of Portfolio Change, ETF Days to Liquidate, and Hedge Fund Percent Outstanding.| |Insider_Activity|Measure the degree to which insiders own, purchase, or sell their company’s stock. Analyze the sentiment of those with access to material non-public information or determine how the amount of insider ownership may impact management’s key business decisions. Metrics are derived from FactSet Ownership and include Insider Percent Outstanding, Insider Number of Buys, and Insider Seller Position Change. |ESG|Analyze Environmental, Social and Governance (ESG) behavior, which are aggregated and categorized into continuously updated, material ESG scores to uncover risks and opportunities from companies. Truvalue Labs focuses on company ESG behavior from external sources and includes both positive and negative events that go beyond traditional sources of ESG risk data. (optional)
|
|
118
120
|
frequency = "M" # str | Controls the display frequency of the data returned. * **D** = Daily * **W** = Weekly, based on the last day of the week of the start date. * **M** = Monthly, based on the last trading day of the month. * **AM** = Monthly, based on the start date (e.g., if the start date is June 16, data is displayed for June 16, May 16, April 16 etc.). * **CQ** = Quarterly based on the last trading day of the calendar quarter (March, June, September, or December). * **AY** = Actual Annual, based on the start date. * **CY** = Calendar Annual, based on the last trading day of the calendar year. (optional) if omitted the server will use the default value of "M"
|
|
119
121
|
|
|
@@ -121,7 +123,7 @@ with fds.sdk.FactSetQuantFactorLibrary.ApiClient(configuration) as api_client:
|
|
|
121
123
|
# Retrieves Quant Factors for a small list of ids.
|
|
122
124
|
# example passing only required values which don't have defaults set
|
|
123
125
|
# and optional values
|
|
124
|
-
api_response = api_instance.get_factors(ids,
|
|
126
|
+
api_response = api_instance.get_factors(ids, start_date, end_date, factors=factors, factor_groups=factor_groups, frequency=frequency)
|
|
125
127
|
|
|
126
128
|
pprint(api_response)
|
|
127
129
|
except fds.sdk.FactSetQuantFactorLibrary.ApiException as e:
|
|
@@ -130,7 +132,7 @@ with fds.sdk.FactSetQuantFactorLibrary.ApiClient(configuration) as api_client:
|
|
|
130
132
|
# # Get response, http status code and response headers
|
|
131
133
|
# try:
|
|
132
134
|
# # Retrieves Quant Factors for a small list of ids.
|
|
133
|
-
# api_response, http_status_code, response_headers = api_instance.get_factors_with_http_info(ids,
|
|
135
|
+
# api_response, http_status_code, response_headers = api_instance.get_factors_with_http_info(ids, start_date, end_date, factors=factors, factor_groups=factor_groups, frequency=frequency)
|
|
134
136
|
|
|
135
137
|
|
|
136
138
|
# pprint(api_response)
|
|
@@ -142,7 +144,7 @@ with fds.sdk.FactSetQuantFactorLibrary.ApiClient(configuration) as api_client:
|
|
|
142
144
|
# # Get response asynchronous
|
|
143
145
|
# try:
|
|
144
146
|
# # Retrieves Quant Factors for a small list of ids.
|
|
145
|
-
# async_result = api_instance.get_factors_async(ids,
|
|
147
|
+
# async_result = api_instance.get_factors_async(ids, start_date, end_date, factors=factors, factor_groups=factor_groups, frequency=frequency)
|
|
146
148
|
# api_response = async_result.get()
|
|
147
149
|
|
|
148
150
|
|
|
@@ -153,7 +155,7 @@ with fds.sdk.FactSetQuantFactorLibrary.ApiClient(configuration) as api_client:
|
|
|
153
155
|
# # Get response, http status code and response headers asynchronous
|
|
154
156
|
# try:
|
|
155
157
|
# # Retrieves Quant Factors for a small list of ids.
|
|
156
|
-
# async_result = api_instance.get_factors_with_http_info_async(ids,
|
|
158
|
+
# async_result = api_instance.get_factors_with_http_info_async(ids, start_date, end_date, factors=factors, factor_groups=factor_groups, frequency=frequency)
|
|
157
159
|
# api_response, http_status_code, response_headers = async_result.get()
|
|
158
160
|
|
|
159
161
|
|
{fds.sdk.FactSetQuantFactorLibrary-1.0.13 → fds.sdk.FactSetQuantFactorLibrary-1.1.0}/README.md
RENAMED
|
@@ -2,8 +2,8 @@
|
|
|
2
2
|
|
|
3
3
|
# FactSet Quant Factor Library client library for Python
|
|
4
4
|
|
|
5
|
-
[](https://pypi.org/project/fds.sdk.FactSetQuantFactorLibrary/)
|
|
5
|
+
[]()
|
|
6
|
+
[](https://pypi.org/project/fds.sdk.FactSetQuantFactorLibrary/v/1.1.0)
|
|
7
7
|
[](https://www.apache.org/licenses/LICENSE-2.0)
|
|
8
8
|
|
|
9
9
|
The FactSet FactSet Quant Factor Library (QFL) API helps to detect investment themes across global equity markets, incorporate ideas into your portfolio construction process, and transform raw data into actionable intelligence. Over 2000+ items spanning Factor Groups in-
|
|
@@ -16,8 +16,8 @@ The FactSet FactSet Quant Factor Library (QFL) API helps to detect investment th
|
|
|
16
16
|
|
|
17
17
|
This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
|
|
18
18
|
|
|
19
|
-
- API version: 1.0.
|
|
20
|
-
- SDK version: 1.0
|
|
19
|
+
- API version: 1.0.2
|
|
20
|
+
- SDK version: 1.1.0
|
|
21
21
|
- Build package: org.openapitools.codegen.languages.PythonClientCodegen
|
|
22
22
|
|
|
23
23
|
For more information, please visit [http://www.factset.com/api](http://www.factset.com/api)
|
|
@@ -31,13 +31,13 @@ For more information, please visit [http://www.factset.com/api](http://www.facts
|
|
|
31
31
|
### Poetry
|
|
32
32
|
|
|
33
33
|
```shell
|
|
34
|
-
poetry add fds.sdk.utils fds.sdk.FactSetQuantFactorLibrary==1.0
|
|
34
|
+
poetry add fds.sdk.utils fds.sdk.FactSetQuantFactorLibrary==1.1.0
|
|
35
35
|
```
|
|
36
36
|
|
|
37
37
|
### pip
|
|
38
38
|
|
|
39
39
|
```shell
|
|
40
|
-
pip install fds.sdk.utils fds.sdk.FactSetQuantFactorLibrary==1.0
|
|
40
|
+
pip install fds.sdk.utils fds.sdk.FactSetQuantFactorLibrary==1.1.0
|
|
41
41
|
```
|
|
42
42
|
|
|
43
43
|
## Usage
|
|
@@ -97,10 +97,12 @@ configuration = fds.sdk.FactSetQuantFactorLibrary.Configuration(
|
|
|
97
97
|
with fds.sdk.FactSetQuantFactorLibrary.ApiClient(configuration) as api_client:
|
|
98
98
|
# Create an instance of the API class
|
|
99
99
|
api_instance = factors_api.FactorsApi(api_client)
|
|
100
|
-
ids = ["
|
|
101
|
-
factors = ["rsi21D","ulcer252D","turbulence21D"] # [str] | Array of individual Factor Items requested. For a list of all available factors and descriptions use the `/library` endpoint.***<p>factors limit** = 20 individual factors per request*
|
|
100
|
+
ids = ["TSLA-US"] # [str] | Security or Entity identifiers. FactSet Identifiers, tickers, CUSIP and SEDOL are accepted as inputs. **NOTE:** Fixed Income identifiers, ETFs, and Options are not accepted in this endpoint. <p>***Maximum possible ids limit** = 3500 per request*</p> `NOTE:` *The maximum possible ids limit for a request will **decrease** based on the size of the historical date range, the number of factors or factorGroups requested.* *<p> 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>*
|
|
102
101
|
start_date = "2020-11-30" # str | The start date requested for a given date range in **YYYY-MM-DD** format. Future dates (T+1) are not accepted in this endpoint.
|
|
103
102
|
end_date = "2021-11-30" # str | The end date requested for a given date range in **YYYY-MM-DD** format. Future dates (T+1) are not accepted in this endpoint. **NOTE:** The input endDate must come AFTER the input startDate.
|
|
103
|
+
factors = [
|
|
104
|
+
"factors_example",
|
|
105
|
+
] # [str] | Array of individual Factor Items requested. For a list of all available factors and descriptions use the `/library` endpoint.***<p>factors limit** = 20 individual factors per request* (optional)
|
|
104
106
|
factor_groups = ["Momentum","Technical","Volatility"] # [str] | Fetch a collection of Factors that fall within one of the below \"groups\". For example, resting factorGroup=Momentum will return all factors under the momentum group. To know which items are available in each group use the /library endpoint.***<p>factor groups limit** = 5 factor groups per request* ### Classification and Reference |Group|Descriptions| |---|---| |Asset_Data|Easily input security-level metadata into your quantitative research process. Common metrics used include Days Since Report, Days to Report, ADR Flag, and Minimum Lot Size. Integrate variables from FactSet Reference, FactSet Fundamentals, and FactSet Estimates databases to impose portfolio constraints and access general reference data.| |Country|Evaluate securities based on the countries in which they have the highest exposure. Analyze company-level exposures across various countries and measure how concentrated a firm’s business is within their countries of operation. Metrics are derived from FactSet Reference and FactSet Geographic Revenue Exposure (GeoRev) databases and include Country Exposure, Country of Incorporation, and Country of Risk.| |Industry|Classify securities based on the industries in which they generate the majority of their revenues. Incorporate variables from the FactSet Revere Business and Industry Classification System (RBICS) database to measure how concentrated a firm’s business is within the industries they operate and across various sub-sectors. Common metrics include Industry Classifications, Industry Exposures, and Industry Concentration.| |Size|Assess how large or small a company is relative to industry peers. Create size buckets and clarify the systematic portion of company returns using variables from FactSet Prices, FactSet RBICS, FactSet Fundamentals, and FactSet Estimates. Common metrics include Size Classification, Enterprise Value, and Market Share.| ### Market Factors |Group|Descriptions| |---|---| |Liquidity|Assess how investible a security is, as well as the potential market impact of a trade using signals built off pricing and volume data from FactSet Prices. Integrate factors as components into your alpha models to evaluate systematic risk or input them into your portfolio construction models to dictate how much of an asset can be bought or sold based on liquidity levels. Common metrics include Average Dollars Traded, Share Turnover, and Bid Ask Spread.| |Market Sensitivity|Clarify the common variations in stock returns attributable to the performance of their local market indices. Leverage regressions performed between security-level and market-index returns across different return horizons and methodologies. Metrics are derived from FactSet Prices and include Beta R-Squared, Up Market Beta, and Down Market Beta.| |Momentum|Analyze the historical momentum of a security and uncover how each underlying data item, calculation, and horizon can be meaningful in different situations. Metrics are derived from FactSet Prices and include 52W Position, Return Momentum, and Velocity.| |Technical|Forecast the direction of future price movements based on historical market data and leverage heuristic or pattern-based signals from FactSet Prices. Common metrics include Average True Range, Ulcer Performance Index, and Money Flow Volume.| |Volatility|Measure the uncertainty in asset price movements with indicators from the FactSet Prices database. Capture various forms of uncertainty by employing statistical calculations on security performance data. Common metrics include Return Volatility, Semivariance, and Turbulence.| ### Core Fundamentals |Group|Descriptions| |---|---| |Efficiency|Leverage core financial data to determine how effectively a company uses its assets, collects payments, and operates its business. Most variables are measured as turnover ratios and include changes over time to provide transparency into the efficiency of each business process. Metrics are derived from FactSet Fundamentals and FactSet Estimates and include Asset Turnover, Receivables Turnover, and Cash Conversion Cycle| |Growth|Measure a company’s ability to grow faster than its peers. Compare the future expected growth of a company with its historical growth and view growth rates adjusted for stability. Integrate variables from FactSet RBICS, FactSet Fundamentals, and FactSet Estimates to analyze growth rates over multiple horizons including Market Share, Sales, and EPS Growth| |Management|Gain insight into how management finances their business and the decisions they make that impact the core financial statements. These choices are reflected in changes to total debt or equity, the overall size of the balance sheet, and decisions around the accounting methods used. Metrics are derived from FactSet Fundamentals and FactSet Estimates and include Capital Expenditures (CAPEX) Growth, Equity Buyback Ratio, and Depreciation & Amortization Variability| |Profitability|Evaluate a company’s ability to generate income relative to its revenue or balance sheet metrics. Identify lucrative businesses relative to their industry, region, and size profile. Metrics are derived from FactSet Fundamentals and FactSet Estimates and include Return on Assets, Return on Invested Capital Change, and Return on Total Equity |Quality|Understand the overall financial health and quality of a company’s business. Use historical data from FactSet Fundamentals to analyze balance sheet health, stability of earnings and profit margins, variability in cash flows, and trends that look beyond headline financial metrics. Common metrics include Cash Earnings Ratio Variability, Revenue Stability, and Accruals Ratios. Composite quality scores (i.e., the Piotroski F-Score, Beneish M-Score, and Altman Z-Score) and their underlying components are also available as individual metrics.| |Solvency|Measure a company’s ability to meet their short- and long-term financial obligations and determine the degree of leverage employed to run their business. Incorporate financial ratios from FactSet Fundamentals and FactSet Estimates to quantify liability or debt obligation relative to earnings, cash flows, equities, or items from the asset side of the balance sheet. Common metrics include Current Ratio, Current Asset Liquidity, and Debt to Equity Change.| |Value|Quickly determine how cheap or expensive a company is based on common security-level characteristics from FactSet Prices, FactSet Fundamentals, and FactSet Estimates. Apply factors as an intersection between other factors for a more customized analysis, such as finding the cheapest stocks among the highest quality companies. Common metrics include Earnings Yield, Book to Price, and Revenue to Enterprise Value.| ### Macro and Cross-Asset |Group|Descriptions| |---|---| |Commodity|Quantify the impact movements in the commodity markets have on equity prices. Metrics are derived from FactSet Prices and allow you to measure company-level exposure to commodities such as Gold, Crude Oil, Coffee, and Live Cattle.| |FX_Sensitivity| Analyze security-level sensitivity to fluctuations in the currency markets. Metrics are derived from FactSet Prices and allow you to identify company exposures to currencies such as USD, EUR, JPY, and CNY. |Debt|Uncover details related to company debt through issuer-level factor exposures. Use the FactSet Fixed Income Prices & Derived Analytics database to aggregate metrics at the company level. Common metrics include Effective Duration, Option Adjusted Spread, and Yield to Worst.| |Economic|Capture daily security exposures to leading economic indicator forecasts. Leverage the Quant Factor Library’s detailed country exposure model to attribute economic measures to individual companies. Metrics are derived from FactSet Economic Estimates and include Real GPD Growth, Industrial Production Growth, Core CPI Inflation, and Policy Rates. ### Alternative |Group|Descriptions| |---|---| |Analyst_Sentiment|Analyze a security’s outlook from the perspective of a sell-side research analyst. Leverage consensus estimates data from the FactSet Estimates database to analyze the directional change in estimate revisions for various financial statement items and time periods. Common metrics include Sales Estimate Revisions, Free Cash Flow Estimate Revisions, and Robust Estimate Revisions.| |Corporate_Governance|Identify companies with strong corporate governance. Analyze the profile of a company’s management and board based on tenure, diversity, compensation incentives, and more factors from the FactSet People database. Common metrics include Management - Average Age, Board - Activist Member, and Executives - Average Bonus.| |Crowding|Understand the degree to which investors own, purchase, or sell a security. View characteristics of each investor’s profile and characterize crowding from passive, active, institutional, ETF, and hedge fund investors. Use metrics from FactSet Ownership, FactSet Prices, and FactSet Fundamentals to help identify potential effects of crowding such as whether certain investor types are acquiring or divesting from a given security. Common metrics include Active Buyer Percent of Portfolio Change, ETF Days to Liquidate, and Hedge Fund Percent Outstanding.| |Insider_Activity|Measure the degree to which insiders own, purchase, or sell their company’s stock. Analyze the sentiment of those with access to material non-public information or determine how the amount of insider ownership may impact management’s key business decisions. Metrics are derived from FactSet Ownership and include Insider Percent Outstanding, Insider Number of Buys, and Insider Seller Position Change. |ESG|Analyze Environmental, Social and Governance (ESG) behavior, which are aggregated and categorized into continuously updated, material ESG scores to uncover risks and opportunities from companies. Truvalue Labs focuses on company ESG behavior from external sources and includes both positive and negative events that go beyond traditional sources of ESG risk data. (optional)
|
|
105
107
|
frequency = "M" # str | Controls the display frequency of the data returned. * **D** = Daily * **W** = Weekly, based on the last day of the week of the start date. * **M** = Monthly, based on the last trading day of the month. * **AM** = Monthly, based on the start date (e.g., if the start date is June 16, data is displayed for June 16, May 16, April 16 etc.). * **CQ** = Quarterly based on the last trading day of the calendar quarter (March, June, September, or December). * **AY** = Actual Annual, based on the start date. * **CY** = Calendar Annual, based on the last trading day of the calendar year. (optional) if omitted the server will use the default value of "M"
|
|
106
108
|
|
|
@@ -108,7 +110,7 @@ with fds.sdk.FactSetQuantFactorLibrary.ApiClient(configuration) as api_client:
|
|
|
108
110
|
# Retrieves Quant Factors for a small list of ids.
|
|
109
111
|
# example passing only required values which don't have defaults set
|
|
110
112
|
# and optional values
|
|
111
|
-
api_response = api_instance.get_factors(ids,
|
|
113
|
+
api_response = api_instance.get_factors(ids, start_date, end_date, factors=factors, factor_groups=factor_groups, frequency=frequency)
|
|
112
114
|
|
|
113
115
|
pprint(api_response)
|
|
114
116
|
except fds.sdk.FactSetQuantFactorLibrary.ApiException as e:
|
|
@@ -117,7 +119,7 @@ with fds.sdk.FactSetQuantFactorLibrary.ApiClient(configuration) as api_client:
|
|
|
117
119
|
# # Get response, http status code and response headers
|
|
118
120
|
# try:
|
|
119
121
|
# # Retrieves Quant Factors for a small list of ids.
|
|
120
|
-
# api_response, http_status_code, response_headers = api_instance.get_factors_with_http_info(ids,
|
|
122
|
+
# api_response, http_status_code, response_headers = api_instance.get_factors_with_http_info(ids, start_date, end_date, factors=factors, factor_groups=factor_groups, frequency=frequency)
|
|
121
123
|
|
|
122
124
|
|
|
123
125
|
# pprint(api_response)
|
|
@@ -129,7 +131,7 @@ with fds.sdk.FactSetQuantFactorLibrary.ApiClient(configuration) as api_client:
|
|
|
129
131
|
# # Get response asynchronous
|
|
130
132
|
# try:
|
|
131
133
|
# # Retrieves Quant Factors for a small list of ids.
|
|
132
|
-
# async_result = api_instance.get_factors_async(ids,
|
|
134
|
+
# async_result = api_instance.get_factors_async(ids, start_date, end_date, factors=factors, factor_groups=factor_groups, frequency=frequency)
|
|
133
135
|
# api_response = async_result.get()
|
|
134
136
|
|
|
135
137
|
|
|
@@ -140,7 +142,7 @@ with fds.sdk.FactSetQuantFactorLibrary.ApiClient(configuration) as api_client:
|
|
|
140
142
|
# # Get response, http status code and response headers asynchronous
|
|
141
143
|
# try:
|
|
142
144
|
# # Retrieves Quant Factors for a small list of ids.
|
|
143
|
-
# async_result = api_instance.get_factors_with_http_info_async(ids,
|
|
145
|
+
# async_result = api_instance.get_factors_with_http_info_async(ids, start_date, end_date, factors=factors, factor_groups=factor_groups, frequency=frequency)
|
|
144
146
|
# api_response, http_status_code, response_headers = async_result.get()
|
|
145
147
|
|
|
146
148
|
|
|
@@ -5,13 +5,13 @@
|
|
|
5
5
|
|
|
6
6
|
The FactSet FactSet Quant Factor Library (QFL) API helps to detect investment themes across global equity markets, incorporate ideas into your portfolio construction process, and transform raw data into actionable intelligence. Over 2000+ items spanning Factor Groups in- * Classification and Reference Data - Asset Data, Country, Industry, and Size * Market - Liquidity, Market Sensitivity, Momentum, Technical, Volatility * Core Fundamentals - Efficiency, Growth, Management, Profitability, Quality, Solvency, Value * Macro and Cross Asset - Commodity, FX Sensitivity, Debt, Economic * Alternative - Analyst Sentiment, Corporate Governance, Crowding, Insider Activity. # noqa: E501
|
|
7
7
|
|
|
8
|
-
The version of the OpenAPI document: 1.0.
|
|
8
|
+
The version of the OpenAPI document: 1.0.2
|
|
9
9
|
Contact: api@factset.com
|
|
10
10
|
Generated by: https://openapi-generator.tech
|
|
11
11
|
"""
|
|
12
12
|
|
|
13
13
|
|
|
14
|
-
__version__ = "1.0
|
|
14
|
+
__version__ = "1.1.0"
|
|
15
15
|
|
|
16
16
|
# import ApiClient
|
|
17
17
|
from fds.sdk.FactSetQuantFactorLibrary.api_client import ApiClient
|
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
|
|
4
4
|
The FactSet FactSet Quant Factor Library (QFL) API helps to detect investment themes across global equity markets, incorporate ideas into your portfolio construction process, and transform raw data into actionable intelligence. Over 2000+ items spanning Factor Groups in- * Classification and Reference Data - Asset Data, Country, Industry, and Size * Market - Liquidity, Market Sensitivity, Momentum, Technical, Volatility * Core Fundamentals - Efficiency, Growth, Management, Profitability, Quality, Solvency, Value * Macro and Cross Asset - Commodity, FX Sensitivity, Debt, Economic * Alternative - Analyst Sentiment, Corporate Governance, Crowding, Insider Activity. # noqa: E501
|
|
5
5
|
|
|
6
|
-
The version of the OpenAPI document: 1.0.
|
|
6
|
+
The version of the OpenAPI document: 1.0.2
|
|
7
7
|
Contact: api@factset.com
|
|
8
8
|
Generated by: https://openapi-generator.tech
|
|
9
9
|
"""
|
|
@@ -63,15 +63,14 @@ class FactorsApi(object):
|
|
|
63
63
|
params_map={
|
|
64
64
|
'all': [
|
|
65
65
|
'ids',
|
|
66
|
-
'factors',
|
|
67
66
|
'start_date',
|
|
68
67
|
'end_date',
|
|
68
|
+
'factors',
|
|
69
69
|
'factor_groups',
|
|
70
70
|
'frequency',
|
|
71
71
|
],
|
|
72
72
|
'required': [
|
|
73
73
|
'ids',
|
|
74
|
-
'factors',
|
|
75
74
|
'start_date',
|
|
76
75
|
'end_date',
|
|
77
76
|
],
|
|
@@ -120,12 +119,12 @@ class FactorsApi(object):
|
|
|
120
119
|
'openapi_types': {
|
|
121
120
|
'ids':
|
|
122
121
|
([str],),
|
|
123
|
-
'factors':
|
|
124
|
-
([str],),
|
|
125
122
|
'start_date':
|
|
126
123
|
(str,),
|
|
127
124
|
'end_date':
|
|
128
125
|
(str,),
|
|
126
|
+
'factors':
|
|
127
|
+
([str],),
|
|
129
128
|
'factor_groups':
|
|
130
129
|
([str],),
|
|
131
130
|
'frequency':
|
|
@@ -133,17 +132,17 @@ class FactorsApi(object):
|
|
|
133
132
|
},
|
|
134
133
|
'attribute_map': {
|
|
135
134
|
'ids': 'ids',
|
|
136
|
-
'factors': 'factors',
|
|
137
135
|
'start_date': 'startDate',
|
|
138
136
|
'end_date': 'endDate',
|
|
137
|
+
'factors': 'factors',
|
|
139
138
|
'factor_groups': 'factorGroups',
|
|
140
139
|
'frequency': 'frequency',
|
|
141
140
|
},
|
|
142
141
|
'location_map': {
|
|
143
142
|
'ids': 'query',
|
|
144
|
-
'factors': 'query',
|
|
145
143
|
'start_date': 'query',
|
|
146
144
|
'end_date': 'query',
|
|
145
|
+
'factors': 'query',
|
|
147
146
|
'factor_groups': 'query',
|
|
148
147
|
'frequency': 'query',
|
|
149
148
|
},
|
|
@@ -236,7 +235,6 @@ class FactorsApi(object):
|
|
|
236
235
|
def get_factors(
|
|
237
236
|
self,
|
|
238
237
|
ids,
|
|
239
|
-
factors,
|
|
240
238
|
start_date,
|
|
241
239
|
end_date,
|
|
242
240
|
**kwargs
|
|
@@ -248,11 +246,11 @@ class FactorsApi(object):
|
|
|
248
246
|
|
|
249
247
|
Args:
|
|
250
248
|
ids ([str]): Security or Entity identifiers. FactSet Identifiers, tickers, CUSIP and SEDOL are accepted as inputs. **NOTE:** Fixed Income identifiers, ETFs, and Options are not accepted in this endpoint. <p>***Maximum possible ids limit** = 3500 per request*</p> `NOTE:` *The maximum possible ids limit for a request will **decrease** based on the size of the historical date range, the number of factors or factorGroups requested.* *<p> 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>*
|
|
251
|
-
factors ([str]): Array of individual Factor Items requested. For a list of all available factors and descriptions use the `/library` endpoint.***<p>factors limit** = 20 individual factors per request*
|
|
252
249
|
start_date (str): The start date requested for a given date range in **YYYY-MM-DD** format. Future dates (T+1) are not accepted in this endpoint.
|
|
253
250
|
end_date (str): The end date requested for a given date range in **YYYY-MM-DD** format. Future dates (T+1) are not accepted in this endpoint. **NOTE:** The input endDate must come AFTER the input startDate.
|
|
254
251
|
|
|
255
252
|
Keyword Args:
|
|
253
|
+
factors ([str]): Array of individual Factor Items requested. For a list of all available factors and descriptions use the `/library` endpoint.***<p>factors limit** = 20 individual factors per request* . [optional]
|
|
256
254
|
factor_groups ([str]): Fetch a collection of Factors that fall within one of the below \"groups\". For example, resting factorGroup=Momentum will return all factors under the momentum group. To know which items are available in each group use the /library endpoint.***<p>factor groups limit** = 5 factor groups per request* ### Classification and Reference |Group|Descriptions| |---|---| |Asset_Data|Easily input security-level metadata into your quantitative research process. Common metrics used include Days Since Report, Days to Report, ADR Flag, and Minimum Lot Size. Integrate variables from FactSet Reference, FactSet Fundamentals, and FactSet Estimates databases to impose portfolio constraints and access general reference data.| |Country|Evaluate securities based on the countries in which they have the highest exposure. Analyze company-level exposures across various countries and measure how concentrated a firm’s business is within their countries of operation. Metrics are derived from FactSet Reference and FactSet Geographic Revenue Exposure (GeoRev) databases and include Country Exposure, Country of Incorporation, and Country of Risk.| |Industry|Classify securities based on the industries in which they generate the majority of their revenues. Incorporate variables from the FactSet Revere Business and Industry Classification System (RBICS) database to measure how concentrated a firm’s business is within the industries they operate and across various sub-sectors. Common metrics include Industry Classifications, Industry Exposures, and Industry Concentration.| |Size|Assess how large or small a company is relative to industry peers. Create size buckets and clarify the systematic portion of company returns using variables from FactSet Prices, FactSet RBICS, FactSet Fundamentals, and FactSet Estimates. Common metrics include Size Classification, Enterprise Value, and Market Share.| ### Market Factors |Group|Descriptions| |---|---| |Liquidity|Assess how investible a security is, as well as the potential market impact of a trade using signals built off pricing and volume data from FactSet Prices. Integrate factors as components into your alpha models to evaluate systematic risk or input them into your portfolio construction models to dictate how much of an asset can be bought or sold based on liquidity levels. Common metrics include Average Dollars Traded, Share Turnover, and Bid Ask Spread.| |Market Sensitivity|Clarify the common variations in stock returns attributable to the performance of their local market indices. Leverage regressions performed between security-level and market-index returns across different return horizons and methodologies. Metrics are derived from FactSet Prices and include Beta R-Squared, Up Market Beta, and Down Market Beta.| |Momentum|Analyze the historical momentum of a security and uncover how each underlying data item, calculation, and horizon can be meaningful in different situations. Metrics are derived from FactSet Prices and include 52W Position, Return Momentum, and Velocity.| |Technical|Forecast the direction of future price movements based on historical market data and leverage heuristic or pattern-based signals from FactSet Prices. Common metrics include Average True Range, Ulcer Performance Index, and Money Flow Volume.| |Volatility|Measure the uncertainty in asset price movements with indicators from the FactSet Prices database. Capture various forms of uncertainty by employing statistical calculations on security performance data. Common metrics include Return Volatility, Semivariance, and Turbulence.| ### Core Fundamentals |Group|Descriptions| |---|---| |Efficiency|Leverage core financial data to determine how effectively a company uses its assets, collects payments, and operates its business. Most variables are measured as turnover ratios and include changes over time to provide transparency into the efficiency of each business process. Metrics are derived from FactSet Fundamentals and FactSet Estimates and include Asset Turnover, Receivables Turnover, and Cash Conversion Cycle| |Growth|Measure a company’s ability to grow faster than its peers. Compare the future expected growth of a company with its historical growth and view growth rates adjusted for stability. Integrate variables from FactSet RBICS, FactSet Fundamentals, and FactSet Estimates to analyze growth rates over multiple horizons including Market Share, Sales, and EPS Growth| |Management|Gain insight into how management finances their business and the decisions they make that impact the core financial statements. These choices are reflected in changes to total debt or equity, the overall size of the balance sheet, and decisions around the accounting methods used. Metrics are derived from FactSet Fundamentals and FactSet Estimates and include Capital Expenditures (CAPEX) Growth, Equity Buyback Ratio, and Depreciation & Amortization Variability| |Profitability|Evaluate a company’s ability to generate income relative to its revenue or balance sheet metrics. Identify lucrative businesses relative to their industry, region, and size profile. Metrics are derived from FactSet Fundamentals and FactSet Estimates and include Return on Assets, Return on Invested Capital Change, and Return on Total Equity |Quality|Understand the overall financial health and quality of a company’s business. Use historical data from FactSet Fundamentals to analyze balance sheet health, stability of earnings and profit margins, variability in cash flows, and trends that look beyond headline financial metrics. Common metrics include Cash Earnings Ratio Variability, Revenue Stability, and Accruals Ratios. Composite quality scores (i.e., the Piotroski F-Score, Beneish M-Score, and Altman Z-Score) and their underlying components are also available as individual metrics.| |Solvency|Measure a company’s ability to meet their short- and long-term financial obligations and determine the degree of leverage employed to run their business. Incorporate financial ratios from FactSet Fundamentals and FactSet Estimates to quantify liability or debt obligation relative to earnings, cash flows, equities, or items from the asset side of the balance sheet. Common metrics include Current Ratio, Current Asset Liquidity, and Debt to Equity Change.| |Value|Quickly determine how cheap or expensive a company is based on common security-level characteristics from FactSet Prices, FactSet Fundamentals, and FactSet Estimates. Apply factors as an intersection between other factors for a more customized analysis, such as finding the cheapest stocks among the highest quality companies. Common metrics include Earnings Yield, Book to Price, and Revenue to Enterprise Value.| ### Macro and Cross-Asset |Group|Descriptions| |---|---| |Commodity|Quantify the impact movements in the commodity markets have on equity prices. Metrics are derived from FactSet Prices and allow you to measure company-level exposure to commodities such as Gold, Crude Oil, Coffee, and Live Cattle.| |FX_Sensitivity| Analyze security-level sensitivity to fluctuations in the currency markets. Metrics are derived from FactSet Prices and allow you to identify company exposures to currencies such as USD, EUR, JPY, and CNY. |Debt|Uncover details related to company debt through issuer-level factor exposures. Use the FactSet Fixed Income Prices & Derived Analytics database to aggregate metrics at the company level. Common metrics include Effective Duration, Option Adjusted Spread, and Yield to Worst.| |Economic|Capture daily security exposures to leading economic indicator forecasts. Leverage the Quant Factor Library’s detailed country exposure model to attribute economic measures to individual companies. Metrics are derived from FactSet Economic Estimates and include Real GPD Growth, Industrial Production Growth, Core CPI Inflation, and Policy Rates. ### Alternative |Group|Descriptions| |---|---| |Analyst_Sentiment|Analyze a security’s outlook from the perspective of a sell-side research analyst. Leverage consensus estimates data from the FactSet Estimates database to analyze the directional change in estimate revisions for various financial statement items and time periods. Common metrics include Sales Estimate Revisions, Free Cash Flow Estimate Revisions, and Robust Estimate Revisions.| |Corporate_Governance|Identify companies with strong corporate governance. Analyze the profile of a company’s management and board based on tenure, diversity, compensation incentives, and more factors from the FactSet People database. Common metrics include Management - Average Age, Board - Activist Member, and Executives - Average Bonus.| |Crowding|Understand the degree to which investors own, purchase, or sell a security. View characteristics of each investor’s profile and characterize crowding from passive, active, institutional, ETF, and hedge fund investors. Use metrics from FactSet Ownership, FactSet Prices, and FactSet Fundamentals to help identify potential effects of crowding such as whether certain investor types are acquiring or divesting from a given security. Common metrics include Active Buyer Percent of Portfolio Change, ETF Days to Liquidate, and Hedge Fund Percent Outstanding.| |Insider_Activity|Measure the degree to which insiders own, purchase, or sell their company’s stock. Analyze the sentiment of those with access to material non-public information or determine how the amount of insider ownership may impact management’s key business decisions. Metrics are derived from FactSet Ownership and include Insider Percent Outstanding, Insider Number of Buys, and Insider Seller Position Change. |ESG|Analyze Environmental, Social and Governance (ESG) behavior, which are aggregated and categorized into continuously updated, material ESG scores to uncover risks and opportunities from companies. Truvalue Labs focuses on company ESG behavior from external sources and includes both positive and negative events that go beyond traditional sources of ESG risk data. . [optional]
|
|
257
255
|
frequency (str): Controls the display frequency of the data returned. * **D** = Daily * **W** = Weekly, based on the last day of the week of the start date. * **M** = Monthly, based on the last trading day of the month. * **AM** = Monthly, based on the start date (e.g., if the start date is June 16, data is displayed for June 16, May 16, April 16 etc.). * **CQ** = Quarterly based on the last trading day of the calendar quarter (March, June, September, or December). * **AY** = Actual Annual, based on the start date. * **CY** = Calendar Annual, based on the last trading day of the calendar year. . [optional] if omitted the server will use the default value of "M"
|
|
258
256
|
_preload_content (bool): if False, the urllib3.HTTPResponse object
|
|
@@ -286,8 +284,6 @@ class FactorsApi(object):
|
|
|
286
284
|
self.apply_kwargs_defaults(kwargs=kwargs, return_http_data_only=True, async_req=False)
|
|
287
285
|
kwargs['ids'] = \
|
|
288
286
|
ids
|
|
289
|
-
kwargs['factors'] = \
|
|
290
|
-
factors
|
|
291
287
|
kwargs['start_date'] = \
|
|
292
288
|
start_date
|
|
293
289
|
kwargs['end_date'] = \
|
|
@@ -297,7 +293,6 @@ class FactorsApi(object):
|
|
|
297
293
|
def get_factors_with_http_info(
|
|
298
294
|
self,
|
|
299
295
|
ids,
|
|
300
|
-
factors,
|
|
301
296
|
start_date,
|
|
302
297
|
end_date,
|
|
303
298
|
**kwargs
|
|
@@ -309,11 +304,11 @@ class FactorsApi(object):
|
|
|
309
304
|
|
|
310
305
|
Args:
|
|
311
306
|
ids ([str]): Security or Entity identifiers. FactSet Identifiers, tickers, CUSIP and SEDOL are accepted as inputs. **NOTE:** Fixed Income identifiers, ETFs, and Options are not accepted in this endpoint. <p>***Maximum possible ids limit** = 3500 per request*</p> `NOTE:` *The maximum possible ids limit for a request will **decrease** based on the size of the historical date range, the number of factors or factorGroups requested.* *<p> 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>*
|
|
312
|
-
factors ([str]): Array of individual Factor Items requested. For a list of all available factors and descriptions use the `/library` endpoint.***<p>factors limit** = 20 individual factors per request*
|
|
313
307
|
start_date (str): The start date requested for a given date range in **YYYY-MM-DD** format. Future dates (T+1) are not accepted in this endpoint.
|
|
314
308
|
end_date (str): The end date requested for a given date range in **YYYY-MM-DD** format. Future dates (T+1) are not accepted in this endpoint. **NOTE:** The input endDate must come AFTER the input startDate.
|
|
315
309
|
|
|
316
310
|
Keyword Args:
|
|
311
|
+
factors ([str]): Array of individual Factor Items requested. For a list of all available factors and descriptions use the `/library` endpoint.***<p>factors limit** = 20 individual factors per request* . [optional]
|
|
317
312
|
factor_groups ([str]): Fetch a collection of Factors that fall within one of the below \"groups\". For example, resting factorGroup=Momentum will return all factors under the momentum group. To know which items are available in each group use the /library endpoint.***<p>factor groups limit** = 5 factor groups per request* ### Classification and Reference |Group|Descriptions| |---|---| |Asset_Data|Easily input security-level metadata into your quantitative research process. Common metrics used include Days Since Report, Days to Report, ADR Flag, and Minimum Lot Size. Integrate variables from FactSet Reference, FactSet Fundamentals, and FactSet Estimates databases to impose portfolio constraints and access general reference data.| |Country|Evaluate securities based on the countries in which they have the highest exposure. Analyze company-level exposures across various countries and measure how concentrated a firm’s business is within their countries of operation. Metrics are derived from FactSet Reference and FactSet Geographic Revenue Exposure (GeoRev) databases and include Country Exposure, Country of Incorporation, and Country of Risk.| |Industry|Classify securities based on the industries in which they generate the majority of their revenues. Incorporate variables from the FactSet Revere Business and Industry Classification System (RBICS) database to measure how concentrated a firm’s business is within the industries they operate and across various sub-sectors. Common metrics include Industry Classifications, Industry Exposures, and Industry Concentration.| |Size|Assess how large or small a company is relative to industry peers. Create size buckets and clarify the systematic portion of company returns using variables from FactSet Prices, FactSet RBICS, FactSet Fundamentals, and FactSet Estimates. Common metrics include Size Classification, Enterprise Value, and Market Share.| ### Market Factors |Group|Descriptions| |---|---| |Liquidity|Assess how investible a security is, as well as the potential market impact of a trade using signals built off pricing and volume data from FactSet Prices. Integrate factors as components into your alpha models to evaluate systematic risk or input them into your portfolio construction models to dictate how much of an asset can be bought or sold based on liquidity levels. Common metrics include Average Dollars Traded, Share Turnover, and Bid Ask Spread.| |Market Sensitivity|Clarify the common variations in stock returns attributable to the performance of their local market indices. Leverage regressions performed between security-level and market-index returns across different return horizons and methodologies. Metrics are derived from FactSet Prices and include Beta R-Squared, Up Market Beta, and Down Market Beta.| |Momentum|Analyze the historical momentum of a security and uncover how each underlying data item, calculation, and horizon can be meaningful in different situations. Metrics are derived from FactSet Prices and include 52W Position, Return Momentum, and Velocity.| |Technical|Forecast the direction of future price movements based on historical market data and leverage heuristic or pattern-based signals from FactSet Prices. Common metrics include Average True Range, Ulcer Performance Index, and Money Flow Volume.| |Volatility|Measure the uncertainty in asset price movements with indicators from the FactSet Prices database. Capture various forms of uncertainty by employing statistical calculations on security performance data. Common metrics include Return Volatility, Semivariance, and Turbulence.| ### Core Fundamentals |Group|Descriptions| |---|---| |Efficiency|Leverage core financial data to determine how effectively a company uses its assets, collects payments, and operates its business. Most variables are measured as turnover ratios and include changes over time to provide transparency into the efficiency of each business process. Metrics are derived from FactSet Fundamentals and FactSet Estimates and include Asset Turnover, Receivables Turnover, and Cash Conversion Cycle| |Growth|Measure a company’s ability to grow faster than its peers. Compare the future expected growth of a company with its historical growth and view growth rates adjusted for stability. Integrate variables from FactSet RBICS, FactSet Fundamentals, and FactSet Estimates to analyze growth rates over multiple horizons including Market Share, Sales, and EPS Growth| |Management|Gain insight into how management finances their business and the decisions they make that impact the core financial statements. These choices are reflected in changes to total debt or equity, the overall size of the balance sheet, and decisions around the accounting methods used. Metrics are derived from FactSet Fundamentals and FactSet Estimates and include Capital Expenditures (CAPEX) Growth, Equity Buyback Ratio, and Depreciation & Amortization Variability| |Profitability|Evaluate a company’s ability to generate income relative to its revenue or balance sheet metrics. Identify lucrative businesses relative to their industry, region, and size profile. Metrics are derived from FactSet Fundamentals and FactSet Estimates and include Return on Assets, Return on Invested Capital Change, and Return on Total Equity |Quality|Understand the overall financial health and quality of a company’s business. Use historical data from FactSet Fundamentals to analyze balance sheet health, stability of earnings and profit margins, variability in cash flows, and trends that look beyond headline financial metrics. Common metrics include Cash Earnings Ratio Variability, Revenue Stability, and Accruals Ratios. Composite quality scores (i.e., the Piotroski F-Score, Beneish M-Score, and Altman Z-Score) and their underlying components are also available as individual metrics.| |Solvency|Measure a company’s ability to meet their short- and long-term financial obligations and determine the degree of leverage employed to run their business. Incorporate financial ratios from FactSet Fundamentals and FactSet Estimates to quantify liability or debt obligation relative to earnings, cash flows, equities, or items from the asset side of the balance sheet. Common metrics include Current Ratio, Current Asset Liquidity, and Debt to Equity Change.| |Value|Quickly determine how cheap or expensive a company is based on common security-level characteristics from FactSet Prices, FactSet Fundamentals, and FactSet Estimates. Apply factors as an intersection between other factors for a more customized analysis, such as finding the cheapest stocks among the highest quality companies. Common metrics include Earnings Yield, Book to Price, and Revenue to Enterprise Value.| ### Macro and Cross-Asset |Group|Descriptions| |---|---| |Commodity|Quantify the impact movements in the commodity markets have on equity prices. Metrics are derived from FactSet Prices and allow you to measure company-level exposure to commodities such as Gold, Crude Oil, Coffee, and Live Cattle.| |FX_Sensitivity| Analyze security-level sensitivity to fluctuations in the currency markets. Metrics are derived from FactSet Prices and allow you to identify company exposures to currencies such as USD, EUR, JPY, and CNY. |Debt|Uncover details related to company debt through issuer-level factor exposures. Use the FactSet Fixed Income Prices & Derived Analytics database to aggregate metrics at the company level. Common metrics include Effective Duration, Option Adjusted Spread, and Yield to Worst.| |Economic|Capture daily security exposures to leading economic indicator forecasts. Leverage the Quant Factor Library’s detailed country exposure model to attribute economic measures to individual companies. Metrics are derived from FactSet Economic Estimates and include Real GPD Growth, Industrial Production Growth, Core CPI Inflation, and Policy Rates. ### Alternative |Group|Descriptions| |---|---| |Analyst_Sentiment|Analyze a security’s outlook from the perspective of a sell-side research analyst. Leverage consensus estimates data from the FactSet Estimates database to analyze the directional change in estimate revisions for various financial statement items and time periods. Common metrics include Sales Estimate Revisions, Free Cash Flow Estimate Revisions, and Robust Estimate Revisions.| |Corporate_Governance|Identify companies with strong corporate governance. Analyze the profile of a company’s management and board based on tenure, diversity, compensation incentives, and more factors from the FactSet People database. Common metrics include Management - Average Age, Board - Activist Member, and Executives - Average Bonus.| |Crowding|Understand the degree to which investors own, purchase, or sell a security. View characteristics of each investor’s profile and characterize crowding from passive, active, institutional, ETF, and hedge fund investors. Use metrics from FactSet Ownership, FactSet Prices, and FactSet Fundamentals to help identify potential effects of crowding such as whether certain investor types are acquiring or divesting from a given security. Common metrics include Active Buyer Percent of Portfolio Change, ETF Days to Liquidate, and Hedge Fund Percent Outstanding.| |Insider_Activity|Measure the degree to which insiders own, purchase, or sell their company’s stock. Analyze the sentiment of those with access to material non-public information or determine how the amount of insider ownership may impact management’s key business decisions. Metrics are derived from FactSet Ownership and include Insider Percent Outstanding, Insider Number of Buys, and Insider Seller Position Change. |ESG|Analyze Environmental, Social and Governance (ESG) behavior, which are aggregated and categorized into continuously updated, material ESG scores to uncover risks and opportunities from companies. Truvalue Labs focuses on company ESG behavior from external sources and includes both positive and negative events that go beyond traditional sources of ESG risk data. . [optional]
|
|
318
313
|
frequency (str): Controls the display frequency of the data returned. * **D** = Daily * **W** = Weekly, based on the last day of the week of the start date. * **M** = Monthly, based on the last trading day of the month. * **AM** = Monthly, based on the start date (e.g., if the start date is June 16, data is displayed for June 16, May 16, April 16 etc.). * **CQ** = Quarterly based on the last trading day of the calendar quarter (March, June, September, or December). * **AY** = Actual Annual, based on the start date. * **CY** = Calendar Annual, based on the last trading day of the calendar year. . [optional] if omitted the server will use the default value of "M"
|
|
319
314
|
_preload_content (bool): if False, the urllib3.HTTPResponse object
|
|
@@ -351,8 +346,6 @@ class FactorsApi(object):
|
|
|
351
346
|
self.apply_kwargs_defaults(kwargs=kwargs, return_http_data_only=False, async_req=False)
|
|
352
347
|
kwargs['ids'] = \
|
|
353
348
|
ids
|
|
354
|
-
kwargs['factors'] = \
|
|
355
|
-
factors
|
|
356
349
|
kwargs['start_date'] = \
|
|
357
350
|
start_date
|
|
358
351
|
kwargs['end_date'] = \
|
|
@@ -362,7 +355,6 @@ class FactorsApi(object):
|
|
|
362
355
|
def get_factors_async(
|
|
363
356
|
self,
|
|
364
357
|
ids,
|
|
365
|
-
factors,
|
|
366
358
|
start_date,
|
|
367
359
|
end_date,
|
|
368
360
|
**kwargs
|
|
@@ -374,11 +366,11 @@ class FactorsApi(object):
|
|
|
374
366
|
|
|
375
367
|
Args:
|
|
376
368
|
ids ([str]): Security or Entity identifiers. FactSet Identifiers, tickers, CUSIP and SEDOL are accepted as inputs. **NOTE:** Fixed Income identifiers, ETFs, and Options are not accepted in this endpoint. <p>***Maximum possible ids limit** = 3500 per request*</p> `NOTE:` *The maximum possible ids limit for a request will **decrease** based on the size of the historical date range, the number of factors or factorGroups requested.* *<p> 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>*
|
|
377
|
-
factors ([str]): Array of individual Factor Items requested. For a list of all available factors and descriptions use the `/library` endpoint.***<p>factors limit** = 20 individual factors per request*
|
|
378
369
|
start_date (str): The start date requested for a given date range in **YYYY-MM-DD** format. Future dates (T+1) are not accepted in this endpoint.
|
|
379
370
|
end_date (str): The end date requested for a given date range in **YYYY-MM-DD** format. Future dates (T+1) are not accepted in this endpoint. **NOTE:** The input endDate must come AFTER the input startDate.
|
|
380
371
|
|
|
381
372
|
Keyword Args:
|
|
373
|
+
factors ([str]): Array of individual Factor Items requested. For a list of all available factors and descriptions use the `/library` endpoint.***<p>factors limit** = 20 individual factors per request* . [optional]
|
|
382
374
|
factor_groups ([str]): Fetch a collection of Factors that fall within one of the below \"groups\". For example, resting factorGroup=Momentum will return all factors under the momentum group. To know which items are available in each group use the /library endpoint.***<p>factor groups limit** = 5 factor groups per request* ### Classification and Reference |Group|Descriptions| |---|---| |Asset_Data|Easily input security-level metadata into your quantitative research process. Common metrics used include Days Since Report, Days to Report, ADR Flag, and Minimum Lot Size. Integrate variables from FactSet Reference, FactSet Fundamentals, and FactSet Estimates databases to impose portfolio constraints and access general reference data.| |Country|Evaluate securities based on the countries in which they have the highest exposure. Analyze company-level exposures across various countries and measure how concentrated a firm’s business is within their countries of operation. Metrics are derived from FactSet Reference and FactSet Geographic Revenue Exposure (GeoRev) databases and include Country Exposure, Country of Incorporation, and Country of Risk.| |Industry|Classify securities based on the industries in which they generate the majority of their revenues. Incorporate variables from the FactSet Revere Business and Industry Classification System (RBICS) database to measure how concentrated a firm’s business is within the industries they operate and across various sub-sectors. Common metrics include Industry Classifications, Industry Exposures, and Industry Concentration.| |Size|Assess how large or small a company is relative to industry peers. Create size buckets and clarify the systematic portion of company returns using variables from FactSet Prices, FactSet RBICS, FactSet Fundamentals, and FactSet Estimates. Common metrics include Size Classification, Enterprise Value, and Market Share.| ### Market Factors |Group|Descriptions| |---|---| |Liquidity|Assess how investible a security is, as well as the potential market impact of a trade using signals built off pricing and volume data from FactSet Prices. Integrate factors as components into your alpha models to evaluate systematic risk or input them into your portfolio construction models to dictate how much of an asset can be bought or sold based on liquidity levels. Common metrics include Average Dollars Traded, Share Turnover, and Bid Ask Spread.| |Market Sensitivity|Clarify the common variations in stock returns attributable to the performance of their local market indices. Leverage regressions performed between security-level and market-index returns across different return horizons and methodologies. Metrics are derived from FactSet Prices and include Beta R-Squared, Up Market Beta, and Down Market Beta.| |Momentum|Analyze the historical momentum of a security and uncover how each underlying data item, calculation, and horizon can be meaningful in different situations. Metrics are derived from FactSet Prices and include 52W Position, Return Momentum, and Velocity.| |Technical|Forecast the direction of future price movements based on historical market data and leverage heuristic or pattern-based signals from FactSet Prices. Common metrics include Average True Range, Ulcer Performance Index, and Money Flow Volume.| |Volatility|Measure the uncertainty in asset price movements with indicators from the FactSet Prices database. Capture various forms of uncertainty by employing statistical calculations on security performance data. Common metrics include Return Volatility, Semivariance, and Turbulence.| ### Core Fundamentals |Group|Descriptions| |---|---| |Efficiency|Leverage core financial data to determine how effectively a company uses its assets, collects payments, and operates its business. Most variables are measured as turnover ratios and include changes over time to provide transparency into the efficiency of each business process. Metrics are derived from FactSet Fundamentals and FactSet Estimates and include Asset Turnover, Receivables Turnover, and Cash Conversion Cycle| |Growth|Measure a company’s ability to grow faster than its peers. Compare the future expected growth of a company with its historical growth and view growth rates adjusted for stability. Integrate variables from FactSet RBICS, FactSet Fundamentals, and FactSet Estimates to analyze growth rates over multiple horizons including Market Share, Sales, and EPS Growth| |Management|Gain insight into how management finances their business and the decisions they make that impact the core financial statements. These choices are reflected in changes to total debt or equity, the overall size of the balance sheet, and decisions around the accounting methods used. Metrics are derived from FactSet Fundamentals and FactSet Estimates and include Capital Expenditures (CAPEX) Growth, Equity Buyback Ratio, and Depreciation & Amortization Variability| |Profitability|Evaluate a company’s ability to generate income relative to its revenue or balance sheet metrics. Identify lucrative businesses relative to their industry, region, and size profile. Metrics are derived from FactSet Fundamentals and FactSet Estimates and include Return on Assets, Return on Invested Capital Change, and Return on Total Equity |Quality|Understand the overall financial health and quality of a company’s business. Use historical data from FactSet Fundamentals to analyze balance sheet health, stability of earnings and profit margins, variability in cash flows, and trends that look beyond headline financial metrics. Common metrics include Cash Earnings Ratio Variability, Revenue Stability, and Accruals Ratios. Composite quality scores (i.e., the Piotroski F-Score, Beneish M-Score, and Altman Z-Score) and their underlying components are also available as individual metrics.| |Solvency|Measure a company’s ability to meet their short- and long-term financial obligations and determine the degree of leverage employed to run their business. Incorporate financial ratios from FactSet Fundamentals and FactSet Estimates to quantify liability or debt obligation relative to earnings, cash flows, equities, or items from the asset side of the balance sheet. Common metrics include Current Ratio, Current Asset Liquidity, and Debt to Equity Change.| |Value|Quickly determine how cheap or expensive a company is based on common security-level characteristics from FactSet Prices, FactSet Fundamentals, and FactSet Estimates. Apply factors as an intersection between other factors for a more customized analysis, such as finding the cheapest stocks among the highest quality companies. Common metrics include Earnings Yield, Book to Price, and Revenue to Enterprise Value.| ### Macro and Cross-Asset |Group|Descriptions| |---|---| |Commodity|Quantify the impact movements in the commodity markets have on equity prices. Metrics are derived from FactSet Prices and allow you to measure company-level exposure to commodities such as Gold, Crude Oil, Coffee, and Live Cattle.| |FX_Sensitivity| Analyze security-level sensitivity to fluctuations in the currency markets. Metrics are derived from FactSet Prices and allow you to identify company exposures to currencies such as USD, EUR, JPY, and CNY. |Debt|Uncover details related to company debt through issuer-level factor exposures. Use the FactSet Fixed Income Prices & Derived Analytics database to aggregate metrics at the company level. Common metrics include Effective Duration, Option Adjusted Spread, and Yield to Worst.| |Economic|Capture daily security exposures to leading economic indicator forecasts. Leverage the Quant Factor Library’s detailed country exposure model to attribute economic measures to individual companies. Metrics are derived from FactSet Economic Estimates and include Real GPD Growth, Industrial Production Growth, Core CPI Inflation, and Policy Rates. ### Alternative |Group|Descriptions| |---|---| |Analyst_Sentiment|Analyze a security’s outlook from the perspective of a sell-side research analyst. Leverage consensus estimates data from the FactSet Estimates database to analyze the directional change in estimate revisions for various financial statement items and time periods. Common metrics include Sales Estimate Revisions, Free Cash Flow Estimate Revisions, and Robust Estimate Revisions.| |Corporate_Governance|Identify companies with strong corporate governance. Analyze the profile of a company’s management and board based on tenure, diversity, compensation incentives, and more factors from the FactSet People database. Common metrics include Management - Average Age, Board - Activist Member, and Executives - Average Bonus.| |Crowding|Understand the degree to which investors own, purchase, or sell a security. View characteristics of each investor’s profile and characterize crowding from passive, active, institutional, ETF, and hedge fund investors. Use metrics from FactSet Ownership, FactSet Prices, and FactSet Fundamentals to help identify potential effects of crowding such as whether certain investor types are acquiring or divesting from a given security. Common metrics include Active Buyer Percent of Portfolio Change, ETF Days to Liquidate, and Hedge Fund Percent Outstanding.| |Insider_Activity|Measure the degree to which insiders own, purchase, or sell their company’s stock. Analyze the sentiment of those with access to material non-public information or determine how the amount of insider ownership may impact management’s key business decisions. Metrics are derived from FactSet Ownership and include Insider Percent Outstanding, Insider Number of Buys, and Insider Seller Position Change. |ESG|Analyze Environmental, Social and Governance (ESG) behavior, which are aggregated and categorized into continuously updated, material ESG scores to uncover risks and opportunities from companies. Truvalue Labs focuses on company ESG behavior from external sources and includes both positive and negative events that go beyond traditional sources of ESG risk data. . [optional]
|
|
383
375
|
frequency (str): Controls the display frequency of the data returned. * **D** = Daily * **W** = Weekly, based on the last day of the week of the start date. * **M** = Monthly, based on the last trading day of the month. * **AM** = Monthly, based on the start date (e.g., if the start date is June 16, data is displayed for June 16, May 16, April 16 etc.). * **CQ** = Quarterly based on the last trading day of the calendar quarter (March, June, September, or December). * **AY** = Actual Annual, based on the start date. * **CY** = Calendar Annual, based on the last trading day of the calendar year. . [optional] if omitted the server will use the default value of "M"
|
|
384
376
|
_preload_content (bool): if False, the urllib3.HTTPResponse object
|
|
@@ -411,8 +403,6 @@ class FactorsApi(object):
|
|
|
411
403
|
self.apply_kwargs_defaults(kwargs=kwargs, return_http_data_only=True, async_req=True)
|
|
412
404
|
kwargs['ids'] = \
|
|
413
405
|
ids
|
|
414
|
-
kwargs['factors'] = \
|
|
415
|
-
factors
|
|
416
406
|
kwargs['start_date'] = \
|
|
417
407
|
start_date
|
|
418
408
|
kwargs['end_date'] = \
|
|
@@ -422,7 +412,6 @@ class FactorsApi(object):
|
|
|
422
412
|
def get_factors_with_http_info_async(
|
|
423
413
|
self,
|
|
424
414
|
ids,
|
|
425
|
-
factors,
|
|
426
415
|
start_date,
|
|
427
416
|
end_date,
|
|
428
417
|
**kwargs
|
|
@@ -434,11 +423,11 @@ class FactorsApi(object):
|
|
|
434
423
|
|
|
435
424
|
Args:
|
|
436
425
|
ids ([str]): Security or Entity identifiers. FactSet Identifiers, tickers, CUSIP and SEDOL are accepted as inputs. **NOTE:** Fixed Income identifiers, ETFs, and Options are not accepted in this endpoint. <p>***Maximum possible ids limit** = 3500 per request*</p> `NOTE:` *The maximum possible ids limit for a request will **decrease** based on the size of the historical date range, the number of factors or factorGroups requested.* *<p> 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>*
|
|
437
|
-
factors ([str]): Array of individual Factor Items requested. For a list of all available factors and descriptions use the `/library` endpoint.***<p>factors limit** = 20 individual factors per request*
|
|
438
426
|
start_date (str): The start date requested for a given date range in **YYYY-MM-DD** format. Future dates (T+1) are not accepted in this endpoint.
|
|
439
427
|
end_date (str): The end date requested for a given date range in **YYYY-MM-DD** format. Future dates (T+1) are not accepted in this endpoint. **NOTE:** The input endDate must come AFTER the input startDate.
|
|
440
428
|
|
|
441
429
|
Keyword Args:
|
|
430
|
+
factors ([str]): Array of individual Factor Items requested. For a list of all available factors and descriptions use the `/library` endpoint.***<p>factors limit** = 20 individual factors per request* . [optional]
|
|
442
431
|
factor_groups ([str]): Fetch a collection of Factors that fall within one of the below \"groups\". For example, resting factorGroup=Momentum will return all factors under the momentum group. To know which items are available in each group use the /library endpoint.***<p>factor groups limit** = 5 factor groups per request* ### Classification and Reference |Group|Descriptions| |---|---| |Asset_Data|Easily input security-level metadata into your quantitative research process. Common metrics used include Days Since Report, Days to Report, ADR Flag, and Minimum Lot Size. Integrate variables from FactSet Reference, FactSet Fundamentals, and FactSet Estimates databases to impose portfolio constraints and access general reference data.| |Country|Evaluate securities based on the countries in which they have the highest exposure. Analyze company-level exposures across various countries and measure how concentrated a firm’s business is within their countries of operation. Metrics are derived from FactSet Reference and FactSet Geographic Revenue Exposure (GeoRev) databases and include Country Exposure, Country of Incorporation, and Country of Risk.| |Industry|Classify securities based on the industries in which they generate the majority of their revenues. Incorporate variables from the FactSet Revere Business and Industry Classification System (RBICS) database to measure how concentrated a firm’s business is within the industries they operate and across various sub-sectors. Common metrics include Industry Classifications, Industry Exposures, and Industry Concentration.| |Size|Assess how large or small a company is relative to industry peers. Create size buckets and clarify the systematic portion of company returns using variables from FactSet Prices, FactSet RBICS, FactSet Fundamentals, and FactSet Estimates. Common metrics include Size Classification, Enterprise Value, and Market Share.| ### Market Factors |Group|Descriptions| |---|---| |Liquidity|Assess how investible a security is, as well as the potential market impact of a trade using signals built off pricing and volume data from FactSet Prices. Integrate factors as components into your alpha models to evaluate systematic risk or input them into your portfolio construction models to dictate how much of an asset can be bought or sold based on liquidity levels. Common metrics include Average Dollars Traded, Share Turnover, and Bid Ask Spread.| |Market Sensitivity|Clarify the common variations in stock returns attributable to the performance of their local market indices. Leverage regressions performed between security-level and market-index returns across different return horizons and methodologies. Metrics are derived from FactSet Prices and include Beta R-Squared, Up Market Beta, and Down Market Beta.| |Momentum|Analyze the historical momentum of a security and uncover how each underlying data item, calculation, and horizon can be meaningful in different situations. Metrics are derived from FactSet Prices and include 52W Position, Return Momentum, and Velocity.| |Technical|Forecast the direction of future price movements based on historical market data and leverage heuristic or pattern-based signals from FactSet Prices. Common metrics include Average True Range, Ulcer Performance Index, and Money Flow Volume.| |Volatility|Measure the uncertainty in asset price movements with indicators from the FactSet Prices database. Capture various forms of uncertainty by employing statistical calculations on security performance data. Common metrics include Return Volatility, Semivariance, and Turbulence.| ### Core Fundamentals |Group|Descriptions| |---|---| |Efficiency|Leverage core financial data to determine how effectively a company uses its assets, collects payments, and operates its business. Most variables are measured as turnover ratios and include changes over time to provide transparency into the efficiency of each business process. Metrics are derived from FactSet Fundamentals and FactSet Estimates and include Asset Turnover, Receivables Turnover, and Cash Conversion Cycle| |Growth|Measure a company’s ability to grow faster than its peers. Compare the future expected growth of a company with its historical growth and view growth rates adjusted for stability. Integrate variables from FactSet RBICS, FactSet Fundamentals, and FactSet Estimates to analyze growth rates over multiple horizons including Market Share, Sales, and EPS Growth| |Management|Gain insight into how management finances their business and the decisions they make that impact the core financial statements. These choices are reflected in changes to total debt or equity, the overall size of the balance sheet, and decisions around the accounting methods used. Metrics are derived from FactSet Fundamentals and FactSet Estimates and include Capital Expenditures (CAPEX) Growth, Equity Buyback Ratio, and Depreciation & Amortization Variability| |Profitability|Evaluate a company’s ability to generate income relative to its revenue or balance sheet metrics. Identify lucrative businesses relative to their industry, region, and size profile. Metrics are derived from FactSet Fundamentals and FactSet Estimates and include Return on Assets, Return on Invested Capital Change, and Return on Total Equity |Quality|Understand the overall financial health and quality of a company’s business. Use historical data from FactSet Fundamentals to analyze balance sheet health, stability of earnings and profit margins, variability in cash flows, and trends that look beyond headline financial metrics. Common metrics include Cash Earnings Ratio Variability, Revenue Stability, and Accruals Ratios. Composite quality scores (i.e., the Piotroski F-Score, Beneish M-Score, and Altman Z-Score) and their underlying components are also available as individual metrics.| |Solvency|Measure a company’s ability to meet their short- and long-term financial obligations and determine the degree of leverage employed to run their business. Incorporate financial ratios from FactSet Fundamentals and FactSet Estimates to quantify liability or debt obligation relative to earnings, cash flows, equities, or items from the asset side of the balance sheet. Common metrics include Current Ratio, Current Asset Liquidity, and Debt to Equity Change.| |Value|Quickly determine how cheap or expensive a company is based on common security-level characteristics from FactSet Prices, FactSet Fundamentals, and FactSet Estimates. Apply factors as an intersection between other factors for a more customized analysis, such as finding the cheapest stocks among the highest quality companies. Common metrics include Earnings Yield, Book to Price, and Revenue to Enterprise Value.| ### Macro and Cross-Asset |Group|Descriptions| |---|---| |Commodity|Quantify the impact movements in the commodity markets have on equity prices. Metrics are derived from FactSet Prices and allow you to measure company-level exposure to commodities such as Gold, Crude Oil, Coffee, and Live Cattle.| |FX_Sensitivity| Analyze security-level sensitivity to fluctuations in the currency markets. Metrics are derived from FactSet Prices and allow you to identify company exposures to currencies such as USD, EUR, JPY, and CNY. |Debt|Uncover details related to company debt through issuer-level factor exposures. Use the FactSet Fixed Income Prices & Derived Analytics database to aggregate metrics at the company level. Common metrics include Effective Duration, Option Adjusted Spread, and Yield to Worst.| |Economic|Capture daily security exposures to leading economic indicator forecasts. Leverage the Quant Factor Library’s detailed country exposure model to attribute economic measures to individual companies. Metrics are derived from FactSet Economic Estimates and include Real GPD Growth, Industrial Production Growth, Core CPI Inflation, and Policy Rates. ### Alternative |Group|Descriptions| |---|---| |Analyst_Sentiment|Analyze a security’s outlook from the perspective of a sell-side research analyst. Leverage consensus estimates data from the FactSet Estimates database to analyze the directional change in estimate revisions for various financial statement items and time periods. Common metrics include Sales Estimate Revisions, Free Cash Flow Estimate Revisions, and Robust Estimate Revisions.| |Corporate_Governance|Identify companies with strong corporate governance. Analyze the profile of a company’s management and board based on tenure, diversity, compensation incentives, and more factors from the FactSet People database. Common metrics include Management - Average Age, Board - Activist Member, and Executives - Average Bonus.| |Crowding|Understand the degree to which investors own, purchase, or sell a security. View characteristics of each investor’s profile and characterize crowding from passive, active, institutional, ETF, and hedge fund investors. Use metrics from FactSet Ownership, FactSet Prices, and FactSet Fundamentals to help identify potential effects of crowding such as whether certain investor types are acquiring or divesting from a given security. Common metrics include Active Buyer Percent of Portfolio Change, ETF Days to Liquidate, and Hedge Fund Percent Outstanding.| |Insider_Activity|Measure the degree to which insiders own, purchase, or sell their company’s stock. Analyze the sentiment of those with access to material non-public information or determine how the amount of insider ownership may impact management’s key business decisions. Metrics are derived from FactSet Ownership and include Insider Percent Outstanding, Insider Number of Buys, and Insider Seller Position Change. |ESG|Analyze Environmental, Social and Governance (ESG) behavior, which are aggregated and categorized into continuously updated, material ESG scores to uncover risks and opportunities from companies. Truvalue Labs focuses on company ESG behavior from external sources and includes both positive and negative events that go beyond traditional sources of ESG risk data. . [optional]
|
|
443
432
|
frequency (str): Controls the display frequency of the data returned. * **D** = Daily * **W** = Weekly, based on the last day of the week of the start date. * **M** = Monthly, based on the last trading day of the month. * **AM** = Monthly, based on the start date (e.g., if the start date is June 16, data is displayed for June 16, May 16, April 16 etc.). * **CQ** = Quarterly based on the last trading day of the calendar quarter (March, June, September, or December). * **AY** = Actual Annual, based on the start date. * **CY** = Calendar Annual, based on the last trading day of the calendar year. . [optional] if omitted the server will use the default value of "M"
|
|
444
433
|
_preload_content (bool): if False, the urllib3.HTTPResponse object
|
|
@@ -471,8 +460,6 @@ class FactorsApi(object):
|
|
|
471
460
|
self.apply_kwargs_defaults(kwargs=kwargs, return_http_data_only=False, async_req=True)
|
|
472
461
|
kwargs['ids'] = \
|
|
473
462
|
ids
|
|
474
|
-
kwargs['factors'] = \
|
|
475
|
-
factors
|
|
476
463
|
kwargs['start_date'] = \
|
|
477
464
|
start_date
|
|
478
465
|
kwargs['end_date'] = \
|
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
|
|
4
4
|
The FactSet FactSet Quant Factor Library (QFL) API helps to detect investment themes across global equity markets, incorporate ideas into your portfolio construction process, and transform raw data into actionable intelligence. Over 2000+ items spanning Factor Groups in- * Classification and Reference Data - Asset Data, Country, Industry, and Size * Market - Liquidity, Market Sensitivity, Momentum, Technical, Volatility * Core Fundamentals - Efficiency, Growth, Management, Profitability, Quality, Solvency, Value * Macro and Cross Asset - Commodity, FX Sensitivity, Debt, Economic * Alternative - Analyst Sentiment, Corporate Governance, Crowding, Insider Activity. # noqa: E501
|
|
5
5
|
|
|
6
|
-
The version of the OpenAPI document: 1.0.
|
|
6
|
+
The version of the OpenAPI document: 1.0.2
|
|
7
7
|
Contact: api@factset.com
|
|
8
8
|
Generated by: https://openapi-generator.tech
|
|
9
9
|
"""
|
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
|
|
4
4
|
The FactSet FactSet Quant Factor Library (QFL) API helps to detect investment themes across global equity markets, incorporate ideas into your portfolio construction process, and transform raw data into actionable intelligence. Over 2000+ items spanning Factor Groups in- * Classification and Reference Data - Asset Data, Country, Industry, and Size * Market - Liquidity, Market Sensitivity, Momentum, Technical, Volatility * Core Fundamentals - Efficiency, Growth, Management, Profitability, Quality, Solvency, Value * Macro and Cross Asset - Commodity, FX Sensitivity, Debt, Economic * Alternative - Analyst Sentiment, Corporate Governance, Crowding, Insider Activity. # noqa: E501
|
|
5
5
|
|
|
6
|
-
The version of the OpenAPI document: 1.0.
|
|
6
|
+
The version of the OpenAPI document: 1.0.2
|
|
7
7
|
Contact: api@factset.com
|
|
8
8
|
Generated by: https://openapi-generator.tech
|
|
9
9
|
"""
|
|
@@ -116,7 +116,7 @@ class ApiClient(object):
|
|
|
116
116
|
self.default_headers[header_name] = header_value
|
|
117
117
|
self.cookie = cookie
|
|
118
118
|
# Set default User-Agent.
|
|
119
|
-
self.user_agent = f'fds-sdk/python/FactSetQuantFactorLibrary/1.0
|
|
119
|
+
self.user_agent = f'fds-sdk/python/FactSetQuantFactorLibrary/1.1.0 ({platform.system()}, Python {platform.python_version()})'
|
|
120
120
|
|
|
121
121
|
def __enter__(self):
|
|
122
122
|
return self
|
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
|
|
4
4
|
The FactSet FactSet Quant Factor Library (QFL) API helps to detect investment themes across global equity markets, incorporate ideas into your portfolio construction process, and transform raw data into actionable intelligence. Over 2000+ items spanning Factor Groups in- * Classification and Reference Data - Asset Data, Country, Industry, and Size * Market - Liquidity, Market Sensitivity, Momentum, Technical, Volatility * Core Fundamentals - Efficiency, Growth, Management, Profitability, Quality, Solvency, Value * Macro and Cross Asset - Commodity, FX Sensitivity, Debt, Economic * Alternative - Analyst Sentiment, Corporate Governance, Crowding, Insider Activity. # noqa: E501
|
|
5
5
|
|
|
6
|
-
The version of the OpenAPI document: 1.0.
|
|
6
|
+
The version of the OpenAPI document: 1.0.2
|
|
7
7
|
Contact: api@factset.com
|
|
8
8
|
Generated by: https://openapi-generator.tech
|
|
9
9
|
"""
|
|
@@ -429,8 +429,8 @@ conf = fds.sdk.FactSetQuantFactorLibrary.Configuration(
|
|
|
429
429
|
return "Python SDK Debug Report:\n"\
|
|
430
430
|
"OS: {env}\n"\
|
|
431
431
|
"Python Version: {pyversion}\n"\
|
|
432
|
-
"Version of the API: 1.0.
|
|
433
|
-
"SDK Package Version: 1.0
|
|
432
|
+
"Version of the API: 1.0.2\n"\
|
|
433
|
+
"SDK Package Version: 1.1.0".\
|
|
434
434
|
format(env=sys.platform, pyversion=sys.version)
|
|
435
435
|
|
|
436
436
|
def get_host_settings(self):
|
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
|
|
4
4
|
The FactSet FactSet Quant Factor Library (QFL) API helps to detect investment themes across global equity markets, incorporate ideas into your portfolio construction process, and transform raw data into actionable intelligence. Over 2000+ items spanning Factor Groups in- * Classification and Reference Data - Asset Data, Country, Industry, and Size * Market - Liquidity, Market Sensitivity, Momentum, Technical, Volatility * Core Fundamentals - Efficiency, Growth, Management, Profitability, Quality, Solvency, Value * Macro and Cross Asset - Commodity, FX Sensitivity, Debt, Economic * Alternative - Analyst Sentiment, Corporate Governance, Crowding, Insider Activity. # noqa: E501
|
|
5
5
|
|
|
6
|
-
The version of the OpenAPI document: 1.0.
|
|
6
|
+
The version of the OpenAPI document: 1.0.2
|
|
7
7
|
Contact: api@factset.com
|
|
8
8
|
Generated by: https://openapi-generator.tech
|
|
9
9
|
"""
|
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
|
|
4
4
|
The FactSet FactSet Quant Factor Library (QFL) API helps to detect investment themes across global equity markets, incorporate ideas into your portfolio construction process, and transform raw data into actionable intelligence. Over 2000+ items spanning Factor Groups in- * Classification and Reference Data - Asset Data, Country, Industry, and Size * Market - Liquidity, Market Sensitivity, Momentum, Technical, Volatility * Core Fundamentals - Efficiency, Growth, Management, Profitability, Quality, Solvency, Value * Macro and Cross Asset - Commodity, FX Sensitivity, Debt, Economic * Alternative - Analyst Sentiment, Corporate Governance, Crowding, Insider Activity. # noqa: E501
|
|
5
5
|
|
|
6
|
-
The version of the OpenAPI document: 1.0.
|
|
6
|
+
The version of the OpenAPI document: 1.0.2
|
|
7
7
|
Contact: api@factset.com
|
|
8
8
|
Generated by: https://openapi-generator.tech
|
|
9
9
|
"""
|
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
|
|
4
4
|
The FactSet FactSet Quant Factor Library (QFL) API helps to detect investment themes across global equity markets, incorporate ideas into your portfolio construction process, and transform raw data into actionable intelligence. Over 2000+ items spanning Factor Groups in- * Classification and Reference Data - Asset Data, Country, Industry, and Size * Market - Liquidity, Market Sensitivity, Momentum, Technical, Volatility * Core Fundamentals - Efficiency, Growth, Management, Profitability, Quality, Solvency, Value * Macro and Cross Asset - Commodity, FX Sensitivity, Debt, Economic * Alternative - Analyst Sentiment, Corporate Governance, Crowding, Insider Activity. # noqa: E501
|
|
5
5
|
|
|
6
|
-
The version of the OpenAPI document: 1.0.
|
|
6
|
+
The version of the OpenAPI document: 1.0.2
|
|
7
7
|
Contact: api@factset.com
|
|
8
8
|
Generated by: https://openapi-generator.tech
|
|
9
9
|
"""
|
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
|
|
4
4
|
The FactSet FactSet Quant Factor Library (QFL) API helps to detect investment themes across global equity markets, incorporate ideas into your portfolio construction process, and transform raw data into actionable intelligence. Over 2000+ items spanning Factor Groups in- * Classification and Reference Data - Asset Data, Country, Industry, and Size * Market - Liquidity, Market Sensitivity, Momentum, Technical, Volatility * Core Fundamentals - Efficiency, Growth, Management, Profitability, Quality, Solvency, Value * Macro and Cross Asset - Commodity, FX Sensitivity, Debt, Economic * Alternative - Analyst Sentiment, Corporate Governance, Crowding, Insider Activity. # noqa: E501
|
|
5
5
|
|
|
6
|
-
The version of the OpenAPI document: 1.0.
|
|
6
|
+
The version of the OpenAPI document: 1.0.2
|
|
7
7
|
Contact: api@factset.com
|
|
8
8
|
Generated by: https://openapi-generator.tech
|
|
9
9
|
"""
|
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
|
|
4
4
|
The FactSet FactSet Quant Factor Library (QFL) API helps to detect investment themes across global equity markets, incorporate ideas into your portfolio construction process, and transform raw data into actionable intelligence. Over 2000+ items spanning Factor Groups in- * Classification and Reference Data - Asset Data, Country, Industry, and Size * Market - Liquidity, Market Sensitivity, Momentum, Technical, Volatility * Core Fundamentals - Efficiency, Growth, Management, Profitability, Quality, Solvency, Value * Macro and Cross Asset - Commodity, FX Sensitivity, Debt, Economic * Alternative - Analyst Sentiment, Corporate Governance, Crowding, Insider Activity. # noqa: E501
|
|
5
5
|
|
|
6
|
-
The version of the OpenAPI document: 1.0.
|
|
6
|
+
The version of the OpenAPI document: 1.0.2
|
|
7
7
|
Contact: api@factset.com
|
|
8
8
|
Generated by: https://openapi-generator.tech
|
|
9
9
|
"""
|
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
|
|
4
4
|
The FactSet FactSet Quant Factor Library (QFL) API helps to detect investment themes across global equity markets, incorporate ideas into your portfolio construction process, and transform raw data into actionable intelligence. Over 2000+ items spanning Factor Groups in- * Classification and Reference Data - Asset Data, Country, Industry, and Size * Market - Liquidity, Market Sensitivity, Momentum, Technical, Volatility * Core Fundamentals - Efficiency, Growth, Management, Profitability, Quality, Solvency, Value * Macro and Cross Asset - Commodity, FX Sensitivity, Debt, Economic * Alternative - Analyst Sentiment, Corporate Governance, Crowding, Insider Activity. # noqa: E501
|
|
5
5
|
|
|
6
|
-
The version of the OpenAPI document: 1.0.
|
|
6
|
+
The version of the OpenAPI document: 1.0.2
|
|
7
7
|
Contact: api@factset.com
|
|
8
8
|
Generated by: https://openapi-generator.tech
|
|
9
9
|
"""
|
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
|
|
4
4
|
The FactSet FactSet Quant Factor Library (QFL) API helps to detect investment themes across global equity markets, incorporate ideas into your portfolio construction process, and transform raw data into actionable intelligence. Over 2000+ items spanning Factor Groups in- * Classification and Reference Data - Asset Data, Country, Industry, and Size * Market - Liquidity, Market Sensitivity, Momentum, Technical, Volatility * Core Fundamentals - Efficiency, Growth, Management, Profitability, Quality, Solvency, Value * Macro and Cross Asset - Commodity, FX Sensitivity, Debt, Economic * Alternative - Analyst Sentiment, Corporate Governance, Crowding, Insider Activity. # noqa: E501
|
|
5
5
|
|
|
6
|
-
The version of the OpenAPI document: 1.0.
|
|
6
|
+
The version of the OpenAPI document: 1.0.2
|
|
7
7
|
Contact: api@factset.com
|
|
8
8
|
Generated by: https://openapi-generator.tech
|
|
9
9
|
"""
|
|
@@ -95,9 +95,9 @@ class FactorsRequest(ModelNormal):
|
|
|
95
95
|
lazy_import()
|
|
96
96
|
return {
|
|
97
97
|
'ids': (Ids,), # noqa: E501
|
|
98
|
-
'factors': (FactorsParam,), # noqa: E501
|
|
99
98
|
'start_date': (str,), # noqa: E501
|
|
100
99
|
'end_date': (str,), # noqa: E501
|
|
100
|
+
'factors': (FactorsParam,), # noqa: E501
|
|
101
101
|
'factor_groups': (FactorGroupsParam,), # noqa: E501
|
|
102
102
|
'frequency': (Frequency,), # noqa: E501
|
|
103
103
|
}
|
|
@@ -109,9 +109,9 @@ class FactorsRequest(ModelNormal):
|
|
|
109
109
|
|
|
110
110
|
attribute_map = {
|
|
111
111
|
'ids': 'ids', # noqa: E501
|
|
112
|
-
'factors': 'factors', # noqa: E501
|
|
113
112
|
'start_date': 'startDate', # noqa: E501
|
|
114
113
|
'end_date': 'endDate', # noqa: E501
|
|
114
|
+
'factors': 'factors', # noqa: E501
|
|
115
115
|
'factor_groups': 'factorGroups', # noqa: E501
|
|
116
116
|
'frequency': 'frequency', # noqa: E501
|
|
117
117
|
}
|
|
@@ -123,12 +123,11 @@ class FactorsRequest(ModelNormal):
|
|
|
123
123
|
|
|
124
124
|
@classmethod
|
|
125
125
|
@convert_js_args_to_python_args
|
|
126
|
-
def _from_openapi_data(cls, ids,
|
|
126
|
+
def _from_openapi_data(cls, ids, start_date, end_date, *args, **kwargs): # noqa: E501
|
|
127
127
|
"""FactorsRequest - a model defined in OpenAPI
|
|
128
128
|
|
|
129
129
|
Args:
|
|
130
130
|
ids (Ids):
|
|
131
|
-
factors (FactorsParam):
|
|
132
131
|
start_date (str): The start date requested for a given date range in **YYYY-MM-DD** format. Future dates (T+1) are not accepted in this endpoint.
|
|
133
132
|
end_date (str): The end date requested for a given date range in **YYYY-MM-DD** format. Future dates (T+1) are not accepted in this endpoint. **NOTE:** The input endDate must come AFTER the input startDate.
|
|
134
133
|
|
|
@@ -163,6 +162,7 @@ class FactorsRequest(ModelNormal):
|
|
|
163
162
|
Animal class but this time we won't travel
|
|
164
163
|
through its discriminator because we passed in
|
|
165
164
|
_visited_composed_classes = (Animal,)
|
|
165
|
+
factors (FactorsParam): [optional] # noqa: E501
|
|
166
166
|
factor_groups (FactorGroupsParam): [optional] # noqa: E501
|
|
167
167
|
frequency (Frequency): [optional] # noqa: E501
|
|
168
168
|
"""
|
|
@@ -193,7 +193,6 @@ class FactorsRequest(ModelNormal):
|
|
|
193
193
|
self._visited_composed_classes = _visited_composed_classes + (self.__class__,)
|
|
194
194
|
|
|
195
195
|
self.ids = ids
|
|
196
|
-
self.factors = factors
|
|
197
196
|
self.start_date = start_date
|
|
198
197
|
self.end_date = end_date
|
|
199
198
|
for var_name, var_value in kwargs.items():
|
|
@@ -216,12 +215,11 @@ class FactorsRequest(ModelNormal):
|
|
|
216
215
|
])
|
|
217
216
|
|
|
218
217
|
@convert_js_args_to_python_args
|
|
219
|
-
def __init__(self, ids,
|
|
218
|
+
def __init__(self, ids, start_date, end_date, *args, **kwargs): # noqa: E501
|
|
220
219
|
"""FactorsRequest - a model defined in OpenAPI
|
|
221
220
|
|
|
222
221
|
Args:
|
|
223
222
|
ids (Ids):
|
|
224
|
-
factors (FactorsParam):
|
|
225
223
|
start_date (str): The start date requested for a given date range in **YYYY-MM-DD** format. Future dates (T+1) are not accepted in this endpoint.
|
|
226
224
|
end_date (str): The end date requested for a given date range in **YYYY-MM-DD** format. Future dates (T+1) are not accepted in this endpoint. **NOTE:** The input endDate must come AFTER the input startDate.
|
|
227
225
|
|
|
@@ -256,6 +254,7 @@ class FactorsRequest(ModelNormal):
|
|
|
256
254
|
Animal class but this time we won't travel
|
|
257
255
|
through its discriminator because we passed in
|
|
258
256
|
_visited_composed_classes = (Animal,)
|
|
257
|
+
factors (FactorsParam): [optional] # noqa: E501
|
|
259
258
|
factor_groups (FactorGroupsParam): [optional] # noqa: E501
|
|
260
259
|
frequency (Frequency): [optional] # noqa: E501
|
|
261
260
|
"""
|
|
@@ -284,7 +283,6 @@ class FactorsRequest(ModelNormal):
|
|
|
284
283
|
self._visited_composed_classes = _visited_composed_classes + (self.__class__,)
|
|
285
284
|
|
|
286
285
|
self.ids = ids
|
|
287
|
-
self.factors = factors
|
|
288
286
|
self.start_date = start_date
|
|
289
287
|
self.end_date = end_date
|
|
290
288
|
for var_name, var_value in kwargs.items():
|
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
|
|
4
4
|
The FactSet FactSet Quant Factor Library (QFL) API helps to detect investment themes across global equity markets, incorporate ideas into your portfolio construction process, and transform raw data into actionable intelligence. Over 2000+ items spanning Factor Groups in- * Classification and Reference Data - Asset Data, Country, Industry, and Size * Market - Liquidity, Market Sensitivity, Momentum, Technical, Volatility * Core Fundamentals - Efficiency, Growth, Management, Profitability, Quality, Solvency, Value * Macro and Cross Asset - Commodity, FX Sensitivity, Debt, Economic * Alternative - Analyst Sentiment, Corporate Governance, Crowding, Insider Activity. # noqa: E501
|
|
5
5
|
|
|
6
|
-
The version of the OpenAPI document: 1.0.
|
|
6
|
+
The version of the OpenAPI document: 1.0.2
|
|
7
7
|
Contact: api@factset.com
|
|
8
8
|
Generated by: https://openapi-generator.tech
|
|
9
9
|
"""
|
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
|
|
4
4
|
The FactSet FactSet Quant Factor Library (QFL) API helps to detect investment themes across global equity markets, incorporate ideas into your portfolio construction process, and transform raw data into actionable intelligence. Over 2000+ items spanning Factor Groups in- * Classification and Reference Data - Asset Data, Country, Industry, and Size * Market - Liquidity, Market Sensitivity, Momentum, Technical, Volatility * Core Fundamentals - Efficiency, Growth, Management, Profitability, Quality, Solvency, Value * Macro and Cross Asset - Commodity, FX Sensitivity, Debt, Economic * Alternative - Analyst Sentiment, Corporate Governance, Crowding, Insider Activity. # noqa: E501
|
|
5
5
|
|
|
6
|
-
The version of the OpenAPI document: 1.0.
|
|
6
|
+
The version of the OpenAPI document: 1.0.2
|
|
7
7
|
Contact: api@factset.com
|
|
8
8
|
Generated by: https://openapi-generator.tech
|
|
9
9
|
"""
|
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
|
|
4
4
|
The FactSet FactSet Quant Factor Library (QFL) API helps to detect investment themes across global equity markets, incorporate ideas into your portfolio construction process, and transform raw data into actionable intelligence. Over 2000+ items spanning Factor Groups in- * Classification and Reference Data - Asset Data, Country, Industry, and Size * Market - Liquidity, Market Sensitivity, Momentum, Technical, Volatility * Core Fundamentals - Efficiency, Growth, Management, Profitability, Quality, Solvency, Value * Macro and Cross Asset - Commodity, FX Sensitivity, Debt, Economic * Alternative - Analyst Sentiment, Corporate Governance, Crowding, Insider Activity. # noqa: E501
|
|
5
5
|
|
|
6
|
-
The version of the OpenAPI document: 1.0.
|
|
6
|
+
The version of the OpenAPI document: 1.0.2
|
|
7
7
|
Contact: api@factset.com
|
|
8
8
|
Generated by: https://openapi-generator.tech
|
|
9
9
|
"""
|
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
|
|
4
4
|
The FactSet FactSet Quant Factor Library (QFL) API helps to detect investment themes across global equity markets, incorporate ideas into your portfolio construction process, and transform raw data into actionable intelligence. Over 2000+ items spanning Factor Groups in- * Classification and Reference Data - Asset Data, Country, Industry, and Size * Market - Liquidity, Market Sensitivity, Momentum, Technical, Volatility * Core Fundamentals - Efficiency, Growth, Management, Profitability, Quality, Solvency, Value * Macro and Cross Asset - Commodity, FX Sensitivity, Debt, Economic * Alternative - Analyst Sentiment, Corporate Governance, Crowding, Insider Activity. # noqa: E501
|
|
5
5
|
|
|
6
|
-
The version of the OpenAPI document: 1.0.
|
|
6
|
+
The version of the OpenAPI document: 1.0.2
|
|
7
7
|
Contact: api@factset.com
|
|
8
8
|
Generated by: https://openapi-generator.tech
|
|
9
9
|
"""
|
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
|
|
4
4
|
The FactSet FactSet Quant Factor Library (QFL) API helps to detect investment themes across global equity markets, incorporate ideas into your portfolio construction process, and transform raw data into actionable intelligence. Over 2000+ items spanning Factor Groups in- * Classification and Reference Data - Asset Data, Country, Industry, and Size * Market - Liquidity, Market Sensitivity, Momentum, Technical, Volatility * Core Fundamentals - Efficiency, Growth, Management, Profitability, Quality, Solvency, Value * Macro and Cross Asset - Commodity, FX Sensitivity, Debt, Economic * Alternative - Analyst Sentiment, Corporate Governance, Crowding, Insider Activity. # noqa: E501
|
|
5
5
|
|
|
6
|
-
The version of the OpenAPI document: 1.0.
|
|
6
|
+
The version of the OpenAPI document: 1.0.2
|
|
7
7
|
Contact: api@factset.com
|
|
8
8
|
Generated by: https://openapi-generator.tech
|
|
9
9
|
"""
|
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
|
|
4
4
|
The FactSet FactSet Quant Factor Library (QFL) API helps to detect investment themes across global equity markets, incorporate ideas into your portfolio construction process, and transform raw data into actionable intelligence. Over 2000+ items spanning Factor Groups in- * Classification and Reference Data - Asset Data, Country, Industry, and Size * Market - Liquidity, Market Sensitivity, Momentum, Technical, Volatility * Core Fundamentals - Efficiency, Growth, Management, Profitability, Quality, Solvency, Value * Macro and Cross Asset - Commodity, FX Sensitivity, Debt, Economic * Alternative - Analyst Sentiment, Corporate Governance, Crowding, Insider Activity. # noqa: E501
|
|
5
5
|
|
|
6
|
-
The version of the OpenAPI document: 1.0.
|
|
6
|
+
The version of the OpenAPI document: 1.0.2
|
|
7
7
|
Contact: api@factset.com
|
|
8
8
|
Generated by: https://openapi-generator.tech
|
|
9
9
|
"""
|
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
|
|
4
4
|
The FactSet FactSet Quant Factor Library (QFL) API helps to detect investment themes across global equity markets, incorporate ideas into your portfolio construction process, and transform raw data into actionable intelligence. Over 2000+ items spanning Factor Groups in- * Classification and Reference Data - Asset Data, Country, Industry, and Size * Market - Liquidity, Market Sensitivity, Momentum, Technical, Volatility * Core Fundamentals - Efficiency, Growth, Management, Profitability, Quality, Solvency, Value * Macro and Cross Asset - Commodity, FX Sensitivity, Debt, Economic * Alternative - Analyst Sentiment, Corporate Governance, Crowding, Insider Activity. # noqa: E501
|
|
5
5
|
|
|
6
|
-
The version of the OpenAPI document: 1.0.
|
|
6
|
+
The version of the OpenAPI document: 1.0.2
|
|
7
7
|
Contact: api@factset.com
|
|
8
8
|
Generated by: https://openapi-generator.tech
|
|
9
9
|
"""
|
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
|
|
4
4
|
The FactSet FactSet Quant Factor Library (QFL) API helps to detect investment themes across global equity markets, incorporate ideas into your portfolio construction process, and transform raw data into actionable intelligence. Over 2000+ items spanning Factor Groups in- * Classification and Reference Data - Asset Data, Country, Industry, and Size * Market - Liquidity, Market Sensitivity, Momentum, Technical, Volatility * Core Fundamentals - Efficiency, Growth, Management, Profitability, Quality, Solvency, Value * Macro and Cross Asset - Commodity, FX Sensitivity, Debt, Economic * Alternative - Analyst Sentiment, Corporate Governance, Crowding, Insider Activity. # noqa: E501
|
|
5
5
|
|
|
6
|
-
The version of the OpenAPI document: 1.0.
|
|
6
|
+
The version of the OpenAPI document: 1.0.2
|
|
7
7
|
Contact: api@factset.com
|
|
8
8
|
Generated by: https://openapi-generator.tech
|
|
9
9
|
"""
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
Metadata-Version: 2.1
|
|
2
2
|
Name: fds.sdk.FactSetQuantFactorLibrary
|
|
3
|
-
Version: 1.0
|
|
3
|
+
Version: 1.1.0
|
|
4
4
|
Summary: FactSet Quant Factor Library client library for Python
|
|
5
5
|
Home-page: https://github.com/FactSet/enterprise-sdk/tree/main/code/python/FactSetQuantFactorLibrary/v1
|
|
6
6
|
Author: FactSet Research Systems
|
|
@@ -15,8 +15,8 @@ License-File: LICENSE
|
|
|
15
15
|
|
|
16
16
|
# FactSet Quant Factor Library client library for Python
|
|
17
17
|
|
|
18
|
-
[](https://pypi.org/project/fds.sdk.FactSetQuantFactorLibrary/)
|
|
18
|
+
[]()
|
|
19
|
+
[](https://pypi.org/project/fds.sdk.FactSetQuantFactorLibrary/v/1.1.0)
|
|
20
20
|
[](https://www.apache.org/licenses/LICENSE-2.0)
|
|
21
21
|
|
|
22
22
|
The FactSet FactSet Quant Factor Library (QFL) API helps to detect investment themes across global equity markets, incorporate ideas into your portfolio construction process, and transform raw data into actionable intelligence. Over 2000+ items spanning Factor Groups in-
|
|
@@ -29,8 +29,8 @@ The FactSet FactSet Quant Factor Library (QFL) API helps to detect investment th
|
|
|
29
29
|
|
|
30
30
|
This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
|
|
31
31
|
|
|
32
|
-
- API version: 1.0.
|
|
33
|
-
- SDK version: 1.0
|
|
32
|
+
- API version: 1.0.2
|
|
33
|
+
- SDK version: 1.1.0
|
|
34
34
|
- Build package: org.openapitools.codegen.languages.PythonClientCodegen
|
|
35
35
|
|
|
36
36
|
For more information, please visit [http://www.factset.com/api](http://www.factset.com/api)
|
|
@@ -44,13 +44,13 @@ For more information, please visit [http://www.factset.com/api](http://www.facts
|
|
|
44
44
|
### Poetry
|
|
45
45
|
|
|
46
46
|
```shell
|
|
47
|
-
poetry add fds.sdk.utils fds.sdk.FactSetQuantFactorLibrary==1.0
|
|
47
|
+
poetry add fds.sdk.utils fds.sdk.FactSetQuantFactorLibrary==1.1.0
|
|
48
48
|
```
|
|
49
49
|
|
|
50
50
|
### pip
|
|
51
51
|
|
|
52
52
|
```shell
|
|
53
|
-
pip install fds.sdk.utils fds.sdk.FactSetQuantFactorLibrary==1.0
|
|
53
|
+
pip install fds.sdk.utils fds.sdk.FactSetQuantFactorLibrary==1.1.0
|
|
54
54
|
```
|
|
55
55
|
|
|
56
56
|
## Usage
|
|
@@ -110,10 +110,12 @@ configuration = fds.sdk.FactSetQuantFactorLibrary.Configuration(
|
|
|
110
110
|
with fds.sdk.FactSetQuantFactorLibrary.ApiClient(configuration) as api_client:
|
|
111
111
|
# Create an instance of the API class
|
|
112
112
|
api_instance = factors_api.FactorsApi(api_client)
|
|
113
|
-
ids = ["
|
|
114
|
-
factors = ["rsi21D","ulcer252D","turbulence21D"] # [str] | Array of individual Factor Items requested. For a list of all available factors and descriptions use the `/library` endpoint.***<p>factors limit** = 20 individual factors per request*
|
|
113
|
+
ids = ["TSLA-US"] # [str] | Security or Entity identifiers. FactSet Identifiers, tickers, CUSIP and SEDOL are accepted as inputs. **NOTE:** Fixed Income identifiers, ETFs, and Options are not accepted in this endpoint. <p>***Maximum possible ids limit** = 3500 per request*</p> `NOTE:` *The maximum possible ids limit for a request will **decrease** based on the size of the historical date range, the number of factors or factorGroups requested.* *<p> 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>*
|
|
115
114
|
start_date = "2020-11-30" # str | The start date requested for a given date range in **YYYY-MM-DD** format. Future dates (T+1) are not accepted in this endpoint.
|
|
116
115
|
end_date = "2021-11-30" # str | The end date requested for a given date range in **YYYY-MM-DD** format. Future dates (T+1) are not accepted in this endpoint. **NOTE:** The input endDate must come AFTER the input startDate.
|
|
116
|
+
factors = [
|
|
117
|
+
"factors_example",
|
|
118
|
+
] # [str] | Array of individual Factor Items requested. For a list of all available factors and descriptions use the `/library` endpoint.***<p>factors limit** = 20 individual factors per request* (optional)
|
|
117
119
|
factor_groups = ["Momentum","Technical","Volatility"] # [str] | Fetch a collection of Factors that fall within one of the below \"groups\". For example, resting factorGroup=Momentum will return all factors under the momentum group. To know which items are available in each group use the /library endpoint.***<p>factor groups limit** = 5 factor groups per request* ### Classification and Reference |Group|Descriptions| |---|---| |Asset_Data|Easily input security-level metadata into your quantitative research process. Common metrics used include Days Since Report, Days to Report, ADR Flag, and Minimum Lot Size. Integrate variables from FactSet Reference, FactSet Fundamentals, and FactSet Estimates databases to impose portfolio constraints and access general reference data.| |Country|Evaluate securities based on the countries in which they have the highest exposure. Analyze company-level exposures across various countries and measure how concentrated a firm’s business is within their countries of operation. Metrics are derived from FactSet Reference and FactSet Geographic Revenue Exposure (GeoRev) databases and include Country Exposure, Country of Incorporation, and Country of Risk.| |Industry|Classify securities based on the industries in which they generate the majority of their revenues. Incorporate variables from the FactSet Revere Business and Industry Classification System (RBICS) database to measure how concentrated a firm’s business is within the industries they operate and across various sub-sectors. Common metrics include Industry Classifications, Industry Exposures, and Industry Concentration.| |Size|Assess how large or small a company is relative to industry peers. Create size buckets and clarify the systematic portion of company returns using variables from FactSet Prices, FactSet RBICS, FactSet Fundamentals, and FactSet Estimates. Common metrics include Size Classification, Enterprise Value, and Market Share.| ### Market Factors |Group|Descriptions| |---|---| |Liquidity|Assess how investible a security is, as well as the potential market impact of a trade using signals built off pricing and volume data from FactSet Prices. Integrate factors as components into your alpha models to evaluate systematic risk or input them into your portfolio construction models to dictate how much of an asset can be bought or sold based on liquidity levels. Common metrics include Average Dollars Traded, Share Turnover, and Bid Ask Spread.| |Market Sensitivity|Clarify the common variations in stock returns attributable to the performance of their local market indices. Leverage regressions performed between security-level and market-index returns across different return horizons and methodologies. Metrics are derived from FactSet Prices and include Beta R-Squared, Up Market Beta, and Down Market Beta.| |Momentum|Analyze the historical momentum of a security and uncover how each underlying data item, calculation, and horizon can be meaningful in different situations. Metrics are derived from FactSet Prices and include 52W Position, Return Momentum, and Velocity.| |Technical|Forecast the direction of future price movements based on historical market data and leverage heuristic or pattern-based signals from FactSet Prices. Common metrics include Average True Range, Ulcer Performance Index, and Money Flow Volume.| |Volatility|Measure the uncertainty in asset price movements with indicators from the FactSet Prices database. Capture various forms of uncertainty by employing statistical calculations on security performance data. Common metrics include Return Volatility, Semivariance, and Turbulence.| ### Core Fundamentals |Group|Descriptions| |---|---| |Efficiency|Leverage core financial data to determine how effectively a company uses its assets, collects payments, and operates its business. Most variables are measured as turnover ratios and include changes over time to provide transparency into the efficiency of each business process. Metrics are derived from FactSet Fundamentals and FactSet Estimates and include Asset Turnover, Receivables Turnover, and Cash Conversion Cycle| |Growth|Measure a company’s ability to grow faster than its peers. Compare the future expected growth of a company with its historical growth and view growth rates adjusted for stability. Integrate variables from FactSet RBICS, FactSet Fundamentals, and FactSet Estimates to analyze growth rates over multiple horizons including Market Share, Sales, and EPS Growth| |Management|Gain insight into how management finances their business and the decisions they make that impact the core financial statements. These choices are reflected in changes to total debt or equity, the overall size of the balance sheet, and decisions around the accounting methods used. Metrics are derived from FactSet Fundamentals and FactSet Estimates and include Capital Expenditures (CAPEX) Growth, Equity Buyback Ratio, and Depreciation & Amortization Variability| |Profitability|Evaluate a company’s ability to generate income relative to its revenue or balance sheet metrics. Identify lucrative businesses relative to their industry, region, and size profile. Metrics are derived from FactSet Fundamentals and FactSet Estimates and include Return on Assets, Return on Invested Capital Change, and Return on Total Equity |Quality|Understand the overall financial health and quality of a company’s business. Use historical data from FactSet Fundamentals to analyze balance sheet health, stability of earnings and profit margins, variability in cash flows, and trends that look beyond headline financial metrics. Common metrics include Cash Earnings Ratio Variability, Revenue Stability, and Accruals Ratios. Composite quality scores (i.e., the Piotroski F-Score, Beneish M-Score, and Altman Z-Score) and their underlying components are also available as individual metrics.| |Solvency|Measure a company’s ability to meet their short- and long-term financial obligations and determine the degree of leverage employed to run their business. Incorporate financial ratios from FactSet Fundamentals and FactSet Estimates to quantify liability or debt obligation relative to earnings, cash flows, equities, or items from the asset side of the balance sheet. Common metrics include Current Ratio, Current Asset Liquidity, and Debt to Equity Change.| |Value|Quickly determine how cheap or expensive a company is based on common security-level characteristics from FactSet Prices, FactSet Fundamentals, and FactSet Estimates. Apply factors as an intersection between other factors for a more customized analysis, such as finding the cheapest stocks among the highest quality companies. Common metrics include Earnings Yield, Book to Price, and Revenue to Enterprise Value.| ### Macro and Cross-Asset |Group|Descriptions| |---|---| |Commodity|Quantify the impact movements in the commodity markets have on equity prices. Metrics are derived from FactSet Prices and allow you to measure company-level exposure to commodities such as Gold, Crude Oil, Coffee, and Live Cattle.| |FX_Sensitivity| Analyze security-level sensitivity to fluctuations in the currency markets. Metrics are derived from FactSet Prices and allow you to identify company exposures to currencies such as USD, EUR, JPY, and CNY. |Debt|Uncover details related to company debt through issuer-level factor exposures. Use the FactSet Fixed Income Prices & Derived Analytics database to aggregate metrics at the company level. Common metrics include Effective Duration, Option Adjusted Spread, and Yield to Worst.| |Economic|Capture daily security exposures to leading economic indicator forecasts. Leverage the Quant Factor Library’s detailed country exposure model to attribute economic measures to individual companies. Metrics are derived from FactSet Economic Estimates and include Real GPD Growth, Industrial Production Growth, Core CPI Inflation, and Policy Rates. ### Alternative |Group|Descriptions| |---|---| |Analyst_Sentiment|Analyze a security’s outlook from the perspective of a sell-side research analyst. Leverage consensus estimates data from the FactSet Estimates database to analyze the directional change in estimate revisions for various financial statement items and time periods. Common metrics include Sales Estimate Revisions, Free Cash Flow Estimate Revisions, and Robust Estimate Revisions.| |Corporate_Governance|Identify companies with strong corporate governance. Analyze the profile of a company’s management and board based on tenure, diversity, compensation incentives, and more factors from the FactSet People database. Common metrics include Management - Average Age, Board - Activist Member, and Executives - Average Bonus.| |Crowding|Understand the degree to which investors own, purchase, or sell a security. View characteristics of each investor’s profile and characterize crowding from passive, active, institutional, ETF, and hedge fund investors. Use metrics from FactSet Ownership, FactSet Prices, and FactSet Fundamentals to help identify potential effects of crowding such as whether certain investor types are acquiring or divesting from a given security. Common metrics include Active Buyer Percent of Portfolio Change, ETF Days to Liquidate, and Hedge Fund Percent Outstanding.| |Insider_Activity|Measure the degree to which insiders own, purchase, or sell their company’s stock. Analyze the sentiment of those with access to material non-public information or determine how the amount of insider ownership may impact management’s key business decisions. Metrics are derived from FactSet Ownership and include Insider Percent Outstanding, Insider Number of Buys, and Insider Seller Position Change. |ESG|Analyze Environmental, Social and Governance (ESG) behavior, which are aggregated and categorized into continuously updated, material ESG scores to uncover risks and opportunities from companies. Truvalue Labs focuses on company ESG behavior from external sources and includes both positive and negative events that go beyond traditional sources of ESG risk data. (optional)
|
|
118
120
|
frequency = "M" # str | Controls the display frequency of the data returned. * **D** = Daily * **W** = Weekly, based on the last day of the week of the start date. * **M** = Monthly, based on the last trading day of the month. * **AM** = Monthly, based on the start date (e.g., if the start date is June 16, data is displayed for June 16, May 16, April 16 etc.). * **CQ** = Quarterly based on the last trading day of the calendar quarter (March, June, September, or December). * **AY** = Actual Annual, based on the start date. * **CY** = Calendar Annual, based on the last trading day of the calendar year. (optional) if omitted the server will use the default value of "M"
|
|
119
121
|
|
|
@@ -121,7 +123,7 @@ with fds.sdk.FactSetQuantFactorLibrary.ApiClient(configuration) as api_client:
|
|
|
121
123
|
# Retrieves Quant Factors for a small list of ids.
|
|
122
124
|
# example passing only required values which don't have defaults set
|
|
123
125
|
# and optional values
|
|
124
|
-
api_response = api_instance.get_factors(ids,
|
|
126
|
+
api_response = api_instance.get_factors(ids, start_date, end_date, factors=factors, factor_groups=factor_groups, frequency=frequency)
|
|
125
127
|
|
|
126
128
|
pprint(api_response)
|
|
127
129
|
except fds.sdk.FactSetQuantFactorLibrary.ApiException as e:
|
|
@@ -130,7 +132,7 @@ with fds.sdk.FactSetQuantFactorLibrary.ApiClient(configuration) as api_client:
|
|
|
130
132
|
# # Get response, http status code and response headers
|
|
131
133
|
# try:
|
|
132
134
|
# # Retrieves Quant Factors for a small list of ids.
|
|
133
|
-
# api_response, http_status_code, response_headers = api_instance.get_factors_with_http_info(ids,
|
|
135
|
+
# api_response, http_status_code, response_headers = api_instance.get_factors_with_http_info(ids, start_date, end_date, factors=factors, factor_groups=factor_groups, frequency=frequency)
|
|
134
136
|
|
|
135
137
|
|
|
136
138
|
# pprint(api_response)
|
|
@@ -142,7 +144,7 @@ with fds.sdk.FactSetQuantFactorLibrary.ApiClient(configuration) as api_client:
|
|
|
142
144
|
# # Get response asynchronous
|
|
143
145
|
# try:
|
|
144
146
|
# # Retrieves Quant Factors for a small list of ids.
|
|
145
|
-
# async_result = api_instance.get_factors_async(ids,
|
|
147
|
+
# async_result = api_instance.get_factors_async(ids, start_date, end_date, factors=factors, factor_groups=factor_groups, frequency=frequency)
|
|
146
148
|
# api_response = async_result.get()
|
|
147
149
|
|
|
148
150
|
|
|
@@ -153,7 +155,7 @@ with fds.sdk.FactSetQuantFactorLibrary.ApiClient(configuration) as api_client:
|
|
|
153
155
|
# # Get response, http status code and response headers asynchronous
|
|
154
156
|
# try:
|
|
155
157
|
# # Retrieves Quant Factors for a small list of ids.
|
|
156
|
-
# async_result = api_instance.get_factors_with_http_info_async(ids,
|
|
158
|
+
# async_result = api_instance.get_factors_with_http_info_async(ids, start_date, end_date, factors=factors, factor_groups=factor_groups, frequency=frequency)
|
|
157
159
|
# api_response, http_status_code, response_headers = async_result.get()
|
|
158
160
|
|
|
159
161
|
|
{fds.sdk.FactSetQuantFactorLibrary-1.0.13 → fds.sdk.FactSetQuantFactorLibrary-1.1.0}/setup.py
RENAMED
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
|
|
4
4
|
The FactSet FactSet Quant Factor Library (QFL) API helps to detect investment themes across global equity markets, incorporate ideas into your portfolio construction process, and transform raw data into actionable intelligence. Over 2000+ items spanning Factor Groups in- * Classification and Reference Data - Asset Data, Country, Industry, and Size * Market - Liquidity, Market Sensitivity, Momentum, Technical, Volatility * Core Fundamentals - Efficiency, Growth, Management, Profitability, Quality, Solvency, Value * Macro and Cross Asset - Commodity, FX Sensitivity, Debt, Economic * Alternative - Analyst Sentiment, Corporate Governance, Crowding, Insider Activity. # noqa: E501
|
|
5
5
|
|
|
6
|
-
The version of the OpenAPI document: 1.0.
|
|
6
|
+
The version of the OpenAPI document: 1.0.2
|
|
7
7
|
Contact: api@factset.com
|
|
8
8
|
Generated by: https://openapi-generator.tech
|
|
9
9
|
"""
|
|
@@ -16,7 +16,7 @@ def read(filename):
|
|
|
16
16
|
return open(os.path.join(os.path.dirname(__file__), filename)).read()
|
|
17
17
|
|
|
18
18
|
NAME = "fds.sdk.FactSetQuantFactorLibrary"
|
|
19
|
-
VERSION = "1.0
|
|
19
|
+
VERSION = "1.1.0"
|
|
20
20
|
# To install the library, run the following
|
|
21
21
|
#
|
|
22
22
|
# python setup.py install
|
{fds.sdk.FactSetQuantFactorLibrary-1.0.13 → fds.sdk.FactSetQuantFactorLibrary-1.1.0}/LICENSE
RENAMED
|
File without changes
|
{fds.sdk.FactSetQuantFactorLibrary-1.0.13 → fds.sdk.FactSetQuantFactorLibrary-1.1.0}/fds/__init__.py
RENAMED
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
{fds.sdk.FactSetQuantFactorLibrary-1.0.13 → fds.sdk.FactSetQuantFactorLibrary-1.1.0}/setup.cfg
RENAMED
|
File without changes
|