fds.sdk.BestExecutionAnalyticsforSmarterTradingBEAST 0.1.0__tar.gz

fds.sdk.BestExecutionAnalyticsforSmarterTradingBEAST-0.1.0/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2019 FactSet Research Systems Inc
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

fds.sdk.BestExecutionAnalyticsforSmarterTradingBEAST-0.1.0/PKG-INFO

@@ -0,0 +1,415 @@
+Metadata-Version: 2.1
+Name: fds.sdk.BestExecutionAnalyticsforSmarterTradingBEAST
+Version: 0.1.0
+Summary: Best Execution Analytics for Smarter Trading (BEAST) client library for Python
+Home-page: https://github.com/FactSet/enterprise-sdk/tree/main/code/python/BestExecutionAnalyticsforSmarterTradingBEAST/v1
+Author: FactSet Research Systems
+License: Apache License, Version 2.0
+Keywords: FactSet,API,SDK
+Platform: UNKNOWN
+Requires-Python: >=3.7
+Description-Content-Type: text/markdown
+License-File: LICENSE
+
+[![FactSet](https://raw.githubusercontent.com/factset/enterprise-sdk/main/docs/images/factset-logo.svg)](https://www.factset.com)
+
+# Best Execution Analytics for Smarter Trading (BEAST) client library for Python
+
+[![API Version](https://img.shields.io/badge/api-v1.0.0-blue)](https://developer.factset.com/api-catalog/)
+[![PyPi](https://img.shields.io/pypi/v/fds.sdk.BestExecutionAnalyticsforSmarterTradingBEAST)](https://pypi.org/project/fds.sdk.BestExecutionAnalyticsforSmarterTradingBEAST/)
+[![Apache-2 license](https://img.shields.io/badge/license-Apache2-brightgreen.svg)](https://www.apache.org/licenses/LICENSE-2.0)
+
+Enables clients to programmatically access the underlying data which powers the BEAST Liquidity Analytics (LA) and Transaction Cost Analysis (TCA) applications.
+
+This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
+
+- API version: 1.0.0
+- SDK version: 0.1.0
+- Build package: org.openapitools.codegen.languages.PythonClientCodegen
+
+For more information, please visit [https://developer.factset.com/contact](https://developer.factset.com/contact)
+
+## Requirements
+
+* Python >= 3.7
+
+## Installation
+
+### Poetry
+
+```shell
+poetry add fds.sdk.utils fds.sdk.BestExecutionAnalyticsforSmarterTradingBEAST==0.1.0
+```
+
+### pip
+
+```shell
+pip install fds.sdk.utils fds.sdk.BestExecutionAnalyticsforSmarterTradingBEAST==0.1.0
+```
+
+## Usage
+
+1. [Generate authentication credentials](../../../../README.md#authentication).
+2. Setup Python environment.
+   1. Install and activate python 3.7+. If you're using [pyenv](https://github.com/pyenv/pyenv):
+
+      ```sh
+      pyenv install 3.9.7
+      pyenv shell 3.9.7
+      ```
+
+   2. (optional) [Install poetry](https://python-poetry.org/docs/#installation).
+3. [Install dependencies](#installation).
+4. Run the following:
+
+> [!IMPORTANT]
+> The parameter variables defined below are just examples and may potentially contain non valid values. Please replace them with valid values.
+
+### Example Code
+
+```python
+from fds.sdk.utils.authentication import ConfidentialClient
+
+import fds.sdk.BestExecutionAnalyticsforSmarterTradingBEAST
+from fds.sdk.BestExecutionAnalyticsforSmarterTradingBEAST.api import market_impact_api
+from fds.sdk.BestExecutionAnalyticsforSmarterTradingBEAST.models import *
+from dateutil.parser import parse as dateutil_parser
+from pprint import pprint
+
+# See configuration.py for a list of all supported configuration parameters.
+
+# Examples for each supported authentication method are below,
+# choose one that satisfies your use case.
+
+# (Preferred) OAuth 2.0: FactSetOAuth2
+# See https://github.com/FactSet/enterprise-sdk#oauth-20
+# for information on how to create the app-config.json file
+#
+# The confidential client instance should be reused in production environments.
+# See https://github.com/FactSet/enterprise-sdk-utils-python#authentication
+# for more information on using the ConfidentialClient class
+configuration = fds.sdk.BestExecutionAnalyticsforSmarterTradingBEAST.Configuration(
+    fds_oauth_client=ConfidentialClient('/path/to/app-config.json')
+)
+
+# Basic authentication: FactSetApiKey
+# See https://github.com/FactSet/enterprise-sdk#api-key
+# for information how to create an API key
+# configuration = fds.sdk.BestExecutionAnalyticsforSmarterTradingBEAST.Configuration(
+#     username='USERNAME-SERIAL',
+#     password='API-KEY'
+# )
+
+# Enter a context with an instance of the API client
+with fds.sdk.BestExecutionAnalyticsforSmarterTradingBEAST.ApiClient(configuration) as api_client:
+    # Create an instance of the API class
+    api_instance = market_impact_api.MarketImpactApi(api_client)
+    date = "2024-08-29" # str | Date in the format YYYY-MM-DD
+    start_time = "10:00:00" # str | Start Time in the format HH:MM:SS
+    end_time = "15:30:00" # str | End Time in the format HH:MM:SS
+    pause_start_time = "12:00:00" # str | Pause Start Time in the format HH:MM:SS
+    pause_end_time = "12:00:00" # str | Pause End Time in the format HH:MM:SS
+    security_id = "FDS" # str | ISIN for European securities, otherwise TICKER
+    region = "US" # str | The two character ISO country code of the trading region. EMEA is used for the European trading region
+    order_volume = 100000 # float | Order Volume
+    front_load_half_life = 5000 # float | Front Load Half Life
+    currency = "USD" # str | The ISO 4217 currency code (optional)
+    isin = "isin_example" # str | Isin code (optional)
+    spread_sensitivity = 0 # float | Spread Sensitivity (optional) if omitted the server will use the default value of 0
+    liquidity_sensitivity = 0 # float | Liquidity Sensitivity (optional) if omitted the server will use the default value of 0
+
+    try:
+        # Get Cost Impact
+        # example passing only required values which don't have defaults set
+        # and optional values
+        api_response = api_instance.get_cost_impact(date, start_time, end_time, pause_start_time, pause_end_time, security_id, region, order_volume, front_load_half_life, currency=currency, isin=isin, spread_sensitivity=spread_sensitivity, liquidity_sensitivity=liquidity_sensitivity)
+
+        pprint(api_response)
+    except fds.sdk.BestExecutionAnalyticsforSmarterTradingBEAST.ApiException as e:
+        print("Exception when calling MarketImpactApi->get_cost_impact: %s\n" % e)
+
+    # # Get response, http status code and response headers
+    # try:
+    #     # Get Cost Impact
+    #     api_response, http_status_code, response_headers = api_instance.get_cost_impact_with_http_info(date, start_time, end_time, pause_start_time, pause_end_time, security_id, region, order_volume, front_load_half_life, currency=currency, isin=isin, spread_sensitivity=spread_sensitivity, liquidity_sensitivity=liquidity_sensitivity)
+
+
+    #     pprint(api_response)
+    #     pprint(http_status_code)
+    #     pprint(response_headers)
+    # except fds.sdk.BestExecutionAnalyticsforSmarterTradingBEAST.ApiException as e:
+    #     print("Exception when calling MarketImpactApi->get_cost_impact: %s\n" % e)
+
+    # # Get response asynchronous
+    # try:
+    #     # Get Cost Impact
+    #     async_result = api_instance.get_cost_impact_async(date, start_time, end_time, pause_start_time, pause_end_time, security_id, region, order_volume, front_load_half_life, currency=currency, isin=isin, spread_sensitivity=spread_sensitivity, liquidity_sensitivity=liquidity_sensitivity)
+    #     api_response = async_result.get()
+
+
+    #     pprint(api_response)
+    # except fds.sdk.BestExecutionAnalyticsforSmarterTradingBEAST.ApiException as e:
+    #     print("Exception when calling MarketImpactApi->get_cost_impact: %s\n" % e)
+
+    # # Get response, http status code and response headers asynchronous
+    # try:
+    #     # Get Cost Impact
+    #     async_result = api_instance.get_cost_impact_with_http_info_async(date, start_time, end_time, pause_start_time, pause_end_time, security_id, region, order_volume, front_load_half_life, currency=currency, isin=isin, spread_sensitivity=spread_sensitivity, liquidity_sensitivity=liquidity_sensitivity)
+    #     api_response, http_status_code, response_headers = async_result.get()
+
+
+    #     pprint(api_response)
+    #     pprint(http_status_code)
+    #     pprint(response_headers)
+    # except fds.sdk.BestExecutionAnalyticsforSmarterTradingBEAST.ApiException as e:
+    #     print("Exception when calling MarketImpactApi->get_cost_impact: %s\n" % e)
+
+```
+
+### Using Pandas
+
+To convert an API response to a Pandas DataFrame, it is necessary to transform it first to a dictionary.
+```python
+import pandas as pd
+
+response_dict = api_response.to_dict()['data']
+
+simple_json_response = pd.DataFrame(response_dict)
+nested_json_response = pd.json_normalize(response_dict)
+```
+
+### Debugging
+
+The SDK uses the standard library [`logging`](https://docs.python.org/3/library/logging.html#module-logging) module.
+
+Setting `debug` to `True` on an instance of the `Configuration` class sets the log-level of related packages to `DEBUG`
+and enables additional logging in Pythons [HTTP Client](https://docs.python.org/3/library/http.client.html).
+
+**Note**: This prints out sensitive information (e.g. the full request and response). Use with care.
+
+```python
+import logging
+import fds.sdk.BestExecutionAnalyticsforSmarterTradingBEAST
+
+logging.basicConfig(level=logging.DEBUG)
+
+configuration = fds.sdk.BestExecutionAnalyticsforSmarterTradingBEAST.Configuration(...)
+configuration.debug = True
+```
+
+### Configure a Proxy
+
+You can pass proxy settings to the Configuration class:
+
+* `proxy`: The URL of the proxy to use.
+* `proxy_headers`: a dictionary to pass additional headers to the proxy (e.g. `Proxy-Authorization`).
+
+```python
+import fds.sdk.BestExecutionAnalyticsforSmarterTradingBEAST
+
+configuration = fds.sdk.BestExecutionAnalyticsforSmarterTradingBEAST.Configuration(
+    # ...
+    proxy="http://secret:password@localhost:5050",
+    proxy_headers={
+        "Custom-Proxy-Header": "Custom-Proxy-Header-Value"
+    }
+)
+```
+
+### Custom SSL Certificate
+
+TLS/SSL certificate verification can be configured with the following Configuration parameters:
+
+* `ssl_ca_cert`: a path to the certificate to use for verification in `PEM` format.
+* `verify_ssl`: setting this to `False` disables the verification of certificates.
+  Disabling the verification is not recommended, but it might be useful during
+  local development or testing.
+
+```python
+import fds.sdk.BestExecutionAnalyticsforSmarterTradingBEAST
+
+configuration = fds.sdk.BestExecutionAnalyticsforSmarterTradingBEAST.Configuration(
+    # ...
+    ssl_ca_cert='/path/to/ca.pem'
+)
+```
+
+### Request Retries
+
+In case the request retry behaviour should be customized, it is possible to pass a `urllib3.Retry` object to the `retry` property of the Configuration.
+
+```python
+from urllib3 import Retry
+import fds.sdk.BestExecutionAnalyticsforSmarterTradingBEAST
+
+configuration = fds.sdk.BestExecutionAnalyticsforSmarterTradingBEAST.Configuration(
+    # ...
+)
+
+configuration.retries = Retry(total=3, status_forcelist=[500, 502, 503, 504])
+```
+
+
+## Documentation for API Endpoints
+
+All URIs are relative to *https://api.factset.com/analytics/beast/v1*
+
+Class | Method | HTTP request | Description
+------------ | ------------- | ------------- | -------------
+*MarketImpactApi* | [**get_cost_impact**](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/BestExecutionAnalyticsforSmarterTradingBEAST/v1/docs/MarketImpactApi.md#get_cost_impact) | **GET** /tca/market-impact/cost-impact | Get Cost Impact
+*MarketImpactApi* | [**get_cost_impact_standard**](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/BestExecutionAnalyticsforSmarterTradingBEAST/v1/docs/MarketImpactApi.md#get_cost_impact_standard) | **GET** /tca/market-impact/cost-impact-standard | Get Standard Cost Impact
+*MarketImpactApi* | [**get_previous_vwaps**](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/BestExecutionAnalyticsforSmarterTradingBEAST/v1/docs/MarketImpactApi.md#get_previous_vwaps) | **GET** /tca/market-impact/previous-vwaps | Get Previous Volume Weighted Average Prices
+*OrderDetailsApi* | [**get_order_fill_count**](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/BestExecutionAnalyticsforSmarterTradingBEAST/v1/docs/OrderDetailsApi.md#get_order_fill_count) | **GET** /tca/order/fill-count | Get Order Fill Count
+*OrderDetailsApi* | [**get_order_index_etf**](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/BestExecutionAnalyticsforSmarterTradingBEAST/v1/docs/OrderDetailsApi.md#get_order_index_etf) | **GET** /tca/order/index-etf | Get Index ETF data
+*OrderDetailsApi* | [**get_order_info**](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/BestExecutionAnalyticsforSmarterTradingBEAST/v1/docs/OrderDetailsApi.md#get_order_info) | **GET** /tca/order/order-info | Get Order Information
+*OrderDetailsApi* | [**get_order_intra_stats**](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/BestExecutionAnalyticsforSmarterTradingBEAST/v1/docs/OrderDetailsApi.md#get_order_intra_stats) | **GET** /tca/order/intra-order-stats | Get Intra Order Stats
+*OrderDetailsApi* | [**get_order_investment_timing**](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/BestExecutionAnalyticsforSmarterTradingBEAST/v1/docs/OrderDetailsApi.md#get_order_investment_timing) | **GET** /tca/order/investment-timing | Get Order Investment Timings
+*OrderDetailsApi* | [**get_order_price_time_fills**](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/BestExecutionAnalyticsforSmarterTradingBEAST/v1/docs/OrderDetailsApi.md#get_order_price_time_fills) | **GET** /tca/order/price-time-fills | Get Price Time Fills
+*OrderDetailsApi* | [**get_order_price_time_quotes**](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/BestExecutionAnalyticsforSmarterTradingBEAST/v1/docs/OrderDetailsApi.md#get_order_price_time_quotes) | **GET** /tca/order/price-time-quotes | Get Price Time Quotes
+*OrderDetailsApi* | [**get_order_price_time_trades**](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/BestExecutionAnalyticsforSmarterTradingBEAST/v1/docs/OrderDetailsApi.md#get_order_price_time_trades) | **GET** /tca/order/price-time-trades | Get Price Time Trades
+*OrderDetailsApi* | [**get_order_volume_price**](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/BestExecutionAnalyticsforSmarterTradingBEAST/v1/docs/OrderDetailsApi.md#get_order_volume_price) | **GET** /tca/order/volume-price | Get Order Volume Prices
+*OrderDetailsApi* | [**get_order_volume_time**](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/BestExecutionAnalyticsforSmarterTradingBEAST/v1/docs/OrderDetailsApi.md#get_order_volume_time) | **GET** /tca/order/volume-time | Get Order Volume Times
+*OrderDetailsApi* | [**get_order_volume_venue**](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/BestExecutionAnalyticsforSmarterTradingBEAST/v1/docs/OrderDetailsApi.md#get_order_volume_venue) | **GET** /tca/order/volume-venue | Get Order Volume Venues
+*OrderSearchApi* | [**get_field_values**](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/BestExecutionAnalyticsforSmarterTradingBEAST/v1/docs/OrderSearchApi.md#get_field_values) | **GET** /tca/search/field-values | Get Order field values
+*OrderSearchApi* | [**get_orders**](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/BestExecutionAnalyticsforSmarterTradingBEAST/v1/docs/OrderSearchApi.md#get_orders) | **GET** /tca/search/orders | Find Orders by field values
+*OutliersApi* | [**get_outlier_metrics**](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/BestExecutionAnalyticsforSmarterTradingBEAST/v1/docs/OutliersApi.md#get_outlier_metrics) | **GET** /tca/outlier/metrics | Get Outlier metrics
+*OutliersApi* | [**get_outlier_metrics_by_percent**](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/BestExecutionAnalyticsforSmarterTradingBEAST/v1/docs/OutliersApi.md#get_outlier_metrics_by_percent) | **GET** /tca/outlier/metrics-by-percent | Get Outlier metrics by percent
+*QuoteAnalyticsApi* | [**get_quote_inside_size**](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/BestExecutionAnalyticsforSmarterTradingBEAST/v1/docs/QuoteAnalyticsApi.md#get_quote_inside_size) | **GET** /la/quote/inside-size | Get Quote Analytics
+*ReportsApi* | [**get_parent_aggregate_analysis**](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/BestExecutionAnalyticsforSmarterTradingBEAST/v1/docs/ReportsApi.md#get_parent_aggregate_analysis) | **GET** /tca/report/parent-aggregate-analysis | Get Parent Aggregate Analysis
+*TradeAnalyticsApi* | [**get_trade_analytics**](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/BestExecutionAnalyticsforSmarterTradingBEAST/v1/docs/TradeAnalyticsApi.md#get_trade_analytics) | **GET** /la/trade/trade-analytics | Get Trade Analytics
+*TradeAnalyticsApi* | [**get_volume_analytics**](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/BestExecutionAnalyticsforSmarterTradingBEAST/v1/docs/TradeAnalyticsApi.md#get_volume_analytics) | **GET** /la/trade/volume-analytics | Get Volume Analytics
+*ZScoreApi* | [**get_z_score_quotes**](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/BestExecutionAnalyticsforSmarterTradingBEAST/v1/docs/ZScoreApi.md#get_z_score_quotes) | **GET** /la/zscore/quotes | Get Quote Z-Scores
+*ZScoreApi* | [**get_z_score_trades**](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/BestExecutionAnalyticsforSmarterTradingBEAST/v1/docs/ZScoreApi.md#get_z_score_trades) | **GET** /la/zscore/trades | Get Trade Z-Scores
+
+
+## Documentation For Models
+
+ - [CostImpact](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/BestExecutionAnalyticsforSmarterTradingBEAST/v1/docs/CostImpact.md)
+ - [CostImpactResponseRoot](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/BestExecutionAnalyticsforSmarterTradingBEAST/v1/docs/CostImpactResponseRoot.md)
+ - [CostImpactStandard](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/BestExecutionAnalyticsforSmarterTradingBEAST/v1/docs/CostImpactStandard.md)
+ - [CostImpactStandardResponseRoot](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/BestExecutionAnalyticsforSmarterTradingBEAST/v1/docs/CostImpactStandardResponseRoot.md)
+ - [Error](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/BestExecutionAnalyticsforSmarterTradingBEAST/v1/docs/Error.md)
+ - [ErrorResponse](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/BestExecutionAnalyticsforSmarterTradingBEAST/v1/docs/ErrorResponse.md)
+ - [FieldValuesResponse](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/BestExecutionAnalyticsforSmarterTradingBEAST/v1/docs/FieldValuesResponse.md)
+ - [FieldValuesResponseRoot](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/BestExecutionAnalyticsforSmarterTradingBEAST/v1/docs/FieldValuesResponseRoot.md)
+ - [IndexETF](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/BestExecutionAnalyticsforSmarterTradingBEAST/v1/docs/IndexETF.md)
+ - [IndexETFResponse](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/BestExecutionAnalyticsforSmarterTradingBEAST/v1/docs/IndexETFResponse.md)
+ - [IndexETFResponseRoot](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/BestExecutionAnalyticsforSmarterTradingBEAST/v1/docs/IndexETFResponseRoot.md)
+ - [IntraOrderStat](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/BestExecutionAnalyticsforSmarterTradingBEAST/v1/docs/IntraOrderStat.md)
+ - [IntraOrderStatResponse](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/BestExecutionAnalyticsforSmarterTradingBEAST/v1/docs/IntraOrderStatResponse.md)
+ - [IntraOrderStatResponseRoot](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/BestExecutionAnalyticsforSmarterTradingBEAST/v1/docs/IntraOrderStatResponseRoot.md)
+ - [InvestmentTiming](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/BestExecutionAnalyticsforSmarterTradingBEAST/v1/docs/InvestmentTiming.md)
+ - [InvestmentTimingResponse](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/BestExecutionAnalyticsforSmarterTradingBEAST/v1/docs/InvestmentTimingResponse.md)
+ - [InvestmentTimingResponseRoot](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/BestExecutionAnalyticsforSmarterTradingBEAST/v1/docs/InvestmentTimingResponseRoot.md)
+ - [MultiDayBenchmarks](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/BestExecutionAnalyticsforSmarterTradingBEAST/v1/docs/MultiDayBenchmarks.md)
+ - [Order](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/BestExecutionAnalyticsforSmarterTradingBEAST/v1/docs/Order.md)
+ - [OrderFillCountResponse](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/BestExecutionAnalyticsforSmarterTradingBEAST/v1/docs/OrderFillCountResponse.md)
+ - [OrderFillCountResponseRoot](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/BestExecutionAnalyticsforSmarterTradingBEAST/v1/docs/OrderFillCountResponseRoot.md)
+ - [OrderInfoResponse](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/BestExecutionAnalyticsforSmarterTradingBEAST/v1/docs/OrderInfoResponse.md)
+ - [OrderInfoResponseRoot](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/BestExecutionAnalyticsforSmarterTradingBEAST/v1/docs/OrderInfoResponseRoot.md)
+ - [OrdersResponse](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/BestExecutionAnalyticsforSmarterTradingBEAST/v1/docs/OrdersResponse.md)
+ - [OrdersResponseRoot](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/BestExecutionAnalyticsforSmarterTradingBEAST/v1/docs/OrdersResponseRoot.md)
+ - [Outlier](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/BestExecutionAnalyticsforSmarterTradingBEAST/v1/docs/Outlier.md)
+ - [OutlierData](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/BestExecutionAnalyticsforSmarterTradingBEAST/v1/docs/OutlierData.md)
+ - [OutlierDataResult](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/BestExecutionAnalyticsforSmarterTradingBEAST/v1/docs/OutlierDataResult.md)
+ - [OutlierMetrics](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/BestExecutionAnalyticsforSmarterTradingBEAST/v1/docs/OutlierMetrics.md)
+ - [OutlierResponse](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/BestExecutionAnalyticsforSmarterTradingBEAST/v1/docs/OutlierResponse.md)
+ - [OutlierResponseRoot](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/BestExecutionAnalyticsforSmarterTradingBEAST/v1/docs/OutlierResponseRoot.md)
+ - [OutputStrategyBinData](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/BestExecutionAnalyticsforSmarterTradingBEAST/v1/docs/OutputStrategyBinData.md)
+ - [PriceTimeFill](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/BestExecutionAnalyticsforSmarterTradingBEAST/v1/docs/PriceTimeFill.md)
+ - [PriceTimeFillResponse](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/BestExecutionAnalyticsforSmarterTradingBEAST/v1/docs/PriceTimeFillResponse.md)
+ - [PriceTimeFillResponseRoot](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/BestExecutionAnalyticsforSmarterTradingBEAST/v1/docs/PriceTimeFillResponseRoot.md)
+ - [PriceTimeQuote](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/BestExecutionAnalyticsforSmarterTradingBEAST/v1/docs/PriceTimeQuote.md)
+ - [PriceTimeQuoteResponse](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/BestExecutionAnalyticsforSmarterTradingBEAST/v1/docs/PriceTimeQuoteResponse.md)
+ - [PriceTimeQuoteResponseRoot](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/BestExecutionAnalyticsforSmarterTradingBEAST/v1/docs/PriceTimeQuoteResponseRoot.md)
+ - [PriceTimeTrade](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/BestExecutionAnalyticsforSmarterTradingBEAST/v1/docs/PriceTimeTrade.md)
+ - [PriceTimeTradeResponse](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/BestExecutionAnalyticsforSmarterTradingBEAST/v1/docs/PriceTimeTradeResponse.md)
+ - [PriceTimeTradeResponseRoot](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/BestExecutionAnalyticsforSmarterTradingBEAST/v1/docs/PriceTimeTradeResponseRoot.md)
+ - [QuoteInsideSize](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/BestExecutionAnalyticsforSmarterTradingBEAST/v1/docs/QuoteInsideSize.md)
+ - [QuoteInsideSizeResponse](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/BestExecutionAnalyticsforSmarterTradingBEAST/v1/docs/QuoteInsideSizeResponse.md)
+ - [QuoteInsideSizeResponseRoot](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/BestExecutionAnalyticsforSmarterTradingBEAST/v1/docs/QuoteInsideSizeResponseRoot.md)
+ - [ReportRecord](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/BestExecutionAnalyticsforSmarterTradingBEAST/v1/docs/ReportRecord.md)
+ - [ReportResponse](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/BestExecutionAnalyticsforSmarterTradingBEAST/v1/docs/ReportResponse.md)
+ - [ReportResponseRoot](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/BestExecutionAnalyticsforSmarterTradingBEAST/v1/docs/ReportResponseRoot.md)
+ - [TradeAnalytic](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/BestExecutionAnalyticsforSmarterTradingBEAST/v1/docs/TradeAnalytic.md)
+ - [TradeAnalyticsResponse](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/BestExecutionAnalyticsforSmarterTradingBEAST/v1/docs/TradeAnalyticsResponse.md)
+ - [TradeAnalyticsResponseRoot](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/BestExecutionAnalyticsforSmarterTradingBEAST/v1/docs/TradeAnalyticsResponseRoot.md)
+ - [VolumeAnalytic](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/BestExecutionAnalyticsforSmarterTradingBEAST/v1/docs/VolumeAnalytic.md)
+ - [VolumeAnalyticsResponse](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/BestExecutionAnalyticsforSmarterTradingBEAST/v1/docs/VolumeAnalyticsResponse.md)
+ - [VolumeAnalyticsResponseRoot](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/BestExecutionAnalyticsforSmarterTradingBEAST/v1/docs/VolumeAnalyticsResponseRoot.md)
+ - [VolumePrice](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/BestExecutionAnalyticsforSmarterTradingBEAST/v1/docs/VolumePrice.md)
+ - [VolumePriceBin](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/BestExecutionAnalyticsforSmarterTradingBEAST/v1/docs/VolumePriceBin.md)
+ - [VolumePriceMetrics](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/BestExecutionAnalyticsforSmarterTradingBEAST/v1/docs/VolumePriceMetrics.md)
+ - [VolumePriceResponse](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/BestExecutionAnalyticsforSmarterTradingBEAST/v1/docs/VolumePriceResponse.md)
+ - [VolumePriceResponseRoot](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/BestExecutionAnalyticsforSmarterTradingBEAST/v1/docs/VolumePriceResponseRoot.md)
+ - [VolumeTime](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/BestExecutionAnalyticsforSmarterTradingBEAST/v1/docs/VolumeTime.md)
+ - [VolumeTimeResponse](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/BestExecutionAnalyticsforSmarterTradingBEAST/v1/docs/VolumeTimeResponse.md)
+ - [VolumeTimeResponseRoot](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/BestExecutionAnalyticsforSmarterTradingBEAST/v1/docs/VolumeTimeResponseRoot.md)
+ - [VolumeVenue](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/BestExecutionAnalyticsforSmarterTradingBEAST/v1/docs/VolumeVenue.md)
+ - [VolumeVenueResponse](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/BestExecutionAnalyticsforSmarterTradingBEAST/v1/docs/VolumeVenueResponse.md)
+ - [VolumeVenueResponseRoot](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/BestExecutionAnalyticsforSmarterTradingBEAST/v1/docs/VolumeVenueResponseRoot.md)
+ - [Vwap](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/BestExecutionAnalyticsforSmarterTradingBEAST/v1/docs/Vwap.md)
+ - [VwapResponse](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/BestExecutionAnalyticsforSmarterTradingBEAST/v1/docs/VwapResponse.md)
+ - [VwapResponseRoot](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/BestExecutionAnalyticsforSmarterTradingBEAST/v1/docs/VwapResponseRoot.md)
+ - [ZScore](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/BestExecutionAnalyticsforSmarterTradingBEAST/v1/docs/ZScore.md)
+ - [ZScoreResponse](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/BestExecutionAnalyticsforSmarterTradingBEAST/v1/docs/ZScoreResponse.md)
+ - [ZScoreResponseRoot](https://github.com/FactSet/enterprise-sdk/tree/main/code/python/BestExecutionAnalyticsforSmarterTradingBEAST/v1/docs/ZScoreResponseRoot.md)
+
+
+## Documentation For Authorization
+
+
+## FactSetApiKey
+
+- **Type**: HTTP basic authentication
+
+
+## FactSetOAuth2
+
+- **Type**: OAuth
+- **Flow**: application
+- **Authorization URL**: 
+- **Scopes**: N/A
+
+
+## Notes for Large OpenAPI documents
+If the OpenAPI document is large, imports in fds.sdk.BestExecutionAnalyticsforSmarterTradingBEAST.apis and fds.sdk.BestExecutionAnalyticsforSmarterTradingBEAST.models may fail with a
+RecursionError indicating the maximum recursion limit has been exceeded. In that case, there are a couple of solutions:
+
+Solution 1:
+Use specific imports for apis and models like:
+- `from fds.sdk.BestExecutionAnalyticsforSmarterTradingBEAST.api.default_api import DefaultApi`
+- `from fds.sdk.BestExecutionAnalyticsforSmarterTradingBEAST.model.pet import Pet`
+
+Solution 2:
+Before importing the package, adjust the maximum recursion limit as shown below:
+```
+import sys
+sys.setrecursionlimit(1500)
+import fds.sdk.BestExecutionAnalyticsforSmarterTradingBEAST
+from fds.sdk.BestExecutionAnalyticsforSmarterTradingBEAST.apis import *
+from fds.sdk.BestExecutionAnalyticsforSmarterTradingBEAST.models import *
+```
+
+## Contributing
+
+Please refer to the [contributing guide](../../../../CONTRIBUTING.md).
+
+## Copyright
+
+Copyright 2022 FactSet Research Systems Inc
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+
+
+