@model-match/api 3.26.0 → 3.27.0

package/openapi.json

@@ -5994,6 +5994,313 @@
         ],
         "type": "object"
       },
+      "AgentMortgagedTimeSeriesRequest": {
+        "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"
+          },
+          "interval": {
+            "$ref": "#/components/schemas/Interval"
+          },
+          "period": {
+            "$ref": "#/components/schemas/DatedPeriod"
+          },
+          "side": {
+            "$ref": "#/components/schemas/AgentSide"
+          }
+        },
+        "type": "object"
+      },
       "AgentProductMixEntry": {
         "additionalProperties": false,
         "properties": {
@@ -6141,6 +6448,17 @@
       "AgentSaleSummary": {
         "properties": {
           "address": {
+            "description": "Full street line — number, directionals, street name, suffix and unit (`123 w 4th st`), lowercase",
+            "nullable": true,
+            "type": "string"
+          },
+          "builderName": {
+            "description": "Builder, on a new-construction sale",
+            "nullable": true,
+            "type": "string"
+          },
+          "buyerName": {
+            "description": "First buyer named on the sale — from the purchase loan's document when the MLS record names none; `null` on most cash deals",
             "nullable": true,
             "type": "string"
           },
@@ -6148,6 +6466,16 @@
             "nullable": true,
             "type": "string"
           },
+          "coListAgentId": {
+            "description": "Co-listing agent's id (`GET /v1/agents/{id}`), when the sale's agent key resolves to one agent",
+            "nullable": true,
+            "type": "string"
+          },
+          "coListAgentName": {
+            "description": "Co-listing agent, as the MLS recorded the name",
+            "nullable": true,
+            "type": "string"
+          },
           "date": {
             "nullable": true,
             "type": "string"
@@ -6155,10 +6483,25 @@
           "id": {
             "type": "string"
           },
+          "listAgentId": {
+            "description": "Listing agent's id (`GET /v1/agents/{id}`), when the sale's agent key resolves to one agent",
+            "nullable": true,
+            "type": "string"
+          },
           "listAgentName": {
             "nullable": true,
             "type": "string"
           },
+          "listDate": {
+            "description": "MLS listing date (`YYYY-MM-DD`); days on market = `date` − `listDate`",
+            "nullable": true,
+            "type": "string"
+          },
+          "listPrice": {
+            "description": "Last MLS list price",
+            "nullable": true,
+            "type": "number"
+          },
           "loan": {
             "description": "The purchase loan recorded against this sale (matched on the sale id), or `null` when none is recorded — a cash deal, or a loan not yet on file.",
             "nullable": true,
@@ -6167,6 +6510,11 @@
                 "nullable": true,
                 "type": "number"
               },
+              "brokerName": {
+                "description": "Mortgage broker as written on the loan document, when the loan was third-party originated",
+                "nullable": true,
+                "type": "string"
+              },
               "brokerNmlsId": {
                 "description": "Mortgage broker NMLS id when the loan was third-party originated",
                 "nullable": true,
@@ -6185,6 +6533,11 @@
                 "description": "Loan id (`GET /v1/loans/{id}`)",
                 "type": "string"
               },
+              "interestRate": {
+                "description": "Note rate in percent (e.g. `6.25`), recorded or modeled; `null` when not on file",
+                "nullable": true,
+                "type": "number"
+              },
               "lenderId": {
                 "description": "Normalized lender key — the value the `lender` filter accepts",
                 "nullable": true,
@@ -6234,10 +6587,20 @@
             ],
             "type": "object"
           },
+          "mmPropertyId": {
+            "description": "The property's id (`GET /v1/properties/{id}`)",
+            "nullable": true,
+            "type": "string"
+          },
           "price": {
             "nullable": true,
             "type": "number"
           },
+          "sellerName": {
+            "description": "First seller named on the sale — from the purchase loan's document when the MLS record names none",
+            "nullable": true,
+            "type": "string"
+          },
           "side": {
             "description": "Which side of this deal the agent was on: `buyer`, `listing`, or `dual` (both). `null` when the sale names the agent under an id this API cannot place on a side.",
             "enum": [
@@ -6249,6 +6612,11 @@
             "nullable": true,
             "type": "string"
           },
+          "soldAgentId": {
+            "description": "Buyer's (selling) agent's id (`GET /v1/agents/{id}`), when the sale's agent key resolves to one agent",
+            "nullable": true,
+            "type": "string"
+          },
           "soldAgentName": {
             "nullable": true,
             "type": "string"
@@ -6272,6 +6640,316 @@
         ],
         "type": "object"
       },
+      "AgentSalesBreakdownRequest": {
+        "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"
+          },
+          "side": {
+            "$ref": "#/components/schemas/AgentSide"
+          },
+          "sort": {
+            "$ref": "#/components/schemas/BreakdownSort"
+          }
+        },
+        "type": "object"
+      },
       "AgentSalesResponse": {
         "properties": {
           "cursor": {
@@ -32189,7 +32867,7 @@
         "type": "object"
       },
       "OriginatorAgentSide": {
-        "description": "Which agent on the LO's loans to rank. `buyer` (default): the buyer's (selling) agent — the agent who brought the borrower. `listing`: the seller's listing agent.",
+        "description": "Which agent on the LO's loans to rank. `buyer` (default): the buyer's (selling) agent — the agent who brought the borrower. `listing`: the seller's listing and co-listing agents.",
         "enum": [
           "buyer",
           "listing"
@@ -41783,7 +42461,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.78.0"
+    "version": "3.79.0"
   },
   "openapi": "3.1.0",
   "paths": {
@@ -42947,6 +43625,99 @@
         ]
       }
     },
+    "/v1/agents/{id}/analytics/mortgaged-time-series": {
+      "post": {
+        "description": "Scoped to the agent's FINANCED deals: recorded loans on which the agent is the buyer's agent or the listing / co-listing agent, matched through the agent's MLS ids. Cash deals carry no loan and are not counted. The date window is the loan's recording date. One bucket per `interval` (default monthly): `units` = financed deals recorded in the bucket, `volume` = their total loan amount (out-of-range fill amounts excluded and counted in `excluded`). `previous` is the same series for the prior window. `side` defaults to `any`; `buyer` + `listing` = `any` per bucket. Pair with `agentAnalyticsTimeSeries` (closed sales by sale date) for a mortgaged-vs-total chart — the two use different date axes (loan recording vs sale close), so a deal can land a month apart.",
+        "operationId": "agentMortgagedTimeSeries",
+        "parameters": [
+          {
+            "description": "Agent document ID",
+            "in": "path",
+            "name": "id",
+            "required": true,
+            "schema": {
+              "description": "Agent document ID",
+              "type": "string"
+            }
+          }
+        ],
+        "requestBody": {
+          "content": {
+            "application/json": {
+              "schema": {
+                "$ref": "#/components/schemas/AgentMortgagedTimeSeriesRequest"
+              }
+            }
+          }
+        },
+        "responses": {
+          "200": {
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/SimpleTimeSeriesResponse"
+                }
+              }
+            },
+            "description": "Financed deals and loan volume per bucket"
+          },
+          "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"
+          }
+        },
+        "summary": "The agent's financed deals and loan volume, over time",
+        "tags": [
+          "Agents"
+        ]
+      }
+    },
     "/v1/agents/{id}/breakdowns/builders": {
       "post": {
         "description": "New-construction builders named on the agent's deals in the period, ranked by units. The pre-aggregated builder list carries a deal COUNT only, so every row's `volume` and `pctVolume` are 0 — rank and share by `units` / `pctUnits` (a share of ALL the agent's deals in the period, so the rows sum to the builder-sold share, not to 1). It carries no buyer/listing split either: `side` must be `any` (or omitted); `buyer`/`listing` return 400.",
@@ -43042,6 +43813,7 @@
     },
     "/v1/agents/{id}/breakdowns/cities": {
       "post": {
+        "description": "Ranks the agent's CLOSED sales (MLS status sold, a real sale price — rentals and lease listings excluded, duplicate MLS records of one sale counted once) by this dimension. The same population `POST /v1/agents/{id}/sales` returns with `flatFilters.mlsStatus: \"SLD\"` and the agent analytics routes count. `side` narrows to the deals the agent was on that side of (`buyer` includes deals on both sides; `buyer` + `listing` = `any`).",
         "operationId": "agentCities",
         "parameters": [
           {
@@ -43059,7 +43831,7 @@
           "content": {
             "application/json": {
               "schema": {
-                "$ref": "#/components/schemas/BreakdownRequest"
+                "$ref": "#/components/schemas/AgentSalesBreakdownRequest"
               }
             }
           }
@@ -43226,6 +43998,7 @@
     },
     "/v1/agents/{id}/breakdowns/counties": {
       "post": {
+        "description": "Ranks the agent's CLOSED sales (MLS status sold, a real sale price — rentals and lease listings excluded, duplicate MLS records of one sale counted once) by this dimension. The same population `POST /v1/agents/{id}/sales` returns with `flatFilters.mlsStatus: \"SLD\"` and the agent analytics routes count. `side` narrows to the deals the agent was on that side of (`buyer` includes deals on both sides; `buyer` + `listing` = `any`).",
         "operationId": "agentCounties",
         "parameters": [
           {
@@ -43243,7 +44016,7 @@
           "content": {
             "application/json": {
               "schema": {
-                "$ref": "#/components/schemas/BreakdownRequest"
+                "$ref": "#/components/schemas/AgentSalesBreakdownRequest"
               }
             }
           }
@@ -43410,6 +44183,7 @@
     },
     "/v1/agents/{id}/breakdowns/offices": {
       "post": {
+        "description": "Ranks the agent's CLOSED sales (MLS status sold, a real sale price — rentals and lease listings excluded, duplicate MLS records of one sale counted once) by this dimension. The same population `POST /v1/agents/{id}/sales` returns with `flatFilters.mlsStatus: \"SLD\"` and the agent analytics routes count. `side` narrows to the deals the agent was on that side of (`buyer` includes deals on both sides; `buyer` + `listing` = `any`).",
         "operationId": "agentOffices",
         "parameters": [
           {
@@ -43427,7 +44201,7 @@
           "content": {
             "application/json": {
               "schema": {
-                "$ref": "#/components/schemas/BreakdownRequest"
+                "$ref": "#/components/schemas/AgentSalesBreakdownRequest"
               }
             }
           }
@@ -43594,6 +44368,7 @@
     },
     "/v1/agents/{id}/breakdowns/states": {
       "post": {
+        "description": "Ranks the agent's CLOSED sales (MLS status sold, a real sale price — rentals and lease listings excluded, duplicate MLS records of one sale counted once) by this dimension. The same population `POST /v1/agents/{id}/sales` returns with `flatFilters.mlsStatus: \"SLD\"` and the agent analytics routes count. `side` narrows to the deals the agent was on that side of (`buyer` includes deals on both sides; `buyer` + `listing` = `any`).",
         "operationId": "agentStates",
         "parameters": [
           {
@@ -43611,7 +44386,7 @@
           "content": {
             "application/json": {
               "schema": {
-                "$ref": "#/components/schemas/BreakdownRequest"
+                "$ref": "#/components/schemas/AgentSalesBreakdownRequest"
               }
             }
           }
@@ -43872,6 +44647,7 @@
     },
     "/v1/agents/{id}/breakdowns/zip-codes": {
       "post": {
+        "description": "Ranks the agent's CLOSED sales (MLS status sold, a real sale price — rentals and lease listings excluded, duplicate MLS records of one sale counted once) by this dimension. The same population `POST /v1/agents/{id}/sales` returns with `flatFilters.mlsStatus: \"SLD\"` and the agent analytics routes count. `side` narrows to the deals the agent was on that side of (`buyer` includes deals on both sides; `buyer` + `listing` = `any`).",
         "operationId": "agentZipCodes",
         "parameters": [
           {
@@ -43889,7 +44665,7 @@
           "content": {
             "application/json": {
               "schema": {
-                "$ref": "#/components/schemas/BreakdownRequest"
+                "$ref": "#/components/schemas/AgentSalesBreakdownRequest"
               }
             }
           }
@@ -69029,7 +69805,7 @@
     },
     "/v1/originators/{nmlsId}/breakdowns/agents": {
       "post": {
-        "description": "Ranks the real-estate agents on this LO's loans, by volume — the buyer's agent by default, the listing agent with `side: \"listing\"`. Buckets whose name is an MLS placeholder for \"no agent recorded\" (`non member`, `non listed agent`, and ~140 board-specific spellings) are excluded rather than ranked as agents — they are not people. `id` is the agent id most often recorded under the name on these loans (pass it to `GET /v1/agents/{id}`); absent when none is recorded. Percentages are shares of the LO's whole loan population, so they do not sum to 100 across the page.",
+        "description": "Ranks the real-estate agents on this LO's loans, by volume — the buyer's agent by default, the listing and co-listing agents with `side: \"listing\"`. Each loan is credited to the agent its MLS agent keys resolve to (a key naming several different people credits only the confirmed one), so `units` counts distinct loans per agent. `id` is that agent's id (pass it to `GET /v1/agents/{id}`); absent when the loan's key matches no agent profile, in which case `label` is the name the MLS recorded. Names that are an MLS placeholder for \"no agent recorded\" (`non member`, `non listed agent`, and ~140 board-specific spellings) are excluded — they are not people. Percentages are shares of the LO's whole loan population, so they do not sum to 100 across the page.",
         "operationId": "originatorAgents",
         "parameters": [
           {