@model-match/api 3.37.0 → 3.38.0

package/openapi.json

@@ -20955,6 +20955,9 @@
             ],
             "type": "object"
           },
+          "boomerangs": {
+            "$ref": "#/components/schemas/TalentFlowBoomerangs"
+          },
           "departures": {
             "description": "Where this window's exits went: each exit's earliest employer record starting on or after their departure. A partition, like `arrivals`. An exit is a loan officer whose latest record at this company ended inside the window and who holds NO open record there — a complete departure.",
             "properties": {
@@ -20994,6 +20997,9 @@
             ],
             "type": "object"
           },
+          "rubberbands": {
+            "$ref": "#/components/schemas/TalentFlowRubberbands"
+          },
           "truncated": {
             "description": "`true` when the company has more than 100,000 loan officers in scope and only the first 100,000 (by NMLS ID) were counted. `false` means every figure covers the full population.",
             "type": "boolean"
@@ -21006,6 +21012,8 @@
           "window",
           "arrivals",
           "departures",
+          "boomerangs",
+          "rubberbands",
           "truncated"
         ],
         "type": "object"
@@ -38129,12 +38137,12 @@
             "type": "array"
           },
           "scopedUnits": {
-            "description": "The originator's loan count INSIDE the geography this request names, on the same basis as `scopedVolume`. Sortable. When the request names no geography — or names one only inside an `or` group or a negation — the scope is everywhere, and this is identical to the unscoped figure beside it. Reconciles with `POST /v1/originators/{nmlsId}/markets` for the same geography and period: both are read from the same per-market rollup on the same record.",
+            "description": "The originator's loan count INSIDE the geography this request names, on the same basis as `scopedVolume`. Sortable. A single positive `footprint` market (city / county / state / zip, never `lender`) scopes it too; a negated, any-market (`dimension` only) or multi-entry footprint names no single place. When the request names no geography — or names one only inside an `or` group or a negation — the scope is everywhere, and this is identical to the unscoped figure beside it. Reconciles with `POST /v1/originators/{nmlsId}/markets` for the same geography and period: both are read from the same per-market rollup on the same record.",
             "nullable": true,
             "type": "number"
           },
           "scopedVolume": {
-            "description": "The originator's dollar production INSIDE the geography this request names — what a `state`/`city`/`county`/`zip` filter was almost certainly asking for, and what the sibling `volume` is not. Sort by `scopedVolume` to rank originators by it. When the request names no geography — or names one only inside an `or` group or a negation — the scope is everywhere, and this is identical to the unscoped figure beside it. Reconciles with `POST /v1/originators/{nmlsId}/markets` for the same geography and period: both are read from the same per-market rollup on the same record.",
+            "description": "The originator's dollar production INSIDE the geography this request names — what a `state`/`city`/`county`/`zip` filter was almost certainly asking for, and what the sibling `volume` is not. Sort by `scopedVolume` to rank originators by it. A single positive `footprint` market (city / county / state / zip, never `lender`) scopes it too; a negated, any-market (`dimension` only) or multi-entry footprint names no single place. When the request names no geography — or names one only inside an `or` group or a negation — the scope is everywhere, and this is identical to the unscoped figure beside it. Reconciles with `POST /v1/originators/{nmlsId}/markets` for the same geography and period: both are read from the same per-market rollup on the same record.",
             "nullable": true,
             "type": "number"
           },
