This request pulls a history of rates from the Variable Rate Index configuration within your account.
Click here to learn more about this request
LoanPro's Variable Interest Rate tools allow users to create loan products that adjust dynamically with the market. Users create a rate index, and then the rates can be referenced when creating and updating loan accounts. This request pulls a history of rates, but the results from this request might be long. Filtering results based on date or index type can help pull specific information. Here's a breakdown of how to filter this request:
Filter by date
Results can be filtered by date to trim results or grab rates from a specific timeframe. This type of filter uses a combination of start dates to create a date range.
Use the $filter
query param to filter, and use startDate
to select one or multiple dates:
/VariableRateIndexHistoryGlobals?$filter=startDate ge datetime '2024-01-01' and startDate le '2024-06-01'
Filter by index type
Results can be filtered by the index time to grab rates from one index. Here's a list of index names and the value used within the filter:
Index Name | Filter Value |
---|---|
Federal Funds Rate | EFFR.MONEY |
SOFR Rate | SOFR.MONEY |
U.S. 1 Year Treasury | US1Y.INDX |
U.S. 2 Year Treasury | US2Y.INDX |
U.S. 5 Year Treasury | US5Y.INDX |
U.S. 10 Year Treasury | US10Y.INDX |
U.S. 30 Year Treasury | US30Y.INDX |
U.S. 1 Month Treasury | US1M.INDX |
U.S. 3 Month Treasury | US3M.INDX |
U.S. 6 Month Treasury | US6M.INDX |
Use the $filter
query param to filter, and use ticker
to select an index:
/VariableRateIndexHistoryGlobals?$filter=ticker eq 'US1Y.INDX'
Filter by both
For true filtering sickos, use the above information to filter by both index type and date:
/VariableRateIndexHistoryGlobals?$filter=startDate ge datetime '2024-01-01' and startDate le '2024-06-01' and ticker eq 'US1Y.INDX'
Double-check the role associated with your API token has access to this endpoint.
LoanPro's Role-Based Access Controls (RBAC) allow users to select which endpoints and methods are available for each API token. If this request results in a
401 Unauthorized
response, your token likely does not have access to this endpoint.To view and update the access level for a role and its API tokens, navigate to Settings > Company > Access > Role-Based Access within the UI.
To learn more, view Creating Agent User Role-based Access ↗