Bonds API for Digital Portals

  • SECTIONS
  • Overview
  • API Definition
  • API Documentation
  • Code Snippet
  • Sample Use Case
Overview

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.

API Definition
Code Snippet
Search for a bond by selected criteria
// This example shows how to screen for
//  * bonds - only active, with prices available after 14-Sep-2020
//  * maturity between 5 and 15 years in the future
//  * issuers registered in the countries DE, FR and US (see /basic/region/country/list for country ids)
//  * coupon: periodic / annually (frequency id = 2, see /basic/region/frequency/type/list)
//  *         fixed interest rate (interest rate type = 2, see /instrument/coupon/interestRate/type/list)
//  *         current coupon > 10%

const postParams = {
    "data": {
      "validation": {
        "onlyActive": true,
        "prices": {
          "latest": {
            "availableOnly": true,
            "minimumDate": "2020-09-14"
          }
        }
      },
      "lifeCycle": {
        "maturity": {
          "restriction": {
            "remainingTermYears": {
              "minimum": {
                "value": 5,
                "inclusive": true
              },
              "maximum": {
                "value": 15,
                "inclusive": true
              }
            }
          }
        },
        "callable": false
      },
      "issuer": {
        "country": {
          "ids": [
            57,
            87,
            244
          ]
        }
      },
      "coupon": {
        "occurrence": {
          "type": [
            "repeated"
          ],
          "frequency": {
            "ids": [
              2
            ]
          }
        },
        "currentInterestRate": {
          "type": {
            "ids": [
              2
            ]
          },
          "value": {
            "minimum": {
              "value": 0.1,
              "inclusive": true
            }
          }
        }
      }
    }
  };
  
  const response = await mdg2Client.requestEndpoint(
      'POST',
      '/api/v1/debtInstrument/notation/screener/search',
      postParams
  );
  if (response.data) {
      console.log('Active bonds matching the given filter criteria');
  }
Sample Use Case

Investors can search for fixed income instruments based on a specific investment focus.

Users benefit from the platform’s consolidated data model to combine search results with quotes, time series, news, watchlists or portfolios.

The Digital Portal use case is focused on high-performance applications that are

  • serving millions of end-users,
  • accessible by client browsers via the internet,
  • typically combining a wide variety of Wealth "for Digital Portals"-APIs into a highly use-case specific solution for customers,
  • integrated into complex infrastructures such as existing frontend frameworks, authentication services.

All APIs labelled "for Digital Portals" have been designed for direct use by client web applications and feature extreme low latency: The average response time across all endpoints is 30 ms whereas 99% of all requests are answered in close to under 300ms.