@@ -39429,12 +39437,12 @@
             "type": "array"
           },
           "scopedUnits": {
-            "description": "The originator's loan count INSIDE the geography this request names, on the same basis as `scopedVolume`. Sortable. When the request names no geography — or names one only inside an `or` group or a negation — the scope is everywhere, and this is identical to the unscoped figure beside it. Reconciles with `POST /v1/originators/{nmlsId}/markets` for the same geography and period: both are read from the same per-market rollup on the same record.",
+            "description": "The originator's loan count INSIDE the geography this request names, on the same basis as `scopedVolume`. Sortable. A single positive `footprint` market (city / county / state / zip, never `lender`) scopes it too; a negated, any-market (`dimension` only) or multi-entry footprint names no single place. When the request names no geography — or names one only inside an `or` group or a negation — the scope is everywhere, and this is identical to the unscoped figure beside it. Reconciles with `POST /v1/originators/{nmlsId}/markets` for the same geography and period: both are read from the same per-market rollup on the same record.",
             "nullable": true,
             "type": "number"
           },
           "scopedVolume": {
-            "description": "The originator's dollar production INSIDE the geography this request names — what a `state`/`city`/`county`/`zip` filter was almost certainly asking for, and what the sibling `volume` is not. Sort by `scopedVolume` to rank originators by it. When the request names no geography — or names one only inside an `or` group or a negation — the scope is everywhere, and this is identical to the unscoped figure beside it. Reconciles with `POST /v1/originators/{nmlsId}/markets` for the same geography and period: both are read from the same per-market rollup on the same record.",
+            "description": "The originator's dollar production INSIDE the geography this request names — what a `state`/`city`/`county`/`zip` filter was almost certainly asking for, and what the sibling `volume` is not. Sort by `scopedVolume` to rank originators by it. A single positive `footprint` market (city / county / state / zip, never `lender`) scopes it too; a negated, any-market (`dimension` only) or multi-entry footprint names no single place. When the request names no geography — or names one only inside an `or` group or a negation — the scope is everywhere, and this is identical to the unscoped figure beside it. Reconciles with `POST /v1/originators/{nmlsId}/markets` for the same geography and period: both are read from the same per-market rollup on the same record.",
             "nullable": true,
             "type": "number"
           },
@@ -40906,6 +40914,23 @@
         ],
         "type": "object"
       },
+      "PropertyBorrower": {
+        "properties": {
+          "firstName": {
+            "nullable": true,
+            "type": "string"
+          },
+          "lastName": {
+            "nullable": true,
+            "type": "string"
+          }
+        },
+        "required": [
+          "firstName",
+          "lastName"
+        ],
+        "type": "object"
+      },
       "PropertyBorrowerStatusFilterValue": {
         "anyOf": [
           {
@@ -41475,7 +41500,15 @@
           "lenderNmls",
           "companyNmls",
           "brokerNmls",
-          "agentUid"
+          "agentUid",
+          "loanRecordedDate",
+          "loanAmount",
+          "loanModeledInterestRate",
+          "loanType",
+          "loanTransactionType",
+          "loanOriginatorName",
+          "loanCompanyName",
+          "loanLenderName"
         ],
         "type": "string"
       },
@@ -41505,6 +41538,23 @@
               }
             ]
           },
+          "agentId": {
+            "anyOf": [
+              {
+                "minLength": 1,
+                "type": "string"
+              },
+              {
+                "items": {
+                  "minLength": 1,
+                  "type": "string"
+                },
+                "minItems": 1,
+                "type": "array"
+              }
+            ],
+            "description": "Agent id(s) (`GET /v1/agents/{id}`): parcels with a recorded sale by the agent."
+          },
           "agentUid": {
             "$ref": "#/components/schemas/TextFilterValue"
           },
@@ -41603,6 +41653,16 @@
               }
             ]
           },
+          "excludeId": {
+            "description": "Parcel ids to exclude — the inverse of `id`.",
+            "items": {
+              "pattern": "^mm_\\S",
+              "type": "string"
+            },
+            "maxItems": 50000,
+            "minItems": 1,
+            "type": "array"
+          },
           "fips": {
             "$ref": "#/components/schemas/TextFilterValue"
           },
@@ -41673,9 +41733,51 @@
               }
             ]
           },
+          "loanCompanyName": {
+            "allOf": [
+              {
+                "$ref": "#/components/schemas/TextFilterValue"
+              },
+              {
+                "description": "Funding-company name on the loan, case-insensitive contains."
+              }
+            ]
+          },
+          "loanCompanyOrLender": {
+            "allOf": [
+              {
+                "$ref": "#/components/schemas/TextFilterValue"
+              },
+              {
+                "description": "NMLS id matched as the loan's funding company OR lender."
+              }
+            ]
+          },
           "loanCount": {
             "$ref": "#/components/schemas/NumericFilterValue"
           },
