@model-match/api 3.57.0 → 3.58.0

package/openapi.json

@@ -25481,7 +25481,7 @@
       "EnrichBulkJobResponse": {
         "properties": {
           "billingStatus": {
-            "description": "Outcome of the job's single finalize debit: `charged`, `capped` (member balance/daily cap hit — customer constraint), `billing_error` (5xx/auth — recoverable revenue to reconcile), or `none` (nothing matched). Absent on older rows.",
+            "description": "Outcome of the job's single finalize debit, taken before the results are released: `charged`, `capped` (member balance / spend cap / daily cap declined it — the job fails `insufficient_credits`), `billing_error` (the debit could not be made — the job fails `billing_unavailable`), or `none` (nothing matched). Absent until billing has run, and on older rows.",
             "enum": [
               "charged",
               "capped",
@@ -25506,6 +25506,7 @@
             "type": "string"
           },
           "error": {
+            "description": "Why the job failed. `insufficient_credits` = the charge was declined (balance, spend cap or daily cap), no results released. `billing_unavailable` = the charge could not be made, no results released — retry.",
             "type": "string"
           },
           "failed": {
@@ -29660,7 +29661,9 @@
               "veteranIndicator",
               "hmdaActionTaken",
               "selfEmployed",
-              "currentHomeOwner"
+              "currentHomeOwner",
+              "lenderType",
+              "lenderVolumeClass"
             ],
             "type": "string"
           }
@@ -30615,6 +30618,660 @@
         ],
         "type": "object"
       },
+      "MarketSignalsRequest": {
+        "additionalProperties": false,
+        "properties": {
+          "flatFilters": {
+            "$ref": "#/components/schemas/MarketFlatFilters"
+          },
+          "lookbackMonths": {
+            "maximum": 120,
+            "minimum": 6,
+            "type": "integer"
+          },
+          "previous": {
+            "allOf": [
+              {
+                "$ref": "#/components/schemas/MarketSignalsWindow"
+              },
+              {
+                "description": "Comparison window; defaults to the preceding equal-length one."
+              }
+            ]
+          },
+          "stats": {
+            "items": {
+              "enum": [
+                "funnel",
+                "refiMix",
+                "affordability",
+                "pipeline",
+                "status",
+                "refiOpportunity"
+              ],
+              "type": "string"
+            },
+            "minItems": 1,
+            "type": "array"
+          },
+          "thresholdBps": {
+            "maximum": 500,
+            "minimum": 0,
+            "type": "integer"
+          },
+          "window": {
+            "$ref": "#/components/schemas/MarketSignalsWindow"
+          }
+        },
+        "required": [
+          "window",
+          "stats"
+        ],
+        "type": "object"
+      },
+      "MarketSignalsResponse": {
+        "properties": {
+          "affordability": {
+            "properties": {
+              "current": {
+                "properties": {
+                  "medianAnnualIncome": {
+                    "nullable": true,
+                    "type": "number"
+                  },
+                  "medianLoanAmount": {
+                    "nullable": true,
+                    "type": "number"
+                  },
+                  "sampleCount": {
+                    "type": "number"
+                  }
+                },
+                "required": [
+                  "medianLoanAmount",
+                  "medianAnnualIncome",
+                  "sampleCount"
+                ],
+                "type": "object"
+              },
+              "monthly": {
+                "items": {
+                  "properties": {
+                    "medianAnnualIncome": {
+                      "nullable": true,
+                      "type": "number"
+                    },
+                    "medianLoanAmount": {
+                      "nullable": true,
+                      "type": "number"
+                    },
+                    "month": {
+                      "type": "string"
+                    },
+                    "sampleCount": {
+                      "type": "number"
+                    }
+                  },
+                  "required": [
+                    "medianLoanAmount",
+                    "medianAnnualIncome",
+                    "sampleCount",
+                    "month"
+                  ],
+                  "type": "object"
+                },
+                "type": "array"
+              },
+              "previous": {
+                "properties": {
+                  "medianAnnualIncome": {
+                    "nullable": true,
+                    "type": "number"
+                  },
+                  "medianLoanAmount": {
+                    "nullable": true,
+                    "type": "number"
+                  },
+                  "sampleCount": {
+                    "type": "number"
+                  }
+                },
+                "required": [
+                  "medianLoanAmount",
+                  "medianAnnualIncome",
+                  "sampleCount"
+                ],
+                "type": "object"
+              }
+            },
+            "required": [
+              "current",
+              "previous",
+              "monthly"
+            ],
+            "type": "object"
+          },
+          "funnel": {
+            "properties": {
+              "reLock": {
+                "properties": {
+                  "reLockedCount": {
+                    "type": "number"
+                  },
+                  "sampleCount": {
+                    "type": "number"
+                  }
+                },
+                "required": [
+                  "reLockedCount",
+                  "sampleCount"
+                ],
+                "type": "object"
+              },
+              "timeToClose": {
+                "properties": {
+                  "p25": {
+                    "nullable": true,
+                    "type": "number"
+                  },
+                  "p50": {
+                    "nullable": true,
+                    "type": "number"
+                  },
+                  "p75": {
+                    "nullable": true,
+                    "type": "number"
+                  },
+                  "sampleCount": {
+                    "type": "number"
+                  }
+                },
+                "required": [
+                  "p25",
+                  "p50",
+                  "p75",
+                  "sampleCount"
+                ],
+                "type": "object"
+              }
+            },
+            "required": [
+              "timeToClose",
+              "reLock"
+            ],
+            "type": "object"
+          },
+          "pipeline": {
+            "properties": {
+              "expected": {
+                "properties": {
+                  "next30Days": {
+                    "type": "number"
+                  },
+                  "next60Days": {
+                    "type": "number"
+                  },
+                  "next90Days": {
+                    "type": "number"
+                  },
+                  "weekly": {
+                    "items": {
+                      "properties": {
+                        "count": {
+                          "type": "number"
+                        },
+                        "weekStart": {
+                          "type": "string"
+                        }
+                      },
+                      "required": [
+                        "weekStart",
+                        "count"
+                      ],
+                      "type": "object"
+                    },
+                    "type": "array"
+                  }
+                },
+                "required": [
+                  "next30Days",
+                  "next60Days",
+                  "next90Days",
+                  "weekly"
+                ],
+                "type": "object"
+              },
+              "funnel": {
+                "properties": {
+                  "application": {
+                    "type": "number"
+                  },
+                  "closing": {
+                    "type": "number"
+                  },
+                  "funded": {
+                    "type": "number"
+                  },
+                  "locked": {
+                    "type": "number"
+                  }
+                },
+                "required": [
+                  "application",
+                  "locked",
+                  "closing",
+                  "funded"
+                ],
+                "type": "object"
+              },
+              "transitions": {
+                "properties": {
+                  "appToLock": {
+                    "properties": {
+                      "converted": {
+                        "type": "number"
+                      },
+                      "p25": {
+                        "nullable": true,
+                        "type": "number"
+                      },
+                      "p50": {
+                        "nullable": true,
+                        "type": "number"
+                      },
+                      "p75": {
+                        "nullable": true,
+                        "type": "number"
+                      },
+                      "priorP50": {
+                        "nullable": true,
+                        "type": "number"
+                      },
+                      "priorSampleCount": {
+                        "type": "number"
+                      },
+                      "reached": {
+                        "type": "number"
+                      },
+                      "sampleCount": {
+                        "type": "number"
+                      }
+                    },
+                    "required": [
+                      "p25",
+                      "p50",
+                      "p75",
+                      "sampleCount",
+                      "priorP50",
+                      "priorSampleCount",
+                      "reached",
+                      "converted"
+                    ],
+                    "type": "object"
+                  },
+                  "closeToFunding": {
+                    "properties": {
+                      "converted": {
+                        "type": "number"
+                      },
+                      "p25": {
+                        "nullable": true,
+                        "type": "number"
+                      },
+                      "p50": {
+                        "nullable": true,
+                        "type": "number"
+                      },
+                      "p75": {
+                        "nullable": true,
+                        "type": "number"
+                      },
+                      "priorP50": {
+                        "nullable": true,
+                        "type": "number"
+                      },
+                      "priorSampleCount": {
+                        "type": "number"
+                      },
+                      "reached": {
+                        "type": "number"
+                      },
+                      "sampleCount": {
+                        "type": "number"
+                      }
+                    },
+                    "required": [
+                      "p25",
+                      "p50",
+                      "p75",
+                      "sampleCount",
+                      "priorP50",
+                      "priorSampleCount",
+                      "reached",
+                      "converted"
+                    ],
+                    "type": "object"
+                  }
+                },
+                "required": [
+                  "appToLock",
+                  "closeToFunding"
+                ],
+                "type": "object"
+              }
+            },
+            "required": [
+              "transitions",
+              "funnel",
+              "expected"
+            ],
+            "type": "object"
+          },
+          "refiMix": {
+            "properties": {
+              "cashOut": {
+                "properties": {
+                  "medianAmount": {
+                    "nullable": true,
+                    "type": "number"
+                  },
+                  "sampleCount": {
+                    "type": "number"
+                  }
+                },
+                "required": [
+                  "medianAmount",
+                  "sampleCount"
+                ],
+                "type": "object"
+              },
+              "purposes": {
+                "items": {
+                  "properties": {
+                    "count": {
+                      "type": "number"
+                    },
+                    "key": {
+                      "type": "string"
+                    }
+                  },
+                  "required": [
+                    "key",
+                    "count"
+                  ],
+                  "type": "object"
+                },
+                "type": "array"
+              }
+            },
+            "required": [
+              "purposes",
+              "cashOut"
+            ],
+            "type": "object"
+          },
+          "refiOpportunity": {
+            "properties": {
+              "baseline": {
+                "nullable": true,
+                "type": "number"
+              },
+              "byLoanType": {
+                "items": {
+                  "properties": {
+                    "count": {
+                      "type": "number"
+                    },
+                    "key": {
+                      "type": "string"
+                    }
+                  },
+                  "required": [
+                    "key",
+                    "count"
+                  ],
+                  "type": "object"
+                },
+                "type": "array"
+              },
+              "byState": {
+                "items": {
+                  "properties": {
+                    "avgRate": {
+                      "nullable": true,
+                      "type": "number"
+                    },
+                    "avgSpreadBps": {
+                      "nullable": true,
+                      "type": "number"
+                    },
+                    "count": {
+                      "type": "number"
+                    },
+                    "state": {
+                      "type": "string"
+                    },
+                    "totalVolume": {
+                      "type": "number"
+                    }
+                  },
+                  "required": [
+                    "state",
+                    "count",
+                    "totalVolume",
+                    "avgRate",
+                    "avgSpreadBps"
+                  ],
+                  "type": "object"
+                },
+                "type": "array"
+              },
+              "byVintage": {
+                "items": {
+                  "properties": {
+                    "count": {
+                      "type": "number"
+                    },
+                    "year": {
+                      "type": "number"
+                    }
+                  },
+                  "required": [
+                    "year",
+                    "count"
+                  ],
+                  "type": "object"
+                },
+                "type": "array"
+              },
+              "lookbackMonths": {
+                "type": "number"
+              },
+              "medianSpreadBps": {
+                "nullable": true,
+                "type": "number"
+              },
+              "spreadHistogram": {
+                "items": {
+                  "properties": {
+                    "count": {
+                      "type": "number"
+                    },
+                    "spreadBps": {
+                      "type": "number"
+                    }
+                  },
+                  "required": [
+                    "spreadBps",
+                    "count"
+                  ],
+                  "type": "object"
+                },
+                "type": "array"
+              },
+              "thresholdBps": {
+                "type": "number"
+              },
+              "topStateConcentrationPct": {
+                "type": "number"
+              },
+              "totals": {
+                "properties": {
+                  "count": {
+                    "type": "number"
+                  },
+                  "medianLoanAmount": {
+                    "nullable": true,
+                    "type": "number"
+                  },
+                  "totalVolume": {
+                    "type": "number"
+                  }
+                },
+                "required": [
+                  "count",
+                  "totalVolume",
+                  "medianLoanAmount"
+                ],
+                "type": "object"
+              }
+            },
+            "required": [
+              "baseline",
+              "thresholdBps",
+              "lookbackMonths",
+              "totals",
+              "byState",
+              "spreadHistogram",
+              "medianSpreadBps",
+              "byVintage",
+              "byLoanType",
+              "topStateConcentrationPct"
+            ],
+            "type": "object"
+          },
+          "status": {
+            "properties": {
+              "applications": {
+                "properties": {
+                  "current": {
+                    "type": "number"
+                  },
+                  "prior": {
+                    "type": "number"
+                  }
+                },
+                "required": [
+                  "current",
+                  "prior"
+                ],
+                "type": "object"
+              },
+              "approvals": {
+                "properties": {
+                  "current": {
+                    "type": "number"
+                  },
+                  "prior": {
+                    "type": "number"
+                  }
+                },
+                "required": [
+                  "current",
+                  "prior"
+                ],
+                "type": "object"
+              },
+              "expectedClosings": {
+                "type": "number"
+              },
+              "locks": {
+                "properties": {
+                  "current": {
+                    "type": "number"
+                  },
+                  "prior": {
+                    "type": "number"
+                  }
+                },
+                "required": [
+                  "current",
+                  "prior"
+                ],
+                "type": "object"
+              },
+              "timeToClose": {
+                "properties": {
+                  "current": {
+                    "properties": {
+                      "median": {
+                        "nullable": true,
+                        "type": "number"
+                      },
+                      "sampleCount": {
+                        "type": "number"
+                      }
+                    },
+                    "required": [
+                      "median",
+                      "sampleCount"
+                    ],
+                    "type": "object"
+                  },
+                  "prior": {
+                    "properties": {
+                      "median": {
+                        "nullable": true,
+                        "type": "number"
+                      },
+                      "sampleCount": {
+                        "type": "number"
+                      }
+                    },
+                    "required": [
+                      "median",
+                      "sampleCount"
+                    ],
+                    "type": "object"
+                  }
+                },
+                "required": [
+                  "current",
+                  "prior"
+                ],
+                "type": "object"
+              }
+            },
+            "required": [
+              "applications",
+              "locks",
+              "approvals",
+              "timeToClose",
+              "expectedClosings"
+            ],
+            "type": "object"
+          }
+        },
+        "type": "object"
+      },
+      "MarketSignalsWindow": {
+        "description": "`[gte, lt)` window, YYYY-MM-DD.",
+        "properties": {
+          "gte": {
+            "format": "date",
+            "type": "string"
+          },
+          "lt": {
+            "format": "date",
+            "type": "string"
+          }
+        },
+        "required": [
+          "gte",
+          "lt"
+        ],
+        "type": "object"
+      },
       "MarketSliceDimension": {
         "enum": [
           "state",
@@ -30632,7 +31289,9 @@
           "veteranIndicator",
           "hmdaActionTaken",
           "selfEmployed",
-          "currentHomeOwner"
+          "currentHomeOwner",
+          "lenderType",
+          "lenderVolumeClass"
         ],
         "type": "string"
       },
@@ -44802,7 +45461,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.123.0"
+    "version": "3.124.0"
   },
   "openapi": "3.1.0",
   "paths": {
@@ -74763,6 +75422,96 @@
         ]
       }
     },
+    "/v1/market/signals": {
+      "post": {
+        "operationId": "marketSignals",
+        "requestBody": {
+          "content": {
+            "application/json": {
+              "schema": {
+                "$ref": "#/components/schemas/MarketSignalsRequest"
+              }
+            }
+          }
+        },
+        "responses": {
+          "200": {
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/MarketSignalsResponse"
+                }
+              }
+            },
+            "description": "The requested stats"
+          },
+          "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": "Market Signals card stats (web app feed)",
+        "tags": [
+          "Market"
+        ]
+      }
+    },
     "/v1/me": {
       "get": {
         "description": "Identity, active organization + membership role, and how the caller authenticated.\n\nExtended profile fields (`nmlsId`, `jobRole`, the contact-card block) are resolved for every caller type — session-cookie, API-key, and OAuth-bearer alike. `auth.profileResolved` is `true` on any successful read; it is retained for compatibility and no longer varies by the credential the caller presented.",