curatedapi

Excel YIELD function: bond yield from price

The yield of a bond paying periodic coupons, from its price, as Excel's YIELD, proven correct to the last digit.

Settlement date (when the buyer gets the bond).
Maturity date.
Annual coupon rate as a decimal. A ratio of two decimals such as "0.08/12" is accepted.
Clean price per 100 of face value. A ratio of two decimals such as "0.08/12" is accepted.
Redemption value per 100 of face value. A ratio of two decimals such as "0.08/12" is accepted.
Coupons per year: 1, 2 or 4.
Day count basis: 0 US (NASD) 30/360; 1 Actual/actual; 2 Actual/360; 3 Actual/365; 4 European 30/360.
More options: rounding and decimals
Precision and rounding
Rounding mode applied once to each result. Default half_even.
Round results to this many digits after the decimal point.
Round results to this many significant digits.

Examples

Result: Microsoft's example: 5.75% semiannual coupon priced at 95.04287

Yield
Annual yield as a decimal.
0.065 rounded
Coupons remaining
Coupons from settlement to maturity (N).
18

Rounding: Half even, 3 decimal places. Calculator excel/yield@2.

How it is calculated

PRICE(settlement, maturity, rate, yield, redemption, frequency, basis) = pr

YIELD(settlement, maturity, rate, pr, redemption, frequency, [basis]): the yield at which PRICE gives pr. With one coupon or less left it is Microsoft's closed form; otherwise the root of the PRICE equation.

  • Excel finds this value by iterating from a guess until it stops changing. Here the root of the same equation is pinned between two proven bounds, so the result is correctly rounded. When the equation has several roots, the one closest to guess is returned (Excel's iteration usually ends there) and all are listed.
  • Arguments are named and ordered as in Excel. Excel computes in binary floating point; this API computes the exact value of the same formula and rounds it once, so it agrees with Excel to the digits Excel can show, and where Excel's own rounding error reaches the 15th digit this answer is the correct one.
  • Dates are ISO 8601 (YYYY-MM-DD) from 1900-03-01 to 9999-12-31, so Excel's fictional 29 February 1900 never comes into play. Each date result also gives Excel's serial number (1900 date system).

References

Results follow each calculator's documented rules and the sources listed. They are not financial, tax or legal advice. Check that the rules fit your case before you rely on a result. See the terms.

Use it from your code

POST /v1/calc/excel/yieldVersion 2
curl https://api.curatedapi.com/v1/calc/excel/yield \
  -H "Authorization: Bearer $CURATEDAPI_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "settlement": "2008-02-15",
    "maturity": "2016-11-15",
    "rate": "0.0575",
    "pr": "95.04287",
    "redemption": "100",
    "frequency": 2,
    "basis": 0,
    "options": {"decimals": 3}
  }'
The same call in Python
import os

import requests

payload = {
    "settlement": "2008-02-15",
    "maturity": "2016-11-15",
    "rate": "0.0575",
    "pr": "95.04287",
    "redemption": "100",
    "frequency": 2,
    "basis": 0,
    "options": {
        "decimals": 3,
    },
}
response = requests.post(
    "https://api.curatedapi.com/v1/calc/excel/yield",
    headers={"Authorization": f"Bearer {os.environ['CURATEDAPI_KEY']}"},
    json=payload,
    timeout=10,
)
print(response.json()["result"])
The same call in JavaScript
const payload = {
    "settlement": "2008-02-15",
    "maturity": "2016-11-15",
    "rate": "0.0575",
    "pr": "95.04287",
    "redemption": "100",
    "frequency": 2,
    "basis": 0,
    "options": {
        "decimals": 3,
    },
};
const response = await fetch("https://api.curatedapi.com/v1/calc/excel/yield", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.CURATEDAPI_KEY}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify(payload),
});
console.log((await response.json()).result);

MCP tool calc_excel_yield at https://mcp.curatedapi.com. Inputs, outputs and errors in the API reference.

Put it on your website

<div data-curatedapi-widget="excel/yield" data-key="capi_public_…"></div>
<script src="https://widgets.curatedapi.com/v1/widget.js" async></script>

Use a public key registered for your site. Calculations are billed like API calls. How widgets work.

Related calculators

Get Excel's answer in your own code

Moving a spreadsheet model into an app? The API returns what Excel returns for the same inputs, so your users see the same numbers in both.

Free for up to 1,000 calculations a month. 50,000 calculations a month cost $9.00 on the Starter plan.