Top Rates
get_top_ratesFetch ranked SwitchWize rates by category with freshness labels, using editor-approved snapshots for deposit accounts and returning no ranked rates for unapproved, stale, or unavailable releases.
Instructions
Return top SwitchWize rates with freshness and attribution. Savings, CDs, checking and money market answer only from their editor-approved snapshot. A category with no approved release yet returns no ranked rates and says so (approval_status: not_yet_approved) rather than serving unverified observations; approvedOnly makes that requirement explicit. Approved responses include product terms and field evidence; stale or unavailable releases return no ranked rates. detail=full (savings) adds the complete shared build: every listed account marked verified or tracked, best picks, movers, history and a headline summary.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | ||
| detail | No | summary (default) adds list_counts. full (savings) adds the complete shared build: accounts (verified and tracked, each marked), best_picks, movers, history and summary. rates stays verified-only either way. | |
| category | Yes | Rate category, e.g. savings, cds, money-market, checking, mortgage. | |
| approvedOnly | No | Require an editor-approved deposit snapshot. Savings, CDs, checking and money market always answer from their own approved release; a category with no release yet returns no ranked rates (approval_status: not_yet_approved), as do stale or unavailable releases. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | No | ||
| asOf | No | ||
| tool | No | ||
| count | No | ||
| error | No | ||
| rates | No | ||
| terms | No | ||
| source | No | ||
| category | No | ||
| rate_type | No | ||
| dataStatus | No | ||
| attribution | No | ||
| emptyReason | No | ||
| generatedAt | Yes | ||
| schemaVersion | Yes | ||
| sourceDetails | No | ||
| methodologyUrl | No | ||
| freshnessStatus | No | ||
| attributionDetails | No | ||
| supportedCategories | No |