Download OpenAPI specification:Download
Calculate price, yield, accrued interest and many more analytics for fixed income securities using market specific conventions.
required | object (Quote) Defines the Quote to be used to calculate results for the provided Security. |
required | object (Security) Defines a Fixed Income Security to be calculated. |
| identifier | string Identifies the security being calculated. This identifier will be returned in the CalculateResponse object. |
| includeDisplayValues | boolean Determines whether or not market conventional display values should be included for all prices and yields. This is in addition to the full precision values. |
| includeCashFlows | boolean Determines whether the Cash Flows are included in the results. |
| includeExtendedAnalytics | boolean Determines whether the Macaulay Duration, Modified Duration, Convexity, and other extended Risk/Analytical values are included in the results. |
| includeAllRedemptions | boolean Determines whether results to each of the provided redemption dates are included in the output. |
[- {
- "quote": {
- "quoteType": "price",
- "value": 0,
- "concession": 0,
- "spreadYield": 0,
- "yieldRedemption": "maturity",
- "settlementDate": "2019-08-24",
- "quantity": 0
}, - "security": {
- "securityType": "fixed",
- "market": "us/municipal",
- "dayCountBasis": "30/360",
- "eomAdjust": true,
- "interestFrequency": 0,
- "interestRate": 0,
- "faceValue": 0,
- "maturityDate": "2019-08-24",
- "redemptionPrice": 0,
- "lastInterestDate": "2019-08-24",
- "datedDate": "2019-08-24",
- "firstInterestDate": "2019-08-24",
- "exDividendDate": "2019-08-24",
- "dividendPaymentDate": "2019-08-24",
- "callSchedule": [
- {
- "date": "2019-08-24",
- "rate": 0
}
], - "couponSchedule": [
- {
- "date": "2019-08-24",
- "rate": 0
}
]
}, - "identifier": "string",
- "includeDisplayValues": true,
- "includeCashFlows": true,
- "includeExtendedAnalytics": true,
- "includeAllRedemptions": true
}
]{- "success": true,
- "calculateResponses": {
- "identifier": "string",
- "success": true,
- "analytics": {
- "settlementDate": "2019-08-24",
- "price": 0,
- "accruedInterest": 0,
- "principal": 0,
- "extAccruedInterest": 0,
- "ytm": 0,
- "ytc": 0,
- "ytp": 0,
- "ytw": 0,
- "ytwDate": "2019-08-24",
- "displayPrice": 0,
- "displayYtm": 0,
- "displayYtc": 0,
- "displayYtp": 0,
- "displayYtw": 0,
- "bey": 0,
- "cey": 0,
- "discount": 0,
- "annualDividend": 0,
- "stripPrice": 0,
- "stripYield": 0,
- "currentYield": 0,
- "duration": 0,
- "modifiedDuration": 0,
- "convexity": 0,
- "pv1bp": 0,
- "yv1_32": 0,
- "interestOnInterest": 0,
- "cashFlows": [
- {
- "date": "2019-08-24",
- "interest": 0,
- "principal": 0
}
], - "redemptions": [
- {
- "redemptionType": "maturity",
- "date": "2019-08-24",
- "yield": 0,
- "displayYield": 0,
- "currentYield": 0,
- "duration": 0,
- "modifiedDuration": 0,
- "convexity": 0,
- "pv1bp": 0,
- "yv1_32": 0,
- "interestOnInterest": 0,
- "cashFlows": [
- {
- "date": "2019-08-24",
- "interest": 0,
- "principal": 0
}
]
}
]
}, - "errorCode": 0,
- "errorMessage": "string"
}, - "errorMessage": "string"
}| tradeDate | string <date> The optional Trade Date. If tradeDate is not provided, then the current day will be used. |
| market | string Enum: "us/municipal" "us/corporate" "us/agency" "us/treasury" "us/cd" Market: us/municipal - US Municipal us/corporate - US Corporate us/agency - US Agency us/treasury - US Treasury us/cd - US CD Either market or settlementDays must be provided. If only market is specified, then the default days to settlement for the provided market is used. |
| settlementDays | integer The number of business days to settlement. Either market or settlementDays must be provided. If this value is not provided, then the default days to settlement for the provided Market is used. |
{- "tradeDate": "2019-08-24",
- "market": "us/municipal",
- "settlementDays": 0
}{- "success": true,
- "settlementDate": "2019-08-24",
- "errorMessage": "string"
}CalculateRequest object that includes the Security and Quote to calculate.
required | object (Quote) Defines the Quote to be used to calculate results for the provided Security. |
required | object (Security) Defines a Fixed Income Security to be calculated. |
| identifier | string Identifies the security being calculated. This identifier will be returned in the CalculateResponse object. |
| includeDisplayValues | boolean Determines whether or not market conventional display values should be included for all prices and yields. This is in addition to the full precision values. |
| includeCashFlows | boolean Determines whether the Cash Flows are included in the results. |
| includeExtendedAnalytics | boolean Determines whether the Macaulay Duration, Modified Duration, Convexity, and other extended Risk/Analytical values are included in the results. |
| includeAllRedemptions | boolean Determines whether results to each of the provided redemption dates are included in the output. |
{- "quote": {
- "quoteType": "price",
- "value": 0,
- "concession": 0,
- "spreadYield": 0,
- "yieldRedemption": "maturity",
- "settlementDate": "2019-08-24",
- "quantity": 0
}, - "security": {
- "securityType": "fixed",
- "market": "us/municipal",
- "dayCountBasis": "30/360",
- "eomAdjust": true,
- "interestFrequency": 0,
- "interestRate": 0,
- "faceValue": 0,
- "maturityDate": "2019-08-24",
- "redemptionPrice": 0,
- "lastInterestDate": "2019-08-24",
- "datedDate": "2019-08-24",
- "firstInterestDate": "2019-08-24",
- "exDividendDate": "2019-08-24",
- "dividendPaymentDate": "2019-08-24",
- "callSchedule": [
- {
- "date": "2019-08-24",
- "rate": 0
}
], - "couponSchedule": [
- {
- "date": "2019-08-24",
- "rate": 0
}
]
}, - "identifier": "string",
- "includeDisplayValues": true,
- "includeCashFlows": true,
- "includeExtendedAnalytics": true,
- "includeAllRedemptions": true
}{- "identifier": "string",
- "success": true,
- "analytics": {
- "settlementDate": "2019-08-24",
- "price": 0,
- "accruedInterest": 0,
- "principal": 0,
- "extAccruedInterest": 0,
- "ytm": 0,
- "ytc": 0,
- "ytp": 0,
- "ytw": 0,
- "ytwDate": "2019-08-24",
- "displayPrice": 0,
- "displayYtm": 0,
- "displayYtc": 0,
- "displayYtp": 0,
- "displayYtw": 0,
- "bey": 0,
- "cey": 0,
- "discount": 0,
- "annualDividend": 0,
- "stripPrice": 0,
- "stripYield": 0,
- "currentYield": 0,
- "duration": 0,
- "modifiedDuration": 0,
- "convexity": 0,
- "pv1bp": 0,
- "yv1_32": 0,
- "interestOnInterest": 0,
- "cashFlows": [
- {
- "date": "2019-08-24",
- "interest": 0,
- "principal": 0
}
], - "redemptions": [
- {
- "redemptionType": "maturity",
- "date": "2019-08-24",
- "yield": 0,
- "displayYield": 0,
- "currentYield": 0,
- "duration": 0,
- "modifiedDuration": 0,
- "convexity": 0,
- "pv1bp": 0,
- "yv1_32": 0,
- "interestOnInterest": 0,
- "cashFlows": [
- {
- "date": "2019-08-24",
- "interest": 0,
- "principal": 0
}
]
}
]
}, - "errorCode": 0,
- "errorMessage": "string"
}