Package: fds.sdk.BondsAPIforDigitalPortals
Bonds API for Digital Portals client library for PythonSearch 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 datestraded markets: filter and indicate a market priority for the validationimportant dates in and features of the life cycle of the fixed income instrumentsfilter by issuer, its country of registration and the issued volumecoupon data: occurrence and frequency of coupon payments, current interest rate rangeyield and yield to maturity range, spreadMacaulay durationsensitivity ranges: base point value, modified duration, elasticity, convexitycash flow for all transactions over a certain time range: sum or averagecountry-specific attributes: for Germany: is eligible for trusteesThe 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 theOpenAPI Generatorproject:API version: 2Package version: 0.10.2Build package: org.openapitools.codegen.languages.PythonClientCodegenRequirementsPython >= 3.7InstallationPoetrypoetryaddfds.sdk.utilsfds.sdk.BondsAPIforDigitalPortalspippipinstallfds.sdk.utilsfds.sdk.BondsAPIforDigitalPortalsUsageGenerate authentication credentials.Setup Python environment.Install and activate python 3.7+. If you're usingpyenv:pyenvinstall3.9.7
pyenvshell3.9.7(optional)Install poetry.Install dependencies.Run the following:fromfds.sdk.utils.authenticationimportConfidentialClientimportfds.sdk.BondsAPIforDigitalPortalsfromfds.sdk.BondsAPIforDigitalPortals.apiimportdebt_instrument_apifromfds.sdk.BondsAPIforDigitalPortals.modelsimport*fromdateutil.parserimportparseasdateutil_parserfrompprintimportpprint# 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 classconfiguration=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 clientwithfds.sdk.BondsAPIforDigitalPortals.ApiClient(configuration)asapi_client:# Create an instance of the API classapi_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)exceptfds.sdk.BondsAPIforDigitalPortals.ApiExceptionase: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 EndpointsAll URIs are relative tohttps://api.factset.com/wealth/v1ClassMethodHTTP requestDescriptionDebtInstrumentApiget_debt_instrument_getGET/debtInstrument/getFundamental data for a debt instrument.DebtInstrumentApiget_debt_instrument_key_figures_notation_getGET/debtInstrument/keyFigures/notation/getKey figures of a debt instrument.DebtInstrumentApipost_debt_instrument_issuer_searchPOST/debtInstrument/issuer/searchSearch for issuers of debt instruments.DebtInstrumentApipost_debt_instrument_notation_screener_searchPOST/debtInstrument/notation/screener/searchScreener for debt instruments' notations based on debt instrument-specific parameters.DebtInstrumentApipost_debt_instrument_notation_screener_value_ranges_getPOST/debtInstrument/notation/screener/valueRanges/getPossible values and value ranges for the parameters used in the endpoint `/debtInstrument/notation/screener/search.`Documentation For ModelsAttributesMemberCursorBasedPaginationOutputObjectCursorBasedPaginationOutputObjectWithoutTotalDebtInstrumentIssuerSearchDataDebtInstrumentIssuerSearchDataCountryDebtInstrumentIssuerSearchDataMarketDebtInstrumentIssuerSearchDataMinimumRatingGradeDebtInstrumentIssuerSearchDataMinimumRatingGradeDebtInstrumentDebtInstrumentIssuerSearchDataNameDebtInstrumentIssuerSearchMetaDebtInstrumentNotationScreenerSearchDataDebtInstrumentNotationScreenerSearchDataComplianceDebtInstrumentNotationScreenerSearchDataComplianceGermanyDebtInstrumentNotationScreenerSearchDataCouponDebtInstrumentNotationScreenerSearchDataCouponCurrentInterestRateDebtInstrumentNotationScreenerSearchDataCouponCurrentInterestRateTypeDebtInstrumentNotationScreenerSearchDataCouponCurrentInterestRateValueDebtInstrumentNotationScreenerSearchDataCouponCurrentInterestRateValueMaximumDebtInstrumentNotationScreenerSearchDataCouponCurrentInterestRateValueMinimumDebtInstrumentNotationScreenerSearchDataCouponOccurrenceDebtInstrumentNotationScreenerSearchDataCouponOccurrenceFrequencyDebtInstrumentNotationScreenerSearchDataIssueDebtInstrumentNotationScreenerSearchDataIssueVolumeDebtInstrumentNotationScreenerSearchDataIssueVolumeCurrencyDebtInstrumentNotationScreenerSearchDataIssueVolumeCurrencyExcludeDebtInstrumentNotationScreenerSearchDataIssueVolumeCurrencyRestrictDebtInstrumentNotationScreenerSearchDataIssuerDebtInstrumentNotationScreenerSearchDataIssuerCountryDebtInstrumentNotationScreenerSearchDataIssuerCountryExcludeDebtInstrumentNotationScreenerSearchDataIssuerCountryRestrictDebtInstrumentNotationScreenerSearchDataIssuerSelectionDebtInstrumentNotationScreenerSearchDataIssuerSelectionExcludeDebtInstrumentNotationScreenerSearchDataIssuerSelectionRestrictDebtInstrumentNotationScreenerSearchDataLifeCycleDebtInstrumentNotationScreenerSearchDataLifeCycleIssueDebtInstrumentNotationScreenerSearchDataLifeCycleMaturityDebtInstrumentNotationScreenerSearchDataLifeCycleMaturityRestrictionDebtInstrumentNotationScreenerSearchDataLifeCycleMaturityRestrictionDateDebtInstrumentNotationScreenerSearchDataLifeCycleMaturityRestrictionRemainingTermYearsDebtInstrumentNotationScreenerSearchDataLifeCycleMaturityRestrictionRemainingTermYearsMaximumDebtInstrumentNotationScreenerSearchDataLifeCycleMaturityRestrictionRemainingTermYearsMinimumDebtInstrumentNotationScreenerSearchDataMacaulayDurationDebtInstrumentNotationScreenerSearchDataRatingDebtInstrumentNotationScreenerSearchDataRatingGradeDebtInstrumentNotationScreenerSearchDataRatingGradeMinimumDebtInstrumentNotationScreenerSearchDataSensitivitiesDebtInstrumentNotationScreenerSearchDataSensitivitiesBasePointValueDebtInstrumentNotationScreenerSearchDataSensitivitiesConvexityDebtInstrumentNotationScreenerSearchDataSensitivitiesElasticityDebtInstrumentNotationScreenerSearchDataSensitivitiesModifiedDurationDebtInstrumentNotationScreenerSearchDataTradedValueDebtInstrumentNotationScreenerSearchDataTradedValueDays30DebtInstrumentNotationScreenerSearchDataTradedValueDays30AverageDebtInstrumentNotationScreenerSearchDataTradedValueDays30SumDebtInstrumentNotationScreenerSearchDataTradingVolumeDebtInstrumentNotationScreenerSearchDataTradingVolumeOtcDebtInstrumentNotationScreenerSearchDataTradingVolumeOtcMinimumDebtInstrumentNotationScreenerSearchDataValidationDebtInstrumentNotationScreenerSearchDataValidationCategorizationDebtInstrumentNotationScreenerSearchDataValidationCategorizationExcludeDebtInstrumentNotationScreenerSearchDataValidationCategorizationRestrictDebtInstrumentNotationScreenerSearchDataValidationInstrumentSelectionListDebtInstrumentNotationScreenerSearchDataValidationInstrumentSelectionListExcludeDebtInstrumentNotationScreenerSearchDataValidationInstrumentSelectionListRestrictDebtInstrumentNotationScreenerSearchDataValidationMarketDebtInstrumentNotationScreenerSearchDataValidationMarketPriorityDebtInstrumentNotationScreenerSearchDataValidationMarketSelectionDebtInstrumentNotationScreenerSearchDataValidationMarketSelectionExcludeDebtInstrumentNotationScreenerSearchDataValidationMarketSelectionRestrictDebtInstrumentNotationScreenerSearchDataValidationNotationSelectionListDebtInstrumentNotationScreenerSearchDataValidationNotationSelectionListExcludeDebtInstrumentNotationScreenerSearchDataValidationNotationSelectionListRestrictDebtInstrumentNotationScreenerSearchDataValidationPricesDebtInstrumentNotationScreenerSearchDataValidationPricesLatestDebtInstrumentNotationScreenerSearchDataValidationPricesPreviousDebtInstrumentNotationScreenerSearchDataValidationValueUnitDebtInstrumentNotationScreenerSearchDataValidationValueUnitExcludeDebtInstrumentNotationScreenerSearchDataValidationValueUnitRestrictDebtInstrumentNotationScreenerSearchDataYieldDebtInstrumentNotationScreenerSearchDataYieldCurrentDebtInstrumentNotationScreenerSearchDataYieldSpreadDebtInstrumentNotationScreenerSearchDataYieldToMaturityDebtInstrumentNotationScreenerSearchMetaDebtInstrumentNotationScreenerSearchMetaPaginationDebtInstrumentNotationScreenerValueRangesGetDataDebtInstrumentNotationScreenerValueRangesGetDataRatingDebtInstrumentNotationScreenerValueRangesGetDataRatingSystemDebtInstrumentNotationScreenerValueRangesGetMetaErrorMetaObjectErrorObjectInlineObjectInlineObject1InlineObject2InlineResponse200InlineResponse2001InlineResponse2001DataInlineResponse2002InlineResponse2002DataInlineResponse2002DataCalculationInlineResponse2002DataCalculationPriceInlineResponse2002DataCalculationPriceValueUnitInlineResponse2002DataSensitivitiesInlineResponse2002DataYieldInlineResponse2003InlineResponse2003DataInlineResponse2003FsymInlineResponse2003FsymListingInlineResponse2003FsymRegionalInlineResponse2003InstrumentInlineResponse2003InstrumentCategorizationInlineResponse2003InstrumentCategorizationLevel1InlineResponse2003InstrumentCategorizationLevel2InlineResponse2003InstrumentCategorizationLevel3InlineResponse2003InstrumentComplianceInlineResponse2003InstrumentComplianceGermanyInlineResponse2003InstrumentCouponInlineResponse2003InstrumentCouponCurrentInterestRateInlineResponse2003InstrumentCouponCurrentInterestRateTypeInlineResponse2003InstrumentCouponOccurrenceInlineResponse2003InstrumentCouponOccurrenceFrequencyInlineResponse2003InstrumentFsymInlineResponse2003InstrumentFsymSecurityInlineResponse2003InstrumentIssueInlineResponse2003InstrumentIssueVolumeInlineResponse2003InstrumentIssueVolumeCurrencyInlineResponse2003InstrumentIssuerInlineResponse2003InstrumentIssuerCountryInlineResponse2003InstrumentLifeCycleInlineResponse2003InstrumentLifeCycleMaturityInlineResponse2003InstrumentNsinInlineResponse2003InstrumentRatingSystem1InlineResponse2003InstrumentRatingSystem1RatingInlineResponse2003InstrumentRatingSystem2InlineResponse2003InstrumentTradingVolumeInlineResponse2003InstrumentTradingVolumeOtcInlineResponse2003MarketInlineResponse2003MetaInlineResponse2003NsinInlineResponse2003SensitivitiesInlineResponse2003TradedValueInlineResponse2003TradedValueDays30InlineResponse2003ValueUnitInlineResponse2003YieldInlineResponse2004InlineResponse2004DataInlineResponse2004DataCategoriesInlineResponse2004DataCategorizationInlineResponse2004DataComplianceInlineResponse2004DataComplianceGermanyInlineResponse2004DataCouponInlineResponse2004DataCouponCurrentInterestRateInlineResponse2004DataCouponCurrentInterestRateTypeInlineResponse2004DataCouponCurrentInterestRateValueInlineResponse2004DataCouponOccurrenceInlineResponse2004DataCouponOccurrenceFrequencyInlineResponse2004DataCouponOccurrenceTypeInlineResponse2004DataIssueInlineResponse2004DataIssueVolumeInlineResponse2004DataIssueVolumeCurrencyInlineResponse2004DataIssuerInlineResponse2004DataIssuerJuristicPersonInlineResponse2004DataLevelInlineResponse2004DataLifeCycleInlineResponse2004DataLifeCycleIssueInlineResponse2004DataLifeCycleMaturityInlineResponse2004DataLifeCycleMaturityDateInlineResponse2004DataLifeCycleMaturityPerpetualInlineResponse2004DataLifeCycleMaturityRemainingTermYearsInlineResponse2004DataMacaulayDurationInlineResponse2004DataMarketInlineResponse2004DataParentInlineResponse2004DataRatingSystem1InlineResponse2004DataRatingSystem1RatingInlineResponse2004DataRatingSystem2InlineResponse2004DataSensitivitiesInlineResponse2004DataSensitivitiesBasePointValueInlineResponse2004DataSensitivitiesConvexityInlineResponse2004DataSensitivitiesElasticityInlineResponse2004DataSensitivitiesModifiedDurationInlineResponse2004DataTradedValueInlineResponse2004DataTradedValueDays30InlineResponse2004DataTradedValueDays30AverageInlineResponse2004DataTradedValueDays30SumInlineResponse2004DataTradingVolumeInlineResponse2004DataTradingVolumeOtcInlineResponse2004DataTradingVolumeOtcMinimumInlineResponse2004DataValueUnitInlineResponse2004DataYieldInlineResponse2004DataYieldCurrentInlineResponse2004DataYieldSpreadInlineResponse2004DataYieldToMaturityInlineResponse200DataInlineResponse200DataDebtRankingInlineResponse200DataGermanyInlineResponse200DataIssueInlineResponse200DataIssuePriceInlineResponse200DataIssuePriceValueUnitInlineResponse200DataIssueVolumeInlineResponse200DataIssueVolumeCurrencyInlineResponse200DataIssuerInlineResponse200DataLifeCycleInlineResponse200DataLifeCycleMaturityInlineResponse200DataNsinInlineResponse200DataRedemptionInlineResponse200DataRedemptionCurrencyInlineResponse200DataRedemptionPriceInlineResponse200DataRedemptionPriceValueUnitInlineResponse200DataTradingVolumeInlineResponse200DataTypeInlineResponse200MetaLanguageMemberOffsetBasedPaginationOutputObjectOffsetBasedPaginationOutputObjectWithoutTotalPartialOutputObjectStatusObjectDocumentation For AuthorizationFactSetApiKeyType: HTTP basic authenticationFactSetOAuth2Type: OAuthFlow: applicationAuthorization URL:Scopes: N/ANotes for Large OpenAPI documentsIf 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 DefaultApifrom fds.sdk.BondsAPIforDigitalPortals.model.pet import PetSolution 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 *ContributingPlease refer to thecontributing guide.CopyrightCopyright 2022 FactSet Research Systems IncLicensed 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 athttp://www.apache.org/licenses/LICENSE-2.0Unless 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.