@model-match/api 3.54.0 → 3.56.0

package/openapi.json

@@ -29354,6 +29354,14 @@
       },
       "MarketCommunityBucket": {
         "properties": {
+          "affordableLoanOriginations": {
+            "type": "number"
+          },
+          "affordableLoanSharePct": {
+            "description": "Share (0-100) of `originations` that are affordable loans.",
+            "nullable": true,
+            "type": "number"
+          },
           "avgMinorityTractPct": {
             "description": "Average non-white share (0-100) of the neighborhood population across originations that carry it. Values describe the U.S. Census tract (neighborhood) as a whole — tract-level aggregate statistics, never an individual, household or applicant attribute. Percentages are 0-100.",
             "nullable": true,
@@ -29364,6 +29372,10 @@
             "nullable": true,
             "type": "number"
           },
+          "craEligibleAndAffordableOriginations": {
+            "description": "Originations both CRA-eligible and affordable.",
+            "type": "number"
+          },
           "craEligibleCoverage": {
             "description": "Originations carrying a CRA-eligibility determination — the denominator of `craEligibleSharePct`. Effectively the whole population: the determination is loan-level and is present on every record.",
             "type": "number"
@@ -29421,6 +29433,14 @@
           "originations": {
             "description": "Originations matched by the filters in this scope.",
             "type": "number"
+          },
+          "underservedMarketOriginations": {
+            "type": "number"
+          },
+          "underservedMarketSharePct": {
+            "description": "Share (0-100) of `originations` in an underserved market.",
+            "nullable": true,
+            "type": "number"
           }
         },
         "required": [
@@ -29439,7 +29459,12 @@
           "minorityTractCoverage",
           "majorityMinorityTractSharePct",
           "avgMinorityTractPct",
-          "avgTractIncomeVsMetroPct"
+          "avgTractIncomeVsMetroPct",
+          "underservedMarketOriginations",
+          "underservedMarketSharePct",
+          "affordableLoanOriginations",
+          "affordableLoanSharePct",
+          "craEligibleAndAffordableOriginations"
         ],
         "type": "object"
       },
@@ -29514,18 +29539,34 @@
         ],
         "description": "FFIEC income classification of the neighborhood the property sits in. A tract-level aggregate statistic describing the neighborhood, never an individual, household or applicant attribute. Carried on roughly a fifth of originations, so this filter narrows sharply."
       },
