Top Rates
get_top_ratesReturn ranked U.S. deposit rates for savings, CDs, checking and money market from editor-approved snapshots, with freshness labels and terms; categories without approval return no ranked rates.
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 | U.S. deposit category: savings (alias hysa), cds, money-market (alias mma), or checking. | |
| 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 | ||
| releaseId | No | ||
| dataStatus | No | ||
| attribution | No | ||
| emptyReason | No | ||
| generatedAt | Yes | ||
| releaseSize | No | ||
| releaseStatus | No | ||
| schemaVersion | Yes | ||
| sourceDetails | No | ||
| methodologyUrl | No | ||
| freshnessStatus | No | ||
| attributionDetails | No | ||
| supportedCategories | No |