+          "loanExclude": {
+            "additionalProperties": false,
+            "description": "Loan filters to EXCLUDE — each key negated on its own, under the same `loanMatchMode`. With `\"most_recent\"`, `{loanCompanyOrLender: \"3030\"}` keeps parcels whose newest loan is not from 3030 (no-loan parcels included); `{loanRecordedDate: {lt: \"2017-01-01\"}}` drops newest loans recorded before 2017, keeping parcels with no date.",
+            "properties": {
+              "loanCompany": {
+                "$ref": "#/components/schemas/TextFilterValue"
+              },
+              "loanCompanyName": {
+                "$ref": "#/components/schemas/TextFilterValue"
+              },
+              "loanCompanyOrLender": {
+                "$ref": "#/components/schemas/TextFilterValue"
+              },
+              "loanOriginator": {
+                "$ref": "#/components/schemas/TextFilterValue"
+              },
+              "loanRecordedDate": {
+                "$ref": "#/components/schemas/DateFilterValue"
+              }
+            },
+            "type": "object"
+          },
           "loanInterestRate": {
             "allOf": [
               {
@@ -41706,6 +41808,16 @@
               }
             ]
           },
+          "loanLenderNameContains": {
+            "allOf": [
+              {
+                "$ref": "#/components/schemas/TextFilterValue"
+              },
+              {
+                "description": "Lender name on the loan, case-insensitive contains (`loanLenderName` is the exact / name-family match)."
+              }
+            ]
+          },
           "loanLtv": {
             "allOf": [
               {
@@ -41757,6 +41869,16 @@
               }
             ]
           },
+          "loanOriginatorNameContains": {
+            "allOf": [
+              {
+                "$ref": "#/components/schemas/TextFilterValue"
+              },
+              {
+                "description": "Loan officer name on the loan, case-insensitive contains. Prefer `loanOriginator` (NMLS id)."
+              }
+            ]
+          },
           "loanRecordedDate": {
             "$ref": "#/components/schemas/DateFilterValue"
           },
@@ -41849,6 +41971,31 @@
           "ownerName": {
             "$ref": "#/components/schemas/TextFilterValue"
           },
