# Rate

| **Name**    | ***Rate***                                                                              |
| ----------- | --------------------------------------------------------------------------------------- |
| Syntax      | Rate (Real numPeriods, Real Pmt, Real PV)                                               |
| Purpose     | To return the interest rate per period for an annuity.                                  |
| Description | Returns the interest rate per period for an annuity.                                    |
| Return Type | Double                                                                                  |
| Parameters  | <p>numPeriods \[System.Double]</p><p>Pmt \[System.Double]</p><p>PV \[System.Double]</p> |

![](https://content.gitbook.com/content/zEifS4h8yurLAAwiGNX2/blobs/BzuMJ8LOZ17Y9C06eOvC/0.png)

### **Example**

In this example, we will be passing the required parameters to the function transformation object using a *Variables* object.

Where,

*numPeriods* = 5

*Pmt ­*= 10

*PV* = 3500

![](https://content.gitbook.com/content/zEifS4h8yurLAAwiGNX2/blobs/sZEB2uyOUrcMXjHNeOpA/1.png)

Right-click on the function transformation object and select *Preview Output.* You can see that Astera Data Stack has applied the Rate function, and returned the Interest rate value.

![](https://content.gitbook.com/content/zEifS4h8yurLAAwiGNX2/blobs/SVcfIWkNQsuvE20mywmL/2.png)


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://documentation.astera.com/functions/financial/rate.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.