Introduction
Welcome to the IFR Deal API documentation page. Here you will find information about the IFR API deal products, API endpoints, authentication and how to process the json or xml format returned by the API.
Products
The IFR Deal API offers all the latest deal content, securely available on a real time basis. In addition, and depending on subscription level, a full archive extract is available for download. Content can also be filtered depending on individual client requirements. Please contact your IFR account manager to discuss all available options.
Subscriptions
Please contact your IFR account manager to find out more about what subscription packages are available.
Endpoints
The Deal API is composed of the following endpoints:
Authentication
Use this endpoint to request a token that will be sent with subsequent requests for stories.
The endpoint can either be used via the Swagger UI or programmatically.
- Swagger UI - login using your credentials and copy the returned token into your client code for use in the authentication header.
- Programmatically - call the endpoint once at the beginning of a session and use the token in subsequent requests.
| Method | POST |
| URL | https://deals-api.ifre.com/v1/auth |
| Input |
Username and Password format - Query parameter to specify the return data type. Can be json or xml. By default the API return json. |
| Request content type | application/x-www-form-urlencoded |
| Response content type | application/xml or application/json |
| Success |
An xml/json response with token and success message. Sample below
|
| Login failed |
401 code and xml/json below
|
| Other possible errors | Code 500, if there is an issue with the server |
Realtime Endpoint
Use this endpoint to request the latest published stories.
- Poll for content a maximum of once every 30 seconds.
- The content returned is based on your subscription. The only input required is the token from the authentication endpoint.
- The endpoint returns content that you have not processed before in the order in which the content was published.
- A maximum of 500 deals can be returned per call.
| Method | GET |
| URL | https://deals-api.ifre.com/v1/realtime |
| Input |
Authorisation header using the token from the Authentication endpoint
format - Query parameter to specify the return data type. Can be json or xml. By default the API return json. |
| Response content type | application/xml or application/json |
| Success | xml/json list of deals |
| Authorisation failed |
403 code and xml/json below
|
| Other possible errors | Code 500 |
Archive Endpoint
Use this endpoint to request and download historical content.
- Ensure you have a subscription that allows for historical content before calling this endpoint.
- The content returned is based on your subscription (and any customisations applied). In addition to the authentication header you can also provide a date range to filter stories and some pagination parameters.
- A maximum of 500 deals will be returned per call. The pagination element can be utilised to scroll through the results.
| Method | POST |
| URL | https://deals-api.ifre.com/v1/archive |
| Input |
Authorisation header using the token from the Authentication endpoint
format - Query parameter to specify the return data type. Can be json or xml. By default the API return json. xml/json request in body
Dates format: YYYY-MM-DD or YYYY-MM-DD HH:mm:ss Time must be in UTC. If YYYY-MM-DD is used,data is returned with timestamps between start date 00:00:00 UTC and end date 23:59:59 UTC |
| Response content type | application/xml or application/json |
| Success | xml/json list of deals |
| Authorisation failed |
403 code and xml/json below
|
| Other possible errors | Code 500 |
Story Format Realtime
Use this endpoint to request deal data in story format. The endpoint returns NewsML formatted response. Refer to the News API for more information.
- Ensure you have a subscription that allow to access deals in story format before calling this endpoint.
- The content returned is based on your subscription (and any customisations applied). The only input required is the token from the authentication endpoint.
- The endpoint returns content that you have not processed before in the order in which the content was published.
- A maximum of 500 deals can be returned per call.
| Method | GET |
| URL | https://deals-api.ifre.com/v1/storyformat/realtime |
| Input |
Authorisation header using the token from the Authentication endpoint
|
| Response content type |
application/xml
The response is specialized XML format called NewsML-G2.
The deal details are in tabular format in the |
| Success | XML list of deals in story format |
| Authorisation failed |
403 code and XML below
|
| Other possible errors | Code 500 |
Story Format Archive
Use this endpoint to request deal data in story format. The endpoint returns NewsML formatted response. Refer to the News API for more information.
- Ensure you have a subscription that allow to access deals in story format before calling this endpoint.
- The content returned is based on your subscription (and any customisations applied). In addition to the authentication header you are required to provide a date range to filter stories and some pagination parameters.
- A maximum of 500 deals can be returned per call.
| Method | POST |
| URL | https://deals-api.ifre.com/v1/storyformat/archive |
| Input |
Authorisation header using the token from the Authentication endpoint
XML request in body
Dates format: YYYY-MM-DD or YYYY-MM-DD HH:mm:ss Time must be in UTC. If YYYY-MM-DD is used,data is returned with timestamps between start date 00:00:00 UTC and end date 23:59:59 UTC |
| Response content type |
application/xml
The response is specialized XML format called NewsML-G2.
The deal details are in tabular format in the |
| Success | XML list of deals in story format |
| Authorisation failed |
403 code and XML below
|
| Other possible errors | Code 500 |
Lookups
Use this endpoint to request deal lookup data. The Deal Item section indicate the field where each lookup is used.
| Method | GET |
| URL | https://deals-api.ifre.com/v1/lookups |
| Input |
Authorisation header using the token from the Authentication endpoint
format - Query parameter to specify the return data type. Can be json or xml. By default the API return json.
|
| Response content type | application/xml or application/json |
| Success | XML or JSON list of deal lookups |
| Authorisation failed |
403 code and xml/json below
|
| Other possible errors | Code 500 |
Swagger
Swagger UI can be found here.
API Response
The Deal API returns data as XML or JSON depending on the format query parameter. This section provides a guide on how to process the data return from the API.
Deal Message
The following snippet is a high-level XML/JSON structure returned by the API.
{
"paging": {
"pageIndex": 1,
"totalPages": 191,
"pageSize": 500,
"totalCount": 95112,
"listCount": 500,
"startIndex": 1,
"endIndex": 500,
"hasNextPage": true,
"hasPreviousPage": false
},
"items": [{
"dealId": 1,
}, {
"dealId": 2,
}, {
"dealId": n,
}
]
}
| $.items | Contains a list of deals. |
| $.paging | This element provides pagination information useful for processing large datasets. |
<deals>
<paging>
<pageIndex>1</pageIndex>
<totalPages>191</totalPages>
<pageSize>500</pageSize>
<totalCount>95112</totalCount>
<listCount>500</listCount>
<startIndex>1</startIndex>
<endIndex>500</endIndex>
<hasNextPage>true</hasNextPage>
<hasPreviousPage>false</hasPreviousPage>
</paging>
<items>
<dealId>1</dealId>
</items>
<items>
<dealId>2</dealId>
</items>
<items>
<dealId>n</dealId>
</items>
</deals>
| /deals | Uppermost element that encapsulates the API response. |
| /deals/items | Contains individual deal details. |
| /deals/paging | This element provides pagination information useful for processing large datasets. |
Deal Item
The deal item contains details of each individual deal. Use the xpath /deals/items to get a list of deals from the XML result or $.items from the JSON response.
{
"publisherAction": "Update",
"dealId": 25019222,
"dealGroupId": 25019222,
"uniqueId": "52dccc83-8641-4c05-a4d5-f76e27253d5e",
"created": "2022-09-13T08:30:41.684Z",
"changed": "2022-09-13T10:39:21.324Z",
"title": "Test deal",
"url": "https://pub-ifrweb-ppe.ifre.com/deal/ifr/25019222",
"author": "",
"dealType": "Structured",
"dealStatus": "PRICED",
"assetType": "High Yield",
"pricingDate": "2022-09-13",
"issuerBorrowerType": "Corporate",
"offeringType": "Dim Sum",
"currency": "USD",
"programType": "MTN",
"size": "45",
"sizeType": "bn",
"bookSize": "50",
"bookSizeModifier": "max",
"coupon": "2300",
"bookSizeType": "bn",
"couponType": "Step-Down",
"overSubscriptionRate": "1.11",
"nic": "11",
"structuredFinanceType": "ABS",
"issuePrice": "1000",
"typeDetail": "CARDS-Fixed/Floating",
"reoffer": "5000",
"yield": "50",
"spread": "T+144",
"guidance": "IPT AlphaA+1/+2 +ve,launch G+3/+4 -ve",
"moodys": {
"rating": "Aaa",
"modifier": "Developing"
},
"sp": {
"rating": "BBB+",
"modifier": "Positive outlook"
},
"fitch": {
"rating": "A+",
"modifier": "Watch Negative"
},
"dbrs": {
"rating": "BBBH",
"modifier": "Watch Negative"
},
"ipt": "AlphaA+1/+2 +ve",
"originators": [
"ACA Management LLC",
"Academic Loan Group"
],
"otherRatings": [
{
"ratingAgency": "Vontobel",
"rating": "A",
"modifier": "Stable"
},
{
"ratingAgency": "ZKB",
"rating": "B",
"modifier": "Negative watch"
}
],
"guarantors": [
{
"guarantorName": "Guarantor 1",
"lei": "10001"
},
{
"guarantorName": "Guarantor 2",
"lei": "10002"
}
],
"tenor": "0.05",
"listed": [
"Oslo",
"Osaka"
],
"maturityDate": "2022-09-30",
"denoms": "DEN001",
"issueTypes": [
"Bank notes",
"Cumul pfd",
"FMB"
],
"uop": [
"CapEx",
"LBO"
],
"reopen": "YES",
"sector": "Technology Equipment",
"total": "90",
"law": [
"Albania",
"Bahrain"
],
"totalType": "bn",
"fees": "500",
"firstPayDate": "2022-09-15",
"market": "SEC Registered",
"business": "Office Equipment",
"country": "UNITED STATES",
"region": "Americas",
"settleDate": "2022-09-13",
"tranches": "",
"notes": "USD45bn 0.05NC4 Bank notes Cumul pfd FMB Sustainable SEC Registered Dim Sum. Aaa/BBB+/A+/BBBH/A/B. Affin/HSBC/BCC Invest. IPT AlphaA+1/+2 +ve, launch G+3/+4 -ve came T+144. Bks 50bn max.",
"contentLinks": [
{
"id": 1524120,
"uniqueId": "6aee8c47-830c-44af-81cf-46e4588d1994",
"title": "US: Ra Pharma offers attractive entry point",
"url": "https://pub-ifrweb-ppe.ifre.com/story/1524120/us-ra-pharma-offers-attractive-entry-point-wkqjftpylx"
},
{
"id": 2914701,
"uniqueId": "828ec873-5bd4-410a-820d-63f687528d2c",
"title": "Keppel DC REIT obtains A$30m loan",
"url": "https://pub-ifrweb-ppe.ifre.com/story/2907679/keppel-dc-reit-obtains-a30m-loan-0rxwgy1tmc"
}
],
"lei": "5493000Y33XDVO2CXC18",
"distribution": "Dist",
"numberOfAccounts": 10,
"ric": "XRX.OQ",
"ticker": "XRX",
"countryOfRisk": "UNITED STATES",
"prepricing": [
{
"stage": "IPT",
"basis": "AlphaA",
"amount1": 1,
"amount2": 2,
"modifier": "+ve"
},
{
"stage": "Launch",
"basis": "Gilts",
"amount1": 3,
"amount2": 4,
"modifier": "-ve"
}
],
"wng": "Max",
"originalAmount": 5,
"couponBasis": "3mP",
"isEsg": true,
"esgType": "Sustainable",
"averageLife": 2,
"taxCall": true,
"pariPassuCall": true,
"crossDefaultCall": true,
"resetDate": "2022-09-13",
"parCall": "1",
"cleanUpCall": "2",
"makeWholeCall": "mwc",
"equityClawBack": "ecb",
"regulatoryCall": "rc",
"cocCall": "coc",
"acqCall": "ac",
"grenium": 14,
"collateralAmount": 59,
"offeredAmount": 60,
"servicer": "serv",
"assetManager": "asst mng",
"isPerpetual": true,
"nonCallPeriod": "4",
"underwriters": [
{
"underwriterName": "Affin Investment Bank",
"role": "Joint Books"
},
{
"underwriterName": "HSBC ",
"role": "GloCo"
},
{
"underwriterName": "BCC Invest",
"role": "Left Lead"
}
],
"identifiers": [
{
"type": "Valoren",
"identifier": "4590948"
},
{
"type": "CUSIP",
"identifier": "4004901"
}
],
"issuer": {
"shortName": "Xerox Corp",
"longName": "Xerox Holdings Corp",
"permId": "5068338327",
"orgId": "117747149",
"ric": "XRX.O"
},
"callDate": "2022-09-13",
"call": [
{
"date": "2022-09-15",
"price": 1000
},
{
"date": "2022-09-14",
"price": 2000
},
{
"date": "2022-09-13",
"price": 3000
}
],
"finalTenor": "5yr",
"finalCoupon":"2300 Step-down"
}
<items>
<publisherAction>Update</publisherAction>
<dealId>25019222</dealId>
<dealGroupId>25019222</dealGroupId>
<uniqueId>52dccc83-8641-4c05-a4d5-f76e27253d5e</uniqueId>
<created>2022-09-13T08:30:41.684Z</created>
<changed>2022-09-13T10:39:21.324Z</changed>
<title>Test deal</title>
<url>https://pub-ifrweb-ppe.ifre.com/deal/ifr/25019222</url>
<author>
</author>
<dealType>Structured</dealType>
<dealStatus>PRICED</dealStatus>
<assetType>High Yield</assetType>
<pricingDate>2022-09-13</pricingDate>
<issuerBorrowerType>Corporate</issuerBorrowerType>
<offeringType>Dim Sum</offeringType>
<currency>USD</currency>
<programType>MTN</programType>
<size>45</size>
<sizeType>bn</sizeType>
<bookSize>50</bookSize>
<bookSizeModifier>max</bookSizeModifier>
<coupon>2300</coupon>
<bookSizeType>bn</bookSizeType>
<couponType>Step-Down</couponType>
<overSubscriptionRate>1.11</overSubscriptionRate>
<nic>11</nic>
<structuredFinanceType>ABS</structuredFinanceType>
<issuePrice>1000</issuePrice>
<typeDetail>CARDS-Fixed/Floating</typeDetail>
<reoffer>5000</reoffer>
<yield>50</yield>
<spread>T+144</spread>
<guidance>IPT AlphaA+1/+2 +ve,launch G+3/+4 -ve</guidance>
<moodys>
<rating>Aaa</rating>
<modifier>Developing</modifier>
</moodys>
<sp>
<rating>BBB+</rating>
<modifier>Positive outlook</modifier>
</sp>
<fitch>
<rating>A+</rating>
<modifier>Watch Negative</modifier>
</fitch>
<dbrs>
<rating>BBBH</rating>
<modifier>Watch Negative</modifier>
</dbrs>
<ipt>AlphaA+1/+2 +ve</ipt>
<originators>ACA Management LLC</originators>
<originators>Academic Loan Group</originators>
<otherRatings>
<ratingAgency>Vontobel</ratingAgency>
<rating>A</rating>
<modifier>Stable</modifier>
</otherRatings>
<otherRatings>
<ratingAgency>ZKB</ratingAgency>
<rating>B</rating>
<modifier>Negative watch</modifier>
</otherRatings>
<guarantors>
<guarantorName>Guarantor 1</guarantorName>
<lei>10001</lei>
</guarantors>
<guarantors>
<guarantorName>Guarantor 2</guarantorName>
<lei>10002</lei>
</guarantors>
<tenor>0.05</tenor>
<listed>Oslo</listed>
<listed>Osaka</listed>
<maturityDate>2022-09-30</maturityDate>
<denoms>DEN001</denoms>
<issueTypes>Bank notes</issueTypes>
<issueTypes>Cumul pfd</issueTypes>
<issueTypes>FMB</issueTypes>
<uop>CapEx</uop>
<uop>LBO</uop>
<reopen>YES</reopen>
<sector>Technology Equipment</sector>
<total>90</total>
<law>Albania</law>
<law>Bahrain</law>
<totalType>bn</totalType>
<fees>500</fees>
<firstPayDate>2022-09-15</firstPayDate>
<market>SEC Registered</market>
<business>Office Equipment</business>
<country>UNITED STATES</country>
<region>Americas</region>
<settleDate>2022-09-13</settleDate>
<tranches>
</tranches>
<notes>USD45bn 0.05NC4 Bank notes Cumul pfd FMB Sustainable SEC Registered Dim Sum. Aaa/BBB+/A+/BBBH/A/B. Affin/HSBC/BCC Invest. IPT AlphaA+1/+2 +ve, launch G+3/+4 -ve came T+144. Bks 50bn max.</notes>
<contentLinks>
<id>1524120</id>
<uniqueId>6aee8c47-830c-44af-81cf-46e4588d1994</uniqueId>
<title>US: Ra Pharma offers attractive entry point</title>
<url>https://pub-ifrweb-ppe.ifre.com/story/1524120/us-ra-pharma-offers-attractive-entry-point-wkqjftpylx</url>
</contentLinks>
<contentLinks>
<id>2914701</id>
<uniqueId>828ec873-5bd4-410a-820d-63f687528d2c</uniqueId>
<title>Keppel DC REIT obtains A$30m loan</title>
<url>https://pub-ifrweb-ppe.ifre.com/story/2907679/keppel-dc-reit-obtains-a30m-loan-0rxwgy1tmc</url>
</contentLinks>
<lei>5493000Y33XDVO2CXC18</lei>
<distribution>Dist</distribution>
<numberOfAccounts>10</numberOfAccounts>
<ric>XRX.OQ</ric>
<ticker>XRX</ticker>
<countryOfRisk>UNITED STATES</countryOfRisk>
<prepricing>
<stage>IPT</stage>
<basis>AlphaA</basis>
<amount1>1</amount1>
<amount2>2</amount2>
<modifier>+ve</modifier>
</prepricing>
<prepricing>
<stage>Launch</stage>
<basis>Gilts</basis>
<amount1>3</amount1>
<amount2>4</amount2>
<modifier>-ve</modifier>
</prepricing>
<wng>Max</wng>
<originalAmount>5</originalAmount>
<couponBasis>3mP</couponBasis>
<isEsg>true</isEsg>
<esgType>Sustainable</esgType>
<averageLife>2</averageLife>
<taxCall>true</taxCall>
<pariPassuCall>true</pariPassuCall>
<crossDefaultCall>true</crossDefaultCall>
<resetDate>2022-09-13</resetDate>
<parCall>1</parCall>
<cleanUpCall>2</cleanUpCall>
<makeWholeCall>mwc</makeWholeCall>
<equityClawBack>ecb</equityClawBack>
<regulatoryCall>rc</regulatoryCall>
<cocCall>coc</cocCall>
<acqCall>ac</acqCall>
<grenium>14</grenium>
<collateralAmount>59</collateralAmount>
<offeredAmount>60</offeredAmount>
<servicer>serv</servicer>
<assetManager>asst mng</assetManager>
<isPerpetual>true</isPerpetual>
<nonCallPeriod>4</nonCallPeriod>
<underwriters>
<underwriterName>Affin Investment Bank</underwriterName>
<role>Joint Books</role>
</underwriters>
<underwriters>
<underwriterName>HSBC </underwriterName>
<role>GloCo</role>
</underwriters>
<underwriters>
<underwriterName>BCC Invest</underwriterName>
<role>Left Lead</role>
</underwriters>
<identifiers>
<type>Valoren</type>
<identifier>4590948</identifier>
</identifiers>
<identifiers>
<type>CUSIP</type>
<identifier>4004901</identifier>
</identifiers>
<issuer>
<shortName>Xerox Corp</shortName>
<longName>Xerox Holdings Corp</longName>
<permId>5068338327</permId>
<orgId>117747149</orgId>
<ric>XRX.O</ric>
</issuer>
<callDate>2022-09-13</callDate>
<call>
<date>2022-09-15</date>
<price>1000</price>
</call>
<call>
<date>2022-09-14</date>
<price>2000</price>
</call>
<call>
<date>2022-09-13</date>
<price>3000</price>
</call>
<finalTenor>5yr</finalTenor>
<finalCoupon>2300 Step-Down</finalCoupon>
</items>
| Field | Description | Definition | Format |
|---|---|---|---|
| publisherAction | Edit action | Action can be Create,Edit or Delete. Details in the next section. | text |
| dealId | Deal ID | Security Identifier | number/integer |
| dealGroupId | Deal Group ID | Security identifier for group | number/integer |
| uniqueId | Unique Id | Security unique identifier | GUID |
| created | The date the deal was initially created | The date the deal was initially created | datetime |
| changed | The most recent modification date | The most recent modification date | datetime |
| title | The Deal headline | Heading/Title for a deal story | text |
| url | The Deal URL | The Deal URL | text |
| author | The Deal author - firstname-space-lastname | The IFR author of the deal | text |
| dealType |
Deal Type
Lookup : dealTypes |
Indicates market-linked vs plain vanila instrument | text |
| dealStatus |
Deal Status
Lookup : dealStatuses |
The current status of the deal | text |
| assetType |
Asset Type
Lookup : assetTypes |
Refers to security structure and rating | text |
| pricingDate | Pricing Date | The date transaction final details released | date |
| issuerBorrowerType |
Issuer/Borrower Type
Lookup : issuerTypes |
Security description | text |
| offeringType |
Offering Type
Lookup : offeringTypes |
Foreign Bond Type | text |
| currency |
Currency
Lookup : currencies |
Currency in which security is issued | text |
| programType |
Program Type
Lookup : programTypes |
Issuance programme eg MTN, EMTN, Debt Issuance Programme, Covered Bond Programme | text |
| size | Size | Size of deal in millions, billions or trillions (specified in size type) | number/decimal |
| sizeType |
Size Type
Lookup : sizeTypes |
Denotes the multiplier | text |
| bookSize | Book size | Amount of the transaction | number/decimal |
| bookSizeModifier | Book Size Modifier | description of book size - +, c., ~, nr., with any other info (eg +, 125m JLM) | text |
| bookSizeType |
Book Size Type
Lookup : sizeTypes |
Long and short scale for the amount (trn vs bn vs mn) | text |
| coupon | Coupon | The interest rate on a debt security the issuer promises to pay to the holder until maturity, expressed as an annual percentage of face value. | number/decimal |
| couponType |
Coupon Type
Lookup : couponTypes |
Coupon payment type | text |
| overSubscriptionRate | Over Subscription Rate | Books Oversubscription rate | number/decimal |
| nic | NIC | New Issue Concession. Difference between the spread at which the new issue printed and the spread at which corresponding bonds trade in the secondary market. | text |
| structuredFinanceType |
Securitisation Type
Lookup : structuredFinanceTypes |
Broad securitisation classification � ABS, CLO, RMBS, CMBS | text |
| issuePrice | Issue Price | Price at which the security is offered to the public | number/decimal |
| typeDetail |
Collateral
Lookup : typeDetails |
The structured finance sub-type (eg AUTO-prime retail, CMBS-single loan, RMBS-BTL) | text |
| reoffer | Reoffer Price | Price at which the security is reoffered to the public | number/decimal |
| yield | Yield | The rate of return an investor will receive if the security is held to the first maturity date | number/decimal |
| spread |
Spread
Basis lookup : spreadBasisList |
The final spread of the deal, based on how it has been marketed | text |
| guidance | Guidance | ||
| moodys |
Moodys
Lookup : moodys Modifier lookup : ratingModifiers |
Rating - rating of security at the time of offer. Modifier - Indicates bond is under watchlist. |
Complex Type - rating : text - modifier : text |
| sp |
S&P
Lookup : standardAndPoors Modifier lookup : ratingModifiers |
Rating - rating of security at the time of offer. Modifier - Indicates bond is under watchlist. |
Complex Type - rating : text - modifier : text |
| fitch |
Fitch
Lookup : fitch Modifier lookup : ratingModifiers |
Rating - rating of security at the time of offer. Modifier - Indicates bond is under watchlist. |
Complex Type - rating : text - modifier : text |
| dbrs |
DBRS
Lookup : dbrs Modifier lookup : ratingModifiers |
Rating - rating of security at the time of offer. Modifier - Indicates bond is under watchlist. |
Complex Type - rating : text - modifier : text |
| ipt | IPT | ||
| originators |
Originator
Lookup : originators |
Company whose assets are being secured in SF | text |
| otherRatings |
Other Ratings
Agency lookup : otherRatings Modifier lookup : ratingModifiers |
Rating of security at the time of offer |
Complex Type - ratingAgency : text - rating : text - modifier : text |
| guarantors | Guarantor | A secondary guarantee that interest and principal payments will be made |
Complex Type - guarantorName : text - lei : text |
| tenor | Tenor | Number of years to final maturity | number/decimal |
| listed |
Listed
Lookup : listingExchanges |
Exchange where the notes are traded | text |
| maturityDate | Maturity date | Date on which the principal amount of the issue comes due | date |
| denoms | Denoms | Face value classification | text |
| issueTypes |
Issue Type
Lookup : issueTypes |
Senior, secured, FA-Backed, benchmark etc | text |
| uop |
UOP
Lookup : uops |
Basis of the issuer�s sale of securities | text |
| reopen |
Reopen/Tap
Lookup : reopens |
Additional amount added to existing notes | text |
| sector |
Sector
Lookup : sectors |
Issuer Segment of Operations | text |
| total | Total | New total size of an issue after increase | number/decimal |
| law |
Law
Lookup : governingLaws |
Security governing law | text |
| totalType |
Total Type
Lookup : totalTypes |
m,bn,trn - size type | text |
| fees | Fees | Refers to dealer's fees | text |
| firstPayDate | 1st Payment date | Refers to first interest payment date | date |
| market |
Format
Lookup : markets |
Deal format - 144a, RegS, SEC Registered | text |
| business | Business | Issuer business description | text |
| country |
Country
Lookup : countries |
Issuer country of operations | text |
| region |
Region
Lookup : regions |
Refers to Region where Issuer Operates | text |
| settleDate | Settle date | Refers to settlement date. Date by which the executed order must be settled. | date |
| tranches | Tranches | Different parts of a multi-part deal | tablefield |
| notes | Notes | Descriptive notes on the deal | text |
| contentLinks | Content Links | Reference link to IFRe.com story |
Complex Type - id : number/integer - uniqueId : GUID - title : text - url : text |
| lei | LEI | Legal Entity Identifier | ID |
| distribution | Distribution | Geographical and investor type distribution of a sold deal | text |
| numberOfAccounts | Number Of Accounts | Number of investors buying a sold deal | number |
| ric | RIC | Reuters Instrument Code | ID |
| ticker | Ticker | Stock exchange ticker | ID |
| countryOfRisk |
Country Of Risk
Lookup : countries |
Country of ultimate risk of issuer - usually owner country, or supranational | text |
| prepricing |
Pre-pricing
Stage lookup : prepricingStages Basis lookup : prepricingBasisList |
The stages of pricing in the marketing period of a bond issue � IPTs, guidance, launch etc. |
Complex Type - stage : text - basis : text - amount1 : number/decimal - amount2 : number/decimal - modifier : text |
| wng |
WNG
Modifier lookup : wngModifiers |
"Will Not Grow" size | text |
| originalAmount | Original Amount | Indicates bond is under watchlist | number/decimal |
| couponBasis |
Coupon Basis
Lookup : couponBasisList |
The benchmark floating basis that a variable rate note is spread over (LIBOR, EURIBOR, 3mBBSW etc) | text |
| isEsg | Is deal ESG? | Is the deal ESG - green, sustainable, etc | true/false |
| esgType |
Type of ESG deal
Lookup : esgTypes |
Type of ESG deal - green, SLB, sustainable, blue etc | text |
| averageLife | Average Life | Weighted average life of bond | number/decimal |
| taxCall | Tax Call | Callable upon a tax event | true/false |
| pariPassuCall | Pari Passu Call (PP) | Call if bonds fail to be ranked equally with similar ones from issuer | true/false |
| crossDefaultCall | Cross Default Call (XD) | Call if other bonds issued by issuer default | true/false |
| resetDate | Reset Date | Date coupon resets | date |
| parCall | Par Call | A call (at par) usually shortly before final maturity (1m/3m/6m typically) | text |
| cleanUpCall | Clean Up Call | Early redemption of the entire balance of a debt issue when a relatively small amount of the original issue remains outstanding. | text |
| makeWholeCall | Make Whole Call | A call , usually at a much tighter level over treasury/bund/government bond than issued at | text |
| equityClawBack | Equity Claw Back | An equity clawback allows a bond issuer to refinance a specific percentage of outstanding bonds. The refinancing happens using proceeds from an equity offering, | text |
| regulatoryCall | Regulatory Call | Call in the event of change of law etc. affecting the utilisation of the Loan as Regulatory Capital | text |
| cocCall | COC Call | Change of control call - Y/N or description | text |
| acqCall | Acq Call | Call in the event the issuer being acquired by another company/entity. | text |
| grenium | Greenium | Green premium | number/decimal |
| collateralAmount | Collateral Amount | Amount of collateral in asset backed (or CLO/mortgage backed) portfolio | number/decimal |
| offeredAmount | Offered Amount | Amount of SF being sold to the market | number/decimal |
| servicer | Servicer | Servicers manage the cash flow of the bonds | text |
| assetManager | Asset Manager | The asset manager in charge of the CLO/CDO | text |
| isPerpetual | Is Perpetual? | Is it a perpetual bond? | true/false |
| nonCallPeriod | Non-call Period | Time in years before first call | text |
| underwriters |
Underwriters
Role lookup : dealerRoles |
Name - The book manager recording activity for the syndicate and underwriting the largest portion of the securities.
Role - Specific role in lead group eg Global Coordinator, Joint Bookrunner, Arranger, Structurer |
Complex Type - underwriterName : text - role : text |
| identifiers |
Identifiers
Type lookup : dealIdentifierTypes |
List of identifier type and value |
Complex Type - type : text - identifier : text |
| issuer | Issuer | Entity which borrows or raises money through the sale of securities |
Complex Type - shortName : text - longName : text - permId : text - orgId : text - ric : text |
| callDate | Call date | Refers to first call date the Issuer has the right to call the security | date |
| call | Call |
Complex Type - date : date - price : decimal |
|
| finalTenor | Final Tenor | Calculated tenor based on the formula below | text |
| finalCoupon | Final Coupon | The interest rate on a debt security the issuer promises to pay to the holder until maturity, expressed as an annual percentage of face value. If the coupon type is FRN the finalCoupon shows the spread in basis points over a basis. | text |
Publisher Actions
The following publisher actions are transmitted via the API with the recommended actions clients should take when processing content.
| Publisher Action | Client Action |
|---|---|
| CreateNew | Add a new deal |
| Update | Update deal with incoming data |
| Delete | Remove deal |
Tenor Calculation
The final tenor is calculated based on the following fields: tenor, isPerpetual and nonCallPeriod
| Scenarios | Tenor | Perpetual | Non-call Period | Final Tenor |
|---|---|---|---|---|
| Non Perpetual without Non call period | 10 | Non-Perp | 10yr | |
| Non Perpetual with Non call period | 10 | Non-Perp | 5 | 10NC5 |
| Non Perpetual without Non call period and tenor | Non-Perp | |||
| Perpetual without Non call period and tenor | Perp | Perp | ||
| Non Perpetual with Non call period and no tenor | Non-Perp | 5 | NC5 | |
| Perpetual with Non call period and no tenor | Perp | 5 | PerpNC5 |
Getting Help
For any queries regarding the Deal API please contact https://myaccount.lseg.com/en/helpandsupport
For any queries regarding subscriptions please contact your LSEG account manager.
Changelog
See what's new added, changed, fixed, improved or updated in the latest versions.
Version 1.0 (20 August, 2022)
Initial Release