Municipal¶
The municipal endpoints provide a way to read and create deal data using a municipal deal specific view. These endpoints are used to provide full workflow functionality for municipal deal types, including viewing all deals, searching for specific deals, as well as creating and maintaining full deal data.
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 |
/v1/deals/fixed-income/municipal |
Get all municipal deals with optional search criteria |
|
Get |
/v1/deals/fixed-income/municipal/{id} |
Get a specific municipal deal |
|
Post |
/v1/deals/fixed-income/municipal |
Create a municipal deal |
|
Put |
/v1/deals/fixed-income/municipal/{id} |
Update a specific municipal deal |
|
Put |
/v1/deals/fixed-income/municipal |
Update a specific municipal deal by source application id |
|
Patch |
/v1/deals/fixed-income/municipal/{id} |
Update a subset of the attributes of an existing Deal |
|
Post |
/v1/tranches/fixed-income/municipal |
Create a tranche for a municipal deal |
Get Deals¶
The get deals endpoint provides a way of accessing a collection of deal objects based on the input parameters.
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 Object. The pagination is in the standard CAS format as described in Pagination.
Get Deal¶
The get deal endpoint provides a way of accessing a specific deal object by id.
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 |
id |
UUID |
URL path |
The unique CAS id of the deal to retrieve |
Response¶
The endpoint returns a json payload containing a Deal Object.
Create Deal¶
The create deal endpoint provides a way of creating a deal object in the CAS system.
Authorization¶
In order to create the deal information, it is required to have the deals-write scope in the access token.
Response¶
The endpoint returns a json payload containing a Deal Object reflecting the object that was just created.
Update Deal¶
The update deal endpoint provides a way of updating a specific deal object by id.
Authorization¶
In order to update the deal, it is required to have the deals-write 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 |
id |
UUID |
URL path |
The unique CAS id of the deal to update |
Response¶
The endpoint returns an http response code indicating the success or failure of the action.
Update Deal by Source Id¶
This update deal endpoint provides a way of updating a specific deal object by source application id. It is for use when the CAS unique id is not known, such as when being invoked by a source application.
Authorization¶
In order to update the deal, it is required to have the deals-write 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 |
sourceId |
string |
Querystring |
A source id to update |
null |
Response¶
The endpoint returns an http response code indicating the success or failure of the action.
Patch Deal¶
The patch deal endpoint provides a way of updating specific fields of an existing Deals object.
Authorization¶
In order to access the Deals information, it is required to have the deals-write scope in the access token.
Parameters¶
The parameter that this endpoint accepts is a list of fields for the Deals object to be updated.
[
{
"value": {},
"path": "string",
"op": "string",
"from": "string"
}
]
Response¶
The endpoint returns a JSON payload containing the new, updated Deal Object if successful.
Create Tranche For Deal¶
The create tranche endpoint provides a way of creating one or more tranche objects in the CAS system for an existing municipal deal object in the CAS system.
Authorization¶
In order to create the tranche information, it is required to have the deals-write scope in the access token.
Parameters¶
N/A
Response¶
The endpoint returns a json payload containing one or more Tranche Objects reflecting the objects that were just created.
Example Search Criteria¶
The table below shows some example search criteria used for municipal deals search to show how the search criteria can be used for some common workflows: (Please note, these queries must be URL encoded before use - they are shown without encoding for readability).
Description |
Query |
Filter for a deal with global ID |
?criteria=[{“field”:”GlobalId”,”operator”:”=”,”value”:”12345”}] |
Competitive public deals for this week |
?accessType=Public&criteria=[{“field”:”SaleDate.Date”,”operator”:”>=”,”value”:”2019-03-01”}, {“field”:”SaleDate.Date”,”operator”:”<=”,”value”:”2019-03-07”}, {“field”:”MethodOfSale”,”operator”:”=”,”value”:”Competitive”}] |
Negotiated deals for this week |
?accessType=Shared,Public&criteria=[{“field”:”ExpectedPricingDate.Date”,”operator”:”>=”,”value”:”2019-03-01”}, {“field”:”ExpectedPricingDate.Date”,”operator”:”<=”,”value”:”2019-03-07”}, {“field”:”MethodOfSale”,”operator”:”=”,”value”:”Negotiated”}] |
List of public deals which have Initial Trade Date for this week |
?accessType=Public&criteria=[{“field”:”Series.InitialTradeDate”,”operator”:”>”,”value”:”2019-03-11”}] |
Schema¶
The municipal deal object builds on the fixed income deal schema described in Fixed Income and extends it with properties that apply to all municipal deals only. 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 common fixed income model are shown below, to avoid duplication.
Example json¶
{
"saleDate": {
"date": "2021-04-12T06:12:07.577Z",
"qualifier": "Date"
},
"expectedPricingDate": {
"date": "2021-04-12T06:12:07.577Z",
"qualifier": "Date"
},
"isBankQualified": true,
"orderPeriod": {
"startDate": "2021-04-12T06:12:07.577Z",
"endDate": "2021-04-12T06:12:07.577Z",
"type": "Retail",
"orderTypes": [
{
"orderType": "string",
"priority": 0
}
]
},
"repricingOrderPeriod": {
"startDate": "2021-04-12T06:12:07.577Z",
"endDate": "2021-04-12T06:12:07.577Z",
"type": "Retail",
"orderTypes": [
{
"orderType": "string",
"priority": 0
}
]
},
"series": [
{
"state": "string",
"firstCouponDate": "2021-04-12T06:12:07.577Z",
"datedDate": "2021-04-12T06:12:07.577Z",
"deliveryDate": "2021-04-12T06:12:07.577Z",
"awardDate": "2021-04-12T06:12:07.577Z",
"initialTradeDate": "2021-04-12T06:12:07.577Z",
"taxStatus": "Taxable",
"stateTaxStatus": "Exempt",
"ratings": [
{
"agency": "StandardAndPoors",
"longTerm": "string",
"shortTerm": "string",
"outlook": "string",
"finality": "Final",
"effectiveDate": "2021-04-12T06:12:07.577Z",
"status": "UnderReview"
}
],
"underlyingRatings": [
{
"agency": "StandardAndPoors",
"longTerm": "string",
"shortTerm": "string",
"outlook": "string",
"finality": "Final",
"effectiveDate": "2021-04-12T06:12:07.577Z",
"status": "UnderReview"
}
],
"certifications": [
{
"type": "Green",
"verifier": "Self",
"preApproved": true,
"esgComments": "string"
}
],
"extraordinaryCall": true,
"subSectors": [
"string"
],
"sourceOfRepayment": "Revenue",
"securityTypes": [
"Bond"
],
"insurer": "string",
"settleDate": "2021-04-12T06:12:07.577Z",
"purposes": [
{
"purposeType": "Refunding",
"amount": 0
}
],
"coupon": {
"type": "Fixed",
"fixedRate": 0,
"floatingRateIndex": "string",
"spread": "string",
"frequency": "Annually",
"dayCount": "string",
"accruedInterest": "2021-04-12T06:12:07.577Z"
},
"callFeatures": [
{
"securityType": "string",
"callFeature": {
"description": "string",
"callType": "Callable",
"callFrequency": "Annual",
"firstCallDate": "2021-04-12T06:12:07.577Z",
"firstCallPrice": 0,
"lastCallDate": "2021-04-12T06:12:07.577Z",
"lastCallPrice": 0,
"maxPrice": 0,
"percentIncrement": 0,
"schedule": [
{
"date": "2021-04-12T06:12:07.577Z",
"price": 0
}
],
"notes": "string"
}
}
],
"isCorporateCusip": true,
"comments": "string",
"qualifiedInstitutionalBuyer": true,
"isBankQualified": true,
"issuer": {
"name": "string",
"country": "string",
"description": "string",
"sector": "string",
"ticker": "string",
"cusipBase": "string",
"ratings": [
{
"agency": "StandardAndPoors",
"longTerm": "string",
"shortTerm": "string",
"outlook": "string",
"finality": "Final",
"effectiveDate": "2021-04-12T06:12:07.578Z",
"status": "UnderReview"
}
],
"firmId": 0,
"marketCap": {
"amount": 0,
"currency": "string"
},
"pmId": "string",
"lei": "string",
"identifications": [
{
"id": "string",
"source": "Brs"
}
],
"industryClassification": {
"industryGroup": "Energy",
"industry": "RenewableEnergyEquipmentandServices",
"subIndustry": "RenewableEnergyEquipmentandServices"
}
},
"registration": {
"country": "string",
"rules": [
"Rule144"
],
"type": "Exempt"
},
"players": [
{
"name": "string",
"firmId": 0,
"shortName": "string",
"role": "Obligor",
"lei": "string",
"identifications": [
{
"id": "string",
"source": "Brs"
}
]
}
],
"forwardDelivery": true,
"class": "New",
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"globalId": "string",
"sourceId": "string",
"name": "string",
"description": "string",
"amount": 0,
"quantity": 0,
"trancheIds": [
"3fa85f64-5717-4562-b3fc-2c963f66afa6"
],
"trancheNames": [
"string"
],
"notes": "string"
}
],
"tranches": [
{
"productNames": [
"string"
],
"notReoffered": true,
"soldNotAvailable": true,
"notRetail": true,
"sealedBid": true,
"orderPeriodTerminated": true,
"confidentialValue": {
"type": "NetInterestCost",
"amount": {
"amount": 0,
"type": "Quantity"
}
},
"debtProgram": "CommercialPaper",
"timing": "string",
"rankingType": "SeniorSecured",
"allowedHedgeSecurityTypes": [
"Any"
],
"collateralizedMortgageObligation": {
"type": "SequentialPay",
"numberOfYears": 0,
"lowerLimit": 0,
"upperLimit": 0,
"association": "FederalHousingAdministration"
},
"class": "New",
"restrictedCountries": "AFG",
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"sourceId": "string",
"dealId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"name": "string",
"status": "Live",
"sectors": [
"string"
],
"indicators": [
"string"
],
"productIds": [
"3fa85f64-5717-4562-b3fc-2c963f66afa6"
],
"amount": 0,
"quantity": 0,
"underwritingEntity": {
"name": "string",
"firmId": 0,
"pmId": "string"
},
"orderAttestation": "string",
"globalId": "string",
"displayOrder": 0,
"notes": "string",
"statusDescription": "string",
"version": 0,
"syndicate": [
{
"name": "string",
"firmId": 0,
"shortName": "string",
"roles": [
"GlobalCoordinator"
],
"role": "GlobalCoordinator",
"brackets": [
{
"id": 0,
"name": "string",
"displayOrder": 0
}
],
"pmId": "string",
"isBookBuilder": true,
"internalId": "string",
"feeDistributions": [
{
"type": "GlobalCoordinator",
"amount": {
"amount": 0,
"type": "Quantity"
}
}
],
"lei": "string"
}
],
"contacts": [
{
"firstName": "string",
"lastName": "string",
"email": "string",
"type": "CapitalMarketsContact"
}
],
"effectiveDateTime": "2021-04-12T06:12:07.578Z",
"offerDate": "2021-04-12T06:12:07.578Z",
"pricingDateTime": "2021-04-12T06:12:07.578Z",
"settlementDate": "2021-04-12T06:12:07.578Z",
"settlementDateOffset": 0,
"fileValue": {
"amount": 0,
"type": "Quantity"
},
"greenShoeOverAllotmentValue": {
"amount": 0,
"type": "Quantity"
},
"currentFileValue": {
"amount": 0,
"type": "Quantity"
},
"certifications": [
{
"type": "Green",
"verifier": "Self",
"preApproved": true,
"esgComments": "string"
}
],
"comments": "string",
"isBase": true,
"expectedValue": {
"amount": "string",
"type": "Quantity"
},
"trancheComments": [
{
"type": "General",
"text": "string"
}
],
"collaborationBookState": "string"
}
],
"products": [
{
"price": 0,
"yield": 0,
"yieldToMaturity": 0,
"priceToMaturity": 0,
"insurer": "string",
"coupon": {
"type": "Fixed",
"fixedRate": 0,
"floatingRateIndex": "string",
"spread": "string",
"frequency": "Annually",
"dayCount": "string",
"accruedInterest": "2021-04-12T06:12:07.578Z"
},
"putDate": "2021-04-12T06:12:07.578Z",
"putType": "Mandatory",
"taxableTreasurySpread": 0,
"taxableTreasuryCoupon": 0,
"taxableTreasuryYield": 0,
"taxableTreasuryMaturity": "string",
"sinkingFunds": [
{
"maturityDate": "2021-04-12T06:12:07.578Z",
"numberOfBonds": 0
}
],
"yieldSpreadBump": 0,
"yieldSpreadValid": true,
"callFeature": {
"description": "string",
"callType": "Callable",
"callFrequency": "Annual",
"firstCallDate": "2021-04-12T06:12:07.578Z",
"firstCallPrice": 0,
"lastCallDate": "2021-04-12T06:12:07.578Z",
"lastCallPrice": 0,
"maxPrice": 0,
"percentIncrement": 0,
"schedule": [
{
"date": "2021-04-12T06:12:07.578Z",
"price": 0
}
],
"notes": "string"
},
"maturityDate": "2021-04-12T06:12:07.578Z",
"perpetualMaturity": true,
"par": 0,
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"sourceId": "string",
"dealId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"currency": "string",
"name": "string",
"securityType": "string",
"ratings": [
{
"agency": "StandardAndPoors",
"longTerm": "string",
"shortTerm": "string",
"outlook": "string",
"finality": "Final",
"effectiveDate": "2021-04-12T06:12:07.578Z",
"status": "UnderReview"
}
],
"redemptionOptions": [
{
"description": "string",
"type": "Callable",
"frequency": "Annual",
"firstDate": "2021-04-12T06:12:07.578Z",
"firstPrice": 0,
"lastDate": "2021-04-12T06:12:07.578Z",
"lastPrice": 0,
"maxPrice": 0,
"priceIncrement": 0,
"schedule": [
{
"date": "2021-04-12T06:12:07.578Z",
"price": 0
}
],
"notes": "string"
}
],
"filings": [
{
"identificationCodes": [
{
"type": "Symbol",
"code": "string"
}
],
"settlement": {
"location": "string",
"currency": "string",
"date": "2021-04-12T06:12:07.578Z"
},
"registration": {
"country": "string",
"rules": [
"Rule144"
],
"type": "Exempt"
},
"isDefault": true,
"structure": "ClassicGlobalNote",
"form": "Bearer",
"governingLaw": [
"Irish"
],
"tefra": "C"
}
],
"version": 0,
"displayOrder": 0,
"isBase": true,
"exchanges": [
"string"
],
"fees": [
{
"type": "GlobalCoordinator",
"amount": {
"amount": 0,
"type": "Quantity"
}
}
],
"lastSalePrice": 0,
"productConversionRatio": "string",
"expectedGrossSpread": "string",
"expectedIncentiveFee": "string"
}
],
"pricingStatus": "Expected",
"posUrl": "string",
"roadshowURL": "string",
"pricingCommitted": true,
"limitedPublicOffering": true,
"bidData": {
"bids": [
{
"dealerId": "string",
"dealerName": "string",
"amount": 0,
"interest": {
"cost": 0,
"costType": "TrueInterestCost"
},
"winningBid": true
}
]
},
"sourceCreatedBy": "string",
"sourceLastModifiedBy": "string",
"sourceId": "string",
"assetClassType": "None",
"dealType": "None",
"currency": "string",
"amount": 0,
"details": "string",
"globalId": "string",
"code": "string",
"description": "string",
"quantity": 0,
"syndicate": [
{
"name": "string",
"firmId": 0,
"shortName": "string",
"roles": [
"GlobalCoordinator"
],
"role": "GlobalCoordinator",
"brackets": [
{
"id": 0,
"name": "string",
"displayOrder": 0
}
],
"pmId": "string",
"isBookBuilder": true,
"internalId": "string",
"feeDistributions": [
{
"type": "GlobalCoordinator",
"amount": {
"amount": 0,
"type": "Quantity"
}
}
],
"lei": "string"
}
],
"contacts": [
{
"firstName": "string",
"lastName": "string",
"email": "string",
"type": "CapitalMarketsContact"
}
],
"issuer": {
"name": "string",
"country": "string",
"description": "string",
"sector": "string",
"ticker": "string",
"cusipBase": "string",
"ratings": [
{
"agency": "StandardAndPoors",
"longTerm": "string",
"shortTerm": "string",
"outlook": "string",
"finality": "Final",
"effectiveDate": "2021-04-12T06:12:07.579Z",
"status": "UnderReview"
}
],
"firmId": 0,
"marketCap": {
"amount": 0,
"currency": "string"
},
"pmId": "string",
"lei": "string",
"identifications": [
{
"id": "string",
"source": "Brs"
}
],
"industryClassification": {
"industryGroup": "Energy",
"industry": "RenewableEnergyEquipmentandServices",
"subIndustry": "RenewableEnergyEquipmentandServices"
}
},
"methodOfSale": "Negotiated",
"players": [
{
"name": "string",
"firmId": 0,
"shortName": "string",
"role": "Obligor",
"lei": "string",
"identifications": [
{
"id": "string",
"source": "Brs"
}
]
}
],
"fileDate": {
"date": "2021-04-12T06:12:07.579Z",
"qualifier": "Date"
},
"launchDate": {
"date": "2021-04-12T06:12:07.579Z",
"qualifier": "Date"
},
"indicators": [
"string"
],
"createdBy": "string",
"createdTimeStamp": "2021-04-12T06:12:07.579Z",
"lastModifiedBy": "string",
"lastModifiedTimeStamp": "2021-04-12T06:12:07.579Z",
"accessType": "Private",
"notes": "string",
"dealStatus": "Active",
"effectiveDateTime": "2021-04-12T06:12:07.579Z",
"offerDate": "2021-04-12T06:12:07.579Z",
"pricingDateTime": "2021-04-12T06:12:07.579Z",
"settlementDate": "2021-04-12T06:12:07.579Z",
"settlementDateOffset": 0,
"expectedValue": {
"amount": "string",
"type": "Quantity"
},
"fileValue": {
"amount": 0,
"type": "Quantity"
},
"postOfferingValue": {
"amount": 0,
"type": "Quantity"
},
"greenShoeOverAllotmentValue": {
"amount": 0,
"type": "Quantity"
},
"currentFileValue": {
"amount": 0,
"type": "Quantity"
},
"primaryOfferingValue": {
"amount": 0,
"type": "Quantity"
},
"secondaryOfferingValue": {
"amount": 0,
"type": "Quantity"
},
"comments": [
{
"type": "General",
"text": "string"
}
],
"blueSky": [
{
"countryCode": "USA",
"stateCode": [
"AL"
],
"status": "NotCleared"
}
],
"effectiveDateTimeZone": "AlphaTimeZone",
"pricingDateTimeZone": "AlphaTimeZone",
"managementType": "SoleManaged",
"documents": [
{
"visibility": "Internal",
"clientDocumentType": "string",
"name": "string",
"url": "string",
"id": "string",
"createdDateTime": "2021-04-12T06:12:07.579Z",
"lastModifiedDateTime": "2021-04-12T06:12:07.579Z"
}
],
"fxRates": {
"filing": [
{
"baseCurrencyCode": "AFG",
"currencyCode": "AFG",
"rate": 0
}
],
"offering": [
{
"baseCurrencyCode": "AFG",
"currencyCode": "AFG",
"rate": 0
}
],
"settlement": [
{
"baseCurrencyCode": "AFG",
"currencyCode": "AFG",
"rate": 0
}
]
},
"transactionalData": {
"created": {
"byFirm": {
"lei": "string",
"pmid": "string"
},
"dateTime": "2021-04-12T06:12:07.579Z"
}
},
"name": "string"
}
Deal Object¶
- saleDate
A complex type showing the sales date of the deal. For full details see Complex Date Object.
- expectedPricingDate
A complex type showing the expected pricing date of the deal. For full details see Complex Date Object.
- isBankQualified
This indicator is used to convey which deals have tax advantages for qualified banks.
- orderPeriod
The date range and type of the order period. For full details see Order Period Object.
- repricingOrderPeriod
The date range and type of the repricing order period. For full details see Order Period Object.
- dealStatus
The current status of the deal. Valid values are
Active,Cancelled,Postponed,NotBoughtorBought.- pricingStatus
The pricing status of the deal. Valid values are
Expected,Live,Priced,SoldorClosed.- posUrl
The URL of the Preliminary Official Statement document.
- roadshowURL
A URL is going to be passed that will allow end users to view the Deal Roadshow if one exists
- pricingCommitted
A boolean value indicating if the pricing id committed.
- limitedPublicOffering
Limited Public Offering indicates if the Deal is only open for certain Investment Banks for bidding.
- bidData
All bids placed for an Issue, including the Bidder, Bid Information, and winning Bid(s)
Series Object¶
- state
Two letter code of the series’ state in the US
- firstCouponDate
The date of the first coupon.
- datedDate
The date interest starts to accrue.
- deliveryDate
The date of delivery.
- awardDate
The date of award.
- settleDate
The date of settlement.
- comments
The Comments field is a text field and has a character limit of 2000
- certifications
An Array of certifications. For full details see Certification Object.
- qualifiedInstitutionalBuyer
Field will convey whether or not buyer needs to be a QIB “Qualified Institutional Buyer”
- taxStatus
Indicates if the Bond is Taxable, Exempt or Subject to AMT on the Federal level. Valid values are
Taxable,ExemptorSubjectToAmt.- stateTaxStatus
Indicates if the Bond is Taxable, Exempt or Subject to AMT on the State level. Valid values are
Taxable,ExemptorSubjectToAmt.- initialTradeDate
The date of the initial trade.
- sourceOfRepayment
The source of repayment. Valid values are
Revenue,GeneralObligation,CertificatesOfParticipation,UnlimitedTaxGO,LimitedTaxGO,Appropriation,AssetBackedTobacco,CorporateBacked,MortgageHousing,TaxAllocIncrement,GovernmentGrantBacked,PersonalIncomeTax,SalesExciseTax,FuelVehicleTax,HotelTax,CigaretteTax,MiscellaneousTax,SpecialAssessment,CarRentalTax,SalesServiceLoanAgreement,LotteryGamingRevenueorDoubleBarreled.- securityTypes
A list of the security type that exist for the maturities in the series. You will get this even if the maturities are not disclosed.
- extraordinaryCall
A boolean value indicating if this is an extraordinary call.
- forwardDelivery
Indicates that a Deal has a longer than usual settlement date. When a forward contract settles in delivery of the underlying asset, that final stage is called forward delivery. Field is optional.
- subSectors
An array of values showing the sub sectors for this series.
- purposes
A complex object showing the list of purposes for this series, with amounts for each
- purposes.purposeType
The type of purpose. Valid values are
Refunding,Remarketing,AdvancedRefundingorNewMoney.- purposes.amount
The amount for this purpose.
- underlyingRatings
The underlying rating for this series. Each entry in the array contains the ratings from one agency. For full details see Ratings Object.
- ratings
The rating for this series. Each entry in the array contains the ratings from one agency. For full details see Ratings Object.
- insurer
The name of the insurer.
- coupon
A complex type showing the information for any coupon on the series level. For full details see Coupon Object.
- callFeature
A complex object containing the information for any Call Feature on the series. For full details see Call Feature Object.
- isCorporateCusip
A boolean value indicating if this is a corporate CUSIP.
- isBankQualified
This indicator is used to convey which deals have tax advantages for qualified banks.
- issuer
An object that contains information about the issuer of the deal. For full details see Issuer Object.
- registration
Registration Information, such as Registration Rule and Registration County, under which the Series is governed. For full details see Registration Object.
- players
An object that contains information about the players of the deal. For full details see Player Object.
Tranche Object¶
- notReoffered
A boolean value indicating if the bonds not being reoffered
- soldNotAvailable
A boolean value indicating if the bonds are sold and not available
- notRetail
A boolean value indicating if retail orders not accepted on these securities
- sealedBid
A boolean value indicating if bonds are a sealed bid and not available for sale
- orderPeriodTerminated
A boolean value indicating if the period is terminated
- confidentialValue
A proprietary value set by the Investment Bank. For full details see the ConfidentialValue Object.
Product Object¶
- price
The price of the security.
- callFeature
A complex object containing the information for any callFeature. For full details see Call Feature Object.
- yield
The Yield of the security.
- yieldToMaturity
The yield to maturity.
- priceToMaturity
The price to maturity.
- insurer
The name of the insurer.
- coupon
A complex type showing the information for the coupon. For full details see Coupon Object.
- putDate
The put date.
- putType
Put option type. Valid values are
MandatoryorOptional.- taxableTreasurySpread
The taxable treasury spread.
- taxableTreasuryCoupon
The Taxable treasury coupon.
- taxableTreasuryYield
The taxable treasury yield.
- taxableTreasuryMaturity
The taxable treasury maturity.
- sinkingFunds
The sinking fund of the maturity.
- sinkingFunds.maturityDate
The maturity date of the sinking fund.
- sinkingFunds.numberOfBonds
These are the maturities and amounts that underly a term bond.
- yieldSpreadBump
This field is used to display the calculation in change between spreads/yields between the releases of data/wires (e.g. change between Prelim and Repricing Wires).
- yieldSpreadValid
This field helps to determine if the maturities.yieldSpreadBump value should be evaluated in more detail due to other factors that may have also changed (e.g. coupon changed between data shares).
Coupon Object¶
- type
The type of coupon. Valid values are
Fixed,FixedToFloating,FloatingorVariable.- fixedRate
The fixed interest rate, if applicable.
- floatingRateIndex
The index for a floating rate, if applicable.
- spread
Used to indicate the difference in the coupon interest rate.
- frequency
The payment frequency of the coupon. Valid values are
Annually,SemiAnnually,Quarterly,Monthly,BiWeekly,Weekly,DailyorOther.- dayCount
The day count for interest calculation.
- accruedInterest
The accrued interest date.
Order Period Object¶
- startDate
The start date of the order period.
- endDate
The end date of the order period.
- type
A value indicating the type of the order period. Valid values are
Retail,InstitutionalorBoth.- orderTypes
An array of order types for the order period.
- orderTypes.orderType
The type of order period order type.
- orderTypes.priority
An integer depicting the priority of the order type.
Issuer Object¶
- name
The name of the issuer.
- country
The country of the Issuer in ISO 3166-1 alpha-2 format.
- description
A description of the Issuer.
- sector
The industry sector of the Issuer.
- ticker
The ticker code of the issuer, if one exists.
- cusipBase
The base CUSIP code for the issuer.
- ratings
An array of objects that contains the agency ratings for the issuer, if they exist. Each entry in the array contains the ratings from one agency. For full details see Ratings Object.
- firmId
The unique IHS Markit identifier of the issuer company.
- pmId
The Primary Market Identifier (PMID) of the issuer, if one exists.
- lei
Legal Entity Identifier for the Issuer. This is used when searching for an issuer to ensure that the correct issuer is selected.
- identifications
Unique identifier for an entity. For full details see Identifications Object.
- industryClassification
IndustryClassification is used to categorize the Industry levels representing specific business activities associated to the Issuer. The Industry level values include: Industry Group, Industry, Sub-Industry. For full details see Industry Classification Object.
Call Feature Object¶
- description
A description of the call feature.
- callType
The type of call feature. Valid values are
Callable,CallableAnytime,MakeWholeCall,NonCallableorPyramid.- callFrequency
The frequency of the call feature. Valid values are
Annual,AnyDate,InterestPaymentDueorSemiAnnual.- firstCallDate
The first call date.
- firstCallPrice
The first call price.
- lastCallDate
The last call date.
- lastCallPrice
The last call price.
- maxPrice
The maximum call price.
- percentIncrement
The percentage Increment.
- schedule
The full schedule of call options as an array of date/price pairs. For full details see Schedule Object.
ConfidentialValue Object¶
The ConfidentialValue field is not mandatory. If a ConfidentialValue is specified, then both its Type and its Amount must be specified.
- type
The type of the ConfidentialValue. Can take following values:
NetInterestCost,TrueInterestCost.- amount
Complex object representing the amount of the ConfidentialValue. For more details, see Complex Amount With Percentage Object.
BidData Object¶
The BidData field is not mandatory. If a BidData is specified, then at least one Bid must be specified.
- bids
The list of the bids available in bidData. For full details see Bids Object.
Bids Object¶
- dealerId
Unique Identifier for the Dealer.
- dealerName
Name of the Dealer.
- amount
Par Amount for Competitive notes deals per bid.
- interest
The Interest Type, like NIC or TIC, and Amount of the Dealer?s Bid. For full details see BidInterest Object.
- winningBid
Indicator for whether the bid is a WinningBid. Takes either a true or false value.
BidInterest Object¶
- cost
The amount of the Dealer’s Bid
- costType
The interest type for the Dealer’s Bid. Can take one of following values:
TrueInterestCost,NetInterestCost.