rate_history
Advertised rate history for one product (institutionId and productId). Returns each recorded rate, comparison rate and fees between two dates, with the date each was recorded. RateSonar's record starts 2026-06-12. Pass grid:true to also get grid, one point per day: status 'observed' on a recorded day; 'carried-forward' with sourceDate and fill {from, through, ageDays, reason:'no-record'} on a day RateSonar has no record for, carrying the last recorded rate (never the next one) until the next record. After the last record it carries only while RateSonar's gap ledger shows the product still expected but unrecorded (not withdrawn), for at most 14 days. A carried-forward value is not an observation.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| to | No | End date YYYY-MM-DD (inclusive). Optional. | |
| from | No | Start date YYYY-MM-DD (inclusive). Optional. | |
| grid | No | Also return `grid`: one labelled point per day (observed or carried-forward), at most 367 days. A wider window returns `gridError` (pass from/to) and keeps `observations`. Default false. | |
| productId | Yes | Product id from find_products or compare_rates, e.g. "f1d6fcc359804f3c9365d576c56356fc" with institutionId "cba" (CBA Standard Variable Rate Home Loan, owner occupied). | |
| institutionId | No | Institution id, e.g. "cba". Pass it with every productId: a product is the pair (institutionId, productId). |