@model-match/api 3.53.0 → 3.55.0

package/openapi.json

@@ -262,6 +262,56 @@
         ],
         "type": "string"
       },
+      "AgentContacts": {
+        "properties": {
+          "emails": {
+            "items": {
+              "type": "string"
+            },
+            "type": "array"
+          },
+          "phones": {
+            "items": {
+              "properties": {
+                "number": {
+                  "type": "string"
+                },
+                "type": {
+                  "enum": [
+                    "mobile",
+                    "direct",
+                    "office"
+                  ],
+                  "type": "string"
+                }
+              },
+              "required": [
+                "number",
+                "type"
+              ],
+              "type": "object"
+            },
+            "type": "array"
+          },
+          "socialLinks": {
+            "items": {
+              "type": "string"
+            },
+            "type": "array"
+          },
+          "website": {
+            "nullable": true,
+            "type": "string"
+          }
+        },
+        "required": [
+          "emails",
+          "phones",
+          "website",
+          "socialLinks"
+        ],
+        "type": "object"
+      },
       "AgentCountyFilterValue": {
         "anyOf": [
           {
@@ -370,6 +420,9 @@
           },
           {
             "properties": {
+              "contacts": {
+                "$ref": "#/components/schemas/AgentContacts"
+              },
               "licenses": {
                 "items": {
                   "$ref": "#/components/schemas/AgentLicense"
@@ -390,6 +443,12 @@
                 "nullable": true,
                 "type": "array"
               },
+              "offices": {
+                "items": {
+                  "$ref": "#/components/schemas/AgentOfficeEntry"
+                },
+                "type": "array"
+              },
               "scored": {
                 "nullable": true
               }
@@ -1051,6 +1110,18 @@
             ],
             "description": "Scoped lender filter(s). Each entry names ONE financing relationship and the metric bounds that must hold INSIDE it — `{lender:'<id>', volume:{gte:10000000}}` means '$10M of their sales were financed by that lender', not '$10M of sales and one deal with them'. Several entries AND together. Geographic market filters are not available here: use `POST /v1/agents/{id}/markets` (live-aggregated) for an agent's geography."
           },
+          "include": {
+            "description": "Opt-in row blocks.",
+            "items": {
+              "enum": [
+                "contacts",
+                "offices",
+                "loanMix"
+              ],
+              "type": "string"
+            },
+            "type": "array"
+          },
           "lenderFilters": {
             "items": {
               "$ref": "#/components/schemas/LenderFilterEntry"
@@ -1125,7 +1196,7 @@
           },
           "data": {
             "items": {
-              "$ref": "#/components/schemas/AgentSummary"
+              "$ref": "#/components/schemas/AgentListRow"
             },
             "type": "array"
           },
@@ -1146,6 +1217,140 @@
         ],
         "type": "object"
       },
+      "AgentListRow": {
+        "properties": {
+          "avgSoldPrice": {
+            "nullable": true,
+            "type": "number"
+          },
+          "buyerUnits": {
+            "nullable": true,
+            "type": "number"
+          },
+          "buyerVolume": {
+            "nullable": true,
+            "type": "number"
+          },
+          "city": {
+            "nullable": true,
+            "type": "string"
+          },
+          "contacts": {
+            "$ref": "#/components/schemas/AgentContacts"
+          },
+          "dualUnits": {
+            "nullable": true,
+            "type": "number"
+          },
+          "dualVolume": {
+            "nullable": true,
+            "type": "number"
+          },
+          "email": {
+            "nullable": true,
+            "type": "string"
+          },
+          "firstName": {
+            "nullable": true,
+            "type": "string"
+          },
+          "fullName": {
+            "nullable": true,
+            "type": "string"
+          },
+          "id": {
+            "description": "Document ID",
+            "type": "string"
+          },
+          "lastName": {
+            "nullable": true,
+            "type": "string"
+          },
+          "licenseNumber": {
+            "nullable": true,
+            "type": "string"
+          },
+          "loanMix": {
+            "items": {
+              "$ref": "#/components/schemas/AgentLoanMixEntry"
+            },
+            "type": "array"
+          },
+          "modelMatchId": {
+            "nullable": true,
+            "type": "string"
+          },
+          "office": {
+            "nullable": true,
+            "type": "string"
+          },
+          "offices": {
+            "items": {
+              "$ref": "#/components/schemas/AgentOfficeEntry"
+            },
+            "type": "array"
+          },
+          "phone": {
+            "nullable": true,
+            "type": "string"
+          },
+          "sellerUnits": {
+            "nullable": true,
+            "type": "number"
+          },
+          "sellerVolume": {
+            "nullable": true,
+            "type": "number"
+          },
+          "state": {
+            "nullable": true,
+            "type": "string"
+          },
+          "totalCompaniesWorkedWith": {
+            "nullable": true,
+            "type": "number"
+          },
+          "totalLendersWorkedWith": {
+            "nullable": true,
+            "type": "number"
+          },
+          "totalOriginatorsWorkedWith": {
+            "nullable": true,
+            "type": "number"
+          },
+          "units": {
+            "nullable": true,
+            "type": "number"
+          },
+          "volume": {
+            "nullable": true,
+            "type": "number"
+          },
+          "zip": {
+            "nullable": true,
+            "type": "string"
+          }
+        },
+        "required": [
+          "id"
+        ],
+        "type": "object"
+      },
+      "AgentLoanMixEntry": {
+        "properties": {
+          "key": {
+            "type": "string"
+          },
+          "volume": {
+            "type": "number"
+          }
+        },
+        "required": [
+          "key",
+          "volume"
+        ],
+        "type": "object"
+      },
       "AgentLoanMixRequest": {
         "additionalProperties": false,
         "properties": {
@@ -2665,6 +2870,63 @@
         "minItems": 1,
         "type": "array"
       },
+      "AgentOfficeEntry": {
+        "properties": {
+          "city": {
+            "nullable": true,
+            "type": "string"
+          },
+          "key": {
+            "nullable": true,
+            "type": "string"
+          },
+          "lastTransactionDate": {
+            "nullable": true,
+            "type": "string"
+          },
+          "lat": {
+            "nullable": true,
+            "type": "number"
+          },
+          "lon": {
+            "nullable": true,
+            "type": "number"
+          },
+          "name": {
+            "nullable": true,
+            "type": "string"
+          },
+          "state": {
+            "nullable": true,
+            "type": "string"
+          },
+          "street": {
+            "nullable": true,
+            "type": "string"
+          },
+          "transactions": {
+            "nullable": true,
+            "type": "number"
+          },
+          "zip": {
+            "nullable": true,
+            "type": "string"
+          }
+        },
+        "required": [
+          "key",
+          "name",
+          "street",
+          "city",
+          "state",
+          "zip",
+          "lat",
+          "lon",
+          "lastTransactionDate",
+          "transactions"
+        ],
+        "type": "object"
+      },
       "AgentOfficeGroup": {
         "properties": {
           "entries": {
@@ -29525,6 +29787,9 @@
           "appraisedValue": {
             "$ref": "#/components/schemas/NumericFilterValue"
           },
+          "borrowerGeneration": {
+            "$ref": "#/components/schemas/TextFilterValue"
+          },
           "channel": {
             "$ref": "#/components/schemas/TextFilterValue"
           },
@@ -29563,12 +29828,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"
           },
@@ -29584,6 +29855,9 @@
           "loanPurpose": {
             "$ref": "#/components/schemas/TextFilterValue"
           },
+          "loanStatus": {
+            "$ref": "#/components/schemas/MarketLoanStatus"
+          },
           "loanTerm": {
             "$ref": "#/components/schemas/NumericFilterValue"
           },
@@ -29662,6 +29936,9 @@
           "purchasePrice": {
             "$ref": "#/components/schemas/NumericFilterValue"
           },
+          "selfEmployed": {
+            "$ref": "#/components/schemas/BooleanFilterValue"
+          },
           "state": {
             "$ref": "#/components/schemas/TextFilterValue"
           },
@@ -29675,6 +29952,9 @@
               }
             ]
           },
+          "veteranIndicator": {
+            "$ref": "#/components/schemas/BooleanFilterValue"
+          },
           "zip": {
             "$ref": "#/components/schemas/TextFilterValue"
           }
@@ -29747,6 +30027,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": [
@@ -44209,7 +44533,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.119.1"
+    "version": "3.121.0"
   },
   "openapi": "3.1.0",
   "paths": {

package/package.json

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