Bonds API for Digital Portals client library for Python

Navigation

Verified details

These details have been verified by PyPI
Maintainers
Avatar for factset from gravatar.com factset

Unverified details

These details have not been verified by PyPI
Project links
Meta
  • License: Apache-2.0
  • Author: FactSet Research Systems
  • Tags FactSet , API , SDK
  • Requires: Python >=3.6
Report project as malware

Project description

FactSet

Bonds API for Digital Portals client library for Python

PyPi Apache-2 license

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.BondsAPIforDigitalPortals

pip

pip install fds.sdk.utils fds.sdk.BondsAPIforDigitalPortals

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.BondsAPIforDigitalPortals
from fds.sdk.BondsAPIforDigitalPortals.api import debt_instrument_api
from fds.sdk.BondsAPIforDigitalPortals.model.inline_object import InlineObject
from fds.sdk.BondsAPIforDigitalPortals.model.inline_object1 import InlineObject1
from fds.sdk.BondsAPIforDigitalPortals.model.inline_object2 import InlineObject2
from fds.sdk.BondsAPIforDigitalPortals.model.inline_response200 import InlineResponse200
from fds.sdk.BondsAPIforDigitalPortals.model.inline_response2001 import InlineResponse2001
from fds.sdk.BondsAPIforDigitalPortals.model.inline_response2002 import InlineResponse2002
from fds.sdk.BondsAPIforDigitalPortals.model.inline_response2003 import InlineResponse2003
from fds.sdk.BondsAPIforDigitalPortals.model.inline_response2004 import InlineResponse2004
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.BondsAPIforDigitalPortals.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.BondsAPIforDigitalPortals.Configuration(
#     username = 'USERNAME-SERIAL',
#     password = 'API-KEY'
# )

# Enter a context with an instance of the API client
with fds.sdk.BondsAPIforDigitalPortals.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = debt_instrument_api.DebtInstrumentApi(api_client)
    id = "id_example" # str | Identifier of the instrument.
attributes = [
        "_attributes_example",
    ] # [str] | Limit the attributes returned in the response to the specified set. (optional)
language = "_language_example" # str | ISO 639-1 code of the language. (optional)

    try:
        # Fundamental data for a debt instrument.
        api_response = api_instance.get_debt_instrument_get(id, attributes=attributes, language=language)
        pprint(api_response)
    except fds.sdk.BondsAPIforDigitalPortals.ApiException as e:
        print("Exception when calling DebtInstrumentApi->get_debt_instrument_get: %s\n" % e)

Documentation for API Endpoints

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

Class Method HTTP request Description
DebtInstrumentApi get_debt_instrument_get GET /debtInstrument/get Fundamental data for a debt instrument.
DebtInstrumentApi get_debt_instrument_key_figures_notation_get GET /debtInstrument/keyFigures/notation/get Key figures of a debt instrument.
DebtInstrumentApi post_debt_instrument_issuer_search POST /debtInstrument/issuer/search Search for issuers of debt instruments.
DebtInstrumentApi post_debt_instrument_notation_screener_search POST /debtInstrument/notation/screener/search Screener for debt instruments' notations based on debt instrument-specific parameters.
DebtInstrumentApi post_debt_instrument_notation_screener_value_ranges_get POST /debtInstrument/notation/screener/valueRanges/get Possible values and value ranges for the parameters used in the endpoint `/debtInstrument/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.BondsAPIforDigitalPortals.apis and fds.sdk.BondsAPIforDigitalPortals.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.BondsAPIforDigitalPortals.api.default_api import DefaultApi
  • from fds.sdk.BondsAPIforDigitalPortals.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.BondsAPIforDigitalPortals
from fds.sdk.BondsAPIforDigitalPortals.apis import *
from fds.sdk.BondsAPIforDigitalPortals.models import *

Contributing

Please refer to the contributing guide.

Copyright

Copyright 2022 FactSet Research Systems Inc

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

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

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

Project details

Verified details

These details have been verified by PyPI
Maintainers
Avatar for factset from gravatar.com factset

Unverified details

These details have not been verified by PyPI
Project links
Meta
  • License: Apache-2.0
  • Author: FactSet Research Systems
  • Tags FactSet , API , SDK
  • Requires: Python >=3.6

Release history Release notifications | RSS feed

0.10.2

0.10.1

0.10.0

This version

0.9.1

0.9.0

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

If you're not sure about the file name format, learn more about wheel file names.

fds.sdk.BondsAPIforDigitalPortals-0.9.1-py3-none-any.whl (637.5 kB view details)

Uploaded Python 3

File details

Details for the file fds.sdk.BondsAPIforDigitalPortals-0.9.1-py3-none-any.whl.

File metadata

  • Download URL: fds.sdk.BondsAPIforDigitalPortals-0.9.1-py3-none-any.whl
  • Upload date:
  • Size: 637.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.8.0 pkginfo/1.8.2 readme-renderer/32.0 requests/2.27.1 requests-toolbelt/0.9.1 urllib3/1.26.8 tqdm/4.62.3 importlib-metadata/4.8.3 keyring/23.4.1 rfc3986/1.5.0 colorama/0.4.4 CPython/3.6.15

File hashes

Hashes for fds.sdk.BondsAPIforDigitalPortals-0.9.1-py3-none-any.whl
Algorithm Hash digest
SHA256 b89b339c46b1974512a0de71b1283e32a2831195002334b70d6b194f70301cfa
MD5 b5f28a48126ddb3e75cb5a2145219265
BLAKE2b-256 c3942baa7067f9a17a96ac4f984309c67080c4b754ba3ff85ca5f08f99fd146f

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page