fds.sdk.BondsAPIforDigitalPortals 0.10.2
Bonds API for Digital Portals client library for Python
License: Apache-2.0
Requires Python: >=3.7
Keywords: FactSet,API,SDK

<img alt="FactSet" src="https://www.factset.com/hubfs/Assets/images/factset-logo.svg" height="56" width="290">

# Bonds API for Digital Portals client library for Python

[![PyPi](https://img.shields.io/pypi/v/fds.sdk.BondsAPIforDigitalPortals)](https://pypi.org/project/fds.sdk.BondsAPIforDigitalPortals/)
[![Apache-2 license](https://img.shields.io/badge/license-Apache2-brightgreen.svg)](https://www.apache.org/licenses/LICENSE-2.0)

Search for fixed income instruments, using a criteria-based screener. The API provides also fundamental data and key figures, basic interest rate information and derived coupon lists.

Available search criteria include:

* validation: filter for only active listings, by price quality and latest/previous available price dates
* traded markets: filter and indicate a market priority for the validation
* important dates in and features of the life cycle of the fixed income instruments
* filter by issuer, its country of registration and the issued volume
* coupon data: occurrence and frequency of coupon payments, current interest rate range
* yield and yield to maturity range, spread
* Macaulay duration
* sensitivity ranges: base point value, modified duration, elasticity, convexity
* cash flow for all transactions over a certain time range: sum or average
* country-specific attributes: for Germany: is eligible for trustees
      
The key figures are calculated using delayed prices with an additional delay of 10 minutes after an update of the debt instrument's price.
Special product features such as the right to a maturity extension, an attached option, or convertibility are not considered for the key figure calculation. Further, a calculation is not performed for perpetual products and for products with variable interest rate.

This API is fully integrated with the corresponding Quotes API, allowing access to detailed price and performance information of instruments, as well as basic security identifier cross-reference. For direct access to price histories, please refer to the Time Series API for Digital Portals.

Similar criteria based screener APIs exist for equity instruments and securitized derivatives: See the Stocks API and the Securitized Derivatives API for details.

This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:

- API version: 2
- Package version: 0.10.2
- Build package: org.openapitools.codegen.languages.PythonClientCodegen

## Requirements

* Python >= 3.7

## Installation

### Poetry

```shell
poetry add fds.sdk.utils fds.sdk.BondsAPIforDigitalPortals
```

### pip

```shell
pip install fds.sdk.utils fds.sdk.BondsAPIforDigitalPortals
```

## 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:

```python

from fds.sdk.utils.authentication import ConfidentialClient
import fds.sdk.BondsAPIforDigitalPortals
from fds.sdk.BondsAPIforDigitalPortals.api import debt_instrument_api
from fds.sdk.BondsAPIforDigitalPortals.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
# 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 | 
    attributes = [
        "_attributes_example",
    ] # [str] | Limit the attributes returned in the response to the specified set. (optional)
    language = "_language_example" # str |  (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)

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

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

    # Get response, http status code and response headers asynchronous
    # try:
    #     # Fundamental data for a debt instrument.
    #     async_result = api_instance.get_debt_instrument_get_with_http_info_async(id, attributes=attributes, language=language)
    #     api_response, http_status_code, response_headers = async_result.get()
    #     pprint(api_response)
    #     pprint(http_status_code)
    #     pprint(response_headers)
    # 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 *https://api.factset.com/wealth/v1*

Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*DebtInstrumentApi* | [**get_debt_instrument_get**](docs/DebtInstrumentApi.md#get_debt_instrument_get) | **GET** /debtInstrument/get | Fundamental data for a debt instrument.
*DebtInstrumentApi* | [**get_debt_instrument_key_figures_notation_get**](docs/DebtInstrumentApi.md#get_debt_instrument_key_figures_notation_get) | **GET** /debtInstrument/keyFigures/notation/get | Key figures of a debt instrument.
*DebtInstrumentApi* | [**post_debt_instrument_issuer_search**](docs/DebtInstrumentApi.md#post_debt_instrument_issuer_search) | **POST** /debtInstrument/issuer/search | Search for issuers of debt instruments.
*DebtInstrumentApi* | [**post_debt_instrument_notation_screener_search**](docs/DebtInstrumentApi.md#post_debt_instrument_notation_screener_search) | **POST** /debtInstrument/notation/screener/search | Screener for debt instruments&#39; notations based on debt instrument-specific parameters.
*DebtInstrumentApi* | [**post_debt_instrument_notation_screener_value_ranges_get**](docs/DebtInstrumentApi.md#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 &#x60;/debtInstrument/notation/screener/search.&#x60;


## Documentation For Models

 - [AttributesMember](docs/AttributesMember.md)
 - [CursorBasedPaginationOutputObject](docs/CursorBasedPaginationOutputObject.md)
 - [CursorBasedPaginationOutputObjectWithoutTotal](docs/CursorBasedPaginationOutputObjectWithoutTotal.md)
 - [DebtInstrumentIssuerSearchData](docs/DebtInstrumentIssuerSearchData.md)
 - [DebtInstrumentIssuerSearchDataCountry](docs/DebtInstrumentIssuerSearchDataCountry.md)
 - [DebtInstrumentIssuerSearchDataMarket](docs/DebtInstrumentIssuerSearchDataMarket.md)
 - [DebtInstrumentIssuerSearchDataMinimumRatingGrade](docs/DebtInstrumentIssuerSearchDataMinimumRatingGrade.md)
 - [DebtInstrumentIssuerSearchDataMinimumRatingGradeDebtInstrument](docs/DebtInstrumentIssuerSearchDataMinimumRatingGradeDebtInstrument.md)
 - [DebtInstrumentIssuerSearchDataName](docs/DebtInstrumentIssuerSearchDataName.md)
 - [DebtInstrumentIssuerSearchMeta](docs/DebtInstrumentIssuerSearchMeta.md)
 - [DebtInstrumentNotationScreenerSearchData](docs/DebtInstrumentNotationScreenerSearchData.md)
 - [DebtInstrumentNotationScreenerSearchDataCompliance](docs/DebtInstrumentNotationScreenerSearchDataCompliance.md)
 - [DebtInstrumentNotationScreenerSearchDataComplianceGermany](docs/DebtInstrumentNotationScreenerSearchDataComplianceGermany.md)
 - [DebtInstrumentNotationScreenerSearchDataCoupon](docs/DebtInstrumentNotationScreenerSearchDataCoupon.md)
 - [DebtInstrumentNotationScreenerSearchDataCouponCurrentInterestRate](docs/DebtInstrumentNotationScreenerSearchDataCouponCurrentInterestRate.md)
 - [DebtInstrumentNotationScreenerSearchDataCouponCurrentInterestRateType](docs/DebtInstrumentNotationScreenerSearchDataCouponCurrentInterestRateType.md)
 - [DebtInstrumentNotationScreenerSearchDataCouponCurrentInterestRateValue](docs/DebtInstrumentNotationScreenerSearchDataCouponCurrentInterestRateValue.md)
 - [DebtInstrumentNotationScreenerSearchDataCouponCurrentInterestRateValueMaximum](docs/DebtInstrumentNotationScreenerSearchDataCouponCurrentInterestRateValueMaximum.md)
 - [DebtInstrumentNotationScreenerSearchDataCouponCurrentInterestRateValueMinimum](docs/DebtInstrumentNotationScreenerSearchDataCouponCurrentInterestRateValueMinimum.md)
 - [DebtInstrumentNotationScreenerSearchDataCouponOccurrence](docs/DebtInstrumentNotationScreenerSearchDataCouponOccurrence.md)
 - [DebtInstrumentNotationScreenerSearchDataCouponOccurrenceFrequency](docs/DebtInstrumentNotationScreenerSearchDataCouponOccurrenceFrequency.md)
 - [DebtInstrumentNotationScreenerSearchDataIssue](docs/DebtInstrumentNotationScreenerSearchDataIssue.md)
 - [DebtInstrumentNotationScreenerSearchDataIssueVolume](docs/DebtInstrumentNotationScreenerSearchDataIssueVolume.md)
 - [DebtInstrumentNotationScreenerSearchDataIssueVolumeCurrency](docs/DebtInstrumentNotationScreenerSearchDataIssueVolumeCurrency.md)
 - [DebtInstrumentNotationScreenerSearchDataIssueVolumeCurrencyExclude](docs/DebtInstrumentNotationScreenerSearchDataIssueVolumeCurrencyExclude.md)
 - [DebtInstrumentNotationScreenerSearchDataIssueVolumeCurrencyRestrict](docs/DebtInstrumentNotationScreenerSearchDataIssueVolumeCurrencyRestrict.md)
 - [DebtInstrumentNotationScreenerSearchDataIssuer](docs/DebtInstrumentNotationScreenerSearchDataIssuer.md)
 - [DebtInstrumentNotationScreenerSearchDataIssuerCountry](docs/DebtInstrumentNotationScreenerSearchDataIssuerCountry.md)
 - [DebtInstrumentNotationScreenerSearchDataIssuerCountryExclude](docs/DebtInstrumentNotationScreenerSearchDataIssuerCountryExclude.md)
 - [DebtInstrumentNotationScreenerSearchDataIssuerCountryRestrict](docs/DebtInstrumentNotationScreenerSearchDataIssuerCountryRestrict.md)
 - [DebtInstrumentNotationScreenerSearchDataIssuerSelection](docs/DebtInstrumentNotationScreenerSearchDataIssuerSelection.md)
 - [DebtInstrumentNotationScreenerSearchDataIssuerSelectionExclude](docs/DebtInstrumentNotationScreenerSearchDataIssuerSelectionExclude.md)
 - [DebtInstrumentNotationScreenerSearchDataIssuerSelectionRestrict](docs/DebtInstrumentNotationScreenerSearchDataIssuerSelectionRestrict.md)
 - [DebtInstrumentNotationScreenerSearchDataLifeCycle](docs/DebtInstrumentNotationScreenerSearchDataLifeCycle.md)
 - [DebtInstrumentNotationScreenerSearchDataLifeCycleIssue](docs/DebtInstrumentNotationScreenerSearchDataLifeCycleIssue.md)
 - [DebtInstrumentNotationScreenerSearchDataLifeCycleMaturity](docs/DebtInstrumentNotationScreenerSearchDataLifeCycleMaturity.md)
 - [DebtInstrumentNotationScreenerSearchDataLifeCycleMaturityRestriction](docs/DebtInstrumentNotationScreenerSearchDataLifeCycleMaturityRestriction.md)
 - [DebtInstrumentNotationScreenerSearchDataLifeCycleMaturityRestrictionDate](docs/DebtInstrumentNotationScreenerSearchDataLifeCycleMaturityRestrictionDate.md)
 - [DebtInstrumentNotationScreenerSearchDataLifeCycleMaturityRestrictionRemainingTermYears](docs/DebtInstrumentNotationScreenerSearchDataLifeCycleMaturityRestrictionRemainingTermYears.md)
 - [DebtInstrumentNotationScreenerSearchDataLifeCycleMaturityRestrictionRemainingTermYearsMaximum](docs/DebtInstrumentNotationScreenerSearchDataLifeCycleMaturityRestrictionRemainingTermYearsMaximum.md)
 - [DebtInstrumentNotationScreenerSearchDataLifeCycleMaturityRestrictionRemainingTermYearsMinimum](docs/DebtInstrumentNotationScreenerSearchDataLifeCycleMaturityRestrictionRemainingTermYearsMinimum.md)
 - [DebtInstrumentNotationScreenerSearchDataMacaulayDuration](docs/DebtInstrumentNotationScreenerSearchDataMacaulayDuration.md)
 - [DebtInstrumentNotationScreenerSearchDataRating](docs/DebtInstrumentNotationScreenerSearchDataRating.md)
 - [DebtInstrumentNotationScreenerSearchDataRatingGrade](docs/DebtInstrumentNotationScreenerSearchDataRatingGrade.md)
 - [DebtInstrumentNotationScreenerSearchDataRatingGradeMinimum](docs/DebtInstrumentNotationScreenerSearchDataRatingGradeMinimum.md)
 - [DebtInstrumentNotationScreenerSearchDataSensitivities](docs/DebtInstrumentNotationScreenerSearchDataSensitivities.md)
 - [DebtInstrumentNotationScreenerSearchDataSensitivitiesBasePointValue](docs/DebtInstrumentNotationScreenerSearchDataSensitivitiesBasePointValue.md)
 - [DebtInstrumentNotationScreenerSearchDataSensitivitiesConvexity](docs/DebtInstrumentNotationScreenerSearchDataSensitivitiesConvexity.md)
 - [DebtInstrumentNotationScreenerSearchDataSensitivitiesElasticity](docs/DebtInstrumentNotationScreenerSearchDataSensitivitiesElasticity.md)
 - [DebtInstrumentNotationScreenerSearchDataSensitivitiesModifiedDuration](docs/DebtInstrumentNotationScreenerSearchDataSensitivitiesModifiedDuration.md)
 - [DebtInstrumentNotationScreenerSearchDataTradedValue](docs/DebtInstrumentNotationScreenerSearchDataTradedValue.md)
 - [DebtInstrumentNotationScreenerSearchDataTradedValueDays30](docs/DebtInstrumentNotationScreenerSearchDataTradedValueDays30.md)
 - [DebtInstrumentNotationScreenerSearchDataTradedValueDays30Average](docs/DebtInstrumentNotationScreenerSearchDataTradedValueDays30Average.md)
 - [DebtInstrumentNotationScreenerSearchDataTradedValueDays30Sum](docs/DebtInstrumentNotationScreenerSearchDataTradedValueDays30Sum.md)
 - [DebtInstrumentNotationScreenerSearchDataTradingVolume](docs/DebtInstrumentNotationScreenerSearchDataTradingVolume.md)
 - [DebtInstrumentNotationScreenerSearchDataTradingVolumeOtc](docs/DebtInstrumentNotationScreenerSearchDataTradingVolumeOtc.md)
 - [DebtInstrumentNotationScreenerSearchDataTradingVolumeOtcMinimum](docs/DebtInstrumentNotationScreenerSearchDataTradingVolumeOtcMinimum.md)
 - [DebtInstrumentNotationScreenerSearchDataValidation](docs/DebtInstrumentNotationScreenerSearchDataValidation.md)
 - [DebtInstrumentNotationScreenerSearchDataValidationCategorization](docs/DebtInstrumentNotationScreenerSearchDataValidationCategorization.md)
 - [DebtInstrumentNotationScreenerSearchDataValidationCategorizationExclude](docs/DebtInstrumentNotationScreenerSearchDataValidationCategorizationExclude.md)
 - [DebtInstrumentNotationScreenerSearchDataValidationCategorizationRestrict](docs/DebtInstrumentNotationScreenerSearchDataValidationCategorizationRestrict.md)
 - [DebtInstrumentNotationScreenerSearchDataValidationInstrumentSelectionList](docs/DebtInstrumentNotationScreenerSearchDataValidationInstrumentSelectionList.md)
 - [DebtInstrumentNotationScreenerSearchDataValidationInstrumentSelectionListExclude](docs/DebtInstrumentNotationScreenerSearchDataValidationInstrumentSelectionListExclude.md)
 - [DebtInstrumentNotationScreenerSearchDataValidationInstrumentSelectionListRestrict](docs/DebtInstrumentNotationScreenerSearchDataValidationInstrumentSelectionListRestrict.md)
 - [DebtInstrumentNotationScreenerSearchDataValidationMarket](docs/DebtInstrumentNotationScreenerSearchDataValidationMarket.md)
 - [DebtInstrumentNotationScreenerSearchDataValidationMarketPriority](docs/DebtInstrumentNotationScreenerSearchDataValidationMarketPriority.md)
 - [DebtInstrumentNotationScreenerSearchDataValidationMarketSelection](docs/DebtInstrumentNotationScreenerSearchDataValidationMarketSelection.md)
 - [DebtInstrumentNotationScreenerSearchDataValidationMarketSelectionExclude](docs/DebtInstrumentNotationScreenerSearchDataValidationMarketSelectionExclude.md)
 - [DebtInstrumentNotationScreenerSearchDataValidationMarketSelectionRestrict](docs/DebtInstrumentNotationScreenerSearchDataValidationMarketSelectionRestrict.md)
 - [DebtInstrumentNotationScreenerSearchDataValidationNotationSelectionList](docs/DebtInstrumentNotationScreenerSearchDataValidationNotationSelectionList.md)
 - [DebtInstrumentNotationScreenerSearchDataValidationNotationSelectionListExclude](docs/DebtInstrumentNotationScreenerSearchDataValidationNotationSelectionListExclude.md)
 - [DebtInstrumentNotationScreenerSearchDataValidationNotationSelectionListRestrict](docs/DebtInstrumentNotationScreenerSearchDataValidationNotationSelectionListRestrict.md)
 - [DebtInstrumentNotationScreenerSearchDataValidationPrices](docs/DebtInstrumentNotationScreenerSearchDataValidationPrices.md)
 - [DebtInstrumentNotationScreenerSearchDataValidationPricesLatest](docs/DebtInstrumentNotationScreenerSearchDataValidationPricesLatest.md)
 - [DebtInstrumentNotationScreenerSearchDataValidationPricesPrevious](docs/DebtInstrumentNotationScreenerSearchDataValidationPricesPrevious.md)
 - [DebtInstrumentNotationScreenerSearchDataValidationValueUnit](docs/DebtInstrumentNotationScreenerSearchDataValidationValueUnit.md)
 - [DebtInstrumentNotationScreenerSearchDataValidationValueUnitExclude](docs/DebtInstrumentNotationScreenerSearchDataValidationValueUnitExclude.md)
 - [DebtInstrumentNotationScreenerSearchDataValidationValueUnitRestrict](docs/DebtInstrumentNotationScreenerSearchDataValidationValueUnitRestrict.md)
 - [DebtInstrumentNotationScreenerSearchDataYield](docs/DebtInstrumentNotationScreenerSearchDataYield.md)
 - [DebtInstrumentNotationScreenerSearchDataYieldCurrent](docs/DebtInstrumentNotationScreenerSearchDataYieldCurrent.md)
 - [DebtInstrumentNotationScreenerSearchDataYieldSpread](docs/DebtInstrumentNotationScreenerSearchDataYieldSpread.md)
 - [DebtInstrumentNotationScreenerSearchDataYieldToMaturity](docs/DebtInstrumentNotationScreenerSearchDataYieldToMaturity.md)
 - [DebtInstrumentNotationScreenerSearchMeta](docs/DebtInstrumentNotationScreenerSearchMeta.md)
 - [DebtInstrumentNotationScreenerSearchMetaPagination](docs/DebtInstrumentNotationScreenerSearchMetaPagination.md)
 - [DebtInstrumentNotationScreenerValueRangesGetData](docs/DebtInstrumentNotationScreenerValueRangesGetData.md)
 - [DebtInstrumentNotationScreenerValueRangesGetDataRating](docs/DebtInstrumentNotationScreenerValueRangesGetDataRating.md)
 - [DebtInstrumentNotationScreenerValueRangesGetDataRatingSystem](docs/DebtInstrumentNotationScreenerValueRangesGetDataRatingSystem.md)
 - [DebtInstrumentNotationScreenerValueRangesGetMeta](docs/DebtInstrumentNotationScreenerValueRangesGetMeta.md)
 - [ErrorMetaObject](docs/ErrorMetaObject.md)
 - [ErrorObject](docs/ErrorObject.md)
 - [InlineObject](docs/InlineObject.md)
 - [InlineObject1](docs/InlineObject1.md)
 - [InlineObject2](docs/InlineObject2.md)
 - [InlineResponse200](docs/InlineResponse200.md)
 - [InlineResponse2001](docs/InlineResponse2001.md)
 - [InlineResponse2001Data](docs/InlineResponse2001Data.md)
 - [InlineResponse2002](docs/InlineResponse2002.md)
 - [InlineResponse2002Data](docs/InlineResponse2002Data.md)
 - [InlineResponse2002DataCalculation](docs/InlineResponse2002DataCalculation.md)
 - [InlineResponse2002DataCalculationPrice](docs/InlineResponse2002DataCalculationPrice.md)
 - [InlineResponse2002DataCalculationPriceValueUnit](docs/InlineResponse2002DataCalculationPriceValueUnit.md)
 - [InlineResponse2002DataSensitivities](docs/InlineResponse2002DataSensitivities.md)
 - [InlineResponse2002DataYield](docs/InlineResponse2002DataYield.md)
 - [InlineResponse2003](docs/InlineResponse2003.md)
 - [InlineResponse2003Data](docs/InlineResponse2003Data.md)
 - [InlineResponse2003Fsym](docs/InlineResponse2003Fsym.md)
 - [InlineResponse2003FsymListing](docs/InlineResponse2003FsymListing.md)
 - [InlineResponse2003FsymRegional](docs/InlineResponse2003FsymRegional.md)
 - [InlineResponse2003Instrument](docs/InlineResponse2003Instrument.md)
 - [InlineResponse2003InstrumentCategorization](docs/InlineResponse2003InstrumentCategorization.md)
 - [InlineResponse2003InstrumentCategorizationLevel1](docs/InlineResponse2003InstrumentCategorizationLevel1.md)
 - [InlineResponse2003InstrumentCategorizationLevel2](docs/InlineResponse2003InstrumentCategorizationLevel2.md)
 - [InlineResponse2003InstrumentCategorizationLevel3](docs/InlineResponse2003InstrumentCategorizationLevel3.md)
 - [InlineResponse2003InstrumentCompliance](docs/InlineResponse2003InstrumentCompliance.md)
 - [InlineResponse2003InstrumentComplianceGermany](docs/InlineResponse2003InstrumentComplianceGermany.md)
 - [InlineResponse2003InstrumentCoupon](docs/InlineResponse2003InstrumentCoupon.md)
 - [InlineResponse2003InstrumentCouponCurrentInterestRate](docs/InlineResponse2003InstrumentCouponCurrentInterestRate.md)
 - [InlineResponse2003InstrumentCouponCurrentInterestRateType](docs/InlineResponse2003InstrumentCouponCurrentInterestRateType.md)
 - [InlineResponse2003InstrumentCouponOccurrence](docs/InlineResponse2003InstrumentCouponOccurrence.md)
 - [InlineResponse2003InstrumentCouponOccurrenceFrequency](docs/InlineResponse2003InstrumentCouponOccurrenceFrequency.md)
 - [InlineResponse2003InstrumentFsym](docs/InlineResponse2003InstrumentFsym.md)
 - [InlineResponse2003InstrumentFsymSecurity](docs/InlineResponse2003InstrumentFsymSecurity.md)
 - [InlineResponse2003InstrumentIssue](docs/InlineResponse2003InstrumentIssue.md)
 - [InlineResponse2003InstrumentIssueVolume](docs/InlineResponse2003InstrumentIssueVolume.md)
 - [InlineResponse2003InstrumentIssueVolumeCurrency](docs/InlineResponse2003InstrumentIssueVolumeCurrency.md)
 - [InlineResponse2003InstrumentIssuer](docs/InlineResponse2003InstrumentIssuer.md)
 - [InlineResponse2003InstrumentIssuerCountry](docs/InlineResponse2003InstrumentIssuerCountry.md)
 - [InlineResponse2003InstrumentLifeCycle](docs/InlineResponse2003InstrumentLifeCycle.md)
 - [InlineResponse2003InstrumentLifeCycleMaturity](docs/InlineResponse2003InstrumentLifeCycleMaturity.md)
 - [InlineResponse2003InstrumentNsin](docs/InlineResponse2003InstrumentNsin.md)
 - [InlineResponse2003InstrumentRatingSystem1](docs/InlineResponse2003InstrumentRatingSystem1.md)
 - [InlineResponse2003InstrumentRatingSystem1Rating](docs/InlineResponse2003InstrumentRatingSystem1Rating.md)
 - [InlineResponse2003InstrumentRatingSystem2](docs/InlineResponse2003InstrumentRatingSystem2.md)
 - [InlineResponse2003InstrumentTradingVolume](docs/InlineResponse2003InstrumentTradingVolume.md)
 - [InlineResponse2003InstrumentTradingVolumeOtc](docs/InlineResponse2003InstrumentTradingVolumeOtc.md)
 - [InlineResponse2003Market](docs/InlineResponse2003Market.md)
 - [InlineResponse2003Meta](docs/InlineResponse2003Meta.md)
 - [InlineResponse2003Nsin](docs/InlineResponse2003Nsin.md)
 - [InlineResponse2003Sensitivities](docs/InlineResponse2003Sensitivities.md)
 - [InlineResponse2003TradedValue](docs/InlineResponse2003TradedValue.md)
 - [InlineResponse2003TradedValueDays30](docs/InlineResponse2003TradedValueDays30.md)
 - [InlineResponse2003ValueUnit](docs/InlineResponse2003ValueUnit.md)
 - [InlineResponse2003Yield](docs/InlineResponse2003Yield.md)
 - [InlineResponse2004](docs/InlineResponse2004.md)
 - [InlineResponse2004Data](docs/InlineResponse2004Data.md)
 - [InlineResponse2004DataCategories](docs/InlineResponse2004DataCategories.md)
 - [InlineResponse2004DataCategorization](docs/InlineResponse2004DataCategorization.md)
 - [InlineResponse2004DataCompliance](docs/InlineResponse2004DataCompliance.md)
 - [InlineResponse2004DataComplianceGermany](docs/InlineResponse2004DataComplianceGermany.md)
 - [InlineResponse2004DataCoupon](docs/InlineResponse2004DataCoupon.md)
 - [InlineResponse2004DataCouponCurrentInterestRate](docs/InlineResponse2004DataCouponCurrentInterestRate.md)
 - [InlineResponse2004DataCouponCurrentInterestRateType](docs/InlineResponse2004DataCouponCurrentInterestRateType.md)
 - [InlineResponse2004DataCouponCurrentInterestRateValue](docs/InlineResponse2004DataCouponCurrentInterestRateValue.md)
 - [InlineResponse2004DataCouponOccurrence](docs/InlineResponse2004DataCouponOccurrence.md)
 - [InlineResponse2004DataCouponOccurrenceFrequency](docs/InlineResponse2004DataCouponOccurrenceFrequency.md)
 - [InlineResponse2004DataCouponOccurrenceType](docs/InlineResponse2004DataCouponOccurrenceType.md)
 - [InlineResponse2004DataIssue](docs/InlineResponse2004DataIssue.md)
 - [InlineResponse2004DataIssueVolume](docs/InlineResponse2004DataIssueVolume.md)
 - [InlineResponse2004DataIssueVolumeCurrency](docs/InlineResponse2004DataIssueVolumeCurrency.md)
 - [InlineResponse2004DataIssuer](docs/InlineResponse2004DataIssuer.md)
 - [InlineResponse2004DataIssuerJuristicPerson](docs/InlineResponse2004DataIssuerJuristicPerson.md)
 - [InlineResponse2004DataLevel](docs/InlineResponse2004DataLevel.md)
 - [InlineResponse2004DataLifeCycle](docs/InlineResponse2004DataLifeCycle.md)
 - [InlineResponse2004DataLifeCycleIssue](docs/InlineResponse2004DataLifeCycleIssue.md)
 - [InlineResponse2004DataLifeCycleMaturity](docs/InlineResponse2004DataLifeCycleMaturity.md)
 - [InlineResponse2004DataLifeCycleMaturityDate](docs/InlineResponse2004DataLifeCycleMaturityDate.md)
 - [InlineResponse2004DataLifeCycleMaturityPerpetual](docs/InlineResponse2004DataLifeCycleMaturityPerpetual.md)
 - [InlineResponse2004DataLifeCycleMaturityRemainingTermYears](docs/InlineResponse2004DataLifeCycleMaturityRemainingTermYears.md)
 - [InlineResponse2004DataMacaulayDuration](docs/InlineResponse2004DataMacaulayDuration.md)
 - [InlineResponse2004DataMarket](docs/InlineResponse2004DataMarket.md)
 - [InlineResponse2004DataParent](docs/InlineResponse2004DataParent.md)
 - [InlineResponse2004DataRatingSystem1](docs/InlineResponse2004DataRatingSystem1.md)
 - [InlineResponse2004DataRatingSystem1Rating](docs/InlineResponse2004DataRatingSystem1Rating.md)
 - [InlineResponse2004DataRatingSystem2](docs/InlineResponse2004DataRatingSystem2.md)
 - [InlineResponse2004DataSensitivities](docs/InlineResponse2004DataSensitivities.md)
 - [InlineResponse2004DataSensitivitiesBasePointValue](docs/InlineResponse2004DataSensitivitiesBasePointValue.md)
 - [InlineResponse2004DataSensitivitiesConvexity](docs/InlineResponse2004DataSensitivitiesConvexity.md)
 - [InlineResponse2004DataSensitivitiesElasticity](docs/InlineResponse2004DataSensitivitiesElasticity.md)
 - [InlineResponse2004DataSensitivitiesModifiedDuration](docs/InlineResponse2004DataSensitivitiesModifiedDuration.md)
 - [InlineResponse2004DataTradedValue](docs/InlineResponse2004DataTradedValue.md)
 - [InlineResponse2004DataTradedValueDays30](docs/InlineResponse2004DataTradedValueDays30.md)
 - [InlineResponse2004DataTradedValueDays30Average](docs/InlineResponse2004DataTradedValueDays30Average.md)
 - [InlineResponse2004DataTradedValueDays30Sum](docs/InlineResponse2004DataTradedValueDays30Sum.md)
 - [InlineResponse2004DataTradingVolume](docs/InlineResponse2004DataTradingVolume.md)
 - [InlineResponse2004DataTradingVolumeOtc](docs/InlineResponse2004DataTradingVolumeOtc.md)
 - [InlineResponse2004DataTradingVolumeOtcMinimum](docs/InlineResponse2004DataTradingVolumeOtcMinimum.md)
 - [InlineResponse2004DataValueUnit](docs/InlineResponse2004DataValueUnit.md)
 - [InlineResponse2004DataYield](docs/InlineResponse2004DataYield.md)
 - [InlineResponse2004DataYieldCurrent](docs/InlineResponse2004DataYieldCurrent.md)
 - [InlineResponse2004DataYieldSpread](docs/InlineResponse2004DataYieldSpread.md)
 - [InlineResponse2004DataYieldToMaturity](docs/InlineResponse2004DataYieldToMaturity.md)
 - [InlineResponse200Data](docs/InlineResponse200Data.md)
 - [InlineResponse200DataDebtRanking](docs/InlineResponse200DataDebtRanking.md)
 - [InlineResponse200DataGermany](docs/InlineResponse200DataGermany.md)
 - [InlineResponse200DataIssue](docs/InlineResponse200DataIssue.md)
 - [InlineResponse200DataIssuePrice](docs/InlineResponse200DataIssuePrice.md)
 - [InlineResponse200DataIssuePriceValueUnit](docs/InlineResponse200DataIssuePriceValueUnit.md)
 - [InlineResponse200DataIssueVolume](docs/InlineResponse200DataIssueVolume.md)
 - [InlineResponse200DataIssueVolumeCurrency](docs/InlineResponse200DataIssueVolumeCurrency.md)
 - [InlineResponse200DataIssuer](docs/InlineResponse200DataIssuer.md)
 - [InlineResponse200DataLifeCycle](docs/InlineResponse200DataLifeCycle.md)
 - [InlineResponse200DataLifeCycleMaturity](docs/InlineResponse200DataLifeCycleMaturity.md)
 - [InlineResponse200DataNsin](docs/InlineResponse200DataNsin.md)
 - [InlineResponse200DataRedemption](docs/InlineResponse200DataRedemption.md)
 - [InlineResponse200DataRedemptionCurrency](docs/InlineResponse200DataRedemptionCurrency.md)
 - [InlineResponse200DataRedemptionPrice](docs/InlineResponse200DataRedemptionPrice.md)
 - [InlineResponse200DataRedemptionPriceValueUnit](docs/InlineResponse200DataRedemptionPriceValueUnit.md)
 - [InlineResponse200DataTradingVolume](docs/InlineResponse200DataTradingVolume.md)
 - [InlineResponse200DataType](docs/InlineResponse200DataType.md)
 - [InlineResponse200Meta](docs/InlineResponse200Meta.md)
 - [LanguageMember](docs/LanguageMember.md)
 - [OffsetBasedPaginationOutputObject](docs/OffsetBasedPaginationOutputObject.md)
 - [OffsetBasedPaginationOutputObjectWithoutTotal](docs/OffsetBasedPaginationOutputObjectWithoutTotal.md)
 - [PartialOutputObject](docs/PartialOutputObject.md)
 - [StatusObject](docs/StatusObject.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.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](../../../../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.