Fixed Income¶

The generic fixed income endpoints provide a way to access deal data using a common fixed income view. All fixed income deal types can be accessed and only those data fields that are applicable to all fixed income deal types will be returned.

It is expected that these endpoints are used to provide functionality where searches and data views are required across any fixed income deal type, for example to show a fixed income only calendar. Deals cannot be created at the generic level, in order to create deals you must use the relevant deal type endpoint.

API Endpoints¶

The full list of available API endpoints is show below, with links to the detailed documentation for each. For a concise, structured definition please reference the Swagger/Open API specification.

Name	Method	Url	Description
Get Deals	Get	/v1/deals/fixed-income	Get all fixed income deals with optional search criteria

Get Deals¶

The get deals endpoint provides a way of accessing a collection of deal objects based on the input parameters.

Authorization¶

In order to access the deal information, it is required to have the deals-read scope in the access token.

Parameters¶

The parameters that this endpoint accepts are shown in the table below, with a description and default values identified.

Name	Type	Format	Description	Default
page	integer	Querystring	See Pagination	1
pageSize	integer	Querystring	See Pagination	250
sourceId	string	Querystring	A comma delimited list of source ids to search for	null
criteria	array[object]	Querystring	See Search Criteria	null
accessType	string	Querystring	A comma delimited list of Access Type	Private
sortField	string	Querystring	See Sort
sortDirection	string	Querystring	See Sort	Asc

Response¶

The endpoint returns a json payload containing an paginated array of Deal Objects. The pagination is in the standard CAS format as described in Pagination.

Schema¶

The generic fixed income deal object builds on the generic deal schema described in Generic Deal and extends it with properties that apply to all fixed income deal types. This deal object structure is shown below, and underneath the json example, each element is described in detail. It is important to note that only the additional fields not in the generic model are shown below, to avoid duplication.

Example json¶

{
     "products":
     [
         {
             "maturityDate": "2019-08-05T09:32:51.932Z",
             "perpetualMaturity": false,
             "par": 10
         }
     ],
     "tranches":
     [
         {
             "debtProgram": "Mtn",
             "timing": "string",
             "rankingType": "BankAT1",
             "allowedHedgeSecurityTypes": ["BenchmarkBond"],
             "collateralizedMortgageObligation":
                 {
                     "type": "PrincipalOnly",
                     "numberOfYears": 3.5,
                     "lowerLimit": 2.5,
                     "upperLimit": 5.5,
                     "association": "PublicSecuritiesAssociation"
                  },
             "class" : "New",
             "restrictedCountries" : ["ABW"]
         }
     ],
      "series":
     [
         {
             "class" : "New"
         }
     ]
}

Product Object¶

maturityDate: The maturity date of the security
perpetualMaturity: Indicates that the bond has a perpetual maturity and pays interest forever
par: Face value of the security

Tranche Object¶

debtProgram: The debt program

Note: This field is only applicable to Fixed Income Corporate New Issuance at this time.

timing: The expected time at which the books will close and has a character limit of 255

Note: This field is only applicable to Fixed Income Corporate New Issuance at this time.

rankingType: The priority of payment for debt obligations Valid values are SeniorSecured, Secured, SeniorUnsecured, SeniorSubordinated, Subordinated, JuniorSubordinated, CorporateHybrid, PreferredSenior, NonPreferredSenior, BankT2, BankAT1, InsuranceT2OrT3, InsuranceRT1 or CoveredPfanbriefe.

Note: This field is only applicable to Fixed Income Corporate New Issuance at this time.

allowedHedgeSecurityTypes: Indicates that this deal will only allow specific Hedge Security Type(s) to be hedged against. Valid values are Any or BenchmarkBond.
collateralizedMortgageObligation: A type of mortgage-backed securities that contain a pool of mortgages bundled together and sold as investments. This field is optional. For full details see CollateralizedMortgageObligation Object.
class: Denotes the tranche class of the Fixed Income Security. Valid values are New, Tap, TenderOffer, ConsentSolicitation, RetainedSales or Exchange. Field is optional.
restrictedCountries: The country or countries in which a security is restricted from sale in the ISO 3166-1 alpha-3 format. Field is optional.

Series Object¶

class: Denotes the series class of the Fixed Income Security. Valid values are New, Tap, TenderOffer, ConsentSolicitation, RetainedSales or Exchange. Field is optional.

CollateralizedMortgageObligation Object¶

type: Defines the type of CMO. Valid values are SequentialPay, PacBond, TacBond, ZTranche, PrincipalOnly, InterestOnly.
numberOfYears: The length of the bond payments.
lowerLimit: The lowest prepayment speed of the bond, also known as the floor. If the rate of the prepayments of the underlying mortgages fall towards the lower limit, the life of the tranche is extended.
upperLimit: The fastest prepayment speed of the bond, also known as the cap. If the rate of the prepayments of the underlying mortgages increase towards the upper limit, the life of the tranche is shortened.
association: Specifies the association that issues the mortgage securities. Valid values are FederalHousingAdministration, PublicSecuritiesAssociation, BondMarketAssociation