@model-match/api 3.22.0 → 3.23.0

package/openapi.json

@@ -4496,6 +4496,11 @@
                   }
                 ]
               },
+              "namePrefix": {
+                "description": "Prefix name search: every word must start a word of the name (\"jen ro\" → Jennifer Rodriguez). 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"
+              },
               "office": {
                 "$ref": "#/components/schemas/TextFilterValue"
               },
@@ -12787,6 +12792,316 @@
         ],
         "type": "object"
       },
+      "CompanyBreakdownRequest": {
+        "additionalProperties": false,
+        "properties": {
+          "advancedFilters": {
+            "$ref": "#/components/schemas/FilterNode"
+          },
+          "filters": {
+            "$ref": "#/components/schemas/FilterNode"
+          },
+          "flatFilters": {
+            "additionalProperties": false,
+            "properties": {
+              "borrowerStatus": {
+                "$ref": "#/components/schemas/LoanBorrowerStatusFilterValue"
+              },
+              "broker": {
+                "allOf": [
+                  {
+                    "$ref": "#/components/schemas/TextFilterValue"
+                  },
+                  {
+                    "description": "Broker shop NMLS id (digits only). A broker is a company — resolve a broker name to its NMLS id via instantSearch (or listCompanies)."
+                  }
+                ]
+              },
+              "buyerEntityType": {
+                "$ref": "#/components/schemas/BooleanFilterValue"
+              },
+              "city": {
+                "$ref": "#/components/schemas/TextFilterValue"
+              },
+              "conforming": {
+                "$ref": "#/components/schemas/BooleanFilterValue"
+              },
+              "county": {
+                "allOf": [
+                  {
+                    "$ref": "#/components/schemas/TextFilterValue"
+                  },
+                  {
+                    "description": "County name (e.g. \"Broward\") or 5-digit FIPS code. Names resolve to FIPS server-side; include a `state` filter to disambiguate."
+                  }
+                ]
+              },
+              "currentBalance": {
+                "allOf": [
+                  {
+                    "$ref": "#/components/schemas/NumericFilterValue"
+                  },
+                  {
+                    "description": "Estimated remaining principal balance (~19% populated). Approximate current equity as `homeValue` (AVM) minus this."
+                  }
+                ]
+              },
+              "employer": {
+                "allOf": [
+                  {
+                    "$ref": "#/components/schemas/TextFilterValue"
+                  },
+                  {
+                    "description": "Employer/company NMLS id (digits only). Resolve a company name to its NMLS id via instantSearch."
+                  }
+                ]
+              },
+              "equity": {
+                "allOf": [
+                  {
+                    "$ref": "#/components/schemas/NumericFilterValue"
+                  },
+                  {
+                    "description": "Point-in-time equity recorded on the loan (sparse, ~10%). NOT a live current-equity figure. For HELOC/cash-out targeting on up-to-date equity, use properties search (listProperties) instead — its equity is far better populated and current."
+                  }
+                ]
+              },
+              "excludeBroker": {
+                "allOf": [
+                  {
+                    "$ref": "#/components/schemas/TextFilterValue"
+                  },
+                  {
+                    "description": "Exclude loans brokered by this broker-shop NMLS id (digits only) — the inverse of `broker`."
+                  }
+                ]
+              },
+              "excludeCity": {
+                "allOf": [
+                  {
+                    "$ref": "#/components/schemas/TextFilterValue"
+                  },
+                  {
+                    "description": "Exclude loans in this city — the inverse of `city`."
+                  }
+                ]
+              },
+              "excludeLender": {
+                "allOf": [
+                  {
+                    "$ref": "#/components/schemas/TextFilterValue"
+                  },
+                  {
+                    "description": "Exclude loans from this lender ID (\"everyone but X\") — the inverse of `lender`, same id contract (resolve via instantSearch/listLenders). Loans with no lender stay in the results."
+                  }
+                ]
+              },
+              "excludeLoanCompany": {
+                "allOf": [
+                  {
+                    "$ref": "#/components/schemas/TextFilterValue"
+                  },
+                  {
+                    "description": "Exclude loans funded by this company NMLS id (digits only) — the inverse of `loanCompany`."
+                  }
+                ]
+              },
+              "excludeOriginator": {
+                "allOf": [
+                  {
+                    "$ref": "#/components/schemas/TextFilterValue"
+                  },
+                  {
+                    "description": "Exclude loans with this originator NMLS id (digits only) — the inverse of `originator`. Common for 'everyone but my own shop' lists."
+                  }
+                ]
+              },
+              "excludeState": {
+                "allOf": [
+                  {
+                    "$ref": "#/components/schemas/TextFilterValue"
+                  },
+                  {
+                    "description": "Exclude loans in this state (2-letter code, e.g. \"CA\") — the inverse of `state`. For \"everywhere but this state\" lists."
+                  }
+                ]
+              },
+              "excludeZipCode": {
+                "allOf": [
+                  {
+                    "$ref": "#/components/schemas/TextFilterValue"
+                  },
+                  {
+                    "description": "Exclude loans in this ZIP code — the inverse of `zipCode`."
+                  }
+                ]
+              },
+              "fips": {
+                "allOf": [
+                  {
+                    "$ref": "#/components/schemas/TextFilterValue"
+                  },
+                  {
+                    "description": "Exact 5-digit county FIPS code (no name resolution) — the code-only escape hatch alongside `county`."
+                  }
+                ]
+              },
+              "geoPoint": {
+                "$ref": "#/components/schemas/GeoFilterValue"
+              },
+              "homeValue": {
+                "allOf": [
+                  {
+                    "$ref": "#/components/schemas/NumericFilterValue"
+                  },
+                  {
+                    "description": "AVM (automated valuation) at the linked property (~26%, MLS-linked). Pair with `currentBalance` to approximate current equity."
+                  }
+                ]
+              },
+              "includeUnknownOriginator": {
+                "allOf": [
+                  {
+                    "$ref": "#/components/schemas/BooleanFilterValue"
+                  },
+                  {
+                    "description": "Include loans that have no originator NMLS id. Omitted/false (default): such loans are excluded — the vast majority are pre-2016 public records with no linkable originator. true: include them. Note that the default scopes results to loans with a known originator (~2016+ recordings)."
+                  }
+                ]
+              },
+              "interestRate": {
+                "$ref": "#/components/schemas/NumericFilterValue"
+              },
+              "lender": {
+                "allOf": [
+                  {
+                    "$ref": "#/components/schemas/TextFilterValue"
+                  },
+                  {
+                    "description": "Lender ID — the normalized lender-dictionary key, NOT a fuzzy name match. Resolve a lender via instantSearch (or listLenders) and pass the `id` it returns (e.g. \"mortgage_rocket\" or \"mortgage rocket\"). Underscores and letter case are normalized, so either id surface works. A stored normalized lender name (what the `slice: \"lender\"` chart buckets emit) is also accepted, so a chart bucket key filters directly. A value that is neither returns 400 rather than silently matching nothing — to search by lender NAME, use `lenderName`."
+                  }
+                ]
+              },
+              "lenderName": {
+                "allOf": [
+                  {
+                    "$ref": "#/components/schemas/TextFilterValue"
+                  },
+                  {
+                    "description": "Lender name as recorded on the loan document — fuzzy, all-terms match (e.g. \"Fifth Third\"). The name counterpart to the exact-id `lender` filter; use `lender` when you have a resolved id, and this when you only have a name."
+                  }
+                ]
+              },
+              "loanCompany": {
+                "allOf": [
+                  {
+                    "$ref": "#/components/schemas/TextFilterValue"
+                  },
+                  {
+                    "description": "Funding/loan company NMLS id (digits only). Resolve a company name to its NMLS id via instantSearch."
+                  }
+                ]
+              },
+              "loanType": {
+                "$ref": "#/components/schemas/LoanTypeFilterValue"
+              },
+              "ltvAtOrigination": {
+                "allOf": [
+                  {
+                    "$ref": "#/components/schemas/NumericFilterValue"
+                  },
+                  {
+                    "description": "Loan-to-value at ORIGINATION (sparse), as a PERCENT on a 0-100 scale (`80` = 80% LTV; values above 100 are real underwater loans). This is not a current LTV — there is no stored current-LTV field on loans."
+                  }
+                ]
+              },
+              "mode": {
+                "enum": [
+                  "and",
+                  "or"
+                ],
+                "type": "string"
+              },
+              "mortgageAmount": {
+                "$ref": "#/components/schemas/NumericFilterValue"
+              },
+              "mortgageDate": {
+                "$ref": "#/components/schemas/DateFilterValue"
+              },
+              "originator": {
+                "allOf": [
+                  {
+                    "$ref": "#/components/schemas/TextFilterValue"
+                  },
+                  {
+                    "description": "Loan originator NMLS id (digits only). To search by name use `originatorName`, or resolve a name to its id via instantSearch."
+                  }
+                ]
+              },
+              "originatorName": {
+                "allOf": [
+                  {
+                    "$ref": "#/components/schemas/TextFilterValue"
+                  },
+                  {
+                    "deprecated": true,
+                    "description": "DEPRECATED — fuzzy name matching is unreliable (same originator can return wildly different counts by name string). Resolve the loan officer via instantSearch and filter by `originator` (exact NMLS id) instead. Still functional for now."
+                  }
+                ]
+              },
+              "propertyId": {
+                "allOf": [
+                  {
+                    "$ref": "#/components/schemas/TextFilterValue"
+                  },
+                  {
+                    "description": "Parcel id — returns every loan recorded against one property. Pass the same string this endpoint returns as `mmPropertyId` on a loan row, or the `mmPropertyId` of a property record.\n\nThis is the parcel's FULL recorded loan history, which is deliberately wider than the loans embedded on a property record: that embed is a snapshot of what is still owed (up to five currently-active loans), so paid-off mortgages are absent from it and present here.\n\nMulti-unit caveat: loans carry a unit-blind parcel id, so for one unit of a multi-unit building this selects every unit in the building, not that unit alone."
+                  }
+                ]
+              },
+              "saleDate": {
+                "$ref": "#/components/schemas/DateFilterValue"
+              },
+              "salePrice": {
+                "$ref": "#/components/schemas/NumericFilterValue"
+              },
+              "state": {
+                "$ref": "#/components/schemas/TextFilterValue"
+              },
+              "transactionType": {
+                "$ref": "#/components/schemas/LoanTransactionTypeFilterValue"
+              },
+              "zip": {
+                "allOf": [
+                  {
+                    "$ref": "#/components/schemas/TextFilterValue"
+                  },
+                  {
+                    "description": "Alias of `zipCode` — same ZIP filter, accepted for cross-entity key parity."
+                  }
+                ]
+              },
+              "zipCode": {
+                "$ref": "#/components/schemas/TextFilterValue"
+              }
+            },
+            "type": "object"
+          },
+          "pagination": {
+            "$ref": "#/components/schemas/Pagination"
+          },
+          "period": {
+            "$ref": "#/components/schemas/DatedPeriod"
+          },
+          "roleScope": {
+            "$ref": "#/components/schemas/CompanyRoleScope"
+          },
+          "sort": {
+            "$ref": "#/components/schemas/BreakdownSort"
+          }
+        },
+        "type": "object"
+      },
       "CompanyChartRequest": {
         "additionalProperties": false,
         "properties": {
@@ -13097,6 +13412,9 @@
           "period": {
             "$ref": "#/components/schemas/Period"
           },
+          "roleScope": {
+            "$ref": "#/components/schemas/CompanyRoleScope"
+          },
           "segment": {
             "allOf": [
               {
@@ -13123,6 +13441,25 @@
           },
           {
             "properties": {
+              "builders": {
+                "description": "Top home builders (up to 10) behind the company's period production — the builder of each sold property, ranked by loan count. Units only (no volume is recorded). Empty when none.",
+                "items": {
+                  "properties": {
+                    "name": {
+                      "type": "string"
+                    },
+                    "units": {
+                      "type": "number"
+                    }
+                  },
+                  "required": [
+                    "name",
+                    "units"
+                  ],
+                  "type": "object"
+                },
+                "type": "array"
+              },
               "communityLending": {
                 "$ref": "#/components/schemas/EntityCommunityLending"
               },
@@ -13445,6 +13782,14 @@
             "nullable": true,
             "type": "string"
           },
+          "companyUnits": {
+            "description": "Loans the loan officer closed while employed here, recorded inside the window. 0 when none.",
+            "type": "number"
+          },
+          "companyVolume": {
+            "description": "Dollar volume the loan officer closed WHILE EMPLOYED HERE (employer at time of loan = this company), recorded inside the window. 0 when none.",
+            "type": "number"
+          },
           "contact": {
             "$ref": "#/components/schemas/EmploymentContact"
           },
@@ -13484,6 +13829,24 @@
           "nmlsId": {
             "type": "string"
           },
+          "previousEmployer": {
+            "description": "The employer whose record ended most recently on or before this loan officer's start here (the same rule `talent-flow` attributes hires by). Both null when none is on file.",
+            "properties": {
+              "name": {
+                "nullable": true,
+                "type": "string"
+              },
+              "nmlsId": {
+                "nullable": true,
+                "type": "string"
+              }
+            },
+            "required": [
+              "nmlsId",
+              "name"
+            ],
+            "type": "object"
+          },
           "startDate": {
             "description": "For current employees, the start of the earliest OPEN record here (current tenure); otherwise the earliest record relevant to the window.",
             "nullable": true,
@@ -13519,6 +13882,9 @@
           "state",
           "volume",
           "units",
+          "companyVolume",
+          "companyUnits",
+          "previousEmployer",
           "contact"
         ],
         "type": "object"
@@ -14065,9 +14431,22 @@
                   }
                 ]
               },
+              "isBroker": {
+                "allOf": [
+                  {
+                    "$ref": "#/components/schemas/BooleanFilterValue"
+                  },
+                  {
+                    "description": "`true`: broker shops — non-bank companies that send more of the period's volume to OTHER lenders than they fund themselves. `false`: everyone else. Computed per period from each company's lender mix. Cannot be combined with `mode: \"or\"`."
+                  }
+                ]
+              },
               "loCount": {
                 "$ref": "#/components/schemas/NumericFilterValue"
               },
+              "loanType": {
+                "$ref": "#/components/schemas/OriginatorLoanTypeFilterValue"
+              },
               "loansWithCommunityData": {
                 "allOf": [
                   {
@@ -14136,6 +14515,11 @@
                   }
                 ]
               },
+              "namePrefix": {
+                "description": "Prefix name search: every word must start a word of the name (\"rock mort\" → Rocket Mortgage). 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"
               },
@@ -14231,6 +14615,9 @@
               "teamSize": {
                 "$ref": "#/components/schemas/NumericFilterValue"
               },
+              "transactionType": {
+                "$ref": "#/components/schemas/OriginatorTransactionTypeFilterValue"
+              },
               "units": {
                 "allOf": [
                   {
@@ -14331,6 +14718,9 @@
           "period": {
             "$ref": "#/components/schemas/Period"
           },
+          "productMix": {
+            "$ref": "#/components/schemas/CompanyProductMixFilter"
+          },
           "sort": {
             "items": {
               "properties": {
@@ -14349,7 +14739,9 @@
                     "loCount",
                     "rosterJoined",
                     "rosterLeft",
-                    "producersOnly"
+                    "producersOnly",
+                    "purchaseShare",
+                    "refinanceShare"
                   ],
                   "type": "string"
                 },
@@ -14363,6 +14755,9 @@
               "type": "object"
             },
             "type": "array"
+          },
+          "transactionMix": {
+            "$ref": "#/components/schemas/CompanyTransactionMixFilter"
           }
         },
         "type": "object"
@@ -15301,6 +15696,69 @@
         ],
         "type": "object"
       },
+      "CompanyProductMixFilter": {
+        "description": "Loan-product share bands for the selected period, ANDed: `[{product:\"fha\", minShare:30}]` = FHA is at least 30% of the company's period volume. Whole-book shares 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": {
+              "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"
+            }
+          },
+          "required": [
+            "product"
+          ],
+          "type": "object"
+        },
+        "maxItems": 10,
+        "minItems": 1,
+        "type": "array"
+      },
       "CompanyRegistration": {
         "nullable": true,
         "properties": {
@@ -15421,8 +15879,20 @@
         },
         "type": "object"
       },