+          "ownerType": {
+            "anyOf": [
+              {
+                "enum": [
+                  "entity",
+                  "trust",
+                  "individual"
+                ],
+                "type": "string"
+              },
+              {
+                "items": {
+                  "enum": [
+                    "entity",
+                    "trust",
+                    "individual"
+                  ],
+                  "type": "string"
+                },
+                "minItems": 1,
+                "type": "array"
+              }
+            ],
+            "description": "Owner vesting type (any-of); `individual` = neither entity nor trust."
+          },
           "preSaleLoanCount": {
             "allOf": [
               {
@@ -42338,6 +42485,14 @@
                 "field": {
                   "$ref": "#/components/schemas/PropertyField"
                 },
+                "missing": {
+                  "description": "Where rows without a value go (default `last` in both directions). `first` with `asc` / `last` with `desc` treats blanks as the smallest value.",
+                  "enum": [
+                    "first",
+                    "last"
+                  ],
+                  "type": "string"
+                },
                 "order": {
                   "$ref": "#/components/schemas/SortOrder"
                 }
@@ -42398,6 +42553,11 @@
             "nullable": true,
             "type": "string"
           },
+          "companyName": {
+            "description": "Funding-company name as recorded on the loan.",
+            "nullable": true,
+            "type": "string"
+          },
           "companyNmls": {
             "nullable": true,
             "type": "string"
@@ -42516,24 +42676,26 @@
       "PropertyLoanTransactionTypeFilterValue": {
         "anyOf": [
           {
-            "description": "One of (case-insensitive): purchase, refinance, equity, construction",
+            "description": "One of (case-insensitive): purchase, refinance, equity, construction, non_residential",
             "enum": [
               "purchase",
               "refinance",
               "equity",
-              "construction"
+              "construction",
+              "non_residential"
             ],
             "type": "string"
           },
           {
             "description": "Match any of these values",
             "items": {
-              "description": "One of (case-insensitive): purchase, refinance, equity, construction",
+              "description": "One of (case-insensitive): purchase, refinance, equity, construction, non_residential",
               "enum": [
                 "purchase",
                 "refinance",
                 "equity",
-                "construction"
+                "construction",
+                "non_residential"
               ],
               "type": "string"
             },
@@ -42559,22 +42721,36 @@
       "PropertyLoanTypeFilterValue": {
         "anyOf": [
           {
-            "description": "One of (case-insensitive): va, fha, conventional",
+            "description": "One of (case-insensitive): va, fha, conventional, usda, home_equity, heloc, reverse, commercial, building, standalone_refi",
             "enum": [
               "va",
               "fha",
-              "conventional"
+              "conventional",
+              "usda",
+              "home_equity",
+              "heloc",
+              "reverse",
+              "commercial",
+              "building",
+              "standalone_refi"
             ],
             "type": "string"
           },
           {
             "description": "Match any of these values",
             "items": {
-              "description": "One of (case-insensitive): va, fha, conventional",
+              "description": "One of (case-insensitive): va, fha, conventional, usda, home_equity, heloc, reverse, commercial, building, standalone_refi",
               "enum": [
                 "va",
                 "fha",
-                "conventional"
+                "conventional",
+                "usda",
+                "home_equity",
+                "heloc",
+                "reverse",
+                "commercial",
+                "building",
+                "standalone_refi"
               ],
               "type": "string"
             },
@@ -43031,6 +43207,13 @@
             "nullable": true,
             "type": "string"
           },
+          "borrowers": {
+            "description": "Borrowers on the current mortgage (up to two); not the owner of record.",
+            "items": {
+              "$ref": "#/components/schemas/PropertyBorrower"
+            },
+            "type": "array"
+          },
           "city": {
             "nullable": true,
             "type": "string"
@@ -43051,6 +43234,16 @@
             ],
             "type": "object"
           },
+          "countyName": {
+            "description": "County name, lowercase (`\"catawba county\"`).",
+            "nullable": true,
+            "type": "string"
+          },
+          "currentOwnerName": {
+            "description": "The assessor's owner-of-record line as recorded — every owner on title.",
+            "nullable": true,
+            "type": "string"
+          },
           "equity": {
             "$ref": "#/components/schemas/PropertyEquity"
           },
@@ -43110,10 +43303,19 @@
             "nullable": true,
             "type": "string"
           },
+          "ownerMiddleName": {
+            "nullable": true,
+            "type": "string"
+          },
           "ownerName": {
             "nullable": true,
             "type": "string"
           },
+          "ownerOccupied": {
+            "description": "`true` if recorded owner-occupied; `null` = unknown.",
+            "nullable": true,
+            "type": "boolean"
+          },
           "partialBaths": {
             "nullable": true,
             "type": "number"
@@ -43484,6 +43686,24 @@
         ],
         "type": "object"
       },
+      "ReturnerCompany": {
+        "description": "Where they worked while away: the first employer whose record overlaps the gap. Null fields when none is on file.",
+        "properties": {
+          "name": {
+            "nullable": true,
+            "type": "string"
+          },
+          "nmlsId": {
+            "nullable": true,
+            "type": "string"
+          }
+        },
+        "required": [
+          "nmlsId",
+          "name"
+        ],
+        "type": "object"
+      },
       "RosterProductionTier": {
         "properties": {
           "count": {
@@ -45229,6 +45449,114 @@
         ],
         "type": "object"
       },
+      "TalentFlowBoomerang": {
+        "properties": {
+          "leftDate": {
+            "description": "End of the stint at this company before the return.",
+            "type": "string"
+          },
+          "name": {
+            "nullable": true,
+            "type": "string"
+          },
+          "nmlsId": {
+            "type": "string"
+          },
+          "returnedDate": {
+            "description": "Start of the returning stint (inside the window).",
+            "type": "string"
+          },
+          "stillHere": {
+            "description": "Still holds an open record at this company.",
+            "type": "boolean"
+          },
+          "units": {
+            "description": "Loans behind `volume`.",
+            "type": "number"
+          },
+          "volume": {
+            "description": "Production AT THIS company (employer at time of loan = this company) recorded inside the window.",
+            "type": "number"
+          },
+          "wentTo": {
+            "$ref": "#/components/schemas/ReturnerCompany"
+          },
+          "wentToDate": {
+            "nullable": true,
+            "type": "string"
+          }
+        },
+        "required": [
+          "nmlsId",
+          "name",
+          "leftDate",
+          "returnedDate",
+          "stillHere",
+          "wentTo",
+          "wentToDate",
+          "volume",
+          "units"
+        ],
+        "type": "object"
+      },
+      "TalentFlowBoomerangs": {
+        "description": "Window hires who came BACK: an earlier stint here ended (before or inside the window) and a later one starts inside it. Stints merge overlapping license records, so dropping one state license is not a departure. Someone who joined and left inside the window without returning is not one.",
+        "properties": {
+          "data": {
+            "description": "Sorted by volume, most first, then NMLS ID.",
+            "items": {
+              "$ref": "#/components/schemas/TalentFlowBoomerang"
+            },
+            "type": "array"
+          },
+          "dataTruncated": {
+            "description": "`true` when more than 500 matched; `data` is then the 500 with the most volume. `total`, `volume` and `units` cover every one.",
+            "type": "boolean"
+          },
+          "stillHere": {
+            "description": "The subset still at the company.",
+            "properties": {
+              "count": {
+                "type": "number"
+              },
+              "units": {
+                "description": "Loans behind `volume`.",
+                "type": "number"
+              },
+              "volume": {
+                "description": "Production AT THIS company (employer at time of loan = this company) recorded inside the window.",
+                "type": "number"
+              }
+            },
+            "required": [
+              "count",
+              "volume",
+              "units"
+            ],
+            "type": "object"
+          },
+          "total": {
+            "type": "number"
+          },
+          "units": {
+            "description": "Loans behind `volume`.",
+            "type": "number"
+          },
+          "volume": {
+            "description": "Production AT THIS company (employer at time of loan = this company) recorded inside the window.",
+            "type": "number"
+          }
+        },
+        "required": [
+          "total",
+          "volume",
+          "units",
+          "dataTruncated",
+          "stillHere",
+          "data"
+        ],
+        "type": "object"
+      },
       "TalentFlowCompany": {
         "properties": {
           "companyName": {
@@ -45261,6 +45589,98 @@
         ],
         "type": "object"
       },
+      "TalentFlowRubberband": {
+        "properties": {
+          "joinedDate": {
+            "description": "First start at this company among the window-relevant records.",
+            "nullable": true,
+            "type": "string"
+          },
+          "leftDate": {
+            "description": "Complete-departure date.",
+            "type": "string"
+          },
+          "leftPreviousDate": {
+            "description": "When their earlier, pre-window stint at `returnedTo` ended.",
+            "type": "string"
+          },
+          "name": {
+            "nullable": true,
+            "type": "string"
+          },
+          "nmlsId": {
+            "type": "string"
+          },
+          "returnedTo": {
+            "allOf": [
+              {
+                "$ref": "#/components/schemas/ReturnerCompany"
+              },
+              {
+                "description": "The earlier employer they went back to (their next employer)."
+              }
+            ]
+          },
+          "returnedToDate": {
+            "type": "string"
+          },
+          "units": {
+            "description": "Loans behind `volume`.",
+            "type": "number"
+          },
+          "volume": {
+            "description": "Production AT THIS company (employer at time of loan = this company) recorded inside the window.",
+            "type": "number"
+          }
+        },
+        "required": [
+          "nmlsId",
+          "name",
+          "joinedDate",
+          "leftDate",
+          "returnedTo",
+          "returnedToDate",
+          "leftPreviousDate",
+          "volume",
+          "units"
+        ],
+        "type": "object"
+      },
+      "TalentFlowRubberbands": {
+        "description": "Window exits who went BACK: their next employer is one where they hold an ended record that started before the window.",
+        "properties": {
+          "data": {
+            "description": "Sorted by volume, most first, then NMLS ID.",
+            "items": {
+              "$ref": "#/components/schemas/TalentFlowRubberband"
+            },
+            "type": "array"
+          },
+          "dataTruncated": {
+            "description": "`true` when more than 500 matched; `data` is then the 500 with the most volume. `total`, `volume` and `units` cover every one.",
+            "type": "boolean"
+          },
+          "total": {
+            "type": "number"
+          },
+          "units": {
+            "description": "Loans behind `volume`.",
+            "type": "number"
+          },
+          "volume": {
+            "description": "Production AT THIS company (employer at time of loan = this company) recorded inside the window.",
+            "type": "number"
+          }
+        },
+        "required": [
+          "total",
+          "volume",
+          "units",
+          "dataTruncated",
+          "data"
+        ],
+        "type": "object"
+      },
       "TextFilterValue": {
         "anyOf": [
           {
@@ -45720,7 +46140,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.97.0"
+    "version": "3.98.0"
   },
   "openapi": "3.1.0",
   "paths": {

package/package.json

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