@model-match/api 3.11.0 → 3.13.0

package/openapi.json

@@ -21720,7 +21720,7 @@
                 "type": "number"
               },
               "truncated": {
-                "description": "True when more movers matched than the analysis scans; the tiers describe a subset.",
+                "description": "Always false: every mover in the window is analyzed. Kept for compatibility.",
                 "type": "boolean"
               }
             },
@@ -21892,7 +21892,7 @@
             "type": "number"
           },
           "volumeTruncated": {
-            "description": "True when the ranked side exceeded the per-company roster cap and `volume`/`units` cover a subset.",
+            "description": "Always false: `volume`/`units` cover every loan officer on the ranked side. Kept for compatibility.",
             "type": "boolean"
           }
         },
@@ -21909,6 +21909,27 @@
         ],
         "type": "object"
       },
+      "MovementComputing": {
+        "description": "The result is not ready within the response budget (25 s). The computation continues and is cached when done — repeat the identical request after `retryAfterMs` until it answers 200. Identical concurrent requests share one computation.",
+        "properties": {
+          "retryAfterMs": {
+            "description": "Suggested wait before repeating the SAME request (also sent as `Retry-After`, in seconds).",
+            "example": 5000,
+            "type": "integer"
+          },
+          "status": {
+            "enum": [
+              "computing"
+            ],
+            "type": "string"
+          }
+        },
+        "required": [
+          "status",
+          "retryAfterMs"
+        ],
+        "type": "object"
+      },
       "MovementMover": {
         "properties": {
           "city": {
@@ -21996,6 +22017,7 @@
             "type": "number"
           },
           "total": {
+            "description": "Rows matching the request (moves for `sort=date`, loan officers for `sort=volume`).",
             "nullable": true,
             "type": "number"
           },
@@ -22207,10 +22229,11 @@
             "type": "number"
           },
           "moversScanned": {
-            "description": "How many moving loan officers the volume figures cover. Below `transitions` only when `moversTruncated` is true.",
+            "description": "How many moving loan officers the volume figures cover (each counted once, at their latest move in the window).",
             "type": "number"
           },
           "moversTruncated": {
+            "description": "Always false: every mover in the window is covered. Kept for compatibility.",
             "type": "boolean"
           },
           "net": {
@@ -22229,7 +22252,7 @@
             "type": "number"
           },
           "volumeTransferred": {
-            "description": "Trailing 14-month origination volume of the loan officers counted in `transitions` (see `moversScanned`).",
+            "description": "Trailing 14-month origination volume of the loan officers counted in `transitions` (see `moversScanned`), as of the last weekly refresh.",
             "type": "number"
           },
           "window": {
@@ -23294,6 +23317,13 @@
             "example": 48213,
             "minimum": 0,
             "type": "integer"
+          },
+          "totalIsLowerBound": {
+            "description": "Present (always `true`) only under `timeAtCompanyMonths` when the other filters match more than 200,000 originators: `total` then counts the tenure matches among the first 200,000 of them (in sort order) and the true count may be higher. Absent means `total` is exact.",
+            "enum": [
+              true
+            ],
+            "type": "boolean"
           }
         },
         "required": [
@@ -24551,7 +24581,7 @@
                 ]
               },
               "timeAtCompanyMonths": {
-                "description": "Whole months at the CURRENT employer (`tenureMonths` on each row), from the NMLS registration record as of the last weekly refresh. `{gte:24}` = at their company two years or more; `{lte:6}` = recent movers. Only originators currently working at a company have a value. Resolved against the registration record before the list query runs, so it must narrow to at most 10,000 originators on ONE side — either the tenure range itself (optionally with `companyNmlsId`), or the rest of your filters (e.g. a state or city). A request where both sides are wider answers 400 naming this limit. Flat filters only, and not inside `mode: \"or\"`. Not sortable — sort by `yearsInIndustry` or production instead.",
+                "description": "Whole months at the CURRENT employer (`tenureMonths` on each row), from the NMLS registration record as of the last weekly refresh. `{gte:24}` = at their company two years or more; `{lte:6}` = recent movers. Only originators currently working at a company have a value. Not sortable — sort by `yearsInIndustry` or production instead. Applied after the rest of the request: the other filters are matched first, in the request's sort order, and each match is checked against the registration record, so it works at any result size up to 200,000 matches of the OTHER filters. Past that, `total` counts only the tenure matches among the first 200,000 scanned and the response carries `totalIsLowerBound: true`; a page beyond what was found answers 400 with `code: \"TIME_AT_COMPANY_SCOPE\"` — add a geography, production or company filter to narrow. Pages use an opaque offset cursor; pass `cursor` back unchanged. Flat filters only, and not inside `mode: \"or\"`.",
                 "nullable": true,
                 "properties": {
                   "gt": {
@@ -24749,6 +24779,13 @@
           },
           "total": {
             "type": "number"
+          },
+          "totalIsLowerBound": {
+            "description": "Present (always `true`) only under `timeAtCompanyMonths` when the other filters match more than 200,000 originators: `total` then counts the tenure matches among the first 200,000 of them (in sort order) and the true count may be higher. Absent means `total` is exact.",
+            "enum": [
+              true
+            ],
+            "type": "boolean"
           }
         },
         "required": [
@@ -31247,7 +31284,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 1,000 rows per delivery: no entitlement required.** Available to\n  every authenticated caller.\n- **Above 1,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.",
     "title": "ModelMatch API",
-    "version": "3.55.0"
+    "version": "3.57.0"
   },
   "openapi": "3.1.0",
   "paths": {
@@ -33042,7 +33079,7 @@
                 }
               }
             },
-            "description": "Validation error. Includes unresolvable location filters: a `city`/`county`/`state`/`zip` value that does not match a recognized location returns 400 rather than an empty result set. Resolve the name with `instantSearch` (use an id from its `results.locations[]`) or `suggestLocations` (use the `id` of a `source: \"dictionary\"` result), then pass that id back as the filter value."
+            "description": "Validation error. Includes unresolvable location filters: a `city`/`county`/`state`/`zip` value that does not match a recognized location returns 400 rather than an empty result set. Resolve the name with `instantSearch` (use an id from its `results.locations[]`) or `suggestLocations` (use the `id` of a `source: \"dictionary\"` result), then pass that id back as the filter value. Also returned with `code: \"TIME_AT_COMPANY_SCOPE\"` when `timeAtCompanyMonths` is set, the other filters match more than 200,000 originators, and the requested page lies past the tenure matches found among the first 200,000 — narrow the request."
           },
           "401": {
             "content": {
@@ -56597,7 +56634,7 @@
     },
     "/v1/market/movement/activity": {
       "get": {
-        "description": "Monthly series of newly licensed loan officers, loan officers with an open employment at month end, and loan officers who left the industry (no open employment; last one ended that month). `becameInactive` (license authorization lapses) is not available and is always null. `all_time` charts the last 60 months. A move is dated by the loan officer's FIRST record at the new company; a loan officer licensed in several states counts once per company. Location filters use the loan officer's CURRENT NMLS location. Results refresh weekly.",
+        "description": "Monthly series of newly licensed loan officers, loan officers with an open employment at month end, and loan officers who left the industry (no open employment; last one ended that month). `becameInactive` (license authorization lapses) is not available and is always null. `all_time` charts the last 60 months. A move is dated by the loan officer's FIRST record at the new company; a loan officer licensed in several states counts once per company. Location filters use the loan officer's CURRENT NMLS location. Results refresh weekly. A response not ready within 25 s answers `202` (`MovementComputing`): repeat the same request after `retryAfterMs`.",
         "operationId": "marketMovementActivity",
         "parameters": [
           {
@@ -56660,6 +56697,27 @@
             },
             "description": "OK"
           },
+          "202": {
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/MovementComputing"
+                }
+              }
+            },
+            "description": "Still computing — poll the same request after `retryAfterMs`. See `MovementComputing`.",
+            "headers": {
+              "Retry-After": {
+                "description": "Seconds to wait before retrying.",
+                "required": true,
+                "schema": {
+                  "description": "Seconds to wait before retrying.",
+                  "example": "5",
+                  "type": "string"
+                }
+              }
+            }
+          },
           "400": {
             "content": {
               "application/json": {
@@ -56719,7 +56777,7 @@
     },
     "/v1/market/movement/by-state": {
       "get": {
-        "description": "Loan officers who changed companies in the window, grouped by state (all states) and city (top `limit`), each with the company that gained the most of them. A move is dated by the loan officer's FIRST record at the new company; a loan officer licensed in several states counts once per company. Location filters use the loan officer's CURRENT NMLS location. Results refresh weekly.",
+        "description": "Loan officers who changed companies in the window, grouped by state (all states) and city (top `limit`), each with the company that gained the most of them. A move is dated by the loan officer's FIRST record at the new company; a loan officer licensed in several states counts once per company. Location filters use the loan officer's CURRENT NMLS location. Results refresh weekly. A response not ready within 25 s answers `202` (`MovementComputing`): repeat the same request after `retryAfterMs`.",
         "operationId": "marketMovementByState",
         "parameters": [
           {
@@ -56806,6 +56864,27 @@
             },
             "description": "OK"
           },
+          "202": {
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/MovementComputing"
+                }
+              }
+            },
+            "description": "Still computing — poll the same request after `retryAfterMs`. See `MovementComputing`.",
+            "headers": {
+              "Retry-After": {
+                "description": "Seconds to wait before retrying.",
+                "required": true,
+                "schema": {
+                  "description": "Seconds to wait before retrying.",
+                  "example": "5",
+                  "type": "string"
+                }
+              }
+            }
+          },
           "400": {
             "content": {
               "application/json": {
@@ -56865,7 +56944,7 @@
     },
     "/v1/market/movement/cohort-payoff": {
       "get": {
-        "description": "For loan officers who moved in the window (default last 24 months), annualized production at the previous employer vs the new one, bucketed by pre-move tier (Low <25, Mid 25–99, High 100+ units/yr). Each side is annualized over the months actually spent there inside a trailing 24-month production window; movers with fewer than `windowMonths` months on either side are excluded. A move is dated by the loan officer's FIRST record at the new company; a loan officer licensed in several states counts once per company. Location filters use the loan officer's CURRENT NMLS location. Results refresh weekly.",
+        "description": "For loan officers who moved in the window (default last 24 months), annualized production at the previous employer vs the new one, bucketed by pre-move tier (Low <25, Mid 25–99, High 100+ units/yr). Each side is annualized over the months actually spent there inside a trailing 24-month production window; movers with fewer than `windowMonths` months on either side are excluded. A move is dated by the loan officer's FIRST record at the new company; a loan officer licensed in several states counts once per company. Location filters use the loan officer's CURRENT NMLS location. Results refresh weekly. A response not ready within 25 s answers `202` (`MovementComputing`): repeat the same request after `retryAfterMs`.",
         "operationId": "marketMovementCohortPayoff",
         "parameters": [
           {
@@ -56955,6 +57034,27 @@
             },
             "description": "OK"
           },
+          "202": {
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/MovementComputing"
+                }
+              }
+            },
+            "description": "Still computing — poll the same request after `retryAfterMs`. See `MovementComputing`.",
+            "headers": {
+              "Retry-After": {
+                "description": "Seconds to wait before retrying.",
+                "required": true,
+                "schema": {
+                  "description": "Seconds to wait before retrying.",
+                  "example": "5",
+                  "type": "string"
+                }
+              }
+            }
+          },
           "400": {
             "content": {
               "application/json": {
@@ -57014,7 +57114,7 @@
     },
     "/v1/market/movement/most-gained": {
       "get": {
-        "description": "Companies ranked by loan officers gained in the window (or by net = gained − lost with `rankBy=net`). Each row carries gained, lost and net, plus the trailing-14-month production of the loan officers on the ranked side. A move is dated by the loan officer's FIRST record at the new company; a loan officer licensed in several states counts once per company. Location filters use the loan officer's CURRENT NMLS location. Results refresh weekly.",
+        "description": "Companies ranked by loan officers gained in the window (or by net = gained − lost with `rankBy=net`). Each row carries gained, lost and net, plus the trailing-14-month production of the loan officers on the ranked side. A move is dated by the loan officer's FIRST record at the new company; a loan officer licensed in several states counts once per company. Location filters use the loan officer's CURRENT NMLS location. Results refresh weekly. A response not ready within 25 s answers `202` (`MovementComputing`): repeat the same request after `retryAfterMs`.",
         "operationId": "marketMovementMostGained",
         "parameters": [
           {
@@ -57115,6 +57215,27 @@
             },
             "description": "OK"
           },
+          "202": {
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/MovementComputing"
+                }
+              }
+            },
+            "description": "Still computing — poll the same request after `retryAfterMs`. See `MovementComputing`.",
+            "headers": {
+              "Retry-After": {
+                "description": "Seconds to wait before retrying.",
+                "required": true,
+                "schema": {
+                  "description": "Seconds to wait before retrying.",
+                  "example": "5",
+                  "type": "string"
+                }
+              }
+            }
+          },
           "400": {
             "content": {
               "application/json": {
@@ -57174,7 +57295,7 @@
     },
     "/v1/market/movement/most-lost": {
       "get": {
-        "description": "Companies ranked by loan officers lost in the window (or by net = gained − lost with `rankBy=net`). Each row carries gained, lost and net, plus the trailing-14-month production of the loan officers on the ranked side. A move is dated by the loan officer's FIRST record at the new company; a loan officer licensed in several states counts once per company. Location filters use the loan officer's CURRENT NMLS location. Results refresh weekly.",
+        "description": "Companies ranked by loan officers lost in the window (or by net = gained − lost with `rankBy=net`). Each row carries gained, lost and net, plus the trailing-14-month production of the loan officers on the ranked side. A move is dated by the loan officer's FIRST record at the new company; a loan officer licensed in several states counts once per company. Location filters use the loan officer's CURRENT NMLS location. Results refresh weekly. A response not ready within 25 s answers `202` (`MovementComputing`): repeat the same request after `retryAfterMs`.",
         "operationId": "marketMovementMostLost",
         "parameters": [
           {
@@ -57275,6 +57396,27 @@
             },
             "description": "OK"
           },
+          "202": {
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/MovementComputing"
+                }
+              }
+            },
+            "description": "Still computing — poll the same request after `retryAfterMs`. See `MovementComputing`.",
+            "headers": {
+              "Retry-After": {
+                "description": "Seconds to wait before retrying.",
+                "required": true,
+                "schema": {
+                  "description": "Seconds to wait before retrying.",
+                  "example": "5",
+                  "type": "string"
+                }
+              }
+            }
+          },
           "400": {
             "content": {
               "application/json": {
@@ -57334,7 +57476,7 @@
     },
     "/v1/market/movement/movers": {
       "get": {
-        "description": "The loan officers who moved to a new company in the window, with previous and new employer, move date, current location and production. `sort=volume` returns the highest producers who moved (notable moves); `sort=date` pages every move newest first. A move is dated by the loan officer's FIRST record at the new company; a loan officer licensed in several states counts once per company. Location filters use the loan officer's CURRENT NMLS location. Results refresh weekly.",
+        "description": "The loan officers who moved to a new company in the window, with previous and new employer, move date, current location and production. `sort=volume` returns the highest producers who moved (notable moves); `sort=date` pages every move newest first. A move is dated by the loan officer's FIRST record at the new company; a loan officer licensed in several states counts once per company. Location filters use the loan officer's CURRENT NMLS location. Results refresh weekly. A response not ready within 25 s answers `202` (`MovementComputing`): repeat the same request after `retryAfterMs`.",
         "operationId": "marketMovementMovers",
         "parameters": [
           {
@@ -57465,6 +57607,27 @@
             },
             "description": "OK"
           },
+          "202": {
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/MovementComputing"
+                }
+              }
+            },
+            "description": "Still computing — poll the same request after `retryAfterMs`. See `MovementComputing`.",
+            "headers": {
+              "Retry-After": {
+                "description": "Seconds to wait before retrying.",
+                "required": true,
+                "schema": {
+                  "description": "Seconds to wait before retrying.",
+                  "example": "5",
+                  "type": "string"
+                }
+              }
+            }
+          },
           "400": {
             "content": {
               "application/json": {
@@ -57524,7 +57687,7 @@
     },
     "/v1/market/movement/rankings": {
       "get": {
-        "description": "The top 100 loan officers for a calendar year by total volume, units, or FHA / VA / purchase / refinance volume, with current employer and retail / banker / broker type. A move is dated by the loan officer's FIRST record at the new company; a loan officer licensed in several states counts once per company. Location filters use the loan officer's CURRENT NMLS location. Results refresh weekly.",
+        "description": "The top 100 loan officers for a calendar year by total volume, units, or FHA / VA / purchase / refinance volume, with current employer and retail / banker / broker type. A move is dated by the loan officer's FIRST record at the new company; a loan officer licensed in several states counts once per company. Location filters use the loan officer's CURRENT NMLS location. Results refresh weekly. A response not ready within 25 s answers `202` (`MovementComputing`): repeat the same request after `retryAfterMs`.",
         "operationId": "marketMovementRankings",
         "parameters": [
           {
@@ -57590,6 +57753,27 @@
             },
             "description": "OK"
           },
+          "202": {
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/MovementComputing"
+                }
+              }
+            },
+            "description": "Still computing — poll the same request after `retryAfterMs`. See `MovementComputing`.",
+            "headers": {
+              "Retry-After": {
+                "description": "Seconds to wait before retrying.",
+                "required": true,
+                "schema": {
+                  "description": "Seconds to wait before retrying.",
+                  "example": "5",
+                  "type": "string"
+                }
+              }
+            }
+          },
           "400": {
             "content": {
               "application/json": {
@@ -57649,7 +57833,7 @@
     },
     "/v1/market/movement/stats": {
       "get": {
-        "description": "Period totals of loan-officer movement: company joins, company-to-company transitions, complete company departures, industry exits, newly licensed loan officers, the working head-count at both ends of the window and its net change, plus the trailing-14-month production of the loan officers who moved. A move is dated by the loan officer's FIRST record at the new company; a loan officer licensed in several states counts once per company. Location filters use the loan officer's CURRENT NMLS location. Results refresh weekly.",
+        "description": "Period totals of loan-officer movement: company joins, company-to-company transitions, complete company departures, industry exits, newly licensed loan officers, the working head-count at both ends of the window and its net change, plus the trailing-14-month production of the loan officers who moved. A move is dated by the loan officer's FIRST record at the new company; a loan officer licensed in several states counts once per company. Location filters use the loan officer's CURRENT NMLS location. Results refresh weekly. A response not ready within 25 s answers `202` (`MovementComputing`): repeat the same request after `retryAfterMs`.",
         "operationId": "marketMovementStats",
         "parameters": [
           {
@@ -57724,6 +57908,27 @@
             },
             "description": "OK"
           },
+          "202": {
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/MovementComputing"
+                }
+              }
+            },
+            "description": "Still computing — poll the same request after `retryAfterMs`. See `MovementComputing`.",
+            "headers": {
+              "Retry-After": {
+                "description": "Seconds to wait before retrying.",
+                "required": true,
+                "schema": {
+                  "description": "Seconds to wait before retrying.",
+                  "example": "5",
+                  "type": "string"
+                }
+              }
+            }
+          },
           "400": {
             "content": {
               "application/json": {
@@ -57783,7 +57988,7 @@
     },
     "/v1/market/movement/transitions": {
       "get": {
-        "description": "The largest company-to-company flows in the window: how many loan officers moved from each previous employer to each new one. Filter to one company (either side) with `companyNmlsId`. A move is dated by the loan officer's FIRST record at the new company; a loan officer licensed in several states counts once per company. Location filters use the loan officer's CURRENT NMLS location. Results refresh weekly.",
+        "description": "The largest company-to-company flows in the window: how many loan officers moved from each previous employer to each new one. Filter to one company (either side) with `companyNmlsId`. A move is dated by the loan officer's FIRST record at the new company; a loan officer licensed in several states counts once per company. Location filters use the loan officer's CURRENT NMLS location. Results refresh weekly. A response not ready within 25 s answers `202` (`MovementComputing`): repeat the same request after `retryAfterMs`.",
         "operationId": "marketMovementTransitions",
         "parameters": [
           {
@@ -57880,6 +58085,27 @@
             },
             "description": "OK"
           },
+          "202": {
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/MovementComputing"
+                }
+              }
+            },
+            "description": "Still computing — poll the same request after `retryAfterMs`. See `MovementComputing`.",
+            "headers": {
+              "Retry-After": {
+                "description": "Seconds to wait before retrying.",
+                "required": true,
+                "schema": {
+                  "description": "Seconds to wait before retrying.",
+                  "example": "5",
+                  "type": "string"
+                }
+              }
+            }
+          },
           "400": {
             "content": {
               "application/json": {
@@ -58630,7 +58856,7 @@
                 }
               }
             },
-            "description": "Validation error. Includes unresolvable location filters: a `city`/`county`/`state`/`zip` value that does not match a recognized location returns 400 rather than an empty result set. Resolve the name with `instantSearch` (use an id from its `results.locations[]`) or `suggestLocations` (use the `id` of a `source: \"dictionary\"` result), then pass that id back as the filter value."
+            "description": "Validation error. Includes unresolvable location filters: a `city`/`county`/`state`/`zip` value that does not match a recognized location returns 400 rather than an empty result set. Resolve the name with `instantSearch` (use an id from its `results.locations[]`) or `suggestLocations` (use the `id` of a `source: \"dictionary\"` result), then pass that id back as the filter value. Also returned with `code: \"TIME_AT_COMPANY_SCOPE\"` when `timeAtCompanyMonths` is set, the other filters match more than 200,000 originators, and the requested page lies past the tenure matches found among the first 200,000 — narrow the request."
           },
           "401": {
             "content": {

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@model-match/api",
-	"version": "3.11.0",
+	"version": "3.13.0",
 	"description": "TypeScript client for the ModelMatch API",
 	"license": "MIT",
 	"files": [
@@ -41,7 +41,7 @@
 	},
 	"devDependencies": {
 		"@hey-api/openapi-ts": "^0.67.6",
-		"@model-match-inc/api": "3.53.3",
+		"@model-match-inc/api": "3.55.0",
 		"tsdown": "^0.21.10",
 		"typescript": "6.0.2",
 		"vitest": "4.1.2"