+      "CompanyRoleScope": {
+        "description": "Which of a loan's party roles make it this company's loan. `loanCompany` (default): the company named on the loan document — one company per loan. `all`: the company appears in ANY role — loan-document company, the originating LO's employer at time of loan, the LO's organization, broker, or funding lender; a loan matching several roles counts once. `employer`: the company employed the originating LO when the loan closed. `broker`: the company brokered the loan. `lender`: the company funded the loan. `tpo`: third-party origination — the company is the loan company or lender but did NOT employ the originating LO (the `channel` dimension's `tpo` bucket as a population; `employer` is its `inHouse` counterpart). Use `all` for a broker shop's full production — its loans are often recorded under the funding lender's name, so `loanCompany` undercounts it.",
+        "enum": [
+          "loanCompany",
+          "all",
+          "employer",
+          "broker",
+          "lender",
+          "tpo"
+        ],
+        "type": "string"
+      },
       "CompanySegment": {
-        "description": "Dimension to group by. Most are the loan's own field (`loanType`, `transactionType`, `state`, …). `lender` groups on the normalized lender (label = display name, `id` = filter key). `propertyType` is the recorder's land-use code of the collateral (`SFR` single-family, `PUD` planned unit development, `CND` condo, `RES` residential-other, `MFD` multi-family dwelling, `2ND` second home, `MFG` manufactured, `TWN` townhouse, `LAN` land, `COM` commercial, …); loans with no code are not grouped (≈20% of recent loans). `conforming` splits on the conforming-loan-limit flag: `conforming` vs `nonConforming` (above the county conforming limit — i.e. jumbo, not Non-QM), raw `true`/`false` on `id`. Time-series only: `titleCompany` groups on the title company named on the deed, with spellings of one company merged per bucket (`label` = most-used spelling across the response, `id` = normalized name — match on `id`) and \"none available\"-style placeholders excluded.",
+        "description": "Dimension to group by. Most are the loan's own field (`loanType`, `transactionType`, `state`, …). `lender` groups on the normalized lender (label = display name, `id` = filter key). `propertyType` is the recorder's land-use code of the collateral (`SFR` single-family, `PUD` planned unit development, `CND` condo, `RES` residential-other, `MFD` multi-family dwelling, `2ND` second home, `MFG` manufactured, `TWN` townhouse, `LAN` land, `COM` commercial, …); loans with no code are not grouped (≈20% of recent loans). `conforming` splits on the conforming-loan-limit flag: `conforming` vs `nonConforming` (above the county conforming limit — i.e. jumbo, not Non-QM), raw `true`/`false` on `id`. Time-series only: `titleCompany` groups on the title company named on the deed, with spellings of one company merged per bucket (`label` = most-used spelling across the response, `id` = normalized name — match on `id`) and \"none available\"-style placeholders excluded. `channel` (companies only) splits the company's loans into `inHouse` — the company employed the originating loan officer — and `tpo` — the company is the loan company or funding lender but did NOT employ the LO (third-party origination). The two never overlap; under `roleScope: \"all\"` they need not sum to the total (broker-only and LO-organization-only matches are in neither). Both buckets are always returned.",
         "enum": [
           "transactionType",
           "loanType",
@@ -15433,12 +15903,15 @@
           "lender",
           "propertyType",
           "conforming",
+          "broker",
+          "originator",
+          "channel",
           "titleCompany"
         ],
         "type": "string"
       },
       "CompanySlice": {
-        "description": "Dimension to group by. Most are the loan's own field (`loanType`, `transactionType`, `state`, …). `lender` groups on the normalized lender (label = display name, `id` = filter key). `propertyType` is the recorder's land-use code of the collateral (`SFR` single-family, `PUD` planned unit development, `CND` condo, `RES` residential-other, `MFD` multi-family dwelling, `2ND` second home, `MFG` manufactured, `TWN` townhouse, `LAN` land, `COM` commercial, …); loans with no code are not grouped (≈20% of recent loans). `conforming` splits on the conforming-loan-limit flag: `conforming` vs `nonConforming` (above the county conforming limit — i.e. jumbo, not Non-QM), raw `true`/`false` on `id`.",
+        "description": "Dimension to group by. Most are the loan's own field (`loanType`, `transactionType`, `state`, …). `lender` groups on the normalized lender (label = display name, `id` = filter key). `propertyType` is the recorder's land-use code of the collateral (`SFR` single-family, `PUD` planned unit development, `CND` condo, `RES` residential-other, `MFD` multi-family dwelling, `2ND` second home, `MFG` manufactured, `TWN` townhouse, `LAN` land, `COM` commercial, …); loans with no code are not grouped (≈20% of recent loans). `conforming` splits on the conforming-loan-limit flag: `conforming` vs `nonConforming` (above the county conforming limit — i.e. jumbo, not Non-QM), raw `true`/`false` on `id`. `channel` (companies only) splits the company's loans into `inHouse` — the company employed the originating loan officer — and `tpo` — the company is the loan company or funding lender but did NOT employ the LO (third-party origination). The two never overlap; under `roleScope: \"all\"` they need not sum to the total (broker-only and LO-organization-only matches are in neither). Both buckets are always returned.",
         "enum": [
           "transactionType",
           "loanType",
@@ -15448,7 +15921,10 @@
           "zip",
           "lender",
           "propertyType",
-          "conforming"
+          "conforming",
+          "broker",
+          "originator",
+          "channel"
         ],
         "type": "string"
       },
@@ -16172,6 +16648,16 @@
             "nullable": true,
             "type": "string"
           },
+          "purchaseShare": {
+            "description": "Purchase loans as a 0–100 percent of the company's period loan COUNT — the value `sort: [{field: \"purchaseShare\"}]` orders by. `null` when it made no purchase loans in the period (sorts as 0).",
+            "nullable": true,
+            "type": "number"
+          },
+          "refinanceShare": {
+            "description": "Refinance loans as a 0–100 percent of the company's period loan COUNT — the value `sort: [{field: \"refinanceShare\"}]` orders by. `null` when none (sorts as 0).",
+            "nullable": true,
+            "type": "number"
+          },
           "rosterJoined": {
             "description": "Loan officers who joined the company during the selected period — individuals whose sponsorship with the company began inside the window. IMPORTANT — this counts LICENSING EVENTS, not confirmed employer moves. A loan officer holds a separate license record for every state they are sponsored in, and this counts each individual whose sponsorship began or ended inside the window, so a single added or lapsed state license registers as an arrival or a departure even when the person's employment did not change. Measured on large lenders: 13-24% of a 12-month `rosterLeft` are still sponsored by the same employer today, and 33-50% of a 12-month `rosterJoined` were already sponsored by it before the window began. Treat both as directional indicators of movement, not as headcounts. `rosterJoined` and `rosterLeft` are measured from the same source on the same window basis, so unlike the retired `loLoss` — which had no arrivals figure computed the same way — the two can legitimately be combined into a churn rate. Both also grow with the window, so a longer period reports more than a shorter one and the periods are comparable in that direction.",
             "nullable": true,
@@ -16526,6 +17012,9 @@
           },
           "period": {
             "$ref": "#/components/schemas/Period"
+          },
+          "roleScope": {
+            "$ref": "#/components/schemas/CompanyRoleScope"
           }
         },
         "type": "object"
@@ -16551,11 +17040,21 @@
               "unattributed": {
                 "description": "Hires with no earlier employer on file that ended by their start date — typically new to the industry.",
                 "type": "number"
+              },
+              "units": {
+                "description": "Loans behind `volume`.",
+                "type": "number"
+              },
+              "volume": {
+                "description": "Every mover on this side's production AT THIS company (employer at time of loan = this company) recorded inside the window — volume gained (arrivals) / lost (departures). Includes unattributed movers.",
+                "type": "number"
               }
             },
             "required": [
               "total",
               "unattributed",
+              "volume",
+              "units",
               "companies",
               "companiesTruncated"
             ],
@@ -16580,11 +17079,21 @@
               "unattributed": {
                 "description": "Exits with no later employer on file — not re-employed yet, or left the industry.",
                 "type": "number"
+              },
+              "units": {
+                "description": "Loans behind `volume`.",
+                "type": "number"
+              },
+              "volume": {
+                "description": "Every mover on this side's production AT THIS company (employer at time of loan = this company) recorded inside the window — volume gained (arrivals) / lost (departures). Includes unattributed movers.",
+                "type": "number"
               }
             },
             "required": [
               "total",
               "unattributed",
+              "volume",
+              "units",
               "companies",
               "companiesTruncated"
             ],
@@ -16919,12 +17428,60 @@
           "period": {
             "$ref": "#/components/schemas/Period"
           },
+          "roleScope": {
+            "$ref": "#/components/schemas/CompanyRoleScope"
+          },
           "segment": {
             "$ref": "#/components/schemas/CompanySegment"
           }
         },
         "type": "object"
       },
+      "CompanyTransactionMixFilter": {
+        "description": "Transaction-type share bands for the selected period, ANDed: `[{transactionType:\"purchase\", minShare:60}]` = purchases are at least 60% of the company'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"
+            }
+          },
+          "required": [
+            "transactionType"
+          ],
+          "type": "object"
+        },
+        "maxItems": 10,
+        "minItems": 1,
+        "type": "array"
+      },
       "CompanyTypeFilterValue": {
         "anyOf": [
           {
@@ -31911,6 +32468,11 @@
                   }
                 ]
               },
+              "namePrefix": {
+                "description": "Prefix name search: every word must start a word of the name (\"jen ro\" → Jennifer Rodriguez). 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"
               },
@@ -39089,12 +39651,22 @@
           "count": {
             "description": "Loan officers attributed.",
             "type": "number"
+          },
+          "units": {
+            "description": "Loans behind `volume`.",
+            "type": "number"
+          },
+          "volume": {
+            "description": "Those loan officers' production AT THIS company (employer at time of loan = this company) recorded inside the window.",
+            "type": "number"
           }
         },
         "required": [
           "companyNmlsId",
           "companyName",
-          "count"
+          "count",
+          "volume",
+          "units"
         ],
         "type": "object"
       },
@@ -39557,7 +40129,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.74.0"
+    "version": "3.75.0"
   },
   "openapi": "3.1.0",
   "paths": {
@@ -47018,7 +47590,7 @@
           "content": {
             "application/json": {
               "schema": {
-                "$ref": "#/components/schemas/BreakdownRequest"
+                "$ref": "#/components/schemas/CompanyBreakdownRequest"
               }
             }
           }
@@ -47110,7 +47682,7 @@
           "content": {
             "application/json": {
               "schema": {
-                "$ref": "#/components/schemas/BreakdownRequest"
+                "$ref": "#/components/schemas/CompanyBreakdownRequest"
               }
             }
           }
@@ -47202,7 +47774,7 @@
           "content": {
             "application/json": {
               "schema": {
-                "$ref": "#/components/schemas/BreakdownRequest"
+                "$ref": "#/components/schemas/CompanyBreakdownRequest"
               }
             }
           }
@@ -47294,7 +47866,7 @@
           "content": {
             "application/json": {
               "schema": {
-                "$ref": "#/components/schemas/BreakdownRequest"
+                "$ref": "#/components/schemas/CompanyBreakdownRequest"
               }
             }
           }
@@ -47386,7 +47958,7 @@
           "content": {
             "application/json": {
               "schema": {
-                "$ref": "#/components/schemas/BreakdownRequest"
+                "$ref": "#/components/schemas/CompanyBreakdownRequest"
               }
             }
           }
@@ -47478,7 +48050,7 @@
           "content": {
             "application/json": {
               "schema": {
-                "$ref": "#/components/schemas/BreakdownRequest"
+                "$ref": "#/components/schemas/CompanyBreakdownRequest"
               }
             }
           }
@@ -47570,7 +48142,7 @@
           "content": {
             "application/json": {
               "schema": {
-                "$ref": "#/components/schemas/BreakdownRequest"
+                "$ref": "#/components/schemas/CompanyBreakdownRequest"
               }
             }
           }
@@ -47662,7 +48234,7 @@
           "content": {
             "application/json": {
               "schema": {
-                "$ref": "#/components/schemas/BreakdownRequest"
+                "$ref": "#/components/schemas/CompanyBreakdownRequest"
               }
             }
           }
@@ -47755,7 +48327,7 @@
           "content": {
             "application/json": {
               "schema": {
-                "$ref": "#/components/schemas/BreakdownRequest"
+                "$ref": "#/components/schemas/CompanyBreakdownRequest"
               }
             }
           }
@@ -47847,7 +48419,7 @@
           "content": {
             "application/json": {
               "schema": {
-                "$ref": "#/components/schemas/BreakdownRequest"
+                "$ref": "#/components/schemas/CompanyBreakdownRequest"
               }
             }
           }
@@ -48300,30 +48872,32 @@
             }
           },
           {
-            "description": "Sort key (default `name`). `volume`/`units` rank by the loan officer's production in `period` across all employers.",
+            "description": "Sort key (default `name`). `volume`/`units` rank by the loan officer's production in `period` across all employers; `companyVolume`/`companyUnits` by their production AT this company inside the window.",
             "in": "query",
             "name": "sort",
             "required": false,
             "schema": {
-              "description": "Sort key (default `name`). `volume`/`units` rank by the loan officer's production in `period` across all employers.",
+              "description": "Sort key (default `name`). `volume`/`units` rank by the loan officer's production in `period` across all employers; `companyVolume`/`companyUnits` by their production AT this company inside the window.",
               "enum": [
                 "name",
                 "nmlsId",
                 "startDate",
                 "exitDate",
                 "volume",
-                "units"
+                "units",
+                "companyVolume",
+                "companyUnits"
               ],
               "type": "string"
             }
           },
           {
-            "description": "Default `asc` for text/date keys, `desc` for volume/units.",
+            "description": "Default `asc` for text/date keys, `desc` for the production keys.",
             "in": "query",
             "name": "order",
             "required": false,
             "schema": {
-              "description": "Default `asc` for text/date keys, `desc` for volume/units.",
+              "description": "Default `asc` for text/date keys, `desc` for the production keys.",
               "enum": [
                 "asc",
                 "desc"