Connection check
verified live · 27h ago
rateapi-mcp
Live US mortgage, auto, HELOC, personal & deposit rates with evidence, plus who can join each lender
Tools
80
GitHub stars
—
Installs / wk
—
Licence
—
Transport
streamable-http
Last checked
27h ago
Tools & capabilities
80 toolsRead from the running server on 27h ago.
add_campaign_recipients
id*recipients*
Add recipients (email + optional name) to a campaign. Up to 50 per request, 200 per campaign. Duplicate addresses are ignored. Add recipients (email + optional name) to a campaign. Up to 50 per request, 200 per campaign. Duplicate addresses are ignored.
analyze_rent_vs_buy
read-only
ratestatepmi_ratehome_price*monthly_hoaterm_months
+12
Compare projected cost of renting vs buying a home over a holding period, anchored to LIVE market mortgage rates. Given home price, down payment, monthly rent, and a holding period… Compare projected cost of renting vs buying a home over a holding period, anchored to LIVE market mortgage rates. Given home price, down payment, monthly rent, and a holding period, returns year-by-year cumulative cost of each path (rent vs PITI), equity built, net cost of owning after sale, and the breakeven year where buying becomes cheaper than renting. If no rate is supplied, the current best market rate for the state is used. Use for 'should I rent or buy?' questions.
assess_buy_timing
read-only
sincestate*loan_amount*term_monthscurrent_rateproduct_type*
+2
Frame a buy/refi-now vs wait recommendation. Combines recent rate movement (direction + magnitude over 1w/2w/4w) with break-even sensitivity on the borrower's loan to return a forw… Frame a buy/refi-now vs wait recommendation. Combines recent rate movement (direction + magnitude over 1w/2w/4w) with break-even sensitivity on the borrower's loan to return a forward 'lock now' vs 'wait' lean, the bps swing that would change the call, and the cost of waiting. Use for 'should I lock now or wait for rates to drop?' questions. Distinct from get_rate_delta (raw historical deltas only) — this adds a forward recommendation. Not a rate forecast.
assess_rate_lock
read-only
sincestate*loan_amount*locked_rate*term_monthsproduct_type*
+4
Lock-window-aware lock-vs-float-down recommendation for a deal already in the pipeline. Given a known lock-expiration date, the currently locked rate, and the float-down cost, retu… Lock-window-aware lock-vs-float-down recommendation for a deal already in the pipeline. Given a known lock-expiration date, the currently locked rate, and the float-down cost, returns a defensible hold-lock vs exercise-float-down call a loan officer can document — combining recent market movement (1w/2w/4w) with payment and break-even math on this loan. Builds on the same recent-movement signal as assess_buy_timing but framed around the lock window/expiration. Not a rate forecast.
batch_decisions
read-only
statescenarios*credit_scoremax_providers
Score an array of inline financing scenarios in one stateless call; returns ranked decisions and top offers per item — no persisted cohorts, no per-borrower HTTP loops. Score an array of inline financing scenarios in one stateless call; returns ranked decisions and top offers per item — no persisted cohorts, no per-borrower HTTP loops.
build_amortization_schedule
read-only
ratestateloan_amount*term_months*credit_scoreproduct_type
+3
Build a year-by-year amortization / payoff schedule for a loan: total lifetime interest, principal/interest split per period, and a what-if extra-payment accelerator showing months… Build a year-by-year amortization / payoff schedule for a loan: total lifetime interest, principal/interest split per period, and a what-if extra-payment accelerator showing months saved and interest saved. Resolves the market rate from real credit-union offers when no rate is provided.
check_advice_guardrails
read-only
scenario*recommendation
Run compliance/suitability guardrails over a financing scenario and an optional recommendation. Returns flags (red/yellow with code + message) for things like DTI strain, long auto… Run compliance/suitability guardrails over a financing scenario and an optional recommendation. Returns flags (red/yellow with code + message) for things like DTI strain, long auto terms with negative-equity risk, possible balloon payments, and stale market data, plus generic disclaimers and an overall verdict (ok/caution/stop). Use this before presenting a rate recommendation to a borrower.
check_competitive_position
read-only
aprrate*state*product*
LENDER-side 'is my offer competitive' check — input your OWN published rate for a state+product, get the market percentile, bps vs the state median, and a leading/competitive/overp… LENDER-side 'is my offer competitive' check — input your OWN published rate for a state+product, get the market percentile, bps vs the state median, and a leading/competitive/overpriced verdict. This is for a loan officer or credit union benchmarking their published pricing against the live market distribution. Do NOT use this for a consumer's quote: if the user is a BORROWER asking whether a rate they were offered is fair, use rate_sanity_check instead.
check_membership_eligibility
read-only
zipstatecountyschoolworshipemployer
+23
Check whether a user can JOIN specific credit unions (field-of-membership eligibility). Batch-friendly: pass 1-50 credit_union_ids (from get_financing_decision offers, list_credit_… Check whether a user can JOIN specific credit unions (field-of-membership eligibility). Batch-friendly: pass 1-50 credit_union_ids (from get_financing_decision offers, list_credit_unions, or get_credit_union) plus whatever is known about the user (home, worksite, and payroll geography are independent facts; employer, occupation, military_status, school plus school_relationship, and worship are also supported). Returns one row for every requested credit union. Positive outcomes include open_to_anyone, likely_eligible, eligible_via_employer, and eligible_via_military. A school name alone is not a positive signal: school_relationship is required to affirm a typed student, alumni, or school-employee path. Only a graph carrying exact active-publication lineage governs the top compatibility verdict; a publication-less shadow graph remains diagnostic and cannot replace the flat result. A non-match is returned as unknown, with `unknown_reason: fom_completeness_unaffirmed` when the published field-of-membership corpus is not attested complete. The legacy `geo_mismatch` enum value is reserved for wire compatibility and is not emitted by this MCP boundary without a future typed closed-world attestation. Verdicts are guidance based on each credit union's published membership criteria; the final membership determination is always the institution's. Non-matches carry `missing_facts` for the named institutions: the exact question to ask next, the `fact_field` an answer populates, and the institution's own words. A check that returns unknown for all of them and a question for each is a SUCCESSFUL call, not a failure — ask the questions, merge the answers into the same request, and call again. Fact fields, in full — supply every one you know: this tool names the person's home geography `zip`, `state`, `county` (find_eligible_credit_unions calls the same three `home_zip`, `home_state`, `home_county`); `work_zip`, `work_state`, `work_county`; `payroll_zip`, `payroll_state`, `payroll_county` (payroll can differ from the worksite and is a separate door); `property_zip`, `property_state`, `property_county` (where they OWN property — never inferred from where they live, and an absentee owner qualifies); `facility_zip`, `facility_state`, `facility_county` (where their business maintains a location); `occupation`; `employer`; `school` plus `school_relationship` (student/alumni/employee — a school name without a relationship affirms nothing); `military_status` plus `military_service_state` (state National Guard doors need the state); `worship`; `family_relation` plus `relative_employers`, `relative_schools`, `relative_associations` (a great many people qualify only through a relative — ask); `applicant_kind` (person/trust/organization/partnership/corporation — some charters admit entities, and a person is never rejected by an entity-only door, only left unknown); and `asserted_org_qualifiers` (narrowings the person asserts about themselves, e.g. "assigned as a recruiter in Arkansas").
compare_products
read-only
state*amount*intentterm_monthscredit_scoreproduct_types*
Compare the best real rates across MULTIPLE lending products in a single call — e.g. show a buyer mortgage vs HELOC, or new vs used auto. Runs the decision engine for each product… Compare the best real rates across MULTIPLE lending products in a single call — e.g. show a buyer mortgage vs HELOC, or new vs used auto. Runs the decision engine for each product and returns a ranked, true-cost (APR + fees) table. Use this instead of calling get_financing_decision repeatedly. Each product returns its top offer with rate, APR, and monthly payment.
compare_total_cost
read-only
feesstate*amount*intentmax_lendersterm_months
+4
Apples-to-apples multi-lender ranking by TOTAL cost of a loan (upfront origination/lender fees + lifetime interest over the holding period), not just the headline rate. Re-ranks re… Apples-to-apples multi-lender ranking by TOTAL cost of a loan (upfront origination/lender fees + lifetime interest over the holding period), not just the headline rate. Re-ranks real credit union offers and flags when the lowest-rate lender is not the cheapest overall.
create_competitor_monitor
name*stateaudienceoccupancyconditionswebhook_url*
+4
Subscribe a monitor to a SPECIFIC named credit union's published rate and alert via webhook when that CU changes its rate (vs the aggregate market-best decision). Returns the monit… Subscribe a monitor to a SPECIFIC named credit union's published rate and alert via webhook when that CU changes its rate (vs the aggregate market-best decision). Returns the monitor with a webhook_signing_secret (shown once) and a baseline snapshot of the CU's current rate.
create_email_campaign
name*regioncadenceproductsstate_codestate_codes
+1
Create a branded rate-email campaign: on a cadence, email the campaign's recipient list the latest rates for one or more states (or a named region preset) under the org's branding,… Create a branded rate-email campaign: on a cadence, email the campaign's recipient list the latest rates for one or more states (or a named region preset) under the org's branding, with ONE OR MORE products (1-5, no duplicates). Each product is one of: {category:'mortgage', subtype:'30-year-fixed'|'15-year-fixed'}, {category:'auto', condition:'new'|'used'|'any', term_months?:36|48|60|72|84} (auto = cars only), or {category:'rv'|'boat'|'motorcycle', condition:'new'|'used'|'any'}. Defaults to a single 30-year-fixed mortgage if products is omitted. Created 'paused'; add recipients, then activate via update_email_campaign (activation requires branding display_name + business_address). Requires a Pro plan. Provide exactly one of state_code, state_codes, or region.
create_monitor
name*conditions*webhook_url*cooldown_hoursdecision_context*subscribed_states
+1
Create a new decision monitor that watches for rate changes and sends webhook notifications when conditions are met. Returns the monitor with a webhook_signing_secret for verifying… Create a new decision monitor that watches for rate changes and sends webhook notifications when conditions are met. Returns the monitor with a webhook_signing_secret for verifying webhook payloads.
delete_cohort
can modify data
id*
Permanently delete a saved cohort by id. This action cannot be undone. Permanently delete a saved cohort by id. This action cannot be undone.
delete_digest
can modify data
id*
Delete a scheduled digest by id. Stops the recurring email. Delete a scheduled digest by id. Stops the recurring email.
delete_email_campaign
can modify data
id*
Delete a branded rate-email campaign and its recipients. This cannot be undone. Delete a branded rate-email campaign and its recipients. This cannot be undone.
delete_monitor
can modify data
monitor_id*
Permanently delete a monitor. This action cannot be undone. Permanently delete a monitor. This action cannot be undone.
delete_scenario
can modify data
id*
Delete a saved scenario by id. Delete a saved scenario by id.
deliver_test_webhook
monitor_id*rate_change*
Send a test webhook for a monitor using a simulated rate change. This actually delivers an HTTP request to the monitor's configured webhook URL. IMPORTANT: a test delivery is NOT s… Send a test webhook for a monitor using a simulated rate change. This actually delivers an HTTP request to the monitor's configured webhook URL. IMPORTANT: a test delivery is NOT signed with the monitor's signing secret — only a hash of that secret is stored, so test deliveries use a placeholder and will FAIL signature verification. Use this to test payload handling, not signature verification. Only use when the user explicitly requests a test webhook delivery.
estimate_affordability
read-only
ratestateterm_monthsback_end_dtidown_paymentproduct_type
+3
Borrower-facing home affordability estimate: given gross income, existing monthly debts, down payment, and front-end/back-end DTI caps, compute the max monthly payment, max loan am… Borrower-facing home affordability estimate: given gross income, existing monthly debts, down payment, and front-end/back-end DTI caps, compute the max monthly payment, max loan amount, and max home price. Surfaces the max_loan annuity engine. If no rate is supplied, the current best market rate for the state is used.
estimate_monthly_cost
read-only
ratestatepmi_ratehome_priceloan_amountmonthly_hoa
+5
Total monthly housing cost (PITI): principal+interest plus property tax, homeowners insurance, PMI, and HOA, so affordability reflects real monthly outlay. If no rate is supplied,… Total monthly housing cost (PITI): principal+interest plus property tax, homeowners insurance, PMI, and HOA, so affordability reflects real monthly outlay. If no rate is supplied, the current best market rate for the state is used.
explain_ranking
read-only
state*amount*intent*term_monthscredit_scoreproduct_type
+1
Explain WHY each top lender ranked where it did for a financing decision. Takes a full decision scenario (same shape as get_financing_decision) and returns a structured per-offer c… Explain WHY each top lender ranked where it did for a financing decision. Takes a full decision scenario (same shape as get_financing_decision) and returns a structured per-offer cost breakdown (rate, points, fees, lifetime interest), scoring signals, how much each offer beats the next by, and a plain-language summary of the ranking weights. Use this when a user asks why one lender beat another.
extract_eligibility_facts
read-only
text*known_facts
Turn a person's own words about themselves into the structured facts the eligibility tools accept. Pass their sentence verbatim ("I'm a nurse at a Tulsa hospital, I live in Broken… Turn a person's own words about themselves into the structured facts the eligibility tools accept. Pass their sentence verbatim ("I'm a nurse at a Tulsa hospital, I live in Broken Arrow, my late father was a TTCU member") and this returns each fact it could read, with the exact words it read it from, a confidence, and a needs_confirmation flag. THIS DOES NOT DECIDE ELIGIBILITY and never returns a credit union: it only fills in fields. Show the extracted facts to the user and get confirmation on every fact with needs_confirmation=true (family relationships, relatives' employers and associations, applicant kind, and asserted qualifiers are always flagged, because a wrong reading of those changes the answer). Then pass `person_search_body` — plus whatever the user confirmed — to find_eligible_credit_unions, which is what actually decides. If extraction is unavailable you get facts: [] and no eligibility signal at all; ask the user for fields directly instead. `confidence` is the extraction model's own uncalibrated self-report and gates only autofill — quote `evidence.quote` to the user, not the number. This call costs 3 API units.
find_credit_unions_near_zip
read-only
zip*max_results
Use when someone asks for "credit unions near me," the closest credit union, local credit-union branches, or nearby alternatives to a bank. Given a 5-digit ZIP, returns credit unio… Use when someone asks for "credit unions near me," the closest credit union, local credit-union branches, or nearby alternatives to a bank. Given a 5-digit ZIP, returns credit unions ordered by the estimated straight-line distance to each institution's closest NCUA-reported branch. Includes approximate miles, branch address, and profile identifiers for checking rates, services, and membership. Distances use ZIP centers and are not driving distance.
find_eligible_credit_unions
read-only
limitschoolworshipemployerhome_zipwork_zip
+25
Discovery tool: find candidate credit unions a person may be able to JOIN, from their own facts rather than from a list of institutions. Pass any combination of home, worksite, or… Discovery tool: find candidate credit unions a person may be able to JOIN, from their own facts rather than from a list of institutions. Pass any combination of home, worksite, or payroll geography (these are independent), occupation, employer, school (+school_relationship), associations, military_status, and worship; at least one discriminating fact is required, or pass willing_to_join_association=true as the sole discriminator to search documented joinable-association paths. This evaluates a bounded, prioritized candidate set, not the entire credit-union fleet: read `candidate_limit`, `candidate_set_truncated`, and `candidate_sources`, and never interpret an absent institution as unavailable or ineligible. Returns four buckets within that candidate set — eligible (a verified path already applies), conditionally_eligible (one more step, e.g. joining an association, with the cost and join URL when known), possibly_eligible (a path may apply but a requirement could not be confirmed), and unknown (we could not decide — either we hold no rules for the institution or the supplied facts cannot decide the rules we hold). Every non-positive entry carries a machine-readable `unknown_reason`: `geo_inputs_missing` / `org_inputs_missing` / `inputs_missing` mean ONE MORE FACT FROM THE USER would resolve it, so ask for it and call again; `no_rules` means we hold nothing for that institution and asking will not help; `incomplete_fom`, `fom_completeness_unaffirmed`, `low_confidence_rules` and `unmodeled_condition` mean we hold rules but will not turn a failure against them into a no. Each entry also carries `coverage` — {state, rules_held, last_confirmed_at, fom_affirmed} — describing what we HOLD about the institution as opposed to what we concluded about the person. Each entry carries the credit union id, name, state, confidence, and deterministic reasons. Use this to find supported candidates; use check_membership_eligibility when you already have specific credit_union_ids. Credit unions are never listed as ineligible — absence of evidence is never treated as evidence of absence, and the final membership determination is always the institution's. Every non-positive entry now also carries `missing_facts`: the exact question to ask the person next, the `fact_field` their answer populates, why it matters, and the institution's own words. The response's top-level `next_questions` ranks those questions across all institutions by how many they unlock — ASK THE TOP ONE TO THREE, MERGE THE ANSWERS INTO THE SAME REQUEST BODY, AND CALL AGAIN. Two or three turns is the intended shape of this tool; a single call is a first draft. Stop when `next_questions` is empty, when the top entry's `unlocks_cu_count` is below 2, or after three turns. `unanswerable` lists what no question can fix — institutions we hold no rules for, boundaries we can state but not decide (census tracts, school districts, a radius around an office the page never identifies), and rule sets whose completeness nobody affirmed; do not ask the user about those. Fact fields, in full — supply every one you know: `home_zip`, `home_state`, `home_county`; `work_zip`, `work_state`, `work_county`; `payroll_zip`, `payroll_state`, `payroll_county` (payroll can differ from the worksite and is a separate door); `property_zip`, `property_state`, `property_county` (where they OWN property — never inferred from where they live, and an absentee owner qualifies); `facility_zip`, `facility_state`, `facility_county` (where their business maintains a location); `occupation`; `employer`; `school` plus `school_relationship` (student/alumni/employee — a school name without a relationship affirms nothing); `associations`; `military_status` plus `military_service_state` (state National Guard doors need the state); `worship`; `family_relation` plus `relative_employers`, `relative_schools`, `relative_associations` (a great many people qualify only through a relative — ask); `willing_to_join_association`; `applicant_kind` (person/trust/organization/partnership/corporation — some charters admit entities, and a person is never rejected by an entity-only door, only left unknown); and `asserted_org_qualifiers` (narrowings the person asserts about themselves, e.g. "assigned as a recruiter in Arkansas").
find_product_rates_near_zip
read-only
zip*max_offersterm_monthsproduct_type*vehicle_condition
Use when someone asks for the best mortgage, auto-loan, HELOC, personal-loan, student-loan, equipment-loan, or credit-card rates near them and provides a ZIP. Finds the nearest NCU… Use when someone asks for the best mortgage, auto-loan, HELOC, personal-loan, student-loan, equipment-loan, or credit-card rates near them and provides a ZIP. Finds the nearest NCUA-reported branch set, keeps credit unions with a current product-matched published rate, and ranks those offers by lowest APR with approximate distance as a tie-breaker. HELOC matching excludes closed-end home-equity loans. This is a local shopping shortlist: distance is straight-line, membership is not guaranteed, and published APR is not personalized approval.
generate_client_report
read-only
resultclient_namescenario_idadvisor_name
Produce a clean, client-facing markdown rate comparison report a loan officer can share with a buyer. Pass either a saved scenario_id, or an inline client_name + comparison result… Produce a clean, client-facing markdown rate comparison report a loan officer can share with a buyer. Pass either a saved scenario_id, or an inline client_name + comparison result (from get_financing_decision/compare_products).
generate_share_link
scenario_id*
Turn a saved client scenario into a public, branded, shareable URL (https://app.rateapi.dev/r/TOKEN) that anyone can view without logging in. Returns a token and url. The link show… Turn a saved client scenario into a public, branded, shareable URL (https://app.rateapi.dev/r/TOKEN) that anyone can view without logging in. Returns a token and url. The link shows the client name, scenario inputs, and the ranked comparison with a "Powered by RateAPI" footer. Use revoke_share to disable a link later.
get_benchmarks
read-only
stateproduct_type
Get rate benchmark statistics (min/median/max APR) across all institutions. Use this for market analysis, comparing user quotes against market rates, or building benchmark dashboar… Get rate benchmark statistics (min/median/max APR) across all institutions. Use this for market analysis, comparing user quotes against market rates, or building benchmark dashboards. Returns statistics for mortgages (30yr fixed, 15yr fixed, and `mortgage_arm` — one bucket covering every adjustable-rate mortgage regardless of initial fixed period), auto loans (new/used — cars only), RV/boat/motorcycle/powersports (first-class vehicle categories), HELOCs, and personal loans. Each product shows the lowest APR institution, median APR, and count of institutions.
get_cohort
read-only
id*
Get a single saved cohort by id, including all members and the last scan snapshot (triage list). Get a single saved cohort by id, including all members and the last scan snapshot (triage list).
get_coverage
read-only
stategroup_byfreshness_daysproduct_category
Introspect what mortgage/loan data the API covers BEFORE scanning — which states, lenders, and product types are present, row counts per segment, and last-updated freshness per seg… Introspect what mortgage/loan data the API covers BEFORE scanning — which states, lenders, and product types are present, row counts per segment, and last-updated freshness per segment. Returns a coverage matrix so an agent can pick a scannable state/product before calling scan_savings or get_financing_decision. Mirrors the /meta global counts, expanded into a per-segment matrix. Boats, RVs, motorcycles, and powersports are first-class product categories; auto means cars.
get_credit_union
read-only
slug*state*
Reference tool: Get a credit union's rates, membership eligibility, and source-labelled NCUA quarterly profile: members, assets, year opened, charter, reported services, and branch… Reference tool: Get a credit union's rates, membership eligibility, and source-labelled NCUA quarterly profile: members, assets, year opened, charter, reported services, and branch locations. Eligibility annotates published criteria and never asserts that an individual is ineligible; profile facts are regulatory snapshots, not live prices. Use this when a user asks about a specific credit union. For personalized rate recommendations, use get_financing_decision instead.
get_deposit_benchmarks
read-only
limitstatemetricproductterm_months
Best/median/spread credit-union deposit APY by product, term, and state, with per-CU peer ranking. Pass the MCP field `product` using one exact underscore value: savings, cd, share… Best/median/spread credit-union deposit APY by product, term, and state, with per-CU peer ranking. Pass the MCP field `product` using one exact underscore value: savings, cd, share_certificate, money_market, ira_cd, ira, or share_savings. The MCP server translates it to REST `product_category`; do not send `product_category`, `mma`, or `money-market` to this tool. Deposits quote APY (no APR); CDs/share certificates include term. Current + recent data; history is retention-bounded.
get_deposit_beta
read-only
statewindowproduct*group_bybenchmarkterm_months
Deposit beta (repricing sensitivity) = change in deposit APY per 100bps change in a benchmark/market rate — the core credit-union/bank ALM & interest-rate-risk (IRR) model input. P… Deposit beta (repricing sensitivity) = change in deposit APY per 100bps change in a benchmark/market rate — the core credit-union/bank ALM & interest-rate-risk (IRR) model input. Pass the MCP field `product` using an exact underscore value such as `money_market`; do not send `product_category`, `mma`, or `money-market`. Derived from RateAPI's retained published deposit-rate history. SHORT-WINDOW / retention-bounded: full-cycle beta needs multi-year history (roadmap) — results ship with an explicit confidence/depth caveat. Deposits quote APY, never APR. Aggregate published rates only — never member/borrower data.
get_doc
read-only
urlslug
DOCS: return the full text of one RateAPI documentation page by slug (from search_docs) or by its published URL. Documentation only — it describes the contract, not live rates. Ava… DOCS: return the full text of one RateAPI documentation page by slug (from search_docs) or by its published URL. Documentation only — it describes the contract, not live rates. Available slugs: quickstart, authentication, rate-limits-and-pricing, coverage, freshness, evidence-and-methodology, quoting-rules, eligibility, endpoints, mcp-server, products-and-parameters, errors-and-troubleshooting, deprecation-policy.
get_eligibility_coverage
read-only
Fleet-wide membership-eligibility coverage: how many US credit unions RateAPI holds live, verbatim-evidenced membership rules for (and what share of the active fleet that is), how… Fleet-wide membership-eligibility coverage: how many US credit unions RateAPI holds live, verbatim-evidenced membership rules for (and what share of the active fleet that is), how the rules split by kind, how many counties, states and employers they name, verification status, and freshness. The `authority` object distinguishes exact immutable active publications from older graph and flat compatibility records; `evidence_sources` reports the public source mix. Returns a dated `headline` sentence that can be quoted verbatim. Use this BEFORE find_eligible_credit_unions or check_membership_eligibility when the user asks how complete, authoritative, or fresh the eligibility data is. Aggregate only — no institution-level rows; those come from the eligibility tools. No API key required. Never reports credit data: the rule schema has no condition kind for credit score, income or debt. An institution absent from the graph is undecided, never ineligible.
get_email_branding
read-only
Get the organization's current email branding (display name, logo URL, brand color, intro, business address, reply-to). Get the organization's current email branding (display name, logo URL, brand color, intro, business address, reply-to).
get_extraction_stats
read-only
endTimestartTimeproduct_type
Get data extraction statistics showing the scale and health of rate data collection. Use this to understand extraction volumes, product coverage, and data freshness. Supports filte… Get data extraction statistics showing the scale and health of rate data collection. Use this to understand extraction volumes, product coverage, and data freshness. Supports filtering by date range and product type. Great for building transparency dashboards or monitoring data collection health.
get_financing_decision
read-only
zipstate*amount*countyintent*school
+17
RECOMMENDED WHEN SHOPPING: Get personalized financing recommendations for ANY loan or credit product across every major type: mortgages (30yr/15yr/20yr/10yr fixed and ARMs), auto l… RECOMMENDED WHEN SHOPPING: Get personalized financing recommendations for ANY loan or credit product across every major type: mortgages (30yr/15yr/20yr/10yr fixed and ARMs), auto loans (new/used/CPO, 36-84 month terms), RV/boat/motorcycle/powersports loans, HELOCs (fixed/variable), personal loans (secured/unsecured), student loans, equipment loans, and credit cards (rewards, cash_back, secured, balance_transfer, low_rate, business, platinum, student). Analyzes current market offers and returns actionable recommendations with explanations. Use this instead of looking up raw rates when the user is asking "what rate can I get?" and does NOT yet have an offer. IMPORTANT: if the user ALREADY has a quoted rate and is asking whether it is good/fair/competitive ("I was quoted 6.9%, is that any good?"), call rate_sanity_check instead — it returns a percentile verdict on their specific number, which is what that question is actually asking. Provide the user's state, intent (purchase/refinance/cash_out/balance_transfer/new_credit), and amount for personalized advice.
get_league_table
read-only
limitstate*metricproduct*include_institution_context
Loan-officer competitive-landscape report: ranked roster of the top N lenders publishing a given mortgage product in a state today — per-lender rows (name, best APR/rate, product,… Loan-officer competitive-landscape report: ranked roster of the top N lenders publishing a given mortgage product in a state today — per-lender rows (name, best APR/rate, product, position, bps above the leader) — plus the market min/median/max. The market median is INSTITUTION-level — one vote per lender, using each lender's best APR (basis = total_lenders, not market.count) — so a lender publishing a large rate matrix cannot pull it. Extends get_benchmarks (which returns only min/median/max + the single lowest institution) with the full ranked table.
get_monitor
read-only
monitor_id*
Get detailed information about a specific monitor by its ID. Get detailed information about a specific monitor by its ID.
get_monitor_stats
read-only
Get rollup stats for the account's rate monitors: total, active, and webhooks sent. Complements list_monitors. Get rollup stats for the account's rate monitors: total, active, and webhooks sent. Complements list_monitors.
get_rate_delta
read-only
sincestate*product_type*
Compare the LIVE market rate distribution now vs ~1/2/4 weeks ago for a product and state. Returns now/then min, median, max, count plus the median and min delta and a direction (d… Compare the LIVE market rate distribution now vs ~1/2/4 weeks ago for a product and state. Returns now/then min, median, max, count plus the median and min delta and a direction (down/up/flat). Bounded by data retention — if no comparable historical snapshot exists, then is null with an explanatory note. Use this to show how rates have moved recently.
get_rate_history
read-only
state*windowintervalproduct_type*vehicle_condition
Historical rate time-series: a date-ranged array of {date, min/median/max APR, count} points per product/state for dashboards, charts, backtests, and timing confidence — bounded by… Historical rate time-series: a date-ranged array of {date, min/median/max APR, count} points per product/state for dashboards, charts, backtests, and timing confidence — bounded by data retention. Differs from get_rate_delta (a single now-vs-then comparison): this returns the full series. Boats, RVs, motorcycles, and powersports are first-class product types; auto_loan means cars. Calls the /v1/rate-history public API (single source of truth).
get_scenario
read-only
id*
Get a single saved scenario by id (inputs + stored comparison). Get a single saved scenario by id (inputs + stored comparison).
get_usage
read-only
Check the calling account's API usage and remaining quota for this month (tier, used, remaining, limit, reset date). Use BEFORE running many calls to avoid hitting rate limits. Check the calling account's API usage and remaining quota for this month (tier, used, remaining, limit, reset date). Use BEFORE running many calls to avoid hitting rate limits.
list_cohorts
read-only
List saved cohorts for the account (newest first). Returns id, name, member count, and last scan time. Keeps the payload small — use get_cohort for full member detail. List saved cohorts for the account (newest first). Returns id, name, member count, and last scan time. Keeps the payload small — use get_cohort for full member detail.
list_credit_unions
read-only
zipstate
Reference tool: Discover credit unions by state or nearest to a 5-digit ZIP. State listings include rate availability, member count, and reported location count. ZIP discovery rank… Reference tool: Discover credit unions by state or nearest to a 5-digit ZIP. State listings include rate availability, member count, and reported location count. ZIP discovery ranks NCUA-reported branches by estimated straight-line miles from the ZIP center. For personalized rate recommendations, use get_financing_decision instead.
list_decision_logs
read-only
limitoffsetrequest_id
Recall past financing decisions made on this account (audit log). Filter by request_id to look up a specific prior decision, or paginate with limit/offset. Recall past financing decisions made on this account (audit log). Filter by request_id to look up a specific prior decision, or paginate with limit/offset.
list_digests
read-only
List the account's scheduled digests (cohort, email, cadence, enabled, last run). List the account's scheduled digests (cohort, email, cadence, enabled, last run).
list_email_campaigns
read-only
List the organization's branded rate-email campaigns (name, criteria, cadence, status, last run). List the organization's branded rate-email campaigns (name, criteria, cadence, status, last run).
list_monitors
read-only
limitoffsetstatus
List all monitors associated with your API key. Supports pagination and filtering by status. List all monitors associated with your API key. Supports pagination and filtering by status.
list_rate_alerts
read-only
email*
List the rate alerts subscribed for a given email (status, product, state, intent, target, last notified). List the rate alerts subscribed for a given email (status, product, state, intent, target, last notified).
list_rates
read-only
sortlimitstatelenderoffsetmax_apr
+5
List and filter raw rate rows (the core data primitive) by product, state, lender, and term with limit/offset pagination. Boats, RVs, motorcycles, and powersports are first-class p… List and filter raw rate rows (the core data primitive) by product, state, lender, and term with limit/offset pagination. Boats, RVs, motorcycles, and powersports are first-class product types; auto_loan means cars.
list_scenarios
read-only
List saved client scenarios for the account, newest first. List saved client scenarios for the account, newest first.
list_shares
read-only
List all hosted shareable report links for the account, newest first. Returns token, scenario_id, client_name, views, last_viewed_at, revoked, created_at, and url for each share. U… List all hosted shareable report links for the account, newest first. Returns token, scenario_id, client_name, views, last_viewed_at, revoked, created_at, and url for each share. Use this to see view analytics and manage which links are still live.
list_webhook_deliveries
limitoffsetstatusmonitor_idredeliver_id
Org-scoped webhook delivery observability for the authenticated API key. Lists the per-event webhook delivery log for your monitors — each row shows status (delivered/failed/pendin… Org-scoped webhook delivery observability for the authenticated API key. Lists the per-event webhook delivery log for your monitors — each row shows status (delivered/failed/pending), HTTP response code, error, response time, the destination URL, and timestamp — with a roll-up summary (total/delivered/failed/pending). Use this to surface SILENT webhook failures (a delivery that never reached your endpoint). Filter by monitor_id and/or status. To replay a failed (or any) delivery, set redeliver_id to that row's id; the original payload is re-sent verbatim and the replay is itself audited. Distinct from deliver_test_webhook, which sends a brand-new simulated event.
max_loan
read-only
dti*ratestateterm_months*product_typeincome_annual*
+1
Estimate the largest loan a borrower can afford from income and a target debt-to-income (DTI) ratio. Returns max monthly payment, max loan amount, and the rate used. If no rate is… Estimate the largest loan a borrower can afford from income and a target debt-to-income (DTI) ratio. Returns max monthly payment, max loan amount, and the rate used. If no rate is supplied, the current best market rate for the product/state is used.
optimize_buydown
read-only
stateoptions*base_rate*hold_monthsloan_amount*term_months*
Given a discount-points / lender-credit tradeoff menu for a candidate loan, returns break-even months, lifetime savings, and the optimal point-spend. The points analog of refinance… Given a discount-points / lender-credit tradeoff menu for a candidate loan, returns break-even months, lifetime savings, and the optimal point-spend. The points analog of refinance_break_even.
project_pmi_removal
read-only
ratestatepmi_ratehome_priceloan_amountterm_months
+3
For low-down-payment borrowers (LTV > 80%): projects when private mortgage insurance (PMI) drops off, the total PMI paid until then, and how much extra monthly principal cancels PM… For low-down-payment borrowers (LTV > 80%): projects when private mortgage insurance (PMI) drops off, the total PMI paid until then, and how much extra monthly principal cancels PMI sooner. Reuses the same amortization + PMI logic as estimate_monthly_cost. If no rate is supplied, the current best market rate for the state is used. Use for 'when does my PMI go away / how do I get rid of PMI faster?' questions.
rate_sanity_check
read-only
aprzipfeesrate*state*amount
+6
RECOMMENDED WHEN THE USER ALREADY HAS A QUOTE: answers "is this rate any good?" for a specific number a borrower was offered. Use this whenever someone says they were quoted / offe… RECOMMENDED WHEN THE USER ALREADY HAS A QUOTE: answers "is this rate any good?" for a specific number a borrower was offered. Use this whenever someone says they were quoted / offered / approved at a rate and wants to know if it is fair, good, competitive, high, or a rip-off — e.g. "I got offered 6.9% on a 30-year in Ohio, is that fair?", "my dealer quoted 8.4% on a used car loan", "is 7.1% high for a HELOC in TX?". Given a product_type, state, and rate (and optional apr/fees/amount/term_months), returns the percentile of the quote within the live market distribution, a verdict (market_leading, plausible, suspicious_low, overpriced), whether it falls below the known product rate floor, and the market min/median/max with an as_of date. Prefer this over get_financing_decision for quote-in-hand questions: the user wants a verdict on THEIR number, not a list of other offers. Set include_better_offers=true to get named statewide lenders beating the quote. When the user provides a ZIP, set include_nearby_offers=true to pair product-matched rates with the closest credit unions by NCUA-reported branch location; distances are straight-line ZIP-center estimates, never driving distance. Every response also returns `share_url` — a link to this same check on rateapi.dev that the borrower can send to their lender or broker. Surface it whenever the user might act on the result; it re-runs against live rates when opened, so it never goes stale. NOTE: this is the BORROWER-side tool; check_competitive_position is the lender-side equivalent for benchmarking a lender's own published pricing. If the quote is an ADJUSTABLE-rate mortgage (the user says ARM / adjustable / "5/1" / "5/5" / "7/1"), pass product_type=mortgage_arm rather than mortgage — ARMs are scored against their own market. Caveat to surface to the user: the comparison does not currently segment by credit score, LTV, or points, and quoted fees are not folded into the APR comparison.
refinance_break_even
read-only
state*balance*term_months*credit_scorecurrent_rate*product_type*
+1
Tell a borrower whether refinancing is worth it. Compares their current rate against the best real market offer and returns monthly savings, lifetime savings, and break-even months… Tell a borrower whether refinancing is worth it. Compares their current rate against the best real market offer and returns monthly savings, lifetime savings, and break-even months. Use for 'should I refinance?' questions.
remove_campaign_recipient
can modify data
id*recipient_id*
Remove one recipient from a campaign by recipient id. Remove one recipient from a campaign by recipient id.
revoke_share
can modify data
token*
Revoke a hosted shareable report link by its token. Once revoked, the public URL returns a 404 and no longer exposes the report. This action cannot be undone. Revoke a hosted shareable report link by its token. Once revoked, the public URL returns a 404 and no longer exposes the report. This action cannot be undone.
save_cohort
name*members*
Save a named cohort ("book of business") — a list of borrower scenarios you want to track and re-scan over time. Each member has a label and a scenario (product_type, state, intent… Save a named cohort ("book of business") — a list of borrower scenarios you want to track and re-scan over time. Each member has a label and a scenario (product_type, state, intent, amount, term_months, optional credit_score and current_offer). Returns the created cohort. Use scan_portfolio later to re-price every member against the live market.
save_scenario
input*client_name*result_snapshot*
Save a rate comparison for a named client so it can be recalled later (a lightweight CRM for loan officers). Pass the client label and the inputs/results you want to keep. Save a rate comparison for a named client so it can be recalled later (a lightweight CRM for loan officers). Pass the client label and the inputs/results you want to keep.
scan_portfolio
id*
Re-scan every member of a saved cohort against the live decision engine to find each member's current best offer. Returns a triage list (label, best lender, best APR, monthly payme… Re-scan every member of a saved cohort against the live decision engine to find each member's current best offer. Returns a triage list (label, best lender, best APR, monthly payment, optional savings vs current) and a diff vs the previous scan (who's new, whose best lender changed, APR deltas). Persists the new snapshot. Use this to refresh a book of business and surface what changed.
scan_savings
read-only
debts*state*credit_score
Scan a list of existing debts and find, for EACH debt, the best qualifying market refinance offer. Returns a ranked "savings stack" with monthly and lifetime savings (net of typica… Scan a list of existing debts and find, for EACH debt, the best qualifying market refinance offer. Returns a ranked "savings stack" with monthly and lifetime savings (net of typical closing costs) per debt plus whether refinancing is worth it, and overall totals. Use this to find refinance opportunities across a borrower's whole debt portfolio.
schedule_digest
email*cadencecohort_id*
Set up a recurring digest: on a cadence (default weekly), automatically re-scan a saved cohort and EMAIL the loan officer a triage of which clients have a new opportunity (best len… Set up a recurring digest: on a cadence (default weekly), automatically re-scan a saved cohort and EMAIL the loan officer a triage of which clients have a new opportunity (best lender changed, crossed a threshold). Turns a one-time portfolio scan into a standing operation. Requires a cohort_id (from save_cohort/list_cohorts) and a delivery email.
search_docs
read-only
limitquery*
DOCS: search the RateAPI documentation (authentication, rate limits and pricing, coverage, freshness, methodology, eligibility, endpoint map, product parameters, errors, the MCP se… DOCS: search the RateAPI documentation (authentication, rate limits and pricing, coverage, freshness, methodology, eligibility, endpoint map, product parameters, errors, the MCP server itself, and the rules for quoting the data). Use this whenever the question is about the API rather than about a rate — "how do I authenticate?", "what does rate_phase mean?", "which endpoint gives deposit APYs?", "how fresh is this?", "what does it cost?" — instead of guessing at parameters or inventing endpoints. Returns ranked pages with an excerpt; call get_doc for the full text. This tool NEVER returns rates.
send_campaign_now
id*
Send a campaign to ALL of its recipients immediately (one full send, the same path the daily cron uses). The campaign must be active. Honors suppressions and the per-org daily cap,… Send a campaign to ALL of its recipients immediately (one full send, the same path the daily cron uses). The campaign must be active. Honors suppressions and the per-org daily cap, resets the cadence clock (the next scheduled send counts from now), and is guarded against double-fires. Returns { run_id, sent, suppressed, failed }.
send_test_campaign
id*
Send a one-off test render of a campaign (with live rates and the org's branding) to the organization owner's email. Does not affect the campaign schedule. Send a one-off test render of a campaign (with live rates and the org's branding) to the organization owner's email. Does not affect the campaign schedule.
set_email_branding
intro_textbrand_colordisplay_namereply_to_emailbusiness_addresslogo_background_color
Set the organization's white-label email branding: display name (used as the From name and CAN-SPAM advertiser identity), brand color (#hex), default intro text, business_address (… Set the organization's white-label email branding: display name (used as the From name and CAN-SPAM advertiser identity), brand color (#hex), default intro text, business_address (CAN-SPAM physical address — required before a campaign can be activated), and reply_to_email. Requires a Pro plan. (Logo upload is app-only — not available over MCP.)
simulate_decision
read-only
sweep*scenario*
Run a what-if sweep over a financing decision. Holds a scenario fixed while sweeping one input (credit_score, down_payment_percent, or rate_shift_bps) across a from/to/step range,… Run a what-if sweep over a financing decision. Holds a scenario fixed while sweeping one input (credit_score, down_payment_percent, or rate_shift_bps) across a from/to/step range, returning a grid of best_lender / best_apr / monthly_payment at each value plus any flip_points where the winning lender changes. Use this to show how rate eligibility or affordability changes with credit score, down payment, or a market rate shift.
simulate_monitor
monitor_id*rate_change*
Test a monitor with a simulated rate change to see if it would trigger. No webhook is sent. It is not a pure dry run: the simulation IS recorded, as a monitor_evaluations row (and… Test a monitor with a simulated rate change to see if it would trigger. No webhook is sent. It is not a pure dry run: the simulation IS recorded, as a monitor_evaluations row (and a webhook audit row) flagged is_simulation = 1, so it appears in the monitor's history clearly marked as a simulation. It does not touch the monitor's cooldown or last_triggered_at. Use deliver_test_webhook to actually send a test webhook.
subscribe_rate_alert
email*stateamountintent*regionstates
+4
Subscribe a consumer to an EMAIL rate alert: notify them when the live market meets their target (rate/apr/monthly_payment crossing a threshold). Consent-first — sends a double-opt… Subscribe a consumer to an EMAIL rate alert: notify them when the live market meets their target (rate/apr/monthly_payment crossing a threshold). Consent-first — sends a double-opt-in confirmation email; the alert only activates after the recipient confirms. One-click unsubscribe in every email (CAN-SPAM). Stores only email + alert criteria. Provide exactly one of state, states, or region.
unsubscribe_rate_alert
can modify data
token*
One-click unsubscribe via the per-alert token embedded in every email. One-click unsubscribe via the per-alert token embedded in every email.
update_email_campaign
id*nameregionstatuscadenceproducts
+3
Update a campaign's name, geography, cadence, intro override, products, or status. products (if given) is the full replacement set (1-5, same union as create_email_campaign). Any g… Update a campaign's name, geography, cadence, intro override, products, or status. products (if given) is the full replacement set (1-5, same union as create_email_campaign). Any geography field replaces the campaign's whole state selection. Set status 'active' to start sending (requires branding display_name + business_address) or 'paused' to stop. Provide exactly one of state_code, state_codes, or region.
update_monitor
namestatusconditionsmonitor_id*webhook_urlcooldown_hours