@model-match/api 3.31.1 → 3.32.0

package/openapi.json

@@ -11804,6 +11804,47 @@
           }
         ]
       },
+      "BranchCrmListFilter": {
+        "additionalProperties": false,
+        "description": "Scope the result to the caller's CRM. Resolved against the caller's ACTIVE WORKSPACE at query time — list membership is read server-side, so the request never carries member ids. Only branch members count; people, companies, offices and manual (unlinked) records on the same list are ignored. `mode: \"in\"` with no matching members returns an empty page (not an unfiltered one). Errors: 400 `crm_list_requires_workspace` when the caller has no active workspace (API-key / OAuth callers must select an organization), 403 / 404 when a named list is not visible to the caller or does not exist, and 400 `crm_list_too_large` when the selected lists hold more than 50,000 branches in total — narrow the selection rather than get a silently partial answer.",
+        "properties": {
+          "lists": {
+            "anyOf": [
+              {
+                "description": "Every list in the caller's workspace that the caller can see (own, org-wide, or shared with them) and that holds this kind of record — People lists for originators and agents, Company lists for companies.",
+                "enum": [
+                  "any"
+                ],
+                "type": "string"
+              },
+              {
+                "description": "Specific CRM list ids (1–50).",
+                "items": {
+                  "minLength": 1,
+                  "type": "string"
+                },
+                "maxItems": 50,
+                "minItems": 1,
+                "type": "array"
+              }
+            ],
+            "description": "Which lists: `\"any\"` for every Company list the caller can see, or an array of list ids. Membership is the UNION across the selected lists."
+          },
+          "mode": {
+            "description": "`in` — only branches who are a member of the selected list(s). `notIn` — exclude every branch who is a member of the selected list(s); everyone else passes, including branches on none of your lists.",
+            "enum": [
+              "in",
+              "notIn"
+            ],
+            "type": "string"
+          }
+        },
+        "required": [
+          "mode",
+          "lists"
+        ],
+        "type": "object"
+      },
       "BranchDetailResponse": {
         "properties": {
           "data": {
@@ -11832,9 +11873,12 @@
           "units",
           "avgLoanAmount",
           "teamSize",
+          "loCount",
           "rosterJoined",
           "rosterLeft",
-          "producersOnly"
+          "producersOnly",
+          "purchaseShare",
+          "refinanceShare"
         ],
         "type": "string"
       },
@@ -12094,6 +12138,16 @@
           "companyType": {
             "$ref": "#/components/schemas/BranchCompanyTypeFilterValue"
           },
+          "county": {
+            "allOf": [
+              {
+                "$ref": "#/components/schemas/TextFilterValue"
+              },
+              {
+                "description": "Branch address COUNTY: a name (`Travis`, with `state` when ambiguous), a 5-digit FIPS (`48453`) or a dictionary county id; an array matches any. Matches when the branch's geocoded address lies inside the county boundary (no geocode = no match). Unknown county = 400."
+              }
+            ]
+          },
           "difficultDevelopmentAreaCount": {
             "allOf": [
               {
@@ -12166,6 +12220,9 @@
           "loCount": {
             "$ref": "#/components/schemas/NumericFilterValue"
           },
+          "loanType": {
+            "$ref": "#/components/schemas/OriginatorLoanTypeFilterValue"
+          },
           "loansWithCommunityData": {
             "allOf": [
               {
@@ -12223,6 +12280,9 @@
             ],
             "type": "string"
           },
+          "msa": {
+            "$ref": "#/components/schemas/BranchMsaFilterValue"
+          },
           "name": {
             "allOf": [
               {
@@ -12230,10 +12290,15 @@
               },
               {
                 "deprecated": true,
-                "description": "DEPRECATED — matches the branch's FULL name exactly (e.g. `Movement Mortgage, LLC, Providence, RI Branch`); a partial name will not match. Resolve via instantSearch and filter by `nmlsId` (exact branch NMLS id) instead."
+                "description": "DEPRECATED — matches the branch's FULL name exactly (e.g. `Movement Mortgage, LLC, Providence, RI Branch`); a partial name will not match. Use `namePrefix` for partial names, or `nmlsId` (exact branch NMLS id)."
               }
             ]
           },
+          "namePrefix": {
+            "description": "Prefix name search: every word must start a word of the name (\"movement prov\" → Movement Mortgage, LLC, Providence, RI Branch; digits = branch NMLS id). No fuzzy/nickname matching; relevance-ranked unless `sort` is set. Max 100 chars / 6 words (emails, URLs, phones ignored), else 400.",
+            "minLength": 1,
+            "type": "string"
+          },
           "nmlsId": {
             "$ref": "#/components/schemas/TextFilterValue"
           },
@@ -12266,6 +12331,9 @@
           "producersOnly": {
             "$ref": "#/components/schemas/BooleanFilterValue"
           },
+          "region": {
+            "$ref": "#/components/schemas/BranchRegionFilterValue"
+          },
           "rosterJoined": {
             "allOf": [
               {
@@ -12329,6 +12397,9 @@
               }
             ]
           },
+          "transactionType": {
+            "$ref": "#/components/schemas/OriginatorTransactionTypeFilterValue"
+          },
           "units": {
             "$ref": "#/components/schemas/NumericFilterValue"
           },
@@ -12377,6 +12448,9 @@
           "advancedFilters": {
             "$ref": "#/components/schemas/FilterNode"
           },
+          "crmList": {
+            "$ref": "#/components/schemas/BranchCrmListFilter"
+          },
           "filters": {
             "$ref": "#/components/schemas/FilterNode"
           },
@@ -12406,10 +12480,13 @@
                 "$ref": "#/components/schemas/Period"
               },
               {
-                "description": "Period for branch production metrics (default: last12Months). Applies to `volume`, `units`, `avgLoanAmount`, `rosterJoined` and `rosterLeft`. It does NOT apply to `teamSize`, which is a current snapshot and reads the same on every period."
+                "description": "Period for branch production metrics (default: last12Months). Applies to `volume`, `units`, `avgLoanAmount`, `rosterJoined`, `rosterLeft` and the loan/transaction-type mix. It does NOT apply to `teamSize`, which is a current snapshot and reads the same on every period."
               }
             ]
           },
+          "productMix": {
+            "$ref": "#/components/schemas/BranchProductMixFilter"
+          },
           "sort": {
             "items": {
               "properties": {
@@ -12426,6 +12503,9 @@
               "type": "object"
             },
             "type": "array"
+          },
+          "transactionMix": {
+            "$ref": "#/components/schemas/BranchTransactionMixFilter"
           }
         },
         "type": "object"
@@ -12471,6 +12551,184 @@
         },
         "type": "object"
       },
