@model-match/api 3.53.0 → 3.54.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/RELEASE_NOTES.md +5 -0
- package/dist/{index-BmT-evv2.d.mts → index-CwPgXL7S.d.mts} +65 -2
- package/dist/index.d.mts +2 -2
- package/dist/slim/index.d.mts +2 -2
- package/openapi.json +264 -2
- package/package.json +1 -1
package/openapi.json
CHANGED
|
@@ -262,6 +262,56 @@
|
|
|
262
262
|
],
|
|
263
263
|
"type": "string"
|
|
264
264
|
},
|
|
265
|
+
"AgentContacts": {
|
|
266
|
+
"properties": {
|
|
267
|
+
"emails": {
|
|
268
|
+
"items": {
|
|
269
|
+
"type": "string"
|
|
270
|
+
},
|
|
271
|
+
"type": "array"
|
|
272
|
+
},
|
|
273
|
+
"phones": {
|
|
274
|
+
"items": {
|
|
275
|
+
"properties": {
|
|
276
|
+
"number": {
|
|
277
|
+
"type": "string"
|
|
278
|
+
},
|
|
279
|
+
"type": {
|
|
280
|
+
"enum": [
|
|
281
|
+
"mobile",
|
|
282
|
+
"direct",
|
|
283
|
+
"office"
|
|
284
|
+
],
|
|
285
|
+
"type": "string"
|
|
286
|
+
}
|
|
287
|
+
},
|
|
288
|
+
"required": [
|
|
289
|
+
"number",
|
|
290
|
+
"type"
|
|
291
|
+
],
|
|
292
|
+
"type": "object"
|
|
293
|
+
},
|
|
294
|
+
"type": "array"
|
|
295
|
+
},
|
|
296
|
+
"socialLinks": {
|
|
297
|
+
"items": {
|
|
298
|
+
"type": "string"
|
|
299
|
+
},
|
|
300
|
+
"type": "array"
|
|
301
|
+
},
|
|
302
|
+
"website": {
|
|
303
|
+
"nullable": true,
|
|
304
|
+
"type": "string"
|
|
305
|
+
}
|
|
306
|
+
},
|
|
307
|
+
"required": [
|
|
308
|
+
"emails",
|
|
309
|
+
"phones",
|
|
310
|
+
"website",
|
|
311
|
+
"socialLinks"
|
|
312
|
+
],
|
|
313
|
+
"type": "object"
|
|
314
|
+
},
|
|
265
315
|
"AgentCountyFilterValue": {
|
|
266
316
|
"anyOf": [
|
|
267
317
|
{
|
|
@@ -370,6 +420,9 @@
|
|
|
370
420
|
},
|
|
371
421
|
{
|
|
372
422
|
"properties": {
|
|
423
|
+
"contacts": {
|
|
424
|
+
"$ref": "#/components/schemas/AgentContacts"
|
|
425
|
+
},
|
|
373
426
|
"licenses": {
|
|
374
427
|
"items": {
|
|
375
428
|
"$ref": "#/components/schemas/AgentLicense"
|
|
@@ -390,6 +443,12 @@
|
|
|
390
443
|
"nullable": true,
|
|
391
444
|
"type": "array"
|
|
392
445
|
},
|
|
446
|
+
"offices": {
|
|
447
|
+
"items": {
|
|
448
|
+
"$ref": "#/components/schemas/AgentOfficeEntry"
|
|
449
|
+
},
|
|
450
|
+
"type": "array"
|
|
451
|
+
},
|
|
393
452
|
"scored": {
|
|
394
453
|
"nullable": true
|
|
395
454
|
}
|
|
@@ -1051,6 +1110,18 @@
|
|
|
1051
1110
|
],
|
|
1052
1111
|
"description": "Scoped lender filter(s). Each entry names ONE financing relationship and the metric bounds that must hold INSIDE it — `{lender:'<id>', volume:{gte:10000000}}` means '$10M of their sales were financed by that lender', not '$10M of sales and one deal with them'. Several entries AND together. Geographic market filters are not available here: use `POST /v1/agents/{id}/markets` (live-aggregated) for an agent's geography."
|
|
1053
1112
|
},
|
|
1113
|
+
"include": {
|
|
1114
|
+
"description": "Opt-in row blocks.",
|
|
1115
|
+
"items": {
|
|
1116
|
+
"enum": [
|
|
1117
|
+
"contacts",
|
|
1118
|
+
"offices",
|
|
1119
|
+
"loanMix"
|
|
1120
|
+
],
|
|
1121
|
+
"type": "string"
|
|
1122
|
+
},
|
|
1123
|
+
"type": "array"
|
|
1124
|
+
},
|
|
1054
1125
|
"lenderFilters": {
|
|
1055
1126
|
"items": {
|
|
1056
1127
|
"$ref": "#/components/schemas/LenderFilterEntry"
|
|
@@ -1125,7 +1196,7 @@
|
|
|
1125
1196
|
},
|
|
1126
1197
|
"data": {
|
|
1127
1198
|
"items": {
|
|
1128
|
-
"$ref": "#/components/schemas/
|
|
1199
|
+
"$ref": "#/components/schemas/AgentListRow"
|
|
1129
1200
|
},
|
|
1130
1201
|
"type": "array"
|
|
1131
1202
|
},
|
|
@@ -1146,6 +1217,140 @@
|
|
|
1146
1217
|
],
|
|
1147
1218
|
"type": "object"
|
|
1148
1219
|
},
|
|
1220
|
+
"AgentListRow": {
|
|
1221
|
+
"properties": {
|
|
1222
|
+
"avgSoldPrice": {
|
|
1223
|
+
"nullable": true,
|
|
1224
|
+
"type": "number"
|
|
1225
|
+
},
|
|
1226
|
+
"buyerUnits": {
|
|
1227
|
+
"nullable": true,
|
|
1228
|
+
"type": "number"
|
|
1229
|
+
},
|
|
1230
|
+
"buyerVolume": {
|
|
1231
|
+
"nullable": true,
|
|
1232
|
+
"type": "number"
|
|
1233
|
+
},
|
|
1234
|
+
"city": {
|
|
1235
|
+
"nullable": true,
|
|
1236
|
+
"type": "string"
|
|
1237
|
+
},
|
|
1238
|
+
"contacts": {
|
|
1239
|
+
"$ref": "#/components/schemas/AgentContacts"
|
|
1240
|
+
},
|
|
1241
|
+
"dualUnits": {
|
|
1242
|
+
"nullable": true,
|
|
1243
|
+
"type": "number"
|
|
1244
|
+
},
|
|
1245
|
+
"dualVolume": {
|
|
1246
|
+
"nullable": true,
|
|
1247
|
+
"type": "number"
|
|
1248
|
+
},
|
|
1249
|
+
"email": {
|
|
1250
|
+
"nullable": true,
|
|
1251
|
+
"type": "string"
|
|
1252
|
+
},
|
|
1253
|
+
"firstName": {
|
|
1254
|
+
"nullable": true,
|
|
1255
|
+
"type": "string"
|
|
1256
|
+
},
|
|
1257
|
+
"fullName": {
|
|
1258
|
+
"nullable": true,
|
|
1259
|
+
"type": "string"
|
|
1260
|
+
},
|
|
1261
|
+
"id": {
|
|
1262
|
+
"description": "Document ID",
|
|
1263
|
+
"type": "string"
|
|
1264
|
+
},
|
|
1265
|
+
"lastName": {
|
|
1266
|
+
"nullable": true,
|
|
1267
|
+
"type": "string"
|
|
1268
|
+
},
|
|
1269
|
+
"licenseNumber": {
|
|
1270
|
+
"nullable": true,
|
|
1271
|
+
"type": "string"
|
|
1272
|
+
},
|
|
1273
|
+
"loanMix": {
|
|
1274
|
+
"items": {
|
|
1275
|
+
"$ref": "#/components/schemas/AgentLoanMixEntry"
|
|
1276
|
+
},
|
|
1277
|
+
"type": "array"
|
|
1278
|
+
},
|
|
1279
|
+
"modelMatchId": {
|
|
1280
|
+
"nullable": true,
|
|
1281
|
+
"type": "string"
|
|
1282
|
+
},
|
|
1283
|
+
"office": {
|
|
1284
|
+
"nullable": true,
|
|
1285
|
+
"type": "string"
|
|
1286
|
+
},
|
|
1287
|
+
"offices": {
|
|
1288
|
+
"items": {
|
|
1289
|
+
"$ref": "#/components/schemas/AgentOfficeEntry"
|
|
1290
|
+
},
|
|
1291
|
+
"type": "array"
|
|
1292
|
+
},
|
|
1293
|
+
"phone": {
|
|
1294
|
+
"nullable": true,
|
|
1295
|
+
"type": "string"
|
|
1296
|
+
},
|
|
1297
|
+
"sellerUnits": {
|
|
1298
|
+
"nullable": true,
|
|
1299
|
+
"type": "number"
|
|
1300
|
+
},
|
|
1301
|
+
"sellerVolume": {
|
|
1302
|
+
"nullable": true,
|
|
1303
|
+
"type": "number"
|
|
1304
|
+
},
|
|
1305
|
+
"state": {
|
|
1306
|
+
"nullable": true,
|
|
1307
|
+
"type": "string"
|
|
1308
|
+
},
|
|
1309
|
+
"totalCompaniesWorkedWith": {
|
|
1310
|
+
"nullable": true,
|
|
1311
|
+
"type": "number"
|
|
1312
|
+
},
|
|
1313
|
+
"totalLendersWorkedWith": {
|
|
1314
|
+
"nullable": true,
|
|
1315
|
+
"type": "number"
|
|
1316
|
+
},
|
|
1317
|
+
"totalOriginatorsWorkedWith": {
|
|
1318
|
+
"nullable": true,
|
|
1319
|
+
"type": "number"
|
|
1320
|
+
},
|
|
1321
|
+
"units": {
|
|
1322
|
+
"nullable": true,
|
|
1323
|
+
"type": "number"
|
|
1324
|
+
},
|
|
1325
|
+
"volume": {
|
|
1326
|
+
"nullable": true,
|
|
1327
|
+
"type": "number"
|
|
1328
|
+
},
|
|
1329
|
+
"zip": {
|
|
1330
|
+
"nullable": true,
|
|
1331
|
+
"type": "string"
|
|
1332
|
+
}
|
|
1333
|
+
},
|
|
1334
|
+
"required": [
|
|
1335
|
+
"id"
|
|
1336
|
+
],
|
|
1337
|
+
"type": "object"
|
|
1338
|
+
},
|
|
1339
|
+
"AgentLoanMixEntry": {
|
|
1340
|
+
"properties": {
|
|
1341
|
+
"key": {
|
|
1342
|
+
"type": "string"
|
|
1343
|
+
},
|
|
1344
|
+
"volume": {
|
|
1345
|
+
"type": "number"
|
|
1346
|
+
}
|
|
1347
|
+
},
|
|
1348
|
+
"required": [
|
|
1349
|
+
"key",
|
|
1350
|
+
"volume"
|
|
1351
|
+
],
|
|
1352
|
+
"type": "object"
|
|
1353
|
+
},
|
|
1149
1354
|
"AgentLoanMixRequest": {
|
|
1150
1355
|
"additionalProperties": false,
|
|
1151
1356
|
"properties": {
|
|
@@ -2665,6 +2870,63 @@
|
|
|
2665
2870
|
"minItems": 1,
|
|
2666
2871
|
"type": "array"
|
|
2667
2872
|
},
|
|
2873
|
+
"AgentOfficeEntry": {
|
|
2874
|
+
"properties": {
|
|
2875
|
+
"city": {
|
|
2876
|
+
"nullable": true,
|
|
2877
|
+
"type": "string"
|
|
2878
|
+
},
|
|
2879
|
+
"key": {
|
|
2880
|
+
"nullable": true,
|
|
2881
|
+
"type": "string"
|
|
2882
|
+
},
|
|
2883
|
+
"lastTransactionDate": {
|
|
2884
|
+
"nullable": true,
|
|
2885
|
+
"type": "string"
|
|
2886
|
+
},
|
|
2887
|
+
"lat": {
|
|
2888
|
+
"nullable": true,
|
|
2889
|
+
"type": "number"
|
|
2890
|
+
},
|
|
2891
|
+
"lon": {
|
|
2892
|
+
"nullable": true,
|
|
2893
|
+
"type": "number"
|
|
2894
|
+
},
|
|
2895
|
+
"name": {
|
|
2896
|
+
"nullable": true,
|
|
2897
|
+
"type": "string"
|
|
2898
|
+
},
|
|
2899
|
+
"state": {
|
|
2900
|
+
"nullable": true,
|
|
2901
|
+
"type": "string"
|
|
2902
|
+
},
|
|
2903
|
+
"street": {
|
|
2904
|
+
"nullable": true,
|
|
2905
|
+
"type": "string"
|
|
2906
|
+
},
|
|
2907
|
+
"transactions": {
|
|
2908
|
+
"nullable": true,
|
|
2909
|
+
"type": "number"
|
|
2910
|
+
},
|
|
2911
|
+
"zip": {
|
|
2912
|
+
"nullable": true,
|
|
2913
|
+
"type": "string"
|
|
2914
|
+
}
|
|
2915
|
+
},
|
|
2916
|
+
"required": [
|
|
2917
|
+
"key",
|
|
2918
|
+
"name",
|
|
2919
|
+
"street",
|
|
2920
|
+
"city",
|
|
2921
|
+
"state",
|
|
2922
|
+
"zip",
|
|
2923
|
+
"lat",
|
|
2924
|
+
"lon",
|
|
2925
|
+
"lastTransactionDate",
|
|
2926
|
+
"transactions"
|
|
2927
|
+
],
|
|
2928
|
+
"type": "object"
|
|
2929
|
+
},
|
|
2668
2930
|
"AgentOfficeGroup": {
|
|
2669
2931
|
"properties": {
|
|
2670
2932
|
"entries": {
|
|
@@ -44209,7 +44471,7 @@
|
|
|
44209
44471
|
"info": {
|
|
44210
44472
|
"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.",
|
|
44211
44473
|
"title": "ModelMatch API",
|
|
44212
|
-
"version": "3.
|
|
44474
|
+
"version": "3.120.0"
|
|
44213
44475
|
},
|
|
44214
44476
|
"openapi": "3.1.0",
|
|
44215
44477
|
"paths": {
|