@model-match/api 3.55.0 → 3.57.0

package/openapi.json

@@ -216,6 +216,27 @@
         ],
         "type": "object"
       },
+      "AgentAka": {
+        "properties": {
+          "lastTransactionDate": {
+            "nullable": true,
+            "type": "string"
+          },
+          "name": {
+            "type": "string"
+          },
+          "transactions": {
+            "nullable": true,
+            "type": "number"
+          }
+        },
+        "required": [
+          "name",
+          "transactions",
+          "lastTransactionDate"
+        ],
+        "type": "object"
+      },
       "AgentChartMeasure": {
         "default": "units",
         "description": "Which metric each bar reports, AND what the bars are ranked by — the list is ordered by the measure you ask for, descending. Defaults to `units`, so an unqualified \"top originators\" means the busiest; pass `volume` for the biggest by dollars, or an average to rank by that average. Two things to know about the averages specifically. Buckets built from fewer than 5 documents are dropped from an average chart entirely, because a mean says nothing about how many transactions produced it and a single-transaction bucket would otherwise outrank real ones; no floor is applied to `units` or `volume`, where a lone large transaction is a legitimate top bar. And ranking a bucket list by a sub-aggregated average is approximate in the search engine — each shard contributes its own local top-N before they are merged — so treat the ordering of an average chart as indicative near the boundary rather than exact. Every bucket publishes its own `count`, so the sample size behind a value is never implicit.",
@@ -262,6 +283,37 @@
         ],
         "type": "string"
       },
+      "AgentContactEntry": {
+        "properties": {
+          "lastTransactionDate": {
+            "nullable": true,
+            "type": "string"
+          },
+          "transactions": {
+            "nullable": true,
+            "type": "number"
+          },
+          "type": {
+            "enum": [
+              "email",
+              "mobile",
+              "direct",
+              "office"
+            ],
+            "type": "string"
+          },
+          "value": {
+            "type": "string"
+          }
+        },
+        "required": [
+          "value",
+          "type",
+          "transactions",
+          "lastTransactionDate"
+        ],
+        "type": "object"
+      },
       "AgentContacts": {
         "properties": {
           "emails": {
@@ -420,6 +472,20 @@
           },
           {
             "properties": {
+              "akas": {
+                "description": "Name variations recorded on past transactions.",
+                "items": {
+                  "$ref": "#/components/schemas/AgentAka"
+                },
+                "type": "array"
+              },
+              "contactHistory": {
+                "description": "Every email and phone on the record with how often and how recently it was seen (`contacts` without the counters).",
+                "items": {
+                  "$ref": "#/components/schemas/AgentContactEntry"
+                },
+                "type": "array"
+              },
               "contacts": {
                 "$ref": "#/components/schemas/AgentContacts"
               },
@@ -29354,6 +29420,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 +29438,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 +29499,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 +29525,12 @@
           "minorityTractCoverage",
           "majorityMinorityTractSharePct",
           "avgMinorityTractPct",
-          "avgTractIncomeVsMetroPct"
+          "avgTractIncomeVsMetroPct",
+          "underservedMarketOriginations",
+          "underservedMarketSharePct",
+          "affordableLoanOriginations",
+          "affordableLoanSharePct",
+          "craEligibleAndAffordableOriginations"
         ],
         "type": "object"
       },
@@ -29514,18 +29605,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 +29672,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 +29714,125 @@
       },
       "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,
+            "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"
+          },
+          "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"
+          },
+          "underservedMarketOriginations": {
+            "type": "number"
+          },
+          "underservedMarketSharePct": {
+            "description": "Share (0-100) of `originations` in an underserved market.",
+            "nullable": true,
+            "type": "number"
+          }
+        },
+        "required": [
+          "originations",
+          "craEligibleOriginations",
+          "craEligibleCoverage",
+          "craEligibleSharePct",
+          "incomeBandCoverage",
+          "lowModIncomeTractOriginations",
+          "lowModIncomeTractSharePct",
+          "middleIncomeTractOriginations",
+          "middleIncomeTractSharePct",
+          "incomeBands",
+          "majorityMinorityTractOriginations",
+          "minorityTractCoverage",
+          "majorityMinorityTractSharePct",
+          "avgMinorityTractPct",
+          "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,
@@ -29601,6 +29843,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"
@@ -29613,6 +29859,10 @@
             "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"
@@ -29654,9 +29904,23 @@
           "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",
@@ -29671,7 +29935,12 @@
           "minorityTractCoverage",
           "majorityMinorityTractSharePct",
           "avgMinorityTractPct",
-          "avgTractIncomeVsMetroPct"
+          "avgTractIncomeVsMetroPct",
+          "underservedMarketOriginations",
+          "underservedMarketSharePct",
+          "affordableLoanOriginations",
+          "affordableLoanSharePct",
+          "craEligibleAndAffordableOriginations"
         ],
         "type": "object"
       },
@@ -44533,7 +44802,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.121.0"
+    "version": "3.123.0"
   },
   "openapi": "3.1.0",
   "paths": {

package/package.json

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