+      "BranchMsaFilterValue": {
+        "anyOf": [
+          {
+            "type": "string"
+          },
+          {
+            "items": {
+              "type": "string"
+            },
+            "maxItems": 50,
+            "minItems": 1,
+            "type": "array"
+          },
+          {
+            "nullable": true
+          }
+        ],
+        "description": "Branch address METRO (MSA / CBSA): 5-digit CBSA code (`12420`) or metro name (`Austin Metro`); an array matches any. The address point inside any member county. Unknown/ambiguous = 400 naming candidates."
+      },
+      "BranchProductMixFilter": {
+        "description": "Loan-product share / volume bands for the selected period, ANDed: `[{product:\"fha\", minShare:30}]` = FHA is at least 30% of the branch's period volume; `[{product:\"va\", volume:{gte:5000000}}]` = at least $5M of VA. `products` lets ANY of several types satisfy one entry. Whole-book figures across all markets.",
+        "items": {
+          "additionalProperties": false,
+          "properties": {
+            "basis": {
+              "description": "`volume` (default) or `units` (loan count).",
+              "enum": [
+                "volume",
+                "units"
+              ],
+              "type": "string"
+            },
+            "maxShare": {
+              "description": "Upper bound, 0–100 percent. No bucket = 0% (passes).",
+              "maximum": 100,
+              "minimum": 0,
+              "type": "number"
+            },
+            "minShare": {
+              "description": "Lower bound, 0–100 percent of the period book.",
+              "maximum": 100,
+              "minimum": 0,
+              "type": "number"
+            },
+            "product": {
+              "description": "The loan product. Send this OR `products`, not both.",
+              "enum": [
+                "conventional",
+                "fha",
+                "va",
+                "he",
+                "heloc",
+                "building",
+                "commercial",
+                "stand_alone_refi",
+                "closed_end",
+                "reverse",
+                "usda",
+                "stand_alone_second",
+                "aggregate",
+                "seller_take_back",
+                "sba_participation_trust_deed",
+                "balloon",
+                "opened_end",
+                "assumption",
+                "negative_amortization",
+                "land_contract",
+                "trade",
+                "modification",
+                "unknown"
+              ],
+              "type": "string"
+            },
+            "products": {
+              "description": "Several products, ANY of which may satisfy the bounds on its own (each type's share is read separately, never summed): `{products:[\"fha\",\"va\",\"usda\"], minShare:30}` = FHA, VA or USDA is on its own at least 30% of the book. Send this OR `product`.",
+              "items": {
+                "enum": [
+                  "conventional",
+                  "fha",
+                  "va",
+                  "he",
+                  "heloc",
+                  "building",
+                  "commercial",
+                  "stand_alone_refi",
+                  "closed_end",
+                  "reverse",
+                  "usda",
+                  "stand_alone_second",
+                  "aggregate",
+                  "seller_take_back",
+                  "sba_participation_trust_deed",
+                  "balloon",
+                  "opened_end",
+                  "assumption",
+                  "negative_amortization",
+                  "land_contract",
+                  "trade",
+                  "modification",
+                  "unknown"
+                ],
+                "type": "string"
+              },
+              "maxItems": 10,
+              "minItems": 1,
+              "type": "array"
+            },
+            "volume": {
+              "additionalProperties": false,
+              "description": "Dollar volume of THIS type in the period, `{gte, lte}` — e.g. `{gte: 5000000}` = at least $5M of FHA. Evaluated inside the same type bucket as the share bounds; a branch with no loans of the type does not match.",
+              "properties": {
+                "gte": {
+                  "minimum": 0,
+                  "type": "number"
+                },
+                "lte": {
+                  "minimum": 0,
+                  "type": "number"
+                }
+              },
+              "type": "object"
+            }
+          },
+          "type": "object"
+        },
+        "maxItems": 10,
+        "minItems": 1,
+        "type": "array"
+      },
+      "BranchRegionFilterValue": {
+        "anyOf": [
+          {
+            "enum": [
+              "northeast",
+              "northeast-division-1",
+              "northeast-division-2",
+              "midwest",
+              "midwest-division-3",
+              "midwest-division-4",
+              "south",
+              "south-division-5",
+              "south-division-6",
+              "south-division-7",
+              "west",
+              "west-division-8",
+              "west-division-9"
+            ],
+            "type": "string"
+          },
+          {
+            "items": {
+              "enum": [
+                "northeast",
+                "northeast-division-1",
+                "northeast-division-2",
+                "midwest",
+                "midwest-division-3",
+                "midwest-division-4",
+                "south",
+                "south-division-5",
+                "south-division-6",
+                "south-division-7",
+                "west",
+                "west-division-8",
+                "west-division-9"
+              ],
+              "type": "string"
+            },
+            "maxItems": 50,
+            "minItems": 1,
+            "type": "array"
+          },
+          {
+            "nullable": true
+          }
+        ],
+        "description": "Branch address CENSUS REGION / DIVISION (`<region>-division-<n>`, 1–9) — branches in ANY state of it. An array matches any."
+      },
       "BranchRosterContact": {
         "nullable": true,
         "properties": {
@@ -12823,10 +13081,20 @@
             "nullable": true,
             "type": "number"
           },
+          "purchaseShare": {
+            "description": "Purchase share (0–100) of the period's loan COUNT — what `sort: purchaseShare` orders by. `null` = none (sorts as 0).",
+            "nullable": true,
+            "type": "number"
+          },
           "refinancePct": {
             "nullable": true,
             "type": "number"
           },
+          "refinanceShare": {
+            "description": "Refinance share (0–100) of the period's loan COUNT — what `sort: refinanceShare` orders by. `null` = none (sorts as 0).",
+            "nullable": true,
+            "type": "number"
+          },
           "rosterCount": {
             "description": "Loan officers on this branch's CURRENT licensing roster: registered to this branch location AND holding an active sponsorship or registration. A current snapshot (refreshed weekly), not period-scoped. Null when the roster is not on file. List rows also carry manager NAMES from the same lookup. See POST /v1/branches/{nmlsId}/roster for the people.",
             "nullable": true,
@@ -13509,6 +13777,66 @@
         ],
         "type": "object"
       },