+      "MarketCommunityInterval": {
+        "description": "Also return `series`: the mix per bucket.",
+        "enum": [
+          "monthly",
+          "quarterly",
+          "yearly"
+        ],
+        "type": "string"
+      },
       "MarketCommunityLendingRequest": {
         "additionalProperties": false,
         "properties": {
           "advancedFilters": {
             "$ref": "#/components/schemas/FilterNode"
           },
+          "compare": {
+            "description": "Also return `previous` (preceding equal-length window).",
+            "type": "boolean"
+          },
           "filters": {
             "$ref": "#/components/schemas/FilterNode"
           },
           "flatFilters": {
             "$ref": "#/components/schemas/MarketFlatFilters"
           },
+          "interval": {
+            "$ref": "#/components/schemas/MarketCommunityInterval"
+          },
           "limit": {
             "description": "Maximum buckets when `slice` is supplied (default 25, max 200).",
             "maximum": 200,
@@ -29565,6 +29606,22 @@
           "overall": {
             "$ref": "#/components/schemas/MarketCommunityMix"
           },
+          "previous": {
+            "allOf": [
+              {
+                "$ref": "#/components/schemas/MarketCommunityMix"
+              },
+              {
+                "description": "With `compare: true`: the mix over the preceding window of equal length."
+              }
+            ]
+          },
+          "series": {
+            "items": {
+              "$ref": "#/components/schemas/MarketCommunitySeriesBucket"
+            },
+            "type": "array"
+          },
           "slice": {
             "properties": {
               "buckets": {
@@ -29591,6 +29648,14 @@
       },
       "MarketCommunityMix": {
         "properties": {
+          "affordableLoanOriginations": {
+            "type": "number"
+          },
+          "affordableLoanSharePct": {
+            "description": "Share (0-100) of `originations` that are affordable loans.",
+            "nullable": true,
+            "type": "number"
+          },
           "avgMinorityTractPct": {
             "description": "Average non-white share (0-100) of the neighborhood population across originations that carry it. Values describe the U.S. Census tract (neighborhood) as a whole — tract-level aggregate statistics, never an individual, household or applicant attribute. Percentages are 0-100.",
             "nullable": true,
@@ -29601,6 +29666,10 @@
             "nullable": true,
             "type": "number"
           },
+          "craEligibleAndAffordableOriginations": {
+            "description": "Originations both CRA-eligible and affordable.",
+            "type": "number"
+          },
           "craEligibleCoverage": {
             "description": "Originations carrying a CRA-eligibility determination — the denominator of `craEligibleSharePct`. Effectively the whole population: the determination is loan-level and is present on every record.",
             "type": "number"
@@ -29654,6 +29723,14 @@
           "originations": {
             "description": "Originations matched by the filters in this scope.",
             "type": "number"
+          },
+          "underservedMarketOriginations": {
+            "type": "number"
+          },
+          "underservedMarketSharePct": {
+            "description": "Share (0-100) of `originations` in an underserved market.",
+            "nullable": true,
+            "type": "number"
           }
         },
         "required": [
@@ -29671,7 +29748,133 @@
           "minorityTractCoverage",
           "majorityMinorityTractSharePct",
           "avgMinorityTractPct",
-          "avgTractIncomeVsMetroPct"
+          "avgTractIncomeVsMetroPct",
+          "underservedMarketOriginations",
+          "underservedMarketSharePct",
+          "affordableLoanOriginations",
+          "affordableLoanSharePct",
+          "craEligibleAndAffordableOriginations"
+        ],
+        "type": "object"
+      },
+      "MarketCommunitySeriesBucket": {
+        "properties": {
+          "affordableLoanOriginations": {
+            "type": "number"
+          },
+          "affordableLoanSharePct": {
+            "description": "Share (0-100) of `originations` that are affordable loans.",
+            "nullable": true,
+            "type": "number"
+          },
+          "avgMinorityTractPct": {
+            "description": "Average non-white share (0-100) of the neighborhood population across originations that carry it. Values describe the U.S. Census tract (neighborhood) as a whole — tract-level aggregate statistics, never an individual, household or applicant attribute. Percentages are 0-100.",
+            "nullable": true,
+            "type": "number"
+          },
+          "avgTractIncomeVsMetroPct": {
+            "description": "Average neighborhood median family income as a percent of its metro area's — 100 is parity, and it legitimately exceeds 100. Values describe the U.S. Census tract (neighborhood) as a whole — tract-level aggregate statistics, never an individual, household or applicant attribute. Percentages are 0-100.",
+            "nullable": true,
+            "type": "number"
+          },
+          "craEligibleAndAffordableOriginations": {
+            "description": "Originations both CRA-eligible and affordable.",
+            "type": "number"
+          },
+          "craEligibleCoverage": {
+            "description": "Originations carrying a CRA-eligibility determination — the denominator of `craEligibleSharePct`. Effectively the whole population: the determination is loan-level and is present on every record.",
+            "type": "number"
+          },
+          "craEligibleOriginations": {
+            "type": "number"
+          },
+          "craEligibleSharePct": {
+            "description": "Share (0-100) of `craEligibleCoverage` that is CRA-eligible — a low- or moderate-income neighborhood OR a low- or moderate-income borrower. Null when nothing in scope carries the determination.",
+            "nullable": true,
+            "type": "number"
+          },
+          "from": {
+            "description": "Bucket start (inclusive), YYYY-MM-DD.",
+            "type": "string"
+          },
+          "incomeBandCoverage": {
+            "description": "Originations whose neighborhood carries an income band — the denominator of `lowModIncomeTractSharePct`, `middleIncomeTractSharePct` and every `incomeBands[].sharePct`. READ THIS FIRST: roughly a fifth of records carry a band, and a share taken over the full population instead is about 4.5x too low.",
+            "type": "number"
+          },
+          "incomeBands": {
+            "items": {
+              "$ref": "#/components/schemas/MarketCommunityIncomeBand"
+            },
+            "type": "array"
+          },
+          "lowModIncomeTractOriginations": {
+            "type": "number"
+          },
+          "lowModIncomeTractSharePct": {
+            "description": "Share (0-100) of `incomeBandCoverage` originated in a low- or moderate-income neighborhood. Values describe the U.S. Census tract (neighborhood) as a whole — tract-level aggregate statistics, never an individual, household or applicant attribute. Percentages are 0-100.",
+            "nullable": true,
+            "type": "number"
+          },
+          "majorityMinorityTractOriginations": {
+            "type": "number"
+          },
+          "majorityMinorityTractSharePct": {
+            "description": "Share (0-100) of `minorityTractCoverage` originated in a majority-minority neighborhood. Values describe the U.S. Census tract (neighborhood) as a whole — tract-level aggregate statistics, never an individual, household or applicant attribute. Percentages are 0-100.",
+            "nullable": true,
+            "type": "number"
+          },
+          "middleIncomeTractOriginations": {
+            "type": "number"
+          },
+          "middleIncomeTractSharePct": {
+            "description": "Share (0-100) of `incomeBandCoverage` originated in a middle-income neighborhood. Values describe the U.S. Census tract (neighborhood) as a whole — tract-level aggregate statistics, never an individual, household or applicant attribute. Percentages are 0-100.",
+            "nullable": true,
+            "type": "number"
+          },
+          "minorityTractCoverage": {
+            "description": "Originations whose neighborhood carries the majority-minority determination — the denominator of `majorityMinorityTractSharePct` and the population behind `avgMinorityTractPct`. About half of all records; it is a different denominator from `incomeBandCoverage`.",
+            "type": "number"
+          },
+          "originations": {
+            "description": "Originations matched by the filters in this scope.",
+            "type": "number"
+          },
+          "to": {
+            "description": "Bucket end (exclusive), YYYY-MM-DD.",
+            "type": "string"
+          },
+          "underservedMarketOriginations": {
+            "type": "number"
+          },
+          "underservedMarketSharePct": {
+            "description": "Share (0-100) of `originations` in an underserved market.",
+            "nullable": true,
+            "type": "number"
+          }
+        },
+        "required": [
+          "from",
+          "to",
+          "originations",
+          "craEligibleOriginations",
+          "craEligibleCoverage",
+          "craEligibleSharePct",
+          "incomeBandCoverage",
+          "lowModIncomeTractOriginations",
+          "lowModIncomeTractSharePct",
+          "middleIncomeTractOriginations",
+          "middleIncomeTractSharePct",
+          "incomeBands",
+          "majorityMinorityTractOriginations",
+          "minorityTractCoverage",
+          "majorityMinorityTractSharePct",
+          "avgMinorityTractPct",
+          "avgTractIncomeVsMetroPct",
+          "underservedMarketOriginations",
+          "underservedMarketSharePct",
+          "affordableLoanOriginations",
+          "affordableLoanSharePct",
+          "craEligibleAndAffordableOriginations"
         ],
         "type": "object"
       },
@@ -29787,6 +29990,9 @@
           "appraisedValue": {
             "$ref": "#/components/schemas/NumericFilterValue"
           },
+          "borrowerGeneration": {
+            "$ref": "#/components/schemas/TextFilterValue"
+          },
           "channel": {
             "$ref": "#/components/schemas/TextFilterValue"
           },
@@ -29825,12 +30031,18 @@
           "creditScore": {
             "$ref": "#/components/schemas/NumericFilterValue"
           },
+          "currentHomeOwner": {
+            "$ref": "#/components/schemas/BooleanFilterValue"
+          },
           "dti": {
             "$ref": "#/components/schemas/NumericFilterValue"
           },
           "dtifront": {
             "$ref": "#/components/schemas/NumericFilterValue"
           },
+          "firstTimeHomebuyer": {
+            "$ref": "#/components/schemas/BooleanFilterValue"
+          },
           "hmdaActionTaken": {
             "$ref": "#/components/schemas/TextFilterValue"
           },
@@ -29846,6 +30058,9 @@
           "loanPurpose": {
             "$ref": "#/components/schemas/TextFilterValue"
           },
+          "loanStatus": {
+            "$ref": "#/components/schemas/MarketLoanStatus"
+          },
           "loanTerm": {
             "$ref": "#/components/schemas/NumericFilterValue"
           },
@@ -29924,6 +30139,9 @@
           "purchasePrice": {
             "$ref": "#/components/schemas/NumericFilterValue"
           },
+          "selfEmployed": {
+            "$ref": "#/components/schemas/BooleanFilterValue"
+          },
           "state": {
             "$ref": "#/components/schemas/TextFilterValue"
           },
@@ -29937,6 +30155,9 @@
               }
             ]
           },
+          "veteranIndicator": {
+            "$ref": "#/components/schemas/BooleanFilterValue"
+          },
           "zip": {
             "$ref": "#/components/schemas/TextFilterValue"
           }
@@ -30009,6 +30230,50 @@
         ],
         "type": "object"
       },
+      "MarketLoanStatus": {
+        "anyOf": [
+          {
+            "description": "One of (case-insensitive): funded, purchased, not_funded, pending",
+            "enum": [
+              "funded",
+              "purchased",
+              "not_funded",
+              "pending"
+            ],
+            "type": "string"
+          },
+          {
+            "description": "Match any of these values",
+            "items": {
+              "description": "One of (case-insensitive): funded, purchased, not_funded, pending",
+              "enum": [
+                "funded",
+                "purchased",
+                "not_funded",
+                "pending"
+              ],
+              "type": "string"
+            },
+            "type": "array"
+          },
+          {
+            "description": "Fuzzy text match",
+            "properties": {
+              "match": {
+                "type": "string"
+              }
+            },
+            "required": [
+              "match"
+            ],
+            "type": "object"
+          },
+          {
+            "nullable": true
+          }
+        ],
+        "description": "HMDA action, else funding/denial/lock date evidence."
+      },
       "MarketMeasure": {
         "description": "Which metric to compute. Every field-backed measure is sentinel-guarded: the source encodes unknown values as an out-of-range fill, so values outside the measure's plausible range are dropped before it is aggregated. Ranges: `volume` 0–100,000,000; `avgRate` 0–25; `avgLoanAmount` 0–100,000,000; `avgCreditScore` 300–850; `avgLTV` 0–999; `avgDTI` 0–999; `avgIncome` 0–100,000,000; `avgAppraisedValue` 0–100,000,000; `avgPurchasePrice` 0–100,000,000; `avgDtiFront` 0–999; `avgCombinedLtv` 0–999; `avgLoanTerm` 0–1,200; `originatedVolume` 0–100,000,000; `originatedAvgDti` 0–100. `units` and `originatedUnits` are document counts and are not guarded. Each response reports how many documents its guard excluded, so a mean taken over 98% of the data can be told apart from one taken over 60%. NOTE on population: `units` and `volume` cover loan APPLICATIONS of every outcome — denials, withdrawals and secondary-market purchases included — and so does `avgDTI`, while `originatedUnits`, `originatedVolume` and `originatedAvgDti` cover originations only.",
         "enum": [
@@ -44471,7 +44736,7 @@
   "info": {
     "description": "ModelMatch API — mortgage and real-estate market data.\n\n## Bulk delivery limits\n\nThe `POST /{entity}/bulk-delivery` endpoints export a full result set to\nS3 as NDJSON, JSON, CSV, or Parquet.\n\n- **Up to 5,000 rows per delivery: no entitlement required.** Available to\n  every authenticated caller.\n- **Above 5,000 rows: requires the entity's `bulk-delivery.{entity}`\n  entitlement** (e.g. `bulk-delivery.loans`). The grant's scope sets your\n  row ceiling and may also restrict which rows and fields you receive.\n\nA delivery that would exceed the limit available to you is rejected with\n`403 entitlement_missing`, reporting the matched row count and the ceiling\nthat applied. To stay under the limit, pass `limit` — the job then delivers\n(and bills for) only the first `limit` rows of a broader query.\n\n**Need a higher limit?** Email support@modelmatch.com to request the\nentitlement. Limits are raised per organization and per entity.\n\nBulk delivery is billed at 1 credit per delivered row whether or not\nan entitlement is held.\n\nInstead of a download, a delivery can be sent to a push target configured\non your workspace: pass `destination: { type: \"push-target\", targetId }`.\nThe same limits and billing apply.",
     "title": "ModelMatch API",
-    "version": "3.120.0"
+    "version": "3.122.0"
   },
   "openapi": "3.1.0",
   "paths": {

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@model-match/api",
-	"version": "3.54.0",
+	"version": "3.56.0",
 	"description": "TypeScript client for the ModelMatch API",
 	"license": "MIT",
 	"files": [