Read-only U.S. mortgage market, lender, GSE performance, and servicing analytics.
Maintain this server? Claim it
Call this server's tools from your browser. Nothing to install.
Requests go through mcptry because browsers can't call most MCP servers directly. Header values are sent to the server for that request only and are never stored or logged.
Tool list from our last check. Connect live to refresh it.
Side-by-side HMDA comparison of two lender groups: yearly volume, loans, rank, and market share for both; loan type / purpose / occupancy mix; and the top states with each lender's volume and the volume multiple between them. Requires canonical keys for both lenders: call search_lenders and pass each result's exact `name`. For a single lender use get_lender_profile. Returns data.lenders, data.current_year, data.previous_year, data.yearly (both lenders per HMDA year), data.loan_type_mix, data.loan_purpose_mix, data.occupancy_mix, and data.top_state_comparison (top_n rows with lender_1_volume, lender_2_volume, multiple). Volumes are USD; shares are percent. Behavior: read-only, no auth or API key, no PII, idempotent and safe to retry. The public endpoint https://mtgmon.com/mcp allows about 60 requests/min and 250 tool calls/day per client IP. Result shape is {data, meta}; meta carries available, as_of, source_scope, weighting, units, cache_status, caveats, and truncated. If meta.available is false the data is unavailable or the cache is still warming (retry after a few seconds); never report it as zero.
First lender. Canonical HMDA lender key: the exact `name` value from a search_lenders result, e.g. 'Rocket/Quicken' or 'United Wholesale Mortgage'. Legal names such as 'Rocket Mortgage, LLC' do not match and return meta.available=false.
Second lender, different from lender_a. Canonical HMDA lender key: the exact `name` value from a search_lenders result, e.g. 'Rocket/Quicken' or 'United Wholesale Mortgage'. Legal names such as 'Rocket Mortgage, LLC' do not match and return meta.available=false.
Maximum states in top_state_comparison, 1-50 (default 10).
Side-by-side HMDA comparison of two lender groups: yearly volume, loans, rank, and market share for both; loan type / purpose / occupancy mix; and the top states with each lender's volume and the volume multiple between them. Requires canonical keys for both lenders: call search_lenders and pass each result's exact `name`. For a single lender use get_lender_profile. Returns data.lenders, data.current_year, data.previous_year, data.yearly (both lenders per HMDA year), data.loan_type_mix, data.loan_purpose_mix, data.occupancy_mix, and data.top_state_comparison (top_n rows with lender_1_volume, lender_2_volume, multiple). Volumes are USD; shares are percent. Behavior: read-only, no auth or API key, no PII, idempotent and safe to retry. The public endpoint https://mtgmon.com/mcp allows about 60 requests/min and 250 tool calls/day per client IP. Result shape is {data, meta}; meta carries available, as_of, source_scope, weighting, units, cache_status, caveats, and truncated. If meta.available is false the data is unavailable or the cache is still warming (retry after a few seconds); never report it as zero.
| Argument | Type | Description |
|---|---|---|
| top_n | integer | Maximum states in top_state_comparison, 1-50 (default 10). |
| lender_a* | string | First lender. Canonical HMDA lender key: the exact `name` value from a search_lenders result, e.g. 'Rocket/Quicken' or 'United Wholesale Mortgage'. Legal names such as 'Rocket Mortgage, LLC' do not match and return meta.available=false. |
| lender_b* | string | Second lender, different from lender_a. Canonical HMDA lender key: the exact `name` value from a search_lenders result, e.g. 'Rocket/Quicken' or 'United Wholesale Mortgage'. Legal names such as 'Rocket Mortgage, LLC' do not match and return meta.available=false. |
{
"type": "object",
"title": "compare_lendersArguments",
"required": [
"lender_a",
"lender_b"
],
"properties": {
"top_n": {
"type": "integer",
"title": "Top N",
"default": 10,
"maximum": 50,
"minimum": 1,
"description": "Maximum states in top_state_comparison, 1-50 (default 10)."
},
"lender_a": {
"type": "string",
"title": "Lender A",
"maxLength": 160,
"minLength": 1,
"description": "First lender. Canonical HMDA lender key: the exact `name` value from a search_lenders result, e.g. 'Rocket/Quicken' or 'United Wholesale Mortgage'. Legal names such as 'Rocket Mortgage, LLC' do not match and return meta.available=false."
},
"lender_b": {
"type": "string",
"title": "Lender B",
"maxLength": 160,
"minLength": 1,
"description": "Second lender, different from lender_a. Canonical HMDA lender key: the exact `name` value from a search_lenders result, e.g. 'Rocket/Quicken' or 'United Wholesale Mortgage'. Legal names such as 'Rocket Mortgage, LLC' do not match and return meta.available=false."
}
}
}Coverage, freshness, and build metadata for every mtgmon dataset. No arguments. Use for: "how current is the data", finding the latest available month or HMDA year before quoting figures, or diagnosing another tool's meta.available=false. Returns data.datasets, a list of {name, description, category, provider, coverage, last_updated, last_updated_label, stats, refresh} covering GSE loan performance, HMDA, market rates, SEC filings, and derived marts; and data.build {app, lake, cache_backend, cache}. Refresh cadences differ by dataset; read each row's coverage and last_updated. Behavior: read-only, no auth or API key, no PII, idempotent and safe to retry. The public endpoint https://mtgmon.com/mcp allows about 60 requests/min and 250 tool calls/day per client IP. Result shape is {data, meta}; meta carries available, as_of, source_scope, weighting, units, cache_status, caveats, and truncated. If meta.available is false the data is unavailable or the cache is still warming (retry after a few seconds); never report it as zero.
No arguments.
{
"type": "object",
"title": "get_dataset_statusArguments",
"properties": {}
}HMDA origination counts, reported dollar amounts, averages, and year-over-year growth for one product family, optionally for one property state or one lender, with an annual history back to 2018. Use for: HELOC, reverse-mortgage, or closed-end mortgage origination volume and growth; product mix by loan program (conventional/FHA/VA/USDA), purpose, lien, occupancy, construction method, or business purpose; state-level or lender-level product questions. Do not use for: lender rankings or market share (search_lenders / get_lender_profile) or GSE loan performance (get_loan_performance). Important: product_family defaults to 'heloc'. Use 'closed_end_mortgage' for ordinary mortgages or 'all' for every HMDA origination. Source is the frozen annual FFIEC/CFPB HMDA Snapshot LAR (one release per year, 2018 onward); state filters use the property state, not the lender's headquarters. Returns data.selected_year, data.current and data.previous (each {year, origination_count, reported_amount_count, reported_amount_sum, average_reported_amount, reported_amount_max, origination_count_yoy_pct, reported_amount_sum_yoy_pct, average_reported_amount_yoy_pct}), data.history (one such row per year), data.filters (applied filters), data.definition, and data.source_releases. Amounts are USD; YoY fields are percent; for HELOCs the amount is credit available, not the drawn balance. Behavior: read-only, no auth or API key, no PII, idempotent and safe to retry. The public endpoint https://mtgmon.com/mcp allows about 60 requests/min and 250 tool calls/day per client IP. Result shape is {data, meta}; meta carries available, as_of, source_scope, weighting, units, cache_status, caveats, and truncated. If meta.available is false the data is unavailable or the cache is still warming (retry after a few seconds); never report it as zero.
| Argument | Type | Description |
|---|---|---|
| year | any | HMDA activity year, 2018 or later. Default: latest published Snapshot year (see data.selected_year). |
| state |
HMDA profile for one lender group: annual origination volume, loan counts, denial rate, national rank and market share, top states with market-share multiples, and loan type / purpose / occupancy / loan-size mix. Requires a canonical key: call search_lenders and pass the exact `name` (e.g. 'Rocket/Quicken'). Any other spelling returns meta.available=false with empty lists. Use compare_lenders for two lenders side by side. Returns data.lender_key, data.name, data.leis, data.current_year, data.previous_year, data.yearly (one row per HMDA year: originated_volume, originated_loans, purchased_volume, purchased_loans, denied_loans, applications_loans, total_funded_volume, avg_loan_size, denial_rate_pct, denial_rate_count_pct, rank, national_volume, market_share_pct), data.top_states {state, volume, loans, previous_volume, previous_loans} and data.state_market_multiples {state, lender_share_pct, market_share_pct, multiple, ...} (top_n rows each), data.loan_type_mix, data.loan_purpose_mix, data.occupancy_mix ({code, label, loans, volume}), and data.loan_size_histogram. Volumes are USD; shares and rates are percent. Behavior: read-only, no auth or API key, no PII, idempotent and safe to retry. The public endpoint https://mtgmon.com/mcp allows about 60 requests/min and 250 tool calls/day per client IP. Result shape is {data, meta}; meta carries available, as_of, source_scope, weighting, units, cache_status, caveats, and truncated. If meta.available is false the data is unavailable or the cache is still warming (retry after a few seconds); never report it as zero.
| Argument | Type | Description |
|---|---|---|
| top_n | integer | Maximum rows in top_states and state_market_multiples, 1-50 (default 10). |
| lender* | string | Canonical HMDA lender key: the exact `name` value from a search_lenders result, e.g. 'Rocket/Quicken' or 'United Wholesale Mortgage'. Legal names such as 'Rocket Mortgage, LLC' do not match and return meta.available=false. |
Fannie Mae and Freddie Mac single-family loan-performance analytics for exactly one topic. Topics: - credit: monthly origination FICO and LTV (origination-UPB weighted). data.series {fico, ltv} and data.latest. - prepayment: monthly CPR and SMM (UPB weighted). - delinquency: monthly 30/60/90+ day delinquency rates (UPB-weighted stock rates). - loss: monthly loss severity (percent) and net loss (USD billions), plus data.latest_waterfall. - vintage: cumulative default-rate curves by vintage year over loan age (data.series = [{vintage, points}]). - transitions: loan-level monthly flows between Current/DQ30/DQ60/DQ90+/Modified/Liquidated (data.flows, top_n rows of {from, to, loans, upb, prob}) and data.history {cure_history, roll_30_60_history, roll_60_90_history}. - modification: outcomes at 6/12/18/24/36 months after a first 90+ DPD event, Modified vs NotModified arms (data.horizons, data.outcome_states, data.cohort_size, data.pooled, data.recent_vintages). - rate_sensitivity: modelled CPR under rate shocks (data.scenario = [{rate_shock_bps, predicted_cpr}], data.model {current_rate, current_cpr, slope}). - lock_in: active book by WAC vs today's mortgage rate: data.summary {total_upb, loan_count, wac_weighted, pct_below_mtg, pct_200bps_otm, pct_100bps_otm, pct_in_money} and data.largest_wac_age_cells {wac, age_band, upb}. Use for: agency credit quality, prepayment speeds, delinquency, roll and cure rates, modification outcomes, losses, the lock-in effect. Do not use for: originator volume or market share (search_lenders / get_lender_profile), today's rates (get_market_snapshot), per-servicer performance (get_servicer_analytics). Time-series topics return data.series {metric: [{date, value}, ...]} downsampled to max_points, plus data.latest. Scope is public GSE loan-level disclosures, not the whole U.S. market; meta.as_of is the latest reporting month. Behavior: read-only, no auth or API key, no PII, idempotent and safe to retry. The public endpoint https://mtgmon.com/mcp allows about 60 requests/min and 250 tool calls/day per client IP. Result shape is {data, meta}; meta carries available, as_of, source_scope, weighting, units, cache_status, caveats, and truncated. If meta.available is false the data is unavailable or the cache is still warming (retry after a few seconds); never report it as zero.
| Argument |
|---|
Latest U.S. mortgage rates, TBA par coupons, Treasury and SOFR benchmarks, and mtgmon's fitted MBS basis in one call. No arguments. Use for: "what are mortgage rates today", 30y vs 15y, current coupon, 2y/10y Treasury, SOFR swap levels, whether MBS spreads are rich or cheap versus the model. Do not use for: rate history (not exposed here) or GSE loan performance (get_loan_performance). Returns data.rates, a list of up to 9 points {series, date, value, previous_value, change} for series MORTGAGE30US and MORTGAGE15US (Freddie Mac PMMS, weekly), tba_par_coupon_30y and tba_par_coupon_15y, 2Y and 10Y Treasury, and SOFR O/N, SOFR 2Y, SOFR 10Y; plus data.mbs_basis {model_version, latest_date, latest_basis_bps, latest_fair_bps, latest_gap_bps, latest_gap_zscore, r2_level_full_sample, ec_half_life_days, ...}. Rates are percent, basis is basis points. Series have different observation dates; quote each point's own date. Behavior: read-only, no auth or API key, no PII, idempotent and safe to retry. The public endpoint https://mtgmon.com/mcp allows about 60 requests/min and 250 tool calls/day per client IP. Result shape is {data, meta}; meta carries available, as_of, source_scope, weighting, units, cache_status, caveats, and truncated. If meta.available is false the data is unavailable or the cache is still warming (retry after a few seconds); never report it as zero.
No arguments.
{
"type": "object",
"title": "get_market_snapshotArguments",
"properties": {}
}Full detail for one SEC filing: metadata and EDGAR link, mtgmon's machine-generated summary, which tracked mortgage entities the filing concerns and in what role, named people with titles and compensation, extracted financial facts, and ownership rows. Get the filing_id from search_sec_filings first. Returns data.filing {filing_id, accession_number, filer_cik, form, filing_date, company_name, description, canonical_summary, summary_status, summary_model, edgar_url, ...}, data.associations [{display_name, ticker (current symbol), retired_tickers, cik, relationship_role, summary, link_status, ...}], data.people [{name, title, compensation, note}], data.financials [{metric, value, unit, period}], and data.ownership. Each list is capped. Verify summaries against the linked filing before relying on them. Behavior: read-only, no auth or API key, no PII, idempotent and safe to retry. The public endpoint https://mtgmon.com/mcp allows about 60 requests/min and 250 tool calls/day per client IP. Result shape is {data, meta}; meta carries available, as_of, source_scope, weighting, units, cache_status, caveats, and truncated. If meta.available is false the data is unavailable or the cache is still warming (retry after a few seconds); never report it as zero.
| Argument | Type | Description |
|---|---|---|
| filing_id* | string | Filing identifier exactly as returned in a search_sec_filings result's filing_id field, typically the SEC accession number such as '0002100121-26-001023'. Letters, digits, '-' and '_' only. |
{
"type": "object",
"title": "get_sec_filingArguments",
"required": [
"filing_id"
],
"properties": {
"filing_id": {
"type": "string",
"title": "Filing Id",
"maxLength": 96,
"minLength": 1,
"description": "Filing identifier exactly as returned in a search_sec_filings result's filing_id field, typically the SEC accession number such as '0002100121-26-001023'. Letters, digits, '-' and '_' only."
}
}
}Agency (Fannie Mae / Freddie Mac) servicer analytics in one of three modes. - mode='scorecard': largest servicers ranked by disclosed origination UPB for the current and previous year with average FICO and LTV. Returns data.servicers (top_n rows of {rank, name, volume, previous_volume, avg_fico, avg_ltv}), data.current_year, data.previous_year. - mode='performance': monthly CPR and 90+ day delinquency per top servicer for one origination vintage against the whole-book benchmark. Returns data.servicers {name: {cpr: [{date, value}], dq90: [...]}} downsampled to max_points, data.book {cpr, dq90}, data.vintage, data.latest_date. - mode='transfers': where one originator's Fannie Mae loans are serviced today and how servicing moved from the seller. Requires `lender` (canonical key from search_lenders). Returns data.seller_name, data.summary {loan_count, origination_upb, loans_with_transfer, pct_loans_with_transfer, total_transfer_events, ...}, data.latest_active_servicers {servicer, loans, upb, upb_share_pct}, data.top_routes and data.top_named_routes {from_servicer, to_servicer, events, event_share_pct}, data.first_to_latest {first_servicer, latest_servicer, loans, original_upb} (top_n rows each). Use for: "largest servicers", "which servicer prepays fastest or has the worst DQ for the 2021 vintage", "who services Rocket's loans now". Do not use for: HMDA origination volume (get_lender_profile) or book-wide delinquency (get_loan_performance topic='delinquency'). Coverage is disclosed agency loans matched by seller/servicer name, not any servicer's full portfolio. UPB and volume are USD; CPR and DQ90 are percent. Behavior: read-only, no auth or API key, no PII, idempotent and safe to retry. The public endpoint https://mtgmon.com/mcp allows about 60 requests/min and 250 tool calls/day per client IP. Result shape is {data, meta}; meta carries available, as_of, source_scope, weighting, units, cache_status, caveats, and truncated. If meta.available is false the data is unavailable or the cache is still warming (retry after a few seconds); never report it as zero.
| Argument | Type | Description |
|---|---|---|
| gse |
Find HMDA lenders and resolve names to canonical lender keys. Call this before any other lender tool. Use for: turning a company name ('Rocket', 'UWM', 'Wells Fargo', 'PennyMac') into its canonical key, ranking lenders by origination volume, or listing lenders by charter type or headquarters state. Then pass a result's exact `name` (e.g. 'Rocket/Quicken') as `lender` to get_lender_profile, get_hmda_product_analytics, or get_servicer_analytics mode='transfers', or as lender_a / lender_b to compare_lenders. Legal names such as 'Rocket Mortgage, LLC' are not keys and return meta.available=false downstream. Returns data.results (at most `limit` rows of {name, leis, charter_type, hq_state, recent_year, recent_volume, total_loans, volume_rank, subsidiary_count}), data.matched_count, and data.total_count. recent_volume is USD originations in recent_year (the latest HMDA year). Keys are holding-company or originator groups, so subsidiaries and LEIs roll up into one key. Behavior: read-only, no auth or API key, no PII, idempotent and safe to retry. The public endpoint https://mtgmon.com/mcp allows about 60 requests/min and 250 tool calls/day per client IP. Result shape is {data, meta}; meta carries available, as_of, source_scope, weighting, units, cache_status, caveats, and truncated. If meta.available is false the data is unavailable or the cache is still warming (retry after a few seconds); never report it as zero.
| Argument | Type | Description |
|---|---|---|
| sort | string | Result order: volume_desc (default, largest recent-year volume first), volume_asc, name_asc, name_desc, loans_desc (most loans first), rank_asc (best volume rank first). |
| limit | integer | Maximum results, 1-25 (default 10). |
| query | string | Case-insensitive substring of the lender name, e.g. 'rocket', 'united wholesale', 'wells'. Empty (default) returns the top lenders in sort order. |
Search SEC EDGAR filings of mortgage-related public companies (lenders, servicers, mortgage REITs, insurers, GSEs) that mtgmon has summarized. Newest filing date first. Use for: finding a company's 10-K, 10-Q, 8-K, or other filings by ticker, CIK, form type, keyword, or date window, and getting the filing_id to pass to get_sec_filing. Do not use for: full filing text (only summaries are stored) or companies outside the mortgage sector. Returns data.filings (at most `limit` rows of {filing_id, accession_number, filer_cik, form, filing_date, company_name, description, summary_status, summary_excerpt, summary_created_at, edgar_url}) and data.next_cursor (pass back as `cursor` for the next page; null when exhausted; meta.truncated is true when more pages exist). Only filings whose summary processing finished are listed; summaries are machine-generated and should be checked against edgar_url. Behavior: read-only, no auth or API key, no PII, idempotent and safe to retry. The public endpoint https://mtgmon.com/mcp allows about 60 requests/min and 250 tool calls/day per client IP. Result shape is {data, meta}; meta carries available, as_of, source_scope, weighting, units, cache_status, caveats, and truncated. If meta.available is false the data is unavailable or the cache is still warming (retry after a few seconds); never report it as zero.
| Argument | Type | Description |
|---|---|---|
| cik | string | SEC Central Index Key of the filer, digits only, e.g. '1805284'. Empty (default) = any filer. |
| form | string | SEC form type, e.g. '10-K', '10-Q', '8-K', 'S-1', 'DEF 14A'. Case-insensitive. Empty (default) = all forms. |
| limit | integer | Maximum filings per page, 1-25 (default 10). |
| query |
| string |
| Two-letter USPS code of the property state, e.g. 'TX' (not the lender HQ). Empty (default) = nationwide. |
| lender | any | Canonical HMDA lender key: the exact `name` value from a search_lenders result, e.g. 'Rocket/Quicken' or 'United Wholesale Mortgage'. Legal names such as 'Rocket Mortgage, LLC' do not match and return meta.available=false. Default: all lenders. |
| loan_program | string | 'all' (default), 'conventional', 'fha', 'va', 'usda_rhs', or 'unknown'. |
| loan_purpose | string | 'all' (default), 'purchase', 'home_improvement', 'refinance' (rate/term), 'cash_out_refinance', 'other', 'not_applicable', or 'unknown'. |
| lien_position | string | 'all' (default), 'first', 'subordinate', 'not_secured', 'not_applicable', or 'unknown'. |
| occupancy_type | string | 'all' (default), 'principal_residence', 'second_residence', 'investment_property', or 'unknown'. |
| product_family | string | 'heloc' (DEFAULT: open-end lines of credit that are not reverse mortgages), 'closed_end_mortgage' (ordinary first and second mortgages), 'reverse_mortgage', 'unclassified_or_exempt', or 'all' (every HMDA origination). Set this explicitly; the default is not the whole market. |
| business_purpose | string | 'all' (default: consumer + business + exempt/unknown records), 'consumer', 'business', or 'exempt_unknown'. |
| credit_structure | string | 'all' (default), 'open_end', 'closed_end', or 'exempt_unknown'. Usually leave 'all'; product_family already implies it. |
| construction_method | string | 'all' (default), 'site_built', 'manufactured', or 'unknown'. |
| reverse_mortgage_status | string | 'all' (default), 'reverse', 'not_reverse', or 'exempt_unknown'. Usually leave 'all'; product_family already implies it. |
{
"type": "object",
"title": "get_hmda_product_analyticsArguments",
"properties": {
"year": {
"anyOf": [
{
"type": "integer",
"maximum": 2100,
"minimum": 2018
},
{
"type": "null"
}
],
"title": "Year",
"default": null,
"description": "HMDA activity year, 2018 or later. Default: latest published Snapshot year (see data.selected_year)."
},
"state": {
"type": "string",
"title": "State",
"default": "",
"maxLength": 2,
"description": "Two-letter USPS code of the property state, e.g. 'TX' (not the lender HQ). Empty (default) = nationwide."
},
"lender": {
"anyOf": [
{
"type": "string",
"maxLength": 160
},
{
"type": "null"
}
],
"title": "Lender",
"default": null,
"description": "Canonical HMDA lender key: the exact `name` value from a search_lenders result, e.g. 'Rocket/Quicken' or 'United Wholesale Mortgage'. Legal names such as 'Rocket Mortgage, LLC' do not match and return meta.available=false. Default: all lenders."
},
"loan_program": {
"enum": [
"all",
"conventional",
"fha",
"va",
"usda_rhs",
"unknown"
],
"type": "string",
"title": "Loan Program",
"default": "all",
"description": "'all' (default), 'conventional', 'fha', 'va', 'usda_rhs', or 'unknown'."
},
"loan_purpose": {
"enum": [
"all",
"purchase",
"home_improvement",
"refinance",
"cash_out_refinance",
"other",
"not_applicable",
"unknown"
],
"type": "string",
"title": "Loan Purpose",
"default": "all",
"description": "'all' (default), 'purchase', 'home_improvement', 'refinance' (rate/term), 'cash_out_refinance', 'other', 'not_applicable', or 'unknown'."
},
"lien_position": {
"enum": [
"all",
"first",
"subordinate",
"not_secured",
"not_applicable",
"unknown"
],
"type": "string",
"title": "Lien Position",
"default": "all",
"description": "'all' (default), 'first', 'subordinate', 'not_secured', 'not_applicable', or 'unknown'."
},
"occupancy_type": {
"enum": [
"all",
"principal_residence",
"second_residence",
"investment_property",
"unknown"
],
"type": "string",
"title": "Occupancy Type",
"default": "all",
"description": "'all' (default), 'principal_residence', 'second_residence', 'investment_property', or 'unknown'."
},
"product_family": {
"enum": [
"all",
"heloc",
"reverse_mortgage",
"closed_end_mortgage",
"unclassified_or_exempt"
],
"type": "string",
"title": "Product Family",
"default": "heloc",
"description": "'heloc' (DEFAULT: open-end lines of credit that are not reverse mortgages), 'closed_end_mortgage' (ordinary first and second mortgages), 'reverse_mortgage', 'unclassified_or_exempt', or 'all' (every HMDA origination). Set this explicitly; the default is not the whole market."
},
"business_purpose": {
"enum": [
"all",
"consumer",
"business",
"exempt_unknown"
],
"type": "string",
"title": "Business Purpose",
"default": "all",
"description": "'all' (default: consumer + business + exempt/unknown records), 'consumer', 'business', or 'exempt_unknown'."
},
"credit_structure": {
"enum": [
"all",
"open_end",
"closed_end",
"exempt_unknown"
],
"type": "string",
"title": "Credit Structure",
"default": "all",
"description": "'all' (default), 'open_end', 'closed_end', or 'exempt_unknown'. Usually leave 'all'; product_family already implies it."
},
"construction_method": {
"enum": [
"all",
"site_built",
"manufactured",
"unknown"
],
"type": "string",
"title": "Construction Method",
"default": "all",
"description": "'all' (default), 'site_built', 'manufactured', or 'unknown'."
},
"reverse_mortgage_status": {
"enum": [
"all",
"reverse",
"not_reverse",
"exempt_unknown"
],
"type": "string",
"title": "Reverse Mortgage Status",
"default": "all",
"description": "'all' (default), 'reverse', 'not_reverse', or 'exempt_unknown'. Usually leave 'all'; product_family already implies it."
}
}
}{
"type": "object",
"title": "get_lender_profileArguments",
"required": [
"lender"
],
"properties": {
"top_n": {
"type": "integer",
"title": "Top N",
"default": 10,
"maximum": 50,
"minimum": 1,
"description": "Maximum rows in top_states and state_market_multiples, 1-50 (default 10)."
},
"lender": {
"type": "string",
"title": "Lender",
"maxLength": 160,
"minLength": 1,
"description": "Canonical HMDA lender key: the exact `name` value from a search_lenders result, e.g. 'Rocket/Quicken' or 'United Wholesale Mortgage'. Legal names such as 'Rocket Mortgage, LLC' do not match and return meta.available=false."
}
}
}| Type |
|---|
| Description |
|---|
| gse | string | 'all' = Fannie Mae + Freddie Mac combined (default), 'fnma' = Fannie Mae only, 'fhlmc' = Freddie Mac only. |
| top_n | integer | Maximum ranked rows, 1-50 (default 20): transition flows, modification vintages, or lock-in WAC/age cells. Ignored by other topics. |
| topic* | string | Exactly one analytics topic: credit, prepayment, delinquency, loss (monthly time series); vintage (curves by vintage year); transitions (loan-level state flows); modification (post-90DPD outcomes); rate_sensitivity (CPR under rate shocks); lock_in (book by WAC vs today's rate). |
| to_date | any | Latest month to include, ISO date YYYY-MM-DD; must be on or after from_date. Default: latest available month. |
| from_date | any | Earliest month to include, ISO date YYYY-MM-DD. Applies to credit, prepayment, delinquency, loss, and transitions history. Default: full available history. |
| max_points | integer | Maximum points per time series after uniform downsampling, 1-120 (default 60). Use 120 for the finest monthly detail. Applies to time-series, vintage, and transitions topics. |
{
"type": "object",
"title": "get_loan_performanceArguments",
"required": [
"topic"
],
"properties": {
"gse": {
"enum": [
"all",
"fnma",
"fhlmc"
],
"type": "string",
"title": "Gse",
"default": "all",
"description": "'all' = Fannie Mae + Freddie Mac combined (default), 'fnma' = Fannie Mae only, 'fhlmc' = Freddie Mac only."
},
"top_n": {
"type": "integer",
"title": "Top N",
"default": 20,
"maximum": 50,
"minimum": 1,
"description": "Maximum ranked rows, 1-50 (default 20): transition flows, modification vintages, or lock-in WAC/age cells. Ignored by other topics."
},
"topic": {
"enum": [
"credit",
"prepayment",
"delinquency",
"vintage",
"transitions",
"modification",
"loss",
"rate_sensitivity",
"lock_in"
],
"type": "string",
"title": "Topic",
"description": "Exactly one analytics topic: credit, prepayment, delinquency, loss (monthly time series); vintage (curves by vintage year); transitions (loan-level state flows); modification (post-90DPD outcomes); rate_sensitivity (CPR under rate shocks); lock_in (book by WAC vs today's rate)."
},
"to_date": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "To Date",
"default": null,
"description": "Latest month to include, ISO date YYYY-MM-DD; must be on or after from_date. Default: latest available month."
},
"from_date": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "From Date",
"default": null,
"description": "Earliest month to include, ISO date YYYY-MM-DD. Applies to credit, prepayment, delinquency, loss, and transitions history. Default: full available history."
},
"max_points": {
"type": "integer",
"title": "Max Points",
"default": 60,
"maximum": 120,
"minimum": 1,
"description": "Maximum points per time series after uniform downsampling, 1-120 (default 60). Use 120 for the finest monthly detail. Applies to time-series, vintage, and transitions topics."
}
}
}| string |
| 'all' = Fannie Mae + Freddie Mac combined (default), 'fnma' = Fannie Mae only, 'fhlmc' = Freddie Mac only. Used by scorecard and performance; transfers is Fannie Mae only. |
| mode* | string | 'scorecard' (servicers ranked by disclosed volume), 'performance' (per-servicer CPR and DQ90 series for one vintage), or 'transfers' (one lender's servicing-transfer routes; requires `lender`). |
| top_n | integer | Maximum servicers (scorecard, performance) or rows per route list (transfers), 1-25 (default 10). |
| lender | any | Canonical HMDA lender key: the exact `name` value from a search_lenders result, e.g. 'Rocket/Quicken' or 'United Wholesale Mortgage'. Legal names such as 'Rocket Mortgage, LLC' do not match and return meta.available=false. Required for mode='transfers'; ignored by other modes. |
| vintage | integer | Origination year for mode='performance' (default 2021). Ignored by other modes. |
| max_points | integer | Maximum points per CPR/DQ90 series for mode='performance', 1-120 (default 60). Ignored by other modes. |
{
"type": "object",
"title": "get_servicer_analyticsArguments",
"required": [
"mode"
],
"properties": {
"gse": {
"enum": [
"all",
"fnma",
"fhlmc"
],
"type": "string",
"title": "Gse",
"default": "all",
"description": "'all' = Fannie Mae + Freddie Mac combined (default), 'fnma' = Fannie Mae only, 'fhlmc' = Freddie Mac only. Used by scorecard and performance; transfers is Fannie Mae only."
},
"mode": {
"enum": [
"scorecard",
"performance",
"transfers"
],
"type": "string",
"title": "Mode",
"description": "'scorecard' (servicers ranked by disclosed volume), 'performance' (per-servicer CPR and DQ90 series for one vintage), or 'transfers' (one lender's servicing-transfer routes; requires `lender`)."
},
"top_n": {
"type": "integer",
"title": "Top N",
"default": 10,
"maximum": 25,
"minimum": 1,
"description": "Maximum servicers (scorecard, performance) or rows per route list (transfers), 1-25 (default 10)."
},
"lender": {
"anyOf": [
{
"type": "string",
"maxLength": 160
},
{
"type": "null"
}
],
"title": "Lender",
"default": null,
"description": "Canonical HMDA lender key: the exact `name` value from a search_lenders result, e.g. 'Rocket/Quicken' or 'United Wholesale Mortgage'. Legal names such as 'Rocket Mortgage, LLC' do not match and return meta.available=false. Required for mode='transfers'; ignored by other modes."
},
"vintage": {
"type": "integer",
"title": "Vintage",
"default": 2021,
"maximum": 2100,
"minimum": 1990,
"description": "Origination year for mode='performance' (default 2021). Ignored by other modes."
},
"max_points": {
"type": "integer",
"title": "Max Points",
"default": 60,
"maximum": 120,
"minimum": 1,
"description": "Maximum points per CPR/DQ90 series for mode='performance', 1-120 (default 60). Ignored by other modes."
}
}
}| state | string | Two-letter USPS code of the lender's headquarters state, e.g. 'MI'. Empty (default) = all states. |
| charter | string | Filter by charter type exactly as shown in results' charter_type, e.g. 'Bank' or 'Independent Mortgage Company'. Empty (default) = all charter types. |
| min_volume | number | Minimum recent-year origination volume in USD, e.g. 1000000000 for $1B+. Default 0 (no floor). |
{
"type": "object",
"title": "search_lendersArguments",
"properties": {
"sort": {
"enum": [
"volume_desc",
"volume_asc",
"name_asc",
"name_desc",
"loans_desc",
"rank_asc"
],
"type": "string",
"title": "Sort",
"default": "volume_desc",
"description": "Result order: volume_desc (default, largest recent-year volume first), volume_asc, name_asc, name_desc, loans_desc (most loans first), rank_asc (best volume rank first)."
},
"limit": {
"type": "integer",
"title": "Limit",
"default": 10,
"maximum": 25,
"minimum": 1,
"description": "Maximum results, 1-25 (default 10)."
},
"query": {
"type": "string",
"title": "Query",
"default": "",
"maxLength": 120,
"description": "Case-insensitive substring of the lender name, e.g. 'rocket', 'united wholesale', 'wells'. Empty (default) returns the top lenders in sort order."
},
"state": {
"type": "string",
"title": "State",
"default": "",
"maxLength": 2,
"description": "Two-letter USPS code of the lender's headquarters state, e.g. 'MI'. Empty (default) = all states."
},
"charter": {
"type": "string",
"title": "Charter",
"default": "",
"maxLength": 80,
"description": "Filter by charter type exactly as shown in results' charter_type, e.g. 'Bank' or 'Independent Mortgage Company'. Empty (default) = all charter types."
},
"min_volume": {
"type": "number",
"title": "Min Volume",
"default": 0,
"minimum": 0,
"description": "Minimum recent-year origination volume in USD, e.g. 1000000000 for $1B+. Default 0 (no floor)."
}
}
}| string |
| Free-text keyword search over company name and summary text, e.g. 'servicing portfolio sale'. Empty (default) = no text filter. |
| cursor | string | Opaque pagination token copied from a previous result's data.next_cursor. Empty (default) = first page. |
| ticker | string | Stock ticker of the filer, e.g. 'RKT', 'UWMC', 'PFSI'. Case-insensitive; retired symbols such as 'GHIV' also match. Empty (default) = any. |
| to_date | any | Latest filing date, ISO YYYY-MM-DD; must not be before from_date. Default: no upper bound. |
| from_date | any | Earliest filing date, ISO YYYY-MM-DD. Default: no lower bound. |
| summary_status | string | '' (default: all), 'summarized' (a machine summary exists), or 'unavailable' (summary could not be produced). |
{
"type": "object",
"title": "search_sec_filingsArguments",
"properties": {
"cik": {
"type": "string",
"title": "Cik",
"default": "",
"maxLength": 10,
"description": "SEC Central Index Key of the filer, digits only, e.g. '1805284'. Empty (default) = any filer."
},
"form": {
"type": "string",
"title": "Form",
"default": "",
"maxLength": 24,
"description": "SEC form type, e.g. '10-K', '10-Q', '8-K', 'S-1', 'DEF 14A'. Case-insensitive. Empty (default) = all forms."
},
"limit": {
"type": "integer",
"title": "Limit",
"default": 10,
"maximum": 25,
"minimum": 1,
"description": "Maximum filings per page, 1-25 (default 10)."
},
"query": {
"type": "string",
"title": "Query",
"default": "",
"maxLength": 200,
"description": "Free-text keyword search over company name and summary text, e.g. 'servicing portfolio sale'. Empty (default) = no text filter."
},
"cursor": {
"type": "string",
"title": "Cursor",
"default": "",
"maxLength": 500,
"description": "Opaque pagination token copied from a previous result's data.next_cursor. Empty (default) = first page."
},
"ticker": {
"type": "string",
"title": "Ticker",
"default": "",
"maxLength": 16,
"description": "Stock ticker of the filer, e.g. 'RKT', 'UWMC', 'PFSI'. Case-insensitive; retired symbols such as 'GHIV' also match. Empty (default) = any."
},
"to_date": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "To Date",
"default": null,
"description": "Latest filing date, ISO YYYY-MM-DD; must not be before from_date. Default: no upper bound."
},
"from_date": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "From Date",
"default": null,
"description": "Earliest filing date, ISO YYYY-MM-DD. Default: no lower bound."
},
"summary_status": {
"enum": [
"",
"summarized",
"unavailable"
],
"type": "string",
"title": "Summary Status",
"default": "",
"description": "'' (default: all), 'summarized' (a machine summary exists), or 'unavailable' (summary could not be produced)."
}
}
}