Skip to main content

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

NameRequired/OptionalData typeDefaultDescription
arg1RequiredApiRangeApiNamenumber
arg2RequiredApiRangeApiNamenumber
arg3RequiredApiRangeApiNamenumber
arg4RequiredApiRangeApiNamenumber
arg6RequiredApiRangeApiNamenumber

Returns

number

Example

var oWorksheet = Api.GetActiveSheet();
var oFunction = Api.GetWorksheetFunction();
oWorksheet.GetRange("A1").SetValue(oFunction.INTRATE("1/1/2018", "11/12/2018", 1000, 1050, 2));