INTRATE
Returns the interest rate for a fully invested security.
Syntax
expression.INTRATE(arg1, arg2, arg3, arg4, arg6);
expression - A variable that represents a ApiWorksheetFunction class.
Parameters
| Name | Required/Optional | Data type | Default | Description |
|---|---|---|---|---|
| arg1 | Required | ApiRange | ApiName | number | The security settlement date, expressed as a serial date number. | |
| arg2 | Required | ApiRange | ApiName | number | The maturity date of the security, expressed as a serial date number. | |
| arg3 | Required | ApiRange | ApiName | number | The amount invested in the security. | |
| arg4 | Required | ApiRange | ApiName | number | The amount to be received at maturity. | |
| arg6 | Optional | ApiRange | ApiName | number | The day count basis to use: 0 or omitted - US (NASD) 30/360; 1 - Actual/actual; 2 - Actual/360; 3 - Actual/365; 4 - European 30/360. |
Returns
number
Example
This example shows how to return an interest rate for a fully invested security.
- Code
- Result
// How to calculate an interest rate for a fully invested security.
// Use a function to get a fully invested security's interest rate.
let worksheet = Api.GetActiveSheet();
let func = Api.GetWorksheetFunction();
worksheet.GetRange("A1").SetValue(func.INTRATE("1/1/2018", "11/12/2018", 1000, 1050, 2));