+      "BranchTransactionMixFilter": {
+        "description": "Transaction-type share bands for the selected period, ANDed: `[{transactionType:\"purchase\", minShare:60}]` = purchases are at least 60% of the branch's period volume.",
+        "items": {
+          "additionalProperties": false,
+          "properties": {
+            "basis": {
+              "description": "`volume` (default) or `units` (loan count).",
+              "enum": [
+                "volume",
+                "units"
+              ],
+              "type": "string"
+            },
+            "maxShare": {
+              "description": "Upper bound, 0–100 percent. No bucket = 0% (passes).",
+              "maximum": 100,
+              "minimum": 0,
+              "type": "number"
+            },
+            "minShare": {
+              "description": "Lower bound, 0–100 percent of the period book.",
+              "maximum": 100,
+              "minimum": 0,
+              "type": "number"
+            },
+            "transactionType": {
+              "enum": [
+                "purchase",
+                "refinance",
+                "construction",
+                "equity",
+                "UNKNOWN"
+              ],
+              "type": "string"
+            },
+            "volume": {
+              "additionalProperties": false,
+              "description": "Dollar volume of THIS type in the period, `{gte, lte}` — e.g. `{gte: 5000000}` = at least $5M of FHA. Evaluated inside the same type bucket as the share bounds; a branch with no loans of the type does not match.",
+              "properties": {
+                "gte": {
+                  "minimum": 0,
+                  "type": "number"
+                },
+                "lte": {
+                  "minimum": 0,
+                  "type": "number"
+                }
+              },
+              "type": "object"
+            }
+          },
+          "required": [
+            "transactionType"
+          ],
+          "type": "object"
+        },
+        "maxItems": 10,
+        "minItems": 1,
+        "type": "array"
+      },
       "BreakdownItem": {
         "properties": {
           "company": {
@@ -15686,7 +16014,7 @@
             "description": "Which lists: `\"any\"` for every Company list the caller can see, or an array of list ids. Membership is the UNION across the selected lists."
           },
           "mode": {
-            "description": "`in` — only companies who are a member of the selected list(s). `notIn` — exclude every companie who is a member of the selected list(s); everyone else passes, including companies on none of your lists.",
+            "description": "`in` — only companies who are a member of the selected list(s). `notIn` — exclude every company who is a member of the selected list(s); everyone else passes, including companies on none of your lists.",
             "enum": [
               "in",
               "notIn"
@@ -42973,7 +43301,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.83.1"
+    "version": "3.84.0"
   },
   "openapi": "3.1.0",
   "paths": {

package/package.json

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