Securitized Derivatives API for Digital Portals client library for Python

These details have not been verified by PyPI

Project links

Homepage

GitHub Statistics

View statistics for this project via Libraries.io, or by using our public dataset on Google BigQuery

Project description

Securitized Derivatives 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.1
Build package: org.openapitools.codegen.languages.PythonClientCodegen

Requirements

Python >= 3.6

Installation

Poetry

poetry add fds.sdk.utils fds.sdk.SecuritizedDerivativesAPIforDigitalPortals

pip

pip install fds.sdk.utils fds.sdk.SecuritizedDerivativesAPIforDigitalPortals

Usage

Generate authentication credentials.
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.
Install dependencies.
Run the following:

from fds.sdk.utils.authentication import ConfidentialClient
import fds.sdk.SecuritizedDerivativesAPIforDigitalPortals
from fds.sdk.SecuritizedDerivativesAPIforDigitalPortals.api import securitized_derivative_api
from fds.sdk.SecuritizedDerivativesAPIforDigitalPortals.model.inline_object import InlineObject
from fds.sdk.SecuritizedDerivativesAPIforDigitalPortals.model.inline_object1 import InlineObject1
from fds.sdk.SecuritizedDerivativesAPIforDigitalPortals.model.inline_object2 import InlineObject2
from fds.sdk.SecuritizedDerivativesAPIforDigitalPortals.model.inline_object3 import InlineObject3
from fds.sdk.SecuritizedDerivativesAPIforDigitalPortals.model.inline_response200 import InlineResponse200
from fds.sdk.SecuritizedDerivativesAPIforDigitalPortals.model.inline_response2001 import InlineResponse2001
from fds.sdk.SecuritizedDerivativesAPIforDigitalPortals.model.inline_response2002 import InlineResponse2002
from fds.sdk.SecuritizedDerivativesAPIforDigitalPortals.model.inline_response2003 import InlineResponse2003
from fds.sdk.SecuritizedDerivativesAPIforDigitalPortals.model.inline_response2004 import InlineResponse2004
from fds.sdk.SecuritizedDerivativesAPIforDigitalPortals.model.inline_response2005 import InlineResponse2005
from fds.sdk.SecuritizedDerivativesAPIforDigitalPortals.model.inline_response2006 import InlineResponse2006
from fds.sdk.SecuritizedDerivativesAPIforDigitalPortals.model.inline_response2007 import InlineResponse2007
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.SecuritizedDerivativesAPIforDigitalPortals.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.SecuritizedDerivativesAPIforDigitalPortals.Configuration(
#     username = 'USERNAME-SERIAL',
#     password = 'API-KEY'
# )

# Enter a context with an instance of the API client
with fds.sdk.SecuritizedDerivativesAPIforDigitalPortals.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = securitized_derivative_api.SecuritizedDerivativeApi(api_client)
    attributes = [
        "_attributes_example",
    ] # [str] | Limit the attributes returned in the response to the specified set. (optional)

    try:
        # List of barrier types.
        api_response = api_instance.get_securitized_derivative_barrier_type_list(attributes=attributes)
        pprint(api_response)
    except fds.sdk.SecuritizedDerivativesAPIforDigitalPortals.ApiException as e:
        print("Exception when calling SecuritizedDerivativeApi->get_securitized_derivative_barrier_type_list: %s\n" % e)

Documentation for API Endpoints

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

Class	Method	HTTP request	Description
SecuritizedDerivativeApi	get_securitized_derivative_barrier_type_list	GET /securitizedDerivative/barrier/type/list	List of barrier types.
SecuritizedDerivativeApi	get_securitized_derivative_get	GET /securitizedDerivative/get	Fundamental data for a single securitized derivative.
SecuritizedDerivativeApi	get_securitized_derivative_key_figures_notation_get	GET /securitizedDerivative/keyFigures/notation/get	Notation-based key figures of a securitized derivative.
SecuritizedDerivativeApi	get_securitized_derivative_underlying_list	GET /securitizedDerivative/underlying/list	List of underlyings with barrier and cash flow information.
SecuritizedDerivativeApi	post_securitized_derivative_issuer_search	POST /securitizedDerivative/issuer/search	Search for issuers of securitized derivatives.
SecuritizedDerivativeApi	post_securitized_derivative_notation_ranking_intraday_list	POST /securitizedDerivative/notation/ranking/intraday/list	Ranking of securitized derivatives' notations using intraday figures.
SecuritizedDerivativeApi	post_securitized_derivative_notation_screener_search	POST /securitizedDerivative/notation/screener/search	Screener for securitized derivatives's notations based on securitized derivatives-specific parameters.
SecuritizedDerivativeApi	post_securitized_derivative_notation_screener_value_ranges_get	POST /securitizedDerivative/notation/screener/valueRanges/get	Possible values and value ranges for the parameters used in the endpoint `/securitizedDerivative/notation/screener/search`.

Documentation For Models

Documentation For Authorization

FactSetApiKey

Type: HTTP basic authentication

FactSetOAuth2

Type: OAuth
Flow: application
Authorization URL:
Scopes: N/A

Notes for Large OpenAPI documents

If the OpenAPI document is large, imports in fds.sdk.SecuritizedDerivativesAPIforDigitalPortals.apis and fds.sdk.SecuritizedDerivativesAPIforDigitalPortals.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.SecuritizedDerivativesAPIforDigitalPortals.api.default_api import DefaultApi
from fds.sdk.SecuritizedDerivativesAPIforDigitalPortals.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.SecuritizedDerivativesAPIforDigitalPortals
from fds.sdk.SecuritizedDerivativesAPIforDigitalPortals.apis import *
from fds.sdk.SecuritizedDerivativesAPIforDigitalPortals.models import *

Contributing

Please refer to the contributing guide.

Copyright

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

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

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

Project details

These details have not been verified by PyPI

Project links

Homepage

GitHub Statistics

View statistics for this project via Libraries.io, or by using our public dataset on Google BigQuery

Release history Release notifications | RSS feed

0.10.2

Aug 31, 2022

0.10.1

Jul 21, 2022

0.10.0

May 24, 2022

This version

0.9.1

Feb 14, 2022

0.9.0

Feb 2, 2022

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distribution

fds.sdk.SecuritizedDerivativesAPIforDigitalPortals-0.9.1-py3-none-any.whl (1.4 MB view hashes)

Uploaded Feb 14, 2022 Python 3

Hashes for fds.sdk.SecuritizedDerivativesAPIforDigitalPortals-0.9.1-py3-none-any.whl

Hashes for fds.sdk.SecuritizedDerivativesAPIforDigitalPortals-0.9.1-py3-none-any.whl
Algorithm	Hash digest
SHA256	`a73f84a4a77d703c0e2babd4773b81b42e9770d64f735832b481dd77c19fa4d7`
MD5	`a5e47369bbc0c4d24608c39dfed9d342`
BLAKE2b-256	`5f3c33a47645bcc32c004a1ee3d3251f92a2b81b89d19dd7277d2e82c42565f4`