|
IHS Markit API |
POST v1/Bonds
Description
Add a new bond asset.
Base Url
https://api-sim.uat.wsohosting.com/
Rest Call Syntax
POST SecurityMaster/v1/Bonds
POST SecurityMaster/v1/Bonds
Name
Description
Type
Additional Information
BondName
The name of the asset in WSO which typically includes the coupon rate and maturity date
string
Required
CouponFrequency
The Coupon Frequency indicates how many times a year there is a coupon payment
Required
CurrencyCode
The currency of the asset by ID value
string
Required
FirstCouponDate
The first coupon date
date
Required
InterestAccrualDate
The first date that the asset starts accruing interest
date
Required
IssuerId
The WSO ID of the issuer for the asset
integer
Required
MaturityDate
The maturity date of the asset
date
Required
AssetClassId
The class of the asset by ID value
integer
Collateral
The description of the collateral that is backing the asset
string
ConvertibleType
The entity into which the asset can be converted
string
CountryId
The legal country for the asset by ID value
integer
CouponDateOffset
Business Day Offset - this determines when a coupon should pay if the coupon date falls on a non-business day
DataFeedId
The source of the data feed by ID value
integer
DateOffset
Given the type of coupon - this is the number of days to offset the coupon rate
integer
DefaultDate
The date that the asset went into default
date
DefaultType
The type of default listed for the asset
string
FixedRate
The fixed coupon rate
decimal number
GuarantorId
The guarantor for the asset by ID value
integer
HasAttachedWarrants
The flag indicating if the asset has attached warrants
boolean
HasDefaulted
The flag indicating if the asset has defaulted
boolean
HasFXRisk
The flag indicating if the asset has foreign exchange risk
boolean
HolidayCalendarId
The holiday calendar for the asset by ID value
integer
InsurerId
The insurer of the asset by ID value
integer
IsBaseRateObservationShiftEnabled
The flag indicating if the Bond asset has Observation Shift on RFR rate option
boolean
IsCallable
The flag indicating if the asset is callable
boolean
IsCollateralized
The flag indicating if the asset is collateralized
boolean
IsEmergingMarket
The flag indicating if the asset is in an emerging market
boolean
IsInterestOnly
The flag indicating if the asset is interest only
boolean
IsPIKBond
The flag indicating if the asset is a PIK Bond
boolean
IsPrincipalOnly
The flag indicating if the asset is principal only
boolean
IsPrivate
The flag indicating if the asset is a private security
boolean
IsPutable
The flag indicating if a Put Schedule can be added
boolean
IsRestructured
The flag indicating if the asset has been restructured since it was initially issued
boolean
IsStructuredFinanceObligation
The flag indicating if the asset belongs to a structured finance obligation
boolean
IssueDate
The date that the asset was officially issued
date
IssuePrice
The price at which the asset was originally issued
decimal number
IssueSize
The original global amount of the asset at issuance
decimal number
IsSynthetic
The flag indicating if this is a synthetic security
boolean
IsTradedAccrued
The flag indicating if the asset trades with accrued interest
boolean
LeadUnderwriterId
The lead underwriter by ID value
integer
LockoutDays
The number of lockout days from 0 (zero) to 30
integer
MaturityDateExpected
The expected maturity date of the asset - optional field
date
Notes
The notes regarding the asset
string
PayNonBusinessDirection
Pay Offset - if the coupon falls on a non-business day this field determines when the coupon will pay
PayOffsetDays
Pay Offset - the number of days that coupon payment occurs differing from the coupon date
integer
PaysEndOfMonth
The flag indicating if this asset pays end of month when the first coupon date does not fall on the 31st
boolean
PIKCashPercentage
PIK - the cash percentage
decimal number
PIKPercentage
PIK - the PIK percentage
decimal number
RateOptionId
The rate option by ID value
integer
RegistrationType
The registration type
string
SeniorityId
The seniority level of the asset by ID value
integer
SpreadRate
The spread rate of the asset
decimal number
TransferAgentId
The transfer agent by ID value
integer
Limitations
-
Bonds can be Interest only or Principal only, but not both
-
Coupon Type: Fixed – rate required.
-
Coupon Type: Fixed Step Up – cannot add a fixed rate, rate option, offset, or coupon date offset.
-
Coupon Type: Float Step Up – cannot add a spread.
-
Coupon Type: Variable – cannot add a rate, rate option type, or offset.
-
Coupon Type: Zero Coupon – cannot add a rate, rate option, coupon date offset, or pay offset.
Request Information
Request body formats
application/json, text/json
{
"bondName": "sample string 1",
"assetClassId": 1,
"collateral": "sample string 2",
"convertibleType": "sample string 3",
"isCollateralized": true,
"countryId": 1,
"couponDateOffset": "None",
"couponFrequency": "Annual",
"couponType": "Fixed",
"currencyCode": "sample string 5",
"dataFeedId": 6,
"dateOffset": 1,
"dayCount": "ACT_ACT",
"defaultDate": "2024-10-08T05:33:27.0866503-05:00",
"defaultType": "sample string 7",
"firstCouponDate": "2024-10-08T05:33:27.0869498-05:00",
"fixedRate": 1.1,
"guarantorId": 1,
"hasAttachedWarrants": true,
"hasDefaulted": true,
"hasFXRisk": true,
"holidayCalendarId": 1,
"insurerId": 1,
"interestAccrualDate": "2024-10-08T05:33:27.0877949-05:00",
"isCallable": true,
"isEmergingMarket": true,
"isInterestOnly": true,
"isPIKBond": true,
"isBaseRateObservationShiftEnabled": true,
"isPrincipalOnly": true,
"isPrivate": true,
"isPutable": true,
"isRestructured": true,
"isStructuredFinanceObligation": true,
"issueDate": "2024-10-08T05:33:27.0887948-05:00",
"issuePrice": 23.1,
"issuerId": 24,
"issueSize": 1.0,
"isSynthetic": true,
"isTradedAccrued": true,
"leadUnderwriterId": 1,
"lockoutDays": 27,
"maturityDate": "2024-10-08T05:33:27.0898198-05:00",
"maturityDateExpected": "2024-10-08T05:33:27.0898198-05:00",
"notes": "sample string 29",
"payNonBusinessDirection": "On",
"payOffsetDays": 30,
"payOffsetDirection": "After",
"payOffsetType": "BusinessDays",
"paysEndOfMonth": true,
"pikCashPercentage": 1.1,
"pikPercentage": 1.1,
"rateOptionId": 1,
"registrationType": "sample string 32",
"seniorityId": 1,
"spreadRate": 1.1,
"transferAgentId": 1,
"baseRateCompoundMethod": "Unassigned",
"baseRateInterestMethod": "Unassigned"
}
application/xml, text/xml
<BondAdd xmlns:i="http://www.w3.org/2001/XMLSchema-instance"> <AssetClassId>1</AssetClassId> <BaseRateCompoundMethod>Unassigned</BaseRateCompoundMethod> <BaseRateInterestMethod>Unassigned</BaseRateInterestMethod> <BondName>sample string 1</BondName> <Collateral>sample string 2</Collateral> <ConvertibleType>sample string 3</ConvertibleType> <CountryId>1</CountryId> <CouponDateOffset>None</CouponDateOffset> <CouponFrequency>Annual</CouponFrequency> <CouponType>Fixed</CouponType> <CurrencyCode>sample string 5</CurrencyCode> <DataFeedId>6</DataFeedId> <DateOffset>1</DateOffset> <DayCount>ACT_ACT</DayCount> <DefaultDate>2024-10-08T05:33:27.0866503-05:00</DefaultDate> <DefaultType>sample string 7</DefaultType> <FirstCouponDate>2024-10-08T05:33:27.0869498-05:00</FirstCouponDate> <FixedRate>1.1</FixedRate> <GuarantorId>1</GuarantorId> <HasAttachedWarrants>true</HasAttachedWarrants> <HasDefaulted>true</HasDefaulted> <HasFXRisk>true</HasFXRisk> <HolidayCalendarId>1</HolidayCalendarId> <InsurerId>1</InsurerId> <InterestAccrualDate>2024-10-08T05:33:27.0877949-05:00</InterestAccrualDate> <IsBaseRateObservationShiftEnabled>true</IsBaseRateObservationShiftEnabled> <IsCallable>true</IsCallable> <IsCollateralized>true</IsCollateralized> <IsEmergingMarket>true</IsEmergingMarket> <IsInterestOnly>true</IsInterestOnly> <IsPIKBond>true</IsPIKBond> <IsPrincipalOnly>true</IsPrincipalOnly> <IsPrivate>true</IsPrivate> <IsPutable>true</IsPutable> <IsRestructured>true</IsRestructured> <IsStructuredFinanceObligation>true</IsStructuredFinanceObligation> <IsSynthetic>true</IsSynthetic> <IsTradedAccrued>true</IsTradedAccrued> <IssueDate>2024-10-08T05:33:27.0887948-05:00</IssueDate> <IssuePrice>23.1</IssuePrice> <IssueSize>1</IssueSize> <IssuerId>24</IssuerId> <LeadUnderwriterId>1</LeadUnderwriterId> <LockoutDays>27</LockoutDays> <MaturityDate>2024-10-08T05:33:27.0898198-05:00</MaturityDate> <MaturityDateExpected>2024-10-08T05:33:27.0898198-05:00</MaturityDateExpected> <Notes>sample string 29</Notes> <PIKCashPercentage>1.1</PIKCashPercentage> <PIKPercentage>1.1</PIKPercentage> <PayNonBusinessDirection>On</PayNonBusinessDirection> <PayOffsetDays>30</PayOffsetDays> <PayOffsetDirection>After</PayOffsetDirection> <PayOffsetType>BusinessDays</PayOffsetType> <PaysEndOfMonth>true</PaysEndOfMonth> <RateOptionId>1</RateOptionId> <RegistrationType>sample string 32</RegistrationType> <SeniorityId>1</SeniorityId> <SpreadRate>1.1</SpreadRate> <TransferAgentId>1</TransferAgentId> </BondAdd>
application/x-www-form-urlencoded
Sample not available.
Response Information
Bond
Name
Description
Type
Additional Information
AssetClassId
The class of the asset by ID value
integer
BondName
The name of the asset in WSO which typically includes the coupon rate and maturity date
string
Collateral
The description of the collateral that is backing the asset
string
ConvertibleType
The entity into which the asset can be converted
string
CountryId
The legal country of this asset by ID value
integer
CouponDateOffset
Business Day Offset - this determines when a coupon should pay if the coupon date falls on a non-business day
CouponFrequency
The Coupon Frequency indicates how many times a year there is a coupon payment
CurrencyCode
The currency type of the asset
string
DateOffset
Given the type of coupon - this is the number of days to offset the coupon rate
integer
DefaultDate
The date that the asset went into default
date
DefaultType
The type of default that has occurred
string
FirstCouponDate
The first date that the asset has a coupon payment
date
FirstSettleDate
The first settle date listed for the asset
date
FixedRate
The fixed coupon rate
decimal number
GuarantorId
The guarantor for the asset by ID value
integer
HasAttachedWarrants
The flag indicating if the asset has attached warrants
boolean
HasDefaulted
The flag indicating if the asset has defaulted
boolean
HasFXRisk
The flag indicating if the asset has foreign exchange risk
boolean
HolidayCalendarId
The holiday calendar for the asset by ID value
integer
Id
The WSO ID for the asset
integer
InsurerId
The insurer of the asset by ID value
integer
InterestAccrualDate
The first date that the asset starts accruing interest
date
IsBaseRateObservationShiftEnabled
Gets or sets a flag indicating whether or not base rate observation shift is enabled for this Bond asset.
boolean
IsCallable
The flag indicating if the asset is callable
boolean
IsCollateralized
Determines if the bond is collateralized
boolean
IsDeleted
A flag indicating if the asset is soft-deleted in the system
boolean
IsEmergingMarket
The flag indicating if the asset is from an emerging market
boolean
IsInterestOnly
The flag indicating if this is an interest only asset
boolean
IsPIKBond
The flag indicating if the asset allows payments in kind (PIK)
boolean
IsPrincipalOnly
The flag indicating if this is a principal only asset
boolean
IsPrivate
The flag indicating if the asset is a private security
boolean
IsPutable
The flag to enable a Put Schedule
boolean
IsRestructured
The flag indicating if the security has been restructured since it was initially issued
boolean
IsStructuredFinanceObligation
The flag indicating if the asset belongs to a structured finance obligation
boolean
IssueDate
The date that the asset was officially issued
date
IssuePrice
The original price at which the asset was issued
decimal number
IssueSize
The global amount of the asset at issuance
decimal number
IsSynthetic
The flag indicating if this a synthetic security
boolean
IsTradedAccrued
The flag indicating if the asset trades with accrued interest
boolean
LockoutDays
integer
MaturityDate
The maturity date of the asset
date
MaturityDateExpected
The expected maturity date of the asset - optional field
date
Notes
The notes regarding the asset
string
PayNonBusinessDirection
Pay Offset - if the coupon falls on a non-business day this field determines when the coupon will pay
PayOffsetDays
Pay Offset - the number of days that coupon payment occurs differing from the coupon date
integer
PaysEndOfMonth
The flag indicating if this asset pays end of month when the first coupon date does not fall on the 31st
boolean
PIKCashPercentage
PIK - the cash percentage
decimal number
PIKPercentage
PIK - the PIK percentage
decimal number
RegistrationType
The registration type
string
SeniorityId
The seniority level of the asset by ID value
integer
SpreadRate
The spread rate of the asset
decimal number
Response Body Formats
application/json, text/json
{
"id": 1,
"bondName": "sample string 2",
"assetClassId": 1,
"isCollateralized": true,
"collateral": "sample string 4",
"convertibleType": "sample string 5",
"countryId": 1,
"currencyCode": "sample string 6",
"couponDateOffset": "None",
"couponFrequency": "Annual",
"couponType": "Fixed",
"dateOffset": 1,
"dayCount": "ACT_ACT",
"defaultDate": "2024-10-08T05:33:27.1571899-05:00",
"defaultType": "sample string 7",
"firstCouponDate": "2024-10-08T05:33:27.1571899-05:00",
"firstSettleDate": "2024-10-08T05:33:27.1571899-05:00",
"fixedRate": 1.1,
"guarantorId": 1,
"hasAttachedWarrants": true,
"hasDefaulted": true,
"hasFXRisk": true,
"holidayCalendarId": 1,
"insurerId": 1,
"interestAccrualDate": "2024-10-08T05:33:27.1571899-05:00",
"isCallable": true,
"isEmergingMarket": true,
"isInterestOnly": true,
"isPIKBond": true,
"isBaseRateObservationShiftEnabled": true,
"isPrincipalOnly": true,
"isPrivate": true,
"isPutable": true,
"isRestructured": true,
"isStructuredFinanceObligation": true,
"issueDate": "2024-10-08T05:33:27.1571899-05:00",
"issuePrice": 1.1,
"issueSize": 1.0,
"isSynthetic": true,
"isTradedAccrued": true,
"issuer": {
"verb": "sample string 1",
"rel": "sample string 2",
"uri": "http://webapihelppage3.com"
},
"maturityDate": "2024-10-08T05:33:27.1571899-05:00",
"maturityDateExpected": "2024-10-08T05:33:27.1571899-05:00",
"notes": "sample string 26",
"payNonBusinessDirection": "On",
"payOffsetDays": 27,
"payOffsetDirection": "After",
"payOffsetType": "BusinessDays",
"paysEndOfMonth": true,
"pikCashPercentage": 1.1,
"pikPercentage": 1.1,
"registrationType": "sample string 29",
"seniorityId": 1,
"spreadRate": 1.1,
"lockoutDays": 30,
"isDeleted": true,
"links": [
{
"verb": "sample string 1",
"rel": "sample string 2",
"uri": "http://webapihelppage3.com"
},
{
"verb": "sample string 1",
"rel": "sample string 2",
"uri": "http://webapihelppage3.com"
}
],
"couponRates": {
"verb": "sample string 1",
"rel": "sample string 2",
"uri": "http://webapihelppage3.com"
},
"callSchedule": {
"verb": "sample string 1",
"rel": "sample string 2",
"uri": "http://webapihelppage3.com"
},
"coupons": {
"verb": "sample string 1",
"rel": "sample string 2",
"uri": "http://webapihelppage3.com"
},
"identifiers": {
"verb": "sample string 1",
"rel": "sample string 2",
"uri": "http://webapihelppage3.com"
},
"ratings": {
"verb": "sample string 1",
"rel": "sample string 2",
"uri": "http://webapihelppage3.com"
},
"udfs": {
"verb": "sample string 1",
"rel": "sample string 2",
"uri": "http://webapihelppage3.com"
},
"baseRateInterestMethod": "Unassigned",
"baseRateCompoundMethod": "Unassigned"
}
application/xml, text/xml
<Bond xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
<AssetClassId>1</AssetClassId>
<BaseRateCompoundMethod>Unassigned</BaseRateCompoundMethod>
<BaseRateInterestMethod>Unassigned</BaseRateInterestMethod>
<BondName>sample string 2</BondName>
<CallSchedule>
<Rel>sample string 2</Rel>
<Uri>http://webapihelppage3.com/</Uri>
<Verb>sample string 1</Verb>
</CallSchedule>
<Collateral>sample string 4</Collateral>
<ConvertibleType>sample string 5</ConvertibleType>
<CountryId>1</CountryId>
<CouponDateOffset>None</CouponDateOffset>
<CouponFrequency>Annual</CouponFrequency>
<CouponRates>
<Rel>sample string 2</Rel>
<Uri>http://webapihelppage3.com/</Uri>
<Verb>sample string 1</Verb>
</CouponRates>
<CouponType>Fixed</CouponType>
<Coupons>
<Rel>sample string 2</Rel>
<Uri>http://webapihelppage3.com/</Uri>
<Verb>sample string 1</Verb>
</Coupons>
<CurrencyCode>sample string 6</CurrencyCode>
<DateOffset>1</DateOffset>
<DayCount>ACT_ACT</DayCount>
<DefaultDate>2024-10-08T05:33:27.1571899-05:00</DefaultDate>
<DefaultType>sample string 7</DefaultType>
<FirstCouponDate>2024-10-08T05:33:27.1571899-05:00</FirstCouponDate>
<FirstSettleDate>2024-10-08T05:33:27.1571899-05:00</FirstSettleDate>
<FixedRate>1.1</FixedRate>
<GuarantorId>1</GuarantorId>
<HasAttachedWarrants>true</HasAttachedWarrants>
<HasDefaulted>true</HasDefaulted>
<HasFXRisk>true</HasFXRisk>
<HolidayCalendarId>1</HolidayCalendarId>
<Id>1</Id>
<Identifiers>
<Rel>sample string 2</Rel>
<Uri>http://webapihelppage3.com/</Uri>
<Verb>sample string 1</Verb>
</Identifiers>
<InsurerId>1</InsurerId>
<InterestAccrualDate>2024-10-08T05:33:27.1571899-05:00</InterestAccrualDate>
<IsBaseRateObservationShiftEnabled>true</IsBaseRateObservationShiftEnabled>
<IsCallable>true</IsCallable>
<IsCollateralized>true</IsCollateralized>
<IsDeleted>true</IsDeleted>
<IsEmergingMarket>true</IsEmergingMarket>
<IsInterestOnly>true</IsInterestOnly>
<IsPIKBond>true</IsPIKBond>
<IsPrincipalOnly>true</IsPrincipalOnly>
<IsPrivate>true</IsPrivate>
<IsPutable>true</IsPutable>
<IsRestructured>true</IsRestructured>
<IsStructuredFinanceObligation>true</IsStructuredFinanceObligation>
<IsSynthetic>true</IsSynthetic>
<IsTradedAccrued>true</IsTradedAccrued>
<IssueDate>2024-10-08T05:33:27.1571899-05:00</IssueDate>
<IssuePrice>1.1</IssuePrice>
<IssueSize>1</IssueSize>
<Issuer>
<Rel>sample string 2</Rel>
<Uri>http://webapihelppage3.com/</Uri>
<Verb>sample string 1</Verb>
</Issuer>
<Links>
<Link>
<Rel>sample string 2</Rel>
<Uri>http://webapihelppage3.com/</Uri>
<Verb>sample string 1</Verb>
</Link>
<Link>
<Rel>sample string 2</Rel>
<Uri>http://webapihelppage3.com/</Uri>
<Verb>sample string 1</Verb>
</Link>
</Links>
<LockoutDays>30</LockoutDays>
<MaturityDate>2024-10-08T05:33:27.1571899-05:00</MaturityDate>
<MaturityDateExpected>2024-10-08T05:33:27.1571899-05:00</MaturityDateExpected>
<Notes>sample string 26</Notes>
<PIKCashPercentage>1.1</PIKCashPercentage>
<PIKPercentage>1.1</PIKPercentage>
<PayNonBusinessDirection>On</PayNonBusinessDirection>
<PayOffsetDays>27</PayOffsetDays>
<PayOffsetDirection>After</PayOffsetDirection>
<PayOffsetType>BusinessDays</PayOffsetType>
<PaysEndOfMonth>true</PaysEndOfMonth>
<Ratings>
<Rel>sample string 2</Rel>
<Uri>http://webapihelppage3.com/</Uri>
<Verb>sample string 1</Verb>
</Ratings>
<RegistrationType>sample string 29</RegistrationType>
<SeniorityId>1</SeniorityId>
<SpreadRate>1.1</SpreadRate>
<Udfs>
<Rel>sample string 2</Rel>
<Uri>http://webapihelppage3.com/</Uri>
<Verb>sample string 1</Verb>
</Udfs>
</Bond>