fds.sdk.TimeSeriesAPIforDigitalPortals 0.9.2

Time Series API for Digital Portals client library for Python

Time Series API for Digital Portals client library for Python

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

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

• API version: v1
• Package version: 0.9.2
• Build package: org.openapitools.codegen.languages.PythonClientCodegen

Requirements

• Python >= 3.6

Installation

Poetry

poetry add fds.sdk.utils fds.sdk.TimeSeriesAPIforDigitalPortals

pip

pip install fds.sdk.utils fds.sdk.TimeSeriesAPIforDigitalPortals

Usage

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

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

      pyenv install 3.9.7
      pyenv shell 3.9.7
      

   2. (optional) Install poetry.

3. Install dependencies.
4. Run the following:

from fds.sdk.utils.authentication import ConfidentialClient
import fds.sdk.TimeSeriesAPIforDigitalPortals
from fds.sdk.TimeSeriesAPIforDigitalPortals.api import prices_api
from fds.sdk.TimeSeriesAPIforDigitalPortals.model.inline_object4 import InlineObject4
from fds.sdk.TimeSeriesAPIforDigitalPortals.model.inline_object5 import InlineObject5
from fds.sdk.TimeSeriesAPIforDigitalPortals.model.inline_object6 import InlineObject6
from fds.sdk.TimeSeriesAPIforDigitalPortals.model.inline_object7 import InlineObject7
from fds.sdk.TimeSeriesAPIforDigitalPortals.model.inline_object8 import InlineObject8
from fds.sdk.TimeSeriesAPIforDigitalPortals.model.inline_response20010 import InlineResponse20010
from fds.sdk.TimeSeriesAPIforDigitalPortals.model.inline_response2005 import InlineResponse2005
from fds.sdk.TimeSeriesAPIforDigitalPortals.model.inline_response2006 import InlineResponse2006
from fds.sdk.TimeSeriesAPIforDigitalPortals.model.inline_response2007 import InlineResponse2007
from fds.sdk.TimeSeriesAPIforDigitalPortals.model.inline_response2008 import InlineResponse2008
from fds.sdk.TimeSeriesAPIforDigitalPortals.model.inline_response2009 import InlineResponse2009
from pprint import pprint

# See configuration.py for a list of all supported configuration parameters.

# Examples for each supported authentication method are below,
# choose one that satisfies your use case.

# (Preferred) OAuth 2.0: FactSetOAuth2
# See https://github.com/FactSet/enterprise-sdk#oauth-20
# for information on how to create the app-config.json file
# See https://github.com/FactSet/enterprise-sdk-utils-python#authentication
# for more information on using the ConfidentialClient class
configuration = fds.sdk.TimeSeriesAPIforDigitalPortals.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.TimeSeriesAPIforDigitalPortals.Configuration(
#     username='USERNAME-SERIAL',
#     password='API-KEY'
# )

# Enter a context with an instance of the API client
with fds.sdk.TimeSeriesAPIforDigitalPortals.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = prices_api.PricesApi(api_client)
    id = "id_example" # str | Identifier of the notation.
    _from = "from_example" # str | Date and time of the start point of the subsample (inclusive). `from` must be aligned to `granularity`. That is, the numerical value is an integral multiple of the time span value represented by `granularity`. The data accessible in the past is limited to a few weeks at most. Dates in the future are not allowed.
    type = "trade" # str | Type of the price as configured for the customer. (optional) (default to "trade")
    quality = "DLY" # str | Quality of the price. (optional) (default to "DLY")
    granularity = "1h" # str | Subsample granularities suitable for intraday data. (optional) (default to "1h")
    attributes = [
        "_attributes_example",
    ] # [str] | Limit the attributes returned in the response to the specified set. (optional)

    # Get response
    try:
        # Single subsample intraday data for a notation.
        api_response = api_instance.get_prices_time_series_intraday_subsample_get(id, _from, type=type, quality=quality, granularity=granularity, attributes=attributes)
        pprint(api_response)
    except fds.sdk.TimeSeriesAPIforDigitalPortals.ApiException as e:
        print("Exception when calling PricesApi->get_prices_time_series_intraday_subsample_get: %s\n" % e)

    # Get response, http status code and response headers
    # try:
    #     # Single subsample intraday data for a notation.
    #     api_response, http_status_code, response_headers = api_instance.get_prices_time_series_intraday_subsample_get_with_http_info(id, _from, type=type, quality=quality, granularity=granularity, attributes=attributes)
    #     pprint(api_response)
    #     pprint(http_status_code)
    #     pprint(response_headers)
    # except fds.sdk.TimeSeriesAPIforDigitalPortals.ApiException as e:
    #     print("Exception when calling PricesApi->get_prices_time_series_intraday_subsample_get: %s\n" % e)

    # Get response asynchronous
    # try:
    #     # Single subsample intraday data for a notation.
    #     async_result = api_instance.get_prices_time_series_intraday_subsample_get_async(id, _from, type=type, quality=quality, granularity=granularity, attributes=attributes)
    #     api_response = async_result.get()
    #     pprint(api_response)
    # except fds.sdk.TimeSeriesAPIforDigitalPortals.ApiException as e:
    #     print("Exception when calling PricesApi->get_prices_time_series_intraday_subsample_get: %s\n" % e)

    # Get response, http status code and response headers asynchronous
    # try:
    #     # Single subsample intraday data for a notation.
    #     async_result = api_instance.get_prices_time_series_intraday_subsample_get_with_http_info_async(id, _from, type=type, quality=quality, granularity=granularity, attributes=attributes)
    #     api_response, http_status_code, response_headers = async_result.get()
    #     pprint(api_response)
    #     pprint(http_status_code)
    #     pprint(response_headers)
    # except fds.sdk.TimeSeriesAPIforDigitalPortals.ApiException as e:
    #     print("Exception when calling PricesApi->get_prices_time_series_intraday_subsample_get: %s\n" % e)

Documentation for API Endpoints

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

Class	Method	HTTP request	Description
PricesApi	get_prices_time_series_intraday_subsample_get	GET /prices/timeSeries/intraday/subsample/get	Single subsample intraday data for a notation.
PricesApi	post_prices_time_series_eod_list	POST /prices/timeSeries/eod/list	End-of-day time series data for a notation.
PricesApi	post_prices_time_series_eod_subsample_get	POST /prices/timeSeries/eod/subsample/get	Single subsample end-of-day data for a notation.
PricesApi	post_prices_time_series_eod_subsample_list	POST /prices/timeSeries/eod/subsample/list	Subsampled end-of-day time series data for a notation.
PricesApi	post_prices_time_series_intraday_list	POST /prices/timeSeries/intraday/list	Intraday time series data for a notation.
PricesApi	post_prices_time_series_intraday_subsample_list	POST /prices/timeSeries/intraday/subsample/list	Subsampled intraday time series data for a notation.
VendorApi	get_vendor_chart_iq_time_series_intraday_subsample_get	GET /vendor/chartIQ/timeSeries/intraday/subsample/get	Single subsample intraday data for a notation.
VendorApi	post_vendor_chart_iq_time_series_eod_list	POST /vendor/chartIQ/timeSeries/eod/list	End-of-day time series data for a notation.
VendorApi	post_vendor_chart_iq_time_series_eod_subsample_get	POST /vendor/chartIQ/timeSeries/eod/subsample/get	Single subsample end-of-day data for a notation.
VendorApi	post_vendor_chart_iq_time_series_eod_subsample_list	POST /vendor/chartIQ/timeSeries/eod/subsample/list	Subsampled end-of-day time series data for a notation.
VendorApi	post_vendor_chart_iq_time_series_intraday_subsample_list	POST /vendor/chartIQ/timeSeries/intraday/subsample/list	Subsampled intraday time series data for a notation.

Documentation For Models

• AttributesMember
• CursorBasedPaginationOutputObject
• CursorBasedPaginationOutputObjectWithoutTotal
• ErrorMetaObject
• ErrorObject
• InlineObject
• InlineObject1
• InlineObject2
• InlineObject3
• InlineObject4
• InlineObject5
• InlineObject6
• InlineObject7
• InlineObject8
• InlineResponse200
• InlineResponse2001
• InlineResponse20010
• InlineResponse20010Data
• InlineResponse20010DataSubsamples
• InlineResponse2001Data
• InlineResponse2001Meta
• InlineResponse2002
• InlineResponse2002Data
• InlineResponse2003
• InlineResponse2003Data
• InlineResponse2004
• InlineResponse2004Data
• InlineResponse2004DataRange
• InlineResponse2005
• InlineResponse2005Data
• InlineResponse2005DataPrices
• InlineResponse2006
• InlineResponse2006Data
• InlineResponse2006DataSubsample
• InlineResponse2007
• InlineResponse2007Data
• InlineResponse2007DataSubsamples
• InlineResponse2008
• InlineResponse2008Data
• InlineResponse2008DataPrices
• InlineResponse2009
• InlineResponse2009Data
• InlineResponse2009DataSubsample
• InlineResponse200Data
• InlineResponse200DataRange
• InlineResponse200Meta
• LanguageMember
• OffsetBasedPaginationOutputObject
• OffsetBasedPaginationOutputObjectWithoutTotal
• PartialOutputObject
• PricesTimeSeriesEodSubsampleGetData
• PricesTimeSeriesEodSubsampleGetDataInterval
• PricesTimeSeriesEodSubsampleListData
• PricesTimeSeriesIntradayListData
• PricesTimeSeriesIntradayListDataRange
• PricesTimeSeriesIntradayListMeta
• PricesTimeSeriesIntradayListMetaPagination
• StatusObject
• VendorChartIQTimeSeriesEodListData
• VendorChartIQTimeSeriesEodListDataAdjustments
• VendorChartIQTimeSeriesEodListDataRange
• VendorChartIQTimeSeriesEodListMeta
• VendorChartIQTimeSeriesEodListMetaPagination
• VendorChartIQTimeSeriesEodSubsampleGetData
• VendorChartIQTimeSeriesEodSubsampleGetDataInterval
• VendorChartIQTimeSeriesEodSubsampleGetMeta
• VendorChartIQTimeSeriesEodSubsampleListData
• VendorChartIQTimeSeriesIntradaySubsampleListData
• VendorChartIQTimeSeriesIntradaySubsampleListDataRange

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

Contributing

Please refer to the contributing guide.

Copyright

Copyright 2022 FactSet Research Systems Inc

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

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

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