Bank Savings Gap
get_bank_gapEstimate annual savings interest forgone for a supplied balance and optional bank, comparing its APY with tracked savings rates and returning the annual gap.
Instructions
Estimate annual savings interest forgone for a supplied balance and optional bank name. comparisonApy is the average of the top three tracked savings rates, not an average across all banks; bankCount is the size of the tracked set. baselineApy is the named bank's APY, or the national savings benchmark when no bank is supplied. Return annualGap, APYs, observation date, freshness and methodology. This is a hypothetical estimate, not guaranteed savings or an account recommendation; verify eligibility, fees and current provider terms.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| bank | No | Optional bank name for user-facing context. | |
| balance | No |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| asOf | No | ISO timestamp of the underlying data this response reflects. | |
| bank | No | ||
| tool | Yes | ||
| error | No | ||
| balance | No | ||
| bankApy | No | ||
| annualGap | No | ||
| bankCount | No | Number of tracked banks in the comparison set, not the number averaged into comparisonApy. | |
| attribution | No | ||
| baselineApy | No | Named bank APY, or national savings benchmark when no bank is supplied. Percentage units. | |
| generatedAt | Yes | ISO timestamp this response was computed at. | |
| verified_at | No | ||
| comparisonApy | No | Average of the top three tracked savings rates (or all available rates if fewer than three). Not an average across bankCount banks. Percentage units. | |
| schemaVersion | Yes | ||
| methodologyUrl | No | ||
| freshnessStatus | No |