@model-match/api 3.41.0 → 3.42.0

package/openapi.json

@@ -35158,6 +35158,47 @@
         },
         "type": "object"
       },
+      "OfficeCrmListFilter": {
+        "additionalProperties": false,
+        "description": "Scope the result to the caller's CRM. Resolved against the caller's ACTIVE WORKSPACE at query time — list membership is read server-side, so the request never carries member ids. Only real-estate office members count; people, mortgage companies, branches and manual (unlinked) records on the same list are ignored. `mode: \"in\"` with no matching members returns an empty page (not an unfiltered one). Errors: 400 `crm_list_requires_workspace` when the caller has no active workspace (API-key / OAuth callers must select an organization), 403 / 404 when a named list is not visible to the caller or does not exist, and 400 `crm_list_too_large` when the selected lists hold more than 50,000 offices in total — narrow the selection rather than get a silently partial answer.",
+        "properties": {
+          "lists": {
+            "anyOf": [
+              {
+                "description": "Every list in the caller's workspace that the caller can see (own, org-wide, or shared with them) and that holds this kind of record — People lists for originators and agents, Company lists for companies.",
+                "enum": [
+                  "any"
+                ],
+                "type": "string"
+              },
+              {
+                "description": "Specific CRM list ids (1–50).",
+                "items": {
+                  "minLength": 1,
+                  "type": "string"
+                },
+                "maxItems": 50,
+                "minItems": 1,
+                "type": "array"
+              }
+            ],
+            "description": "Which lists: `\"any\"` for every Company list the caller can see, or an array of list ids. Membership is the UNION across the selected lists."
+          },
+          "mode": {
+            "description": "`in` — only offices who are a member of the selected list(s). `notIn` — exclude every office who is a member of the selected list(s); everyone else passes, including offices on none of your lists.",
+            "enum": [
+              "in",
+              "notIn"
+            ],
+            "type": "string"
+          }
+        },
+        "required": [
+          "mode",
+          "lists"
+        ],
+        "type": "object"
+      },
       "OfficeDetail": {
         "allOf": [
           {
@@ -35165,10 +35206,6 @@
           },
           {
             "properties": {
-              "email": {
-                "nullable": true,
-                "type": "string"
-              },
               "fullAddress": {
                 "nullable": true,
                 "type": "string"
@@ -35177,10 +35214,6 @@
                 "nullable": true,
                 "type": "string"
               },
-              "phone": {
-                "nullable": true,
-                "type": "string"
-              },
               "totalListPriceActive": {
                 "description": "Total list price of active listings at this office",
                 "nullable": true,
@@ -35236,9 +35269,49 @@
           "avgListPrice": {
             "$ref": "#/components/schemas/NumericFilterValue"
           },
+          "avgMortgagedBuyerLoanAmount": {
+            "allOf": [
+              {
+                "$ref": "#/components/schemas/NumericFilterValue"
+              },
+              {
+                "description": "Mean loan size on the office's financed BUYER-side deals in the period."
+              }
+            ]
+          },
+          "avgMortgagedLoanAmount": {
+            "allOf": [
+              {
+                "$ref": "#/components/schemas/NumericFilterValue"
+              },
+              {
+                "description": "Mean loan size on the office's financed deals in the period (either side)."
+              }
+            ]
+          },
+          "avgMortgagedSellerLoanAmount": {
+            "allOf": [
+              {
+                "$ref": "#/components/schemas/NumericFilterValue"
+              },
+              {
+                "description": "Mean loan size on the office's financed LISTING-side deals (the buyer's loan) in the period."
+              }
+            ]
+          },
           "avgSalePrice": {
             "$ref": "#/components/schemas/NumericFilterValue"
           },
+          "builderCount": {
+            "allOf": [
+              {
+                "$ref": "#/components/schemas/NumericFilterValue"
+              },
+              {
+                "description": "Distinct home builders on the office's deals in the period — `{gt: 0}` = works with builders."
+              }
+            ]
+          },
           "buyerUnits": {
             "$ref": "#/components/schemas/NumericFilterValue"
           },
@@ -35251,6 +35324,16 @@
           "company": {
             "$ref": "#/components/schemas/TextFilterValue"
           },
+          "county": {
+            "allOf": [
+              {
+                "$ref": "#/components/schemas/TextFilterValue"
+              },
+              {
+                "description": "Office address COUNTY: a name (`Travis`, with `state` when ambiguous), a 5-digit FIPS (`48453`) or a dictionary county id; an array matches any. Matches when the office's geocoded point lies inside the county boundary (no geocode = no match). Unknown county = 400."
+              }
+            ]
+          },
           "dualUnits": {
             "$ref": "#/components/schemas/NumericFilterValue"
           },
@@ -35267,6 +35350,17 @@
             ],
             "type": "string"
           },
+          "msa": {
+            "$ref": "#/components/schemas/OfficeMsaFilterValue"
+          },
+          "namePrefix": {
+            "description": "Prefix name search: every word must start a word of the name (\"keller wil\" → Keller Williams Realty). No fuzzy/nickname matching; relevance-ranked unless `sort` is set. Max 100 chars / 6 words (emails, URLs, phones ignored), else 400. Spelling variants of brokerage names also match (\"remax\" ↔ \"Re/Max\").",
+            "minLength": 1,
+            "type": "string"
+          },
+          "region": {
+            "$ref": "#/components/schemas/OfficeRegionFilterValue"
+          },
           "sellerUnits": {
             "$ref": "#/components/schemas/NumericFilterValue"
           },
@@ -35300,12 +35394,36 @@
           "advancedFilters": {
             "$ref": "#/components/schemas/FilterNode"
           },
+          "builderShare": {
+            "additionalProperties": false,
+            "description": "Share of the office's deals in the period that named a home builder, as a 0–100 percent (Σ builder units / total units). Implies `builderCount > 0`.",
+            "properties": {
+              "gte": {
+                "maximum": 100,
+                "minimum": 0,
+                "type": "number"
+              },
+              "lte": {
+                "maximum": 100,
+                "minimum": 0,
+                "type": "number"
+              }
+            },
+            "type": "object"
+          },
+          "crmList": {
+            "$ref": "#/components/schemas/OfficeCrmListFilter"
+          },
           "filters": {
             "$ref": "#/components/schemas/FilterNode"
           },
           "flatFilters": {
             "$ref": "#/components/schemas/OfficeFlatFilters"
           },
+          "includeTopOriginator": {
+            "description": "Add `topOriginator` to every row (the LO on the most buyer-side deals in the period). Off by default — it reads each office's LO list.",
+            "type": "boolean"
+          },
           "lenderFilters": {
             "items": {
               "$ref": "#/components/schemas/LenderFilterEntry"
@@ -35362,6 +35480,146 @@
         ],
         "type": "object"
       },
+      "OfficeMsaFilterValue": {
+        "anyOf": [
+          {
+            "type": "string"
+          },
+          {
+            "items": {
+              "type": "string"
+            },
+            "maxItems": 50,
+            "minItems": 1,
+            "type": "array"
+          },
+          {
+            "nullable": true
+          }
+        ],
+        "description": "Office address METRO (MSA / CBSA): 5-digit CBSA code (`12420`) or metro name (`Austin Metro`); an array matches any. The office point inside any member county. Unknown/ambiguous = 400 naming candidates."
+      },
+      "OfficeNameSuggestRequest": {
+        "additionalProperties": false,
+        "properties": {
+          "limit": {
+            "description": "Max names (default 20).",
+            "maximum": 50,
+            "minimum": 1,
+            "type": "integer"
+          },
+          "query": {
+            "description": "The start of an office name (≥ 2 chars), matched as a phrase prefix on the name's words.",
+            "maxLength": 100,
+            "minLength": 2,
+            "type": "string"
+          }
+        },
+        "required": [
+          "query"
+        ],
+        "type": "object"
+      },
+      "OfficeNameSuggestResponse": {
+        "properties": {
+          "data": {
+            "items": {
+              "properties": {
+                "agentCount": {
+                  "description": "Agents across every office with this name",
+                  "type": "number"
+                },
+                "name": {
+                  "description": "The office name as stored (lowercase) — pass it back as `company` on `listOffices`, or as `currentOffice` / `office` on `listAgents`.",
+                  "type": "string"
+                },
+                "officeCount": {
+                  "description": "Offices with this name",
+                  "type": "number"
+                }
+              },
+              "required": [
+                "name",
+                "agentCount",
+                "officeCount"
+              ],
+              "type": "object"
+            },
+            "type": "array"
+          }
+        },
+        "required": [
+          "data"
+        ],
+        "type": "object"
+      },
+      "OfficeRegionFilterValue": {
+        "anyOf": [
+          {
+            "enum": [
+              "northeast",
+              "northeast-division-1",
+              "northeast-division-2",
+              "midwest",
+              "midwest-division-3",
+              "midwest-division-4",
+              "south",
+              "south-division-5",
+              "south-division-6",
+              "south-division-7",
+              "west",
+              "west-division-8",
+              "west-division-9"
+            ],
+            "type": "string"
+          },
+          {
+            "items": {
+              "enum": [
+                "northeast",
+                "northeast-division-1",
+                "northeast-division-2",
+                "midwest",
+                "midwest-division-3",
+                "midwest-division-4",
+                "south",
+                "south-division-5",
+                "south-division-6",
+                "south-division-7",
+                "west",
+                "west-division-8",
+                "west-division-9"
+              ],
+              "type": "string"
+            },
+            "maxItems": 50,
+            "minItems": 1,
+            "type": "array"
+          },
+          {
+            "nullable": true
+          }
+        ],
+        "description": "Office address CENSUS REGION / DIVISION (`<region>-division-<n>`, 1–9) — offices in ANY state of it. An array matches any."
+      },
+      "OfficeScoredBreakdownRequest": {
+        "properties": {
+          "bySide": {
+            "description": "Also return the `buyer` and `listing` views under `bySide`, computed in the same query — each identical to calling again with that `side`. Use instead of one call per side. `pagination.cursor` pages every view in step (each view's own `cursor` is absent once it ends).",
+            "type": "boolean"
+          },
+          "period": {
+            "$ref": "#/components/schemas/Period"
+          },
+          "side": {
+            "$ref": "#/components/schemas/AgentSide"
+          },
+          "sort": {
+            "$ref": "#/components/schemas/BreakdownSort"
+          }
+        },
+        "type": "object"
+      },
       "OfficeSummary": {
         "properties": {
           "activeListings": {
@@ -35426,6 +35684,11 @@
             "nullable": true,
             "type": "number"
           },
+          "email": {
+            "description": "Office email (list rows since 2026-10-15; was detail-only)",
+            "nullable": true,
+            "type": "string"
+          },
           "id": {
             "description": "Office key (mm_office_key)",
             "type": "string"
@@ -35438,6 +35701,11 @@
             "nullable": true,
             "type": "string"
           },
+          "phone": {
+            "description": "Office phone (list rows since 2026-10-15; was detail-only)",
+            "nullable": true,
+            "type": "string"
+          },
           "sellerUnits": {
             "nullable": true,
             "type": "number"
@@ -35459,6 +35727,50 @@
             "nullable": true,
             "type": "number"
           },
+          "topOriginator": {
+            "description": "Present only when the request set `includeTopOriginator`: the loan officer on the most of this office's BUYER-side deals in the period (ties → more volume, then lower NMLS id), named from the LO's own profile with their current employer. `null` when no buyer-side deal had a tracked LO.",
+            "nullable": true,
+            "properties": {
+              "buyerUnits": {
+                "type": "number"
+              },
+              "buyerVolume": {
+                "type": "number"
+              },
+              "company": {
+                "nullable": true,
+                "properties": {
+                  "name": {
+                    "nullable": true,
+                    "type": "string"
+                  },
+                  "nmlsId": {
+                    "nullable": true,
+                    "type": "string"
+                  }
+                },
+                "required": [
+                  "name",
+                  "nmlsId"
+                ],
+                "type": "object"
+              },
+              "name": {
+                "type": "string"
+              },
+              "nmlsId": {
+                "type": "string"
+              }
+            },
+            "required": [
+              "nmlsId",
+              "name",
+              "company",
+              "buyerUnits",
+              "buyerVolume"
+            ],
+            "type": "object"
+          },
           "units": {
             "nullable": true,
             "type": "number"
@@ -46248,7 +46560,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.101.0"
+    "version": "3.102.0"
   },
   "openapi": "3.1.0",
   "paths": {
@@ -75881,16 +76193,496 @@
             },
             "description": "Response payload too large — detail endpoint capped to fit Lambda response limits"
           },
-          "502": {
-            "content": {
-              "application/json": {
-                "schema": {
-                  "$ref": "#/components/schemas/AccountServiceUnavailable"
-                }
-              }
-            },
-            "description": "Account service unavailable"
-          },
+          "502": {
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/AccountServiceUnavailable"
+                }
+              }
+            },
+            "description": "Account service unavailable"
+          },
+          "503": {
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/SearchUnavailable"
+                }
+              }
+            },
+            "description": "Search timed out or the cluster is overloaded — retry after `Retry-After` seconds."
+          }
+        },
+        "summary": "Update the current caller's profile",
+        "tags": [
+          "Me"
+        ]
+      }
+    },
+    "/v1/me/credits": {
+      "get": {
+        "description": "Balance split by bucket (cycle allowance, purchased on-demand, personal), the per-cycle allowance and on-demand unit price, and ledger totals over a window.\n\nThe window defaults to the current calendar month to date (UTC). Figures are for the caller's own membership in their active organization — the same organization the API meters requests against.",
+        "operationId": "getMeCredits",
+        "parameters": [
+          {
+            "description": "Usage window start (YYYY-MM-DD, inclusive)",
+            "in": "query",
+            "name": "startDate",
+            "required": false,
+            "schema": {
+              "description": "Usage window start (YYYY-MM-DD, inclusive)",
+              "pattern": "^\\d{4}-\\d{2}-\\d{2}$",
+              "type": "string"
+            }
+          },
+          {
+            "description": "Usage window end (YYYY-MM-DD, inclusive)",
+            "in": "query",
+            "name": "endDate",
+            "required": false,
+            "schema": {
+              "description": "Usage window end (YYYY-MM-DD, inclusive)",
+              "pattern": "^\\d{4}-\\d{2}-\\d{2}$",
+              "type": "string"
+            }
+          }
+        ],
+        "responses": {
+          "200": {
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/MeCreditsResponse"
+                }
+              }
+            },
+            "description": "Credit balance and usage"
+          },
+          "400": {
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/ErrorResponse"
+                }
+              }
+            },
+            "description": "Validation error"
+          },
+          "401": {
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/ErrorResponse"
+                }
+              }
+            },
+            "description": "Unauthorized"
+          },
+          "403": {
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/ErrorResponse"
+                }
+              }
+            },
+            "description": "Forbidden (authenticated, but missing required context — e.g. no active organization)"
+          },
+          "404": {
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/ErrorResponse"
+                }
+              }
+            },
+            "description": "Not found"
+          },
+          "413": {
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/PayloadTooLarge"
+                }
+              }
+            },
+            "description": "Response payload too large — detail endpoint capped to fit Lambda response limits"
+          },
+          "502": {
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/AccountServiceUnavailable"
+                }
+              }
+            },
+            "description": "Account service unavailable"
+          },
+          "503": {
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/SearchUnavailable"
+                }
+              }
+            },
+            "description": "Search timed out or the cluster is overloaded — retry after `Retry-After` seconds."
+          }
+        },
+        "summary": "Get the caller's credit balance and usage",
+        "tags": [
+          "Me"
+        ]
+      }
+    },
+    "/v1/me/plan": {
+      "get": {
+        "description": "The active organization's resolved plan (with its limit map), the subscription status backing it, and the plan grants attached to the organization and to the user.\n\n`plan` is null when the workspace has no active, trialing, or past-due subscription. No billing details (invoices, payment methods) are exposed.",
+        "operationId": "getMePlan",
+        "responses": {
+          "200": {
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/MePlanResponse"
+                }
+              }
+            },
+            "description": "The caller's plan"
+          },
+          "400": {
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/ErrorResponse"
+                }
+              }
+            },
+            "description": "Validation error"
+          },
+          "401": {
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/ErrorResponse"
+                }
+              }
+            },
+            "description": "Unauthorized"
+          },
+          "403": {
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/ErrorResponse"
+                }
+              }
+            },
+            "description": "Forbidden (authenticated, but missing required context — e.g. no active organization)"
+          },
+          "404": {
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/ErrorResponse"
+                }
+              }
+            },
+            "description": "Not found"
+          },
+          "413": {
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/PayloadTooLarge"
+                }
+              }
+            },
+            "description": "Response payload too large — detail endpoint capped to fit Lambda response limits"
+          },
+          "502": {
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/AccountServiceUnavailable"
+                }
+              }
+            },
+            "description": "Account service unavailable"
+          },
+          "503": {
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/SearchUnavailable"
+                }
+              }
+            },
+            "description": "Search timed out or the cluster is overloaded — retry after `Retry-After` seconds."
+          }
+        },
+        "summary": "Get the caller's current plan",
+        "tags": [
+          "Me"
+        ]
+      }
+    },
+    "/v1/offices": {
+      "post": {
+        "description": "NOT NMLS mortgage branches — use `/branches` for those. Returns office name, address, agent count, coordinates, and office-level production for the selected period. Default sort is by agent count descending. If you only need how many offices match and not the records themselves, send the same request body to `countOffices`.",
+        "operationId": "listOffices",
+        "requestBody": {
+          "content": {
+            "application/json": {
+              "schema": {
+                "$ref": "#/components/schemas/OfficeListRequest"
+              }
+            }
+          }
+        },
+        "responses": {
+          "200": {
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/OfficeListResponse"
+                }
+              }
+            },
+            "description": "Paginated list of offices"
+          },
+          "400": {
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/ErrorResponse"
+                }
+              }
+            },
+            "description": "Validation error"
+          },
+          "401": {
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/ErrorResponse"
+                }
+              }
+            },
+            "description": "Unauthorized"
+          },
+          "403": {
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/ErrorResponse"
+                }
+              }
+            },
+            "description": "Forbidden (authenticated, but missing required context — e.g. no active organization)"
+          },
+          "404": {
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/ErrorResponse"
+                }
+              }
+            },
+            "description": "Not found"
+          },
+          "413": {
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/PayloadTooLarge"
+                }
+              }
+            },
+            "description": "Response payload too large — detail endpoint capped to fit Lambda response limits"
+          },
+          "503": {
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/SearchUnavailable"
+                }
+              }
+            },
+            "description": "Search timed out or the cluster is overloaded — retry after `Retry-After` seconds."
+          }
+        },
+        "summary": "Search real-estate offices with filters",
+        "tags": [
+          "Offices"
+        ]
+      }
+    },
+    "/v1/offices/agents": {
+      "post": {
+        "operationId": "officeAgents",
+        "requestBody": {
+          "content": {
+            "application/json": {
+              "schema": {
+                "$ref": "#/components/schemas/OfficeAgentsRequest"
+              }
+            }
+          }
+        },
+        "responses": {
+          "200": {
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/AgentListResponse"
+                }
+              }
+            },
+            "description": "Paginated list of agents at the office"
+          },
+          "400": {
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/ErrorResponse"
+                }
+              }
+            },
+            "description": "Validation error"
+          },
+          "401": {
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/ErrorResponse"
+                }
+              }
+            },
+            "description": "Unauthorized"
+          },
+          "403": {
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/ErrorResponse"
+                }
+              }
+            },
+            "description": "Forbidden (authenticated, but missing required context — e.g. no active organization)"
+          },
+          "404": {
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/ErrorResponse"
+                }
+              }
+            },
+            "description": "Not found"
+          },
+          "413": {
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/PayloadTooLarge"
+                }
+              }
+            },
+            "description": "Response payload too large — detail endpoint capped to fit Lambda response limits"
+          },
+          "503": {
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/SearchUnavailable"
+                }
+              }
+            },
+            "description": "Search timed out or the cluster is overloaded — retry after `Retry-After` seconds."
+          }
+        },
+        "summary": "Agents at an office",
+        "tags": [
+          "Offices"
+        ]
+      }
+    },
+    "/v1/offices/count": {
+      "post": {
+        "description": "Return the exact number of offices matching the given filters. Accepts the same request body as `listOffices` (pagination and sort are ignored). Use this when you only need a total; to get the matching offices themselves, send the same request body to `listOffices`.",
+        "operationId": "countOffices",
+        "requestBody": {
+          "content": {
+            "application/json": {
+              "schema": {
+                "$ref": "#/components/schemas/OfficeListRequest"
+              }
+            }
+          }
+        },
+        "responses": {
+          "200": {
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/CountResponse"
+                }
+              }
+            },
+            "description": "Exact count of matching offices"
+          },
+          "400": {
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/ErrorResponse"
+                }
+              }
+            },
+            "description": "Validation error"
+          },
+          "401": {
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/ErrorResponse"
+                }
+              }
+            },
+            "description": "Unauthorized"
+          },
+          "403": {
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/ErrorResponse"
+                }
+              }
+            },
+            "description": "Forbidden (authenticated, but missing required context — e.g. no active organization)"
+          },
+          "404": {
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/ErrorResponse"
+                }
+              }
+            },
+            "description": "Not found"
+          },
+          "413": {
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/PayloadTooLarge"
+                }
+              }
+            },
+            "description": "Response payload too large — detail endpoint capped to fit Lambda response limits"
+          },
           "503": {
             "content": {
               "application/json": {
@@ -75902,50 +76694,36 @@
             "description": "Search timed out or the cluster is overloaded — retry after `Retry-After` seconds."
           }
         },
-        "summary": "Update the current caller's profile",
+        "summary": "Count offices matching filters",
         "tags": [
-          "Me"
-        ]
+          "Offices"
+        ],
+        "x-mm-records-via": "listOffices"
       }
     },
-    "/v1/me/credits": {
-      "get": {
-        "description": "Balance split by bucket (cycle allowance, purchased on-demand, personal), the per-cycle allowance and on-demand unit price, and ledger totals over a window.\n\nThe window defaults to the current calendar month to date (UTC). Figures are for the caller's own membership in their active organization — the same organization the API meters requests against.",
-        "operationId": "getMeCredits",
-        "parameters": [
-          {
-            "description": "Usage window start (YYYY-MM-DD, inclusive)",
-            "in": "query",
-            "name": "startDate",
-            "required": false,
-            "schema": {
-              "description": "Usage window start (YYYY-MM-DD, inclusive)",
-              "pattern": "^\\d{4}-\\d{2}-\\d{2}$",
-              "type": "string"
-            }
-          },
-          {
-            "description": "Usage window end (YYYY-MM-DD, inclusive)",
-            "in": "query",
-            "name": "endDate",
-            "required": false,
-            "schema": {
-              "description": "Usage window end (YYYY-MM-DD, inclusive)",
-              "pattern": "^\\d{4}-\\d{2}-\\d{2}$",
-              "type": "string"
+    "/v1/offices/names": {
+      "post": {
+        "description": "Distinct real-estate office names starting with `query`, each with the agents and offices behind that name across all its offices — the picker for filters that match by office name (`listOffices` `company`, `listAgents` `currentOffice`). To find one office, use `instantSearch` or `listOffices` instead.",
+        "operationId": "suggestOfficeNames",
+        "requestBody": {
+          "content": {
+            "application/json": {
+              "schema": {
+                "$ref": "#/components/schemas/OfficeNameSuggestRequest"
+              }
             }
           }
-        ],
+        },
         "responses": {
           "200": {
             "content": {
               "application/json": {
                 "schema": {
-                  "$ref": "#/components/schemas/MeCreditsResponse"
+                  "$ref": "#/components/schemas/OfficeNameSuggestResponse"
                 }
               }
             },
-            "description": "Credit balance and usage"
+            "description": "Matching office names"
           },
           "400": {
             "content": {
@@ -75997,47 +76775,117 @@
             },
             "description": "Response payload too large — detail endpoint capped to fit Lambda response limits"
           },
-          "502": {
+          "503": {
             "content": {
               "application/json": {
                 "schema": {
-                  "$ref": "#/components/schemas/AccountServiceUnavailable"
+                  "$ref": "#/components/schemas/SearchUnavailable"
                 }
               }
             },
-            "description": "Account service unavailable"
+            "description": "Search timed out or the cluster is overloaded — retry after `Retry-After` seconds."
+          }
+        },
+        "summary": "Office-name typeahead (distinct names with agent totals)",
+        "tags": [
+          "Offices"
+        ]
+      }
+    },
+    "/v1/offices/{id}": {
+      "get": {
+        "operationId": "getOffice",
+        "parameters": [
+          {
+            "description": "Office key (mm_office_key)",
+            "in": "path",
+            "name": "id",
+            "required": true,
+            "schema": {
+              "description": "Office key (mm_office_key)",
+              "type": "string"
+            }
           },
-          "503": {
+          {
+            "description": "Period for production metrics (default: last12Months)",
+            "in": "query",
+            "name": "period",
+            "required": false,
+            "schema": {
+              "allOf": [
+                {
+                  "$ref": "#/components/schemas/Period"
+                },
+                {
+                  "description": "Period for production metrics (default: last12Months)"
+                }
+              ]
+            }
+          }
+        ],
+        "responses": {
+          "200": {
             "content": {
               "application/json": {
                 "schema": {
-                  "$ref": "#/components/schemas/SearchUnavailable"
+                  "$ref": "#/components/schemas/OfficeDetailResponse"
                 }
               }
             },
-            "description": "Search timed out or the cluster is overloaded — retry after `Retry-After` seconds."
+            "description": "Office detail"
+          },
+          "404": {
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/ErrorResponse"
+                }
+              }
+            },
+            "description": "Office not found"
           }
         },
-        "summary": "Get the caller's credit balance and usage",
+        "summary": "Get office by key with office-level production",
         "tags": [
-          "Me"
+          "Offices"
         ]
       }
     },
-    "/v1/me/plan": {
-      "get": {
-        "description": "The active organization's resolved plan (with its limit map), the subscription status backing it, and the plan grants attached to the organization and to the user.\n\n`plan` is null when the workspace has no active, trialing, or past-due subscription. No billing details (invoices, payment methods) are exposed.",
-        "operationId": "getMePlan",
+    "/v1/offices/{id}/breakdowns/builders": {
+      "post": {
+        "description": "New-construction builders named on the office's deals in the period, ranked by units. Deal COUNT only: every row's `volume` / `pctVolume` is 0 and `pctUnits` is a share of ALL the office's deals. No buyer/listing split: `side` must be `any` (or omitted).",
+        "operationId": "officeBuilders",
+        "parameters": [
+          {
+            "description": "Office id (from `listOffices` / `instantSearch`)",
+            "in": "path",
+            "name": "id",
+            "required": true,
+            "schema": {
+              "description": "Office id (from `listOffices` / `instantSearch`)",
+              "type": "string"
+            }
+          }
+        ],
+        "requestBody": {
+          "content": {
+            "application/json": {
+              "schema": {
+                "$ref": "#/components/schemas/OfficeScoredBreakdownRequest"
+              }
+            }
+          }
+        },
         "responses": {
           "200": {
             "content": {
               "application/json": {
                 "schema": {
-                  "$ref": "#/components/schemas/MePlanResponse"
+                  "$ref": "#/components/schemas/AgentSidedBreakdownResponse"
                 }
               }
             },
-            "description": "The caller's plan"
+            "description": "Pre-aggregated builders breakdown from the office's scored doc"
           },
           "400": {
             "content": {
@@ -76089,16 +76937,6 @@
             },
             "description": "Response payload too large — detail endpoint capped to fit Lambda response limits"
           },
-          "502": {
-            "content": {
-              "application/json": {
-                "schema": {
-                  "$ref": "#/components/schemas/AccountServiceUnavailable"
-                }
-              }
-            },
-            "description": "Account service unavailable"
-          },
           "503": {
             "content": {
               "application/json": {
@@ -76110,21 +76948,33 @@
             "description": "Search timed out or the cluster is overloaded — retry after `Retry-After` seconds."
           }
         },
-        "summary": "Get the caller's current plan",
+        "summary": "Home builders on the office's deals (pre-aggregated)",
         "tags": [
-          "Me"
+          "Offices"
         ]
       }
     },
-    "/v1/offices": {
+    "/v1/offices/{id}/breakdowns/lenders": {
       "post": {
-        "description": "NOT NMLS mortgage branches — use `/branches` for those. Returns office name, address, agent count, coordinates, and office-level production for the selected period. Default sort is by agent count descending. If you only need how many offices match and not the records themselves, send the same request body to `countOffices`.",
-        "operationId": "listOffices",
+        "description": "Lenders that financed the office's deals in the period. `id` is the lender id (pass it back as the `lender` filter on the loans routes), `label` its display name. The row for deals with no lender attributed carries no `id`.",
+        "operationId": "officeLenders",
+        "parameters": [
+          {
+            "description": "Office id (from `listOffices` / `instantSearch`)",
+            "in": "path",
+            "name": "id",
+            "required": true,
+            "schema": {
+              "description": "Office id (from `listOffices` / `instantSearch`)",
+              "type": "string"
+            }
+          }
+        ],
         "requestBody": {
           "content": {
             "application/json": {
               "schema": {
-                "$ref": "#/components/schemas/OfficeListRequest"
+                "$ref": "#/components/schemas/OfficeScoredBreakdownRequest"
               }
             }
           }
@@ -76134,11 +76984,11 @@
             "content": {
               "application/json": {
                 "schema": {
-                  "$ref": "#/components/schemas/OfficeListResponse"
+                  "$ref": "#/components/schemas/AgentSidedBreakdownResponse"
                 }
               }
             },
-            "description": "Paginated list of offices"
+            "description": "Pre-aggregated lenders breakdown from the office's scored doc"
           },
           "400": {
             "content": {
@@ -76201,20 +77051,33 @@
             "description": "Search timed out or the cluster is overloaded — retry after `Retry-After` seconds."
           }
         },
-        "summary": "Search real-estate offices with filters",
+        "summary": "Lenders on the office's deals (pre-aggregated)",
         "tags": [
           "Offices"
         ]
       }
     },
-    "/v1/offices/agents": {
+    "/v1/offices/{id}/breakdowns/loanTypes": {
       "post": {
-        "operationId": "officeAgents",
+        "description": "The office's financed deals in the period by loan product (`label` = product key, e.g. `conventional`, `fha`, `va`), summed across its lenders. Shares are of the financed deals on the requested side, so rows sum to 1; cash deals are not counted.",
+        "operationId": "officeLoanTypes",
+        "parameters": [
+          {
+            "description": "Office id (from `listOffices` / `instantSearch`)",
+            "in": "path",
+            "name": "id",
+            "required": true,
+            "schema": {
+              "description": "Office id (from `listOffices` / `instantSearch`)",
+              "type": "string"
+            }
+          }
+        ],
         "requestBody": {
           "content": {
             "application/json": {
               "schema": {
-                "$ref": "#/components/schemas/OfficeAgentsRequest"
+                "$ref": "#/components/schemas/OfficeScoredBreakdownRequest"
               }
             }
           }
@@ -76224,11 +77087,11 @@
             "content": {
               "application/json": {
                 "schema": {
-                  "$ref": "#/components/schemas/AgentListResponse"
+                  "$ref": "#/components/schemas/AgentSidedBreakdownResponse"
                 }
               }
             },
-            "description": "Paginated list of agents at the office"
+            "description": "Pre-aggregated loanTypes breakdown from the office's scored doc"
           },
           "400": {
             "content": {
@@ -76291,21 +77154,33 @@
             "description": "Search timed out or the cluster is overloaded — retry after `Retry-After` seconds."
           }
         },
-        "summary": "Agents at an office",
+        "summary": "Loan products on the office's financed deals (pre-aggregated)",
         "tags": [
           "Offices"
         ]
       }
     },
-    "/v1/offices/count": {
+    "/v1/offices/{id}/breakdowns/originators": {
       "post": {
-        "description": "Return the exact number of offices matching the given filters. Accepts the same request body as `listOffices` (pagination and sort are ignored). Use this when you only need a total; to get the matching offices themselves, send the same request body to `listOffices`.",
-        "operationId": "countOffices",
+        "description": "Loan officers on the office's deals in the period. `id` is the LO's NMLS id; `label` their registered name and `company` their current employer (both from the LO's own profile, not the deal records). `side: buyer` = deals where this office represented the buyer.",
+        "operationId": "officeOriginators",
+        "parameters": [
+          {
+            "description": "Office id (from `listOffices` / `instantSearch`)",
+            "in": "path",
+            "name": "id",
+            "required": true,
+            "schema": {
+              "description": "Office id (from `listOffices` / `instantSearch`)",
+              "type": "string"
+            }
+          }
+        ],
         "requestBody": {
           "content": {
             "application/json": {
               "schema": {
-                "$ref": "#/components/schemas/OfficeListRequest"
+                "$ref": "#/components/schemas/OfficeScoredBreakdownRequest"
               }
             }
           }
@@ -76315,11 +77190,11 @@
             "content": {
               "application/json": {
                 "schema": {
-                  "$ref": "#/components/schemas/CountResponse"
+                  "$ref": "#/components/schemas/AgentSidedBreakdownResponse"
                 }
               }
             },
-            "description": "Exact count of matching offices"
+            "description": "Pre-aggregated originators breakdown from the office's scored doc"
           },
           "400": {
             "content": {
@@ -76382,67 +77257,7 @@
             "description": "Search timed out or the cluster is overloaded — retry after `Retry-After` seconds."
           }
         },
-        "summary": "Count offices matching filters",
-        "tags": [
-          "Offices"
-        ],
-        "x-mm-records-via": "listOffices"
-      }
-    },
-    "/v1/offices/{id}": {
-      "get": {
-        "operationId": "getOffice",
-        "parameters": [
-          {
-            "description": "Office key (mm_office_key)",
-            "in": "path",
-            "name": "id",
-            "required": true,
-            "schema": {
-              "description": "Office key (mm_office_key)",
-              "type": "string"
-            }
-          },
-          {
-            "description": "Period for production metrics (default: last12Months)",
-            "in": "query",
-            "name": "period",
-            "required": false,
-            "schema": {
-              "allOf": [
-                {
-                  "$ref": "#/components/schemas/Period"
-                },
-                {
-                  "description": "Period for production metrics (default: last12Months)"
-                }
-              ]
-            }
-          }
-        ],
-        "responses": {
-          "200": {
-            "content": {
-              "application/json": {
-                "schema": {
-                  "$ref": "#/components/schemas/OfficeDetailResponse"
-                }
-              }
-            },
-            "description": "Office detail"
-          },
-          "404": {
-            "content": {
-              "application/json": {
-                "schema": {
-                  "$ref": "#/components/schemas/ErrorResponse"
-                }
-              }
-            },
-            "description": "Office not found"
-          }
-        },
-        "summary": "Get office by key with office-level production",
+        "summary": "Loan officers the office's agents worked with (pre-aggregated)",
         "tags": [
           "Offices"
         ]