@model-match/api 3.59.1 → 3.61.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 +8 -0
- package/dist/{index-D0bHfN1q.d.mts → index-DMF1PBUb.d.mts} +30 -106
- package/dist/index.d.mts +2 -2
- package/dist/index.mjs +1 -1
- package/dist/slim/index.d.mts +2 -8
- package/dist/slim/index.mjs +2 -22
- package/dist/{src-DDDDlSvL.mjs → src-CCQcx7Ow.mjs} +0 -22
- package/openapi.json +58 -320
- package/package.json +1 -1
package/dist/slim/index.mjs
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { S as client, n as createClient } from "../src-
|
|
1
|
+
import { S as client, n as createClient } from "../src-CCQcx7Ow.mjs";
|
|
2
2
|
//#region src/slim/sdk.gen.ts
|
|
3
3
|
/**
|
|
4
4
|
* Search agents with filters
|
|
@@ -4563,26 +4563,6 @@ const suggestLocations = (options) => (options.client ?? client).get({
|
|
|
4563
4563
|
...options
|
|
4564
4564
|
});
|
|
4565
4565
|
/**
|
|
4566
|
-
* Search aggregated market data with filters
|
|
4567
|
-
*
|
|
4568
|
-
* Search aggregated loan origination market data. Filterable dimensions cover geography (state, county, zip), product (loan purpose / type / amortization), borrower demographics, and loan numerics.
|
|
4569
|
-
*/
|
|
4570
|
-
const listMarket = (options) => (options?.client ?? client).post({
|
|
4571
|
-
security: [{
|
|
4572
|
-
name: "x-api-key",
|
|
4573
|
-
type: "apiKey"
|
|
4574
|
-
}, {
|
|
4575
|
-
scheme: "bearer",
|
|
4576
|
-
type: "http"
|
|
4577
|
-
}],
|
|
4578
|
-
url: "/v1/market",
|
|
4579
|
-
...options,
|
|
4580
|
-
headers: {
|
|
4581
|
-
"Content-Type": "application/json",
|
|
4582
|
-
...options?.headers
|
|
4583
|
-
}
|
|
4584
|
-
});
|
|
4585
|
-
/**
|
|
4586
4566
|
* Market measure by dimension breakdown
|
|
4587
4567
|
*/
|
|
4588
4568
|
const marketAnalyticsChart = (options) => (options?.client ?? client).post({
|
|
@@ -6229,4 +6209,4 @@ const getSearchToken = (options) => (options?.client ?? client).get({
|
|
|
6229
6209
|
...options
|
|
6230
6210
|
});
|
|
6231
6211
|
//#endregion
|
|
6232
|
-
export { client as _heyApiClient, actionCrmCallerId, addCrmContactMethod, addCrmListMember, addCrmListMembersBulk, addCrmNote, addCrmRecord, addCrmRecordsBulk, addWatchedAgent, addWatchedArea, addWatchedDocument, agentAnalyticsChart, agentAnalyticsSummary, agentAnalyticsTimeSeries, agentBuilders, agentCities, agentCompanies, agentCounties, agentLenders, agentLoanMix, agentMarkets, agentMortgagedTimeSeries, agentOffices, agentOriginators, agentProperties, agentRelated, agentSales, agentStates, agentTitleCompanies, agentTitleCompaniesTimeSeries, agentZipCodes, analyzeCrmCall, applyCrmEnrichment, applyCrmListMiUpdates, applyCrmListTemplate, applyCrmMiUpdates, branchAnalyticsChart, branchAnalyticsSummary, branchAnalyticsTimeSeries, branchCities, branchCommunityLendingMap, branchCounties, branchLenders, branchLoans, branchOriginators, branchRoster, branchStates, branchStats, branchTitleCompanies, cancelAgentsBulkDeliveryJob, cancelBranchesBulkDeliveryJob, cancelCompaniesBulkDeliveryJob, cancelEnrichBulkJob, cancelLoansBulkDeliveryJob, cancelOriginatorsBulkDeliveryJob, cancelPropertiesBulkDeliveryJob, checkCrmImport, companyAgents, companyAnalyticsChart, companyAnalyticsSummary, companyAnalyticsTimeSeries, companyBranches, companyBrokers, companyCities, companyCommunityLendingBenchmark, companyCommunityLendingMap, companyCounties, companyDepartureStatus, companyEarlyExits, companyEmployeeStats, companyEmployment, companyHeadcount, companyLenders, companyMarkets, companyMoverProduction, companyOffices, companyOriginators, companyRelated, companyRetention, companyRetentionActiveListings, companySponsoredIndividuals, companySponsorshipMovement, companyStates, companyTalentFlow, companyTitleCompanies, companyZipCodes, countAgents, countBranches, countCompanies, countLenders, countLoans, countOffices, countOriginators, countProperties, countSales, createAgentContactSubmission, createAlertSubscription, createClient, createCrmList, createCrmListField, createCrmManualRecord, createCrmMeeting, createCrmObjectField, createCrmRecord, createCrmTask, createCrmTemplate, createMyAlertRecipe, createOriginatorContactSubmission, createSavedFilter, crmLenderChannels, crmLoLoanMix, crmLoMomentum, crmLoSponsorLocation, crmSimilarOriginators, declineCrmMiUpdate, deleteAlertSubscription, deleteCrmCallerId, deleteCrmList, deleteCrmListField, deleteCrmMeeting, deleteCrmNote, deleteCrmObjectField, deleteCrmRecord, deleteCrmRecords, deleteCrmTask, deleteCrmTemplate, deleteMyAlertRecipe, deleteSavedFilter, describeCrmRecordsOnAdd, dismissCrmListMiUpdates, dismissCrmMiUpdates, editCrmLoggedActivity, editCrmNote, enrichPropertiesBatch, enrichPropertiesBulk, enrichProperty, filterCrmListMembers, findCrmRecordByNmls, generateCrmRecordDescription, getAgent, getAgentsBulkDeliveryJob, getAlertConditions, getAlertEmailTokens, getAlertUnreadCount, getBranch, getBranchesBulkDeliveryJob, getCompaniesBulkDeliveryJob, getCompany, getCrmActiveCall, getCrmActivityReport, getCrmCall, getCrmCallTranscript, getCrmCustomValues, getCrmImport, getCrmImportJob, getCrmList, getCrmListMemberIds, getCrmListMiUpdates, getCrmListShares, getCrmMiUpdates, getCrmOutcomesReport, getCrmOverrides, getCrmProductionEnrichJob, getCrmRecordAccess, getCrmRecordAccessRequest, getCrmRecordConnections, getCrmRecordMemberIds, getCrmRecordProfile, getCrmTemplate, getCrmTemplateShares, getEnrichBulkJob, getHubspotPushStatus, getLender, getLoan, getLoansBulkDeliveryJob, getMe, getMeCredits, getMePlan, getOffice, getOriginator, getOriginatorsBulkDeliveryJob, getPropertiesBulkDeliveryJob, getProperty, getRealtimeConfig, getSale, getSavedFilter, getSavedFilterShares, getSearchToken, grantCrmListAccess, grantCrmRecordAccess, grantCrmRecordAccessRequest, grantSavedFilterAccess, hangupCrmCall, importCrmRecords, instantSearch, lenderCities, lenderCompanies, lenderCounties, lenderOriginators, lenderStates, linkCrmRecord, listAgentOfficeGroups, listAgents, listAlertDigests, listAlertLog, listAlertRecipes, listAlertSubscriptions, listBranches, listCompanies, listCrmActivity, listCrmCallerIds, listCrmCustomFields, listCrmImportRows, listCrmImports, listCrmListAssignees, listCrmListFields, listCrmListMemberships, listCrmListShareableMembers, listCrmLists, listCrmMeetings, listCrmMembers, listCrmOrgMembers, listCrmRecordShareableMembers, listCrmRecordShares, listCrmReferencedActivity, listCrmTasks, listCrmTemplates, listCrmWorkspaceMeetings, listCrmWorkspaceTasks, listEnrichments, listLenders, listLoans,
|
|
6212
|
+
export { client as _heyApiClient, actionCrmCallerId, addCrmContactMethod, addCrmListMember, addCrmListMembersBulk, addCrmNote, addCrmRecord, addCrmRecordsBulk, addWatchedAgent, addWatchedArea, addWatchedDocument, agentAnalyticsChart, agentAnalyticsSummary, agentAnalyticsTimeSeries, agentBuilders, agentCities, agentCompanies, agentCounties, agentLenders, agentLoanMix, agentMarkets, agentMortgagedTimeSeries, agentOffices, agentOriginators, agentProperties, agentRelated, agentSales, agentStates, agentTitleCompanies, agentTitleCompaniesTimeSeries, agentZipCodes, analyzeCrmCall, applyCrmEnrichment, applyCrmListMiUpdates, applyCrmListTemplate, applyCrmMiUpdates, branchAnalyticsChart, branchAnalyticsSummary, branchAnalyticsTimeSeries, branchCities, branchCommunityLendingMap, branchCounties, branchLenders, branchLoans, branchOriginators, branchRoster, branchStates, branchStats, branchTitleCompanies, cancelAgentsBulkDeliveryJob, cancelBranchesBulkDeliveryJob, cancelCompaniesBulkDeliveryJob, cancelEnrichBulkJob, cancelLoansBulkDeliveryJob, cancelOriginatorsBulkDeliveryJob, cancelPropertiesBulkDeliveryJob, checkCrmImport, companyAgents, companyAnalyticsChart, companyAnalyticsSummary, companyAnalyticsTimeSeries, companyBranches, companyBrokers, companyCities, companyCommunityLendingBenchmark, companyCommunityLendingMap, companyCounties, companyDepartureStatus, companyEarlyExits, companyEmployeeStats, companyEmployment, companyHeadcount, companyLenders, companyMarkets, companyMoverProduction, companyOffices, companyOriginators, companyRelated, companyRetention, companyRetentionActiveListings, companySponsoredIndividuals, companySponsorshipMovement, companyStates, companyTalentFlow, companyTitleCompanies, companyZipCodes, countAgents, countBranches, countCompanies, countLenders, countLoans, countOffices, countOriginators, countProperties, countSales, createAgentContactSubmission, createAlertSubscription, createClient, createCrmList, createCrmListField, createCrmManualRecord, createCrmMeeting, createCrmObjectField, createCrmRecord, createCrmTask, createCrmTemplate, createMyAlertRecipe, createOriginatorContactSubmission, createSavedFilter, crmLenderChannels, crmLoLoanMix, crmLoMomentum, crmLoSponsorLocation, crmSimilarOriginators, declineCrmMiUpdate, deleteAlertSubscription, deleteCrmCallerId, deleteCrmList, deleteCrmListField, deleteCrmMeeting, deleteCrmNote, deleteCrmObjectField, deleteCrmRecord, deleteCrmRecords, deleteCrmTask, deleteCrmTemplate, deleteMyAlertRecipe, deleteSavedFilter, describeCrmRecordsOnAdd, dismissCrmListMiUpdates, dismissCrmMiUpdates, editCrmLoggedActivity, editCrmNote, enrichPropertiesBatch, enrichPropertiesBulk, enrichProperty, filterCrmListMembers, findCrmRecordByNmls, generateCrmRecordDescription, getAgent, getAgentsBulkDeliveryJob, getAlertConditions, getAlertEmailTokens, getAlertUnreadCount, getBranch, getBranchesBulkDeliveryJob, getCompaniesBulkDeliveryJob, getCompany, getCrmActiveCall, getCrmActivityReport, getCrmCall, getCrmCallTranscript, getCrmCustomValues, getCrmImport, getCrmImportJob, getCrmList, getCrmListMemberIds, getCrmListMiUpdates, getCrmListShares, getCrmMiUpdates, getCrmOutcomesReport, getCrmOverrides, getCrmProductionEnrichJob, getCrmRecordAccess, getCrmRecordAccessRequest, getCrmRecordConnections, getCrmRecordMemberIds, getCrmRecordProfile, getCrmTemplate, getCrmTemplateShares, getEnrichBulkJob, getHubspotPushStatus, getLender, getLoan, getLoansBulkDeliveryJob, getMe, getMeCredits, getMePlan, getOffice, getOriginator, getOriginatorsBulkDeliveryJob, getPropertiesBulkDeliveryJob, getProperty, getRealtimeConfig, getSale, getSavedFilter, getSavedFilterShares, getSearchToken, grantCrmListAccess, grantCrmRecordAccess, grantCrmRecordAccessRequest, grantSavedFilterAccess, hangupCrmCall, importCrmRecords, instantSearch, lenderCities, lenderCompanies, lenderCounties, lenderOriginators, lenderStates, linkCrmRecord, listAgentOfficeGroups, listAgents, listAlertDigests, listAlertLog, listAlertRecipes, listAlertSubscriptions, listBranches, listCompanies, listCrmActivity, listCrmCallerIds, listCrmCustomFields, listCrmImportRows, listCrmImports, listCrmListAssignees, listCrmListFields, listCrmListMemberships, listCrmListShareableMembers, listCrmLists, listCrmMeetings, listCrmMembers, listCrmOrgMembers, listCrmRecordShareableMembers, listCrmRecordShares, listCrmReferencedActivity, listCrmTasks, listCrmTemplates, listCrmWorkspaceMeetings, listCrmWorkspaceTasks, listEnrichments, listLenders, listLoans, listMyAlertRecipes, listOffices, listOriginators, listProperties, listSales, listSavedFilterShareableMembers, listSavedFilters, listWatchedAgents, listWatchedAreas, listWatchedDocuments, loanRelated, loansAnalyticsChart, loansAnalyticsSummary, loansAnalyticsTimeSeries, logCrmActivity, lookupCompanies, markAlertDigestRead, markAlertRead, markAllAlertsRead, marketAnalyticsChart, marketAnalyticsSummary, marketAnalyticsTimeSeries, marketCommunityLending, marketMovementActivity, marketMovementByState, marketMovementCohortPayoff, marketMovementMostGained, marketMovementMostLost, marketMovementMovers, marketMovementRankings, marketMovementStats, marketMovementTransitions, marketSignals, officeAgents, officeBuilders, officeLenders, officeLoanTypes, officeOriginators, originatorAgents, originatorAnalyticsChart, originatorAnalyticsSummary, originatorAnalyticsTimeSeries, originatorBranches, originatorBrokers, originatorBuilders, originatorCitiesBreakdown, originatorCommunityLendingBenchmark, originatorCommunityLendingMap, originatorCompanies, originatorCountiesBreakdown, originatorLenders, originatorLoans, originatorMarkets, originatorOffices, originatorProperties, originatorRelated, originatorRetention, originatorStatesBreakdown, originatorTitleCompanies, originatorZipCodes, placeCrmCall, previewAlertEmailTemplate, previewAlertRecipe, previewAlerts, previewMyAlertRecipe, propertiesAnalyticsChart, propertiesAnalyticsSummary, propertyRelated, pushToHubspot, reconcileCrmMeetings, refreshCrmRecordMirror, removeCrmContactMethod, removeCrmListMember, removeWatchedAgent, removeWatchedArea, removeWatchedDocument, requestCrmAccess, requestCrmRecordAccess, resolveProperties, retrieveLocation, revokeCrmListAccess, revokeCrmRecordAccess, revokeSavedFilterAccess, saleRelated, salesAnalyticsChart, salesAnalyticsSummary, salesAnalyticsTimeSeries, searchCrmEmailRecipients, searchCrmMatchCandidates, searchCrmMentionRecords, searchCrmRecords, searchProperties, sendCrmEmail, setCrmCallAnalysis, setCrmCustomValue, setCrmOverride, setCrmRecordOwner, setDefaultCrmCallerId, shareCrmTemplate, submitAgentsBulkDelivery, submitBranchesBulkDelivery, submitCompaniesBulkDelivery, submitLoansBulkDelivery, submitOriginatorsBulkDelivery, submitPropertiesBulkDelivery, subscribeAlertRecipe, suggestLocations, suggestOfficeNames, transcribeCrmCall, transferCrmListOwnership, undoCrmImport, unshareCrmTemplate, unsubscribeAlertRecipe, updateAlertConditions, updateCrmContactMethod, updateCrmList, updateCrmListField, updateCrmMeeting, updateCrmObjectField, updateCrmTask, updateCrmTemplate, updateMe, updateMyAlertRecipe, updateSavedFilter };
|
|
@@ -5801,28 +5801,6 @@ var Locations = class {
|
|
|
5801
5801
|
}
|
|
5802
5802
|
};
|
|
5803
5803
|
var Market = class {
|
|
5804
|
-
/**
|
|
5805
|
-
* Search aggregated market data with filters
|
|
5806
|
-
*
|
|
5807
|
-
* Search aggregated loan origination market data. Filterable dimensions cover geography (state, county, zip), product (loan purpose / type / amortization), borrower demographics, and loan numerics.
|
|
5808
|
-
*/
|
|
5809
|
-
static list(options) {
|
|
5810
|
-
return (options?.client ?? client).post({
|
|
5811
|
-
security: [{
|
|
5812
|
-
name: "x-api-key",
|
|
5813
|
-
type: "apiKey"
|
|
5814
|
-
}, {
|
|
5815
|
-
scheme: "bearer",
|
|
5816
|
-
type: "http"
|
|
5817
|
-
}],
|
|
5818
|
-
url: "/v1/market",
|
|
5819
|
-
...options,
|
|
5820
|
-
headers: {
|
|
5821
|
-
"Content-Type": "application/json",
|
|
5822
|
-
...options?.headers
|
|
5823
|
-
}
|
|
5824
|
-
});
|
|
5825
|
-
}
|
|
5826
5804
|
/**
|
|
5827
5805
|
* Market measure by dimension breakdown
|
|
5828
5806
|
*/
|
package/openapi.json
CHANGED
|
@@ -11912,6 +11912,11 @@
|
|
|
11912
11912
|
},
|
|
11913
11913
|
"propertyId": {
|
|
11914
11914
|
"type": "string"
|
|
11915
|
+
},
|
|
11916
|
+
"writtenAt": {
|
|
11917
|
+
"description": "`view=team` only: the previous employer the LO wrote this loan at. Null on a loan written at the company (and on every `view=company` row).",
|
|
11918
|
+
"nullable": true,
|
|
11919
|
+
"type": "string"
|
|
11915
11920
|
}
|
|
11916
11921
|
},
|
|
11917
11922
|
"required": [
|
|
@@ -11989,6 +11994,38 @@
|
|
|
11989
11994
|
],
|
|
11990
11995
|
"type": "string"
|
|
11991
11996
|
},
|
|
11997
|
+
"team": {
|
|
11998
|
+
"description": "The current-team view's counts; null until the batch has checked it for this company.",
|
|
11999
|
+
"nullable": true,
|
|
12000
|
+
"properties": {
|
|
12001
|
+
"roster": {
|
|
12002
|
+
"description": "Current LOs (active sponsorships) checked.",
|
|
12003
|
+
"type": "integer"
|
|
12004
|
+
},
|
|
12005
|
+
"status": {
|
|
12006
|
+
"enum": [
|
|
12007
|
+
"ok",
|
|
12008
|
+
"timeout"
|
|
12009
|
+
],
|
|
12010
|
+
"type": "string"
|
|
12011
|
+
},
|
|
12012
|
+
"total": {
|
|
12013
|
+
"description": "Rows in `view=team`: listings on loans by the company's current LOs, written at the company or at a previous employer.",
|
|
12014
|
+
"type": "integer"
|
|
12015
|
+
},
|
|
12016
|
+
"writtenElsewhere": {
|
|
12017
|
+
"description": "Of those, loans the LOs wrote at a previous employer.",
|
|
12018
|
+
"type": "integer"
|
|
12019
|
+
}
|
|
12020
|
+
},
|
|
12021
|
+
"required": [
|
|
12022
|
+
"status",
|
|
12023
|
+
"total",
|
|
12024
|
+
"writtenElsewhere",
|
|
12025
|
+
"roster"
|
|
12026
|
+
],
|
|
12027
|
+
"type": "object"
|
|
12028
|
+
},
|
|
11992
12029
|
"topOriginators": {
|
|
11993
12030
|
"description": "Top 10 LOs by active listings.",
|
|
11994
12031
|
"items": {
|
|
@@ -30181,34 +30218,6 @@
|
|
|
30181
30218
|
},
|
|
30182
30219
|
"type": "object"
|
|
30183
30220
|
},
|
|
30184
|
-
"MarketField": {
|
|
30185
|
-
"enum": [
|
|
30186
|
-
"state",
|
|
30187
|
-
"county",
|
|
30188
|
-
"zip",
|
|
30189
|
-
"closingDate",
|
|
30190
|
-
"loanPurpose",
|
|
30191
|
-
"loanType",
|
|
30192
|
-
"propertyType",
|
|
30193
|
-
"occupancyType",
|
|
30194
|
-
"amortizationType",
|
|
30195
|
-
"channel",
|
|
30196
|
-
"noteRate",
|
|
30197
|
-
"loanAmount",
|
|
30198
|
-
"creditScore",
|
|
30199
|
-
"ltv",
|
|
30200
|
-
"dti",
|
|
30201
|
-
"income",
|
|
30202
|
-
"appraisedValue",
|
|
30203
|
-
"purchasePrice",
|
|
30204
|
-
"combinedLtv",
|
|
30205
|
-
"dtifront",
|
|
30206
|
-
"loanTerm",
|
|
30207
|
-
"hmdaActionTaken",
|
|
30208
|
-
"loanApplicationDate"
|
|
30209
|
-
],
|
|
30210
|
-
"type": "string"
|
|
30211
|
-
},
|
|
30212
30221
|
"MarketFlatFilters": {
|
|
30213
30222
|
"additionalProperties": false,
|
|
30214
30223
|
"properties": {
|
|
@@ -30392,72 +30401,6 @@
|
|
|
30392
30401
|
},
|
|
30393
30402
|
"type": "object"
|
|
30394
30403
|
},
|
|
30395
|
-
"MarketListRequest": {
|
|
30396
|
-
"additionalProperties": false,
|
|
30397
|
-
"properties": {
|
|
30398
|
-
"advancedFilters": {
|
|
30399
|
-
"$ref": "#/components/schemas/FilterNode"
|
|
30400
|
-
},
|
|
30401
|
-
"filters": {
|
|
30402
|
-
"$ref": "#/components/schemas/FilterNode"
|
|
30403
|
-
},
|
|
30404
|
-
"flatFilters": {
|
|
30405
|
-
"$ref": "#/components/schemas/MarketFlatFilters"
|
|
30406
|
-
},
|
|
30407
|
-
"pagination": {
|
|
30408
|
-
"$ref": "#/components/schemas/Pagination"
|
|
30409
|
-
},
|
|
30410
|
-
"period": {
|
|
30411
|
-
"$ref": "#/components/schemas/DatedPeriod"
|
|
30412
|
-
},
|
|
30413
|
-
"sort": {
|
|
30414
|
-
"items": {
|
|
30415
|
-
"properties": {
|
|
30416
|
-
"field": {
|
|
30417
|
-
"$ref": "#/components/schemas/MarketField"
|
|
30418
|
-
},
|
|
30419
|
-
"order": {
|
|
30420
|
-
"$ref": "#/components/schemas/SortOrder"
|
|
30421
|
-
}
|
|
30422
|
-
},
|
|
30423
|
-
"required": [
|
|
30424
|
-
"field"
|
|
30425
|
-
],
|
|
30426
|
-
"type": "object"
|
|
30427
|
-
},
|
|
30428
|
-
"type": "array"
|
|
30429
|
-
}
|
|
30430
|
-
},
|
|
30431
|
-
"type": "object"
|
|
30432
|
-
},
|
|
30433
|
-
"MarketListResponse": {
|
|
30434
|
-
"properties": {
|
|
30435
|
-
"cursor": {
|
|
30436
|
-
"type": "string"
|
|
30437
|
-
},
|
|
30438
|
-
"data": {
|
|
30439
|
-
"items": {
|
|
30440
|
-
"$ref": "#/components/schemas/MarketRecord"
|
|
30441
|
-
},
|
|
30442
|
-
"type": "array"
|
|
30443
|
-
},
|
|
30444
|
-
"locationNormalizations": {
|
|
30445
|
-
"description": "How each location filter value resolved. Present when a `city`/`county`/`state`/`zip` filter was supplied.",
|
|
30446
|
-
"items": {
|
|
30447
|
-
"$ref": "#/components/schemas/LocationNormalization"
|
|
30448
|
-
},
|
|
30449
|
-
"type": "array"
|
|
30450
|
-
},
|
|
30451
|
-
"total": {
|
|
30452
|
-
"type": "number"
|
|
30453
|
-
}
|
|
30454
|
-
},
|
|
30455
|
-
"required": [
|
|
30456
|
-
"data",
|
|
30457
|
-
"total"
|
|
30458
|
-
],
|
|
30459
|
-
"type": "object"
|
|
30460
|
-
},
|
|
30461
30404
|
"MarketLoanStatus": {
|
|
30462
30405
|
"anyOf": [
|
|
30463
30406
|
{
|
|
@@ -30649,134 +30592,6 @@
|
|
|
30649
30592
|
],
|
|
30650
30593
|
"type": "object"
|
|
30651
30594
|
},
|
|
30652
|
-
"MarketRecord": {
|
|
30653
|
-
"properties": {
|
|
30654
|
-
"amortizationType": {
|
|
30655
|
-
"nullable": true,
|
|
30656
|
-
"type": "string"
|
|
30657
|
-
},
|
|
30658
|
-
"appraisedValue": {
|
|
30659
|
-
"nullable": true,
|
|
30660
|
-
"type": "number"
|
|
30661
|
-
},
|
|
30662
|
-
"borrowerGeneration": {
|
|
30663
|
-
"nullable": true,
|
|
30664
|
-
"type": "string"
|
|
30665
|
-
},
|
|
30666
|
-
"channel": {
|
|
30667
|
-
"nullable": true,
|
|
30668
|
-
"type": "string"
|
|
30669
|
-
},
|
|
30670
|
-
"closingDate": {
|
|
30671
|
-
"nullable": true,
|
|
30672
|
-
"type": "string"
|
|
30673
|
-
},
|
|
30674
|
-
"combinedLtv": {
|
|
30675
|
-
"nullable": true,
|
|
30676
|
-
"type": "number"
|
|
30677
|
-
},
|
|
30678
|
-
"county": {
|
|
30679
|
-
"nullable": true,
|
|
30680
|
-
"type": "string"
|
|
30681
|
-
},
|
|
30682
|
-
"creditScore": {
|
|
30683
|
-
"nullable": true,
|
|
30684
|
-
"type": "number"
|
|
30685
|
-
},
|
|
30686
|
-
"currentHomeOwner": {
|
|
30687
|
-
"nullable": true,
|
|
30688
|
-
"type": "boolean"
|
|
30689
|
-
},
|
|
30690
|
-
"dti": {
|
|
30691
|
-
"nullable": true,
|
|
30692
|
-
"type": "number"
|
|
30693
|
-
},
|
|
30694
|
-
"dtifront": {
|
|
30695
|
-
"nullable": true,
|
|
30696
|
-
"type": "number"
|
|
30697
|
-
},
|
|
30698
|
-
"firstTimeHomebuyer": {
|
|
30699
|
-
"nullable": true,
|
|
30700
|
-
"type": "boolean"
|
|
30701
|
-
},
|
|
30702
|
-
"fundingDate": {
|
|
30703
|
-
"nullable": true,
|
|
30704
|
-
"type": "string"
|
|
30705
|
-
},
|
|
30706
|
-
"hmdaActionTaken": {
|
|
30707
|
-
"nullable": true,
|
|
30708
|
-
"type": "string"
|
|
30709
|
-
},
|
|
30710
|
-
"id": {
|
|
30711
|
-
"description": "Document ID",
|
|
30712
|
-
"type": "string"
|
|
30713
|
-
},
|
|
30714
|
-
"income": {
|
|
30715
|
-
"nullable": true,
|
|
30716
|
-
"type": "number"
|
|
30717
|
-
},
|
|
30718
|
-
"loanAmount": {
|
|
30719
|
-
"nullable": true,
|
|
30720
|
-
"type": "number"
|
|
30721
|
-
},
|
|
30722
|
-
"loanApplicationDate": {
|
|
30723
|
-
"nullable": true,
|
|
30724
|
-
"type": "string"
|
|
30725
|
-
},
|
|
30726
|
-
"loanPurpose": {
|
|
30727
|
-
"nullable": true,
|
|
30728
|
-
"type": "string"
|
|
30729
|
-
},
|
|
30730
|
-
"loanTerm": {
|
|
30731
|
-
"nullable": true,
|
|
30732
|
-
"type": "number"
|
|
30733
|
-
},
|
|
30734
|
-
"loanType": {
|
|
30735
|
-
"nullable": true,
|
|
30736
|
-
"type": "string"
|
|
30737
|
-
},
|
|
30738
|
-
"ltv": {
|
|
30739
|
-
"nullable": true,
|
|
30740
|
-
"type": "number"
|
|
30741
|
-
},
|
|
30742
|
-
"noteRate": {
|
|
30743
|
-
"nullable": true,
|
|
30744
|
-
"type": "number"
|
|
30745
|
-
},
|
|
30746
|
-
"occupancyType": {
|
|
30747
|
-
"nullable": true,
|
|
30748
|
-
"type": "string"
|
|
30749
|
-
},
|
|
30750
|
-
"propertyType": {
|
|
30751
|
-
"nullable": true,
|
|
30752
|
-
"type": "string"
|
|
30753
|
-
},
|
|
30754
|
-
"purchasePrice": {
|
|
30755
|
-
"nullable": true,
|
|
30756
|
-
"type": "number"
|
|
30757
|
-
},
|
|
30758
|
-
"selfEmployed": {
|
|
30759
|
-
"nullable": true,
|
|
30760
|
-
"type": "boolean"
|
|
30761
|
-
},
|
|
30762
|
-
"state": {
|
|
30763
|
-
"nullable": true,
|
|
30764
|
-
"type": "string"
|
|
30765
|
-
},
|
|
30766
|
-
"veteranIndicator": {
|
|
30767
|
-
"nullable": true,
|
|
30768
|
-
"type": "boolean"
|
|
30769
|
-
},
|
|
30770
|
-
"zip": {
|
|
30771
|
-
"nullable": true,
|
|
30772
|
-
"type": "string"
|
|
30773
|
-
}
|
|
30774
|
-
},
|
|
30775
|
-
"required": [
|
|
30776
|
-
"id"
|
|
30777
|
-
],
|
|
30778
|
-
"type": "object"
|
|
30779
|
-
},
|
|
30780
30595
|
"MarketSignalsRequest": {
|
|
30781
30596
|
"additionalProperties": false,
|
|
30782
30597
|
"properties": {
|
|
@@ -45620,7 +45435,7 @@
|
|
|
45620
45435
|
"info": {
|
|
45621
45436
|
"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.",
|
|
45622
45437
|
"title": "ModelMatch API",
|
|
45623
|
-
"version": "3.
|
|
45438
|
+
"version": "3.127.0"
|
|
45624
45439
|
},
|
|
45625
45440
|
"openapi": "3.1.0",
|
|
45626
45441
|
"paths": {
|
|
@@ -52958,12 +52773,12 @@
|
|
|
52958
52773
|
"operationId": "branchCommunityLendingMap",
|
|
52959
52774
|
"parameters": [
|
|
52960
52775
|
{
|
|
52961
|
-
"description": "
|
|
52776
|
+
"description": "Branch NMLS ID",
|
|
52962
52777
|
"in": "path",
|
|
52963
52778
|
"name": "nmlsId",
|
|
52964
52779
|
"required": true,
|
|
52965
52780
|
"schema": {
|
|
52966
|
-
"description": "
|
|
52781
|
+
"description": "Branch NMLS ID",
|
|
52967
52782
|
"type": "string"
|
|
52968
52783
|
}
|
|
52969
52784
|
},
|
|
@@ -55439,12 +55254,12 @@
|
|
|
55439
55254
|
"operationId": "companyCommunityLendingBenchmark",
|
|
55440
55255
|
"parameters": [
|
|
55441
55256
|
{
|
|
55442
|
-
"description": "
|
|
55257
|
+
"description": "Company NMLS ID",
|
|
55443
55258
|
"in": "path",
|
|
55444
55259
|
"name": "nmlsId",
|
|
55445
55260
|
"required": true,
|
|
55446
55261
|
"schema": {
|
|
55447
|
-
"description": "
|
|
55262
|
+
"description": "Company NMLS ID",
|
|
55448
55263
|
"type": "string"
|
|
55449
55264
|
}
|
|
55450
55265
|
},
|
|
@@ -55549,12 +55364,12 @@
|
|
|
55549
55364
|
"operationId": "companyCommunityLendingMap",
|
|
55550
55365
|
"parameters": [
|
|
55551
55366
|
{
|
|
55552
|
-
"description": "
|
|
55367
|
+
"description": "Company NMLS ID",
|
|
55553
55368
|
"in": "path",
|
|
55554
55369
|
"name": "nmlsId",
|
|
55555
55370
|
"required": true,
|
|
55556
55371
|
"schema": {
|
|
55557
|
-
"description": "
|
|
55372
|
+
"description": "Company NMLS ID",
|
|
55558
55373
|
"type": "string"
|
|
55559
55374
|
}
|
|
55560
55375
|
},
|
|
@@ -56822,6 +56637,20 @@
|
|
|
56822
56637
|
"type": "string"
|
|
56823
56638
|
}
|
|
56824
56639
|
},
|
|
56640
|
+
{
|
|
56641
|
+
"description": "`company` (default): loans written at the company. `team`: the company's CURRENT loan officers' borrowers — loans they wrote at the company or at a previous employer (`writtenAt`), e.g. a recruit's book.",
|
|
56642
|
+
"in": "query",
|
|
56643
|
+
"name": "view",
|
|
56644
|
+
"required": false,
|
|
56645
|
+
"schema": {
|
|
56646
|
+
"description": "`company` (default): loans written at the company. `team`: the company's CURRENT loan officers' borrowers — loans they wrote at the company or at a previous employer (`writtenAt`), e.g. a recruit's book.",
|
|
56647
|
+
"enum": [
|
|
56648
|
+
"company",
|
|
56649
|
+
"team"
|
|
56650
|
+
],
|
|
56651
|
+
"type": "string"
|
|
56652
|
+
}
|
|
56653
|
+
},
|
|
56825
56654
|
{
|
|
56826
56655
|
"description": "Only rows whose loan was written by this LO (NMLS id) — e.g. one of `activeListings.topOriginators`.",
|
|
56827
56656
|
"in": "query",
|
|
@@ -73636,97 +73465,6 @@
|
|
|
73636
73465
|
]
|
|
73637
73466
|
}
|
|
73638
73467
|
},
|
|
73639
|
-
"/v1/market": {
|
|
73640
|
-
"post": {
|
|
73641
|
-
"description": "Search aggregated loan origination market data. Filterable dimensions cover geography (state, county, zip), product (loan purpose / type / amortization), borrower demographics, and loan numerics.",
|
|
73642
|
-
"operationId": "listMarket",
|
|
73643
|
-
"requestBody": {
|
|
73644
|
-
"content": {
|
|
73645
|
-
"application/json": {
|
|
73646
|
-
"schema": {
|
|
73647
|
-
"$ref": "#/components/schemas/MarketListRequest"
|
|
73648
|
-
}
|
|
73649
|
-
}
|
|
73650
|
-
}
|
|
73651
|
-
},
|
|
73652
|
-
"responses": {
|
|
73653
|
-
"200": {
|
|
73654
|
-
"content": {
|
|
73655
|
-
"application/json": {
|
|
73656
|
-
"schema": {
|
|
73657
|
-
"$ref": "#/components/schemas/MarketListResponse"
|
|
73658
|
-
}
|
|
73659
|
-
}
|
|
73660
|
-
},
|
|
73661
|
-
"description": "Paginated list of market records"
|
|
73662
|
-
},
|
|
73663
|
-
"400": {
|
|
73664
|
-
"content": {
|
|
73665
|
-
"application/json": {
|
|
73666
|
-
"schema": {
|
|
73667
|
-
"$ref": "#/components/schemas/ErrorResponse"
|
|
73668
|
-
}
|
|
73669
|
-
}
|
|
73670
|
-
},
|
|
73671
|
-
"description": "Validation error. Includes unresolvable location filters: a `city`/`county`/`state`/`zip` value that does not match a recognized location returns 400 rather than an empty result set. Resolve the name with `instantSearch` (use an id from its `results.locations[]`) or `suggestLocations` (use the `id` of a `source: \"dictionary\"` result), then pass that id back as the filter value."
|
|
73672
|
-
},
|
|
73673
|
-
"401": {
|
|
73674
|
-
"content": {
|
|
73675
|
-
"application/json": {
|
|
73676
|
-
"schema": {
|
|
73677
|
-
"$ref": "#/components/schemas/ErrorResponse"
|
|
73678
|
-
}
|
|
73679
|
-
}
|
|
73680
|
-
},
|
|
73681
|
-
"description": "Unauthorized"
|
|
73682
|
-
},
|
|
73683
|
-
"403": {
|
|
73684
|
-
"content": {
|
|
73685
|
-
"application/json": {
|
|
73686
|
-
"schema": {
|
|
73687
|
-
"$ref": "#/components/schemas/ErrorResponse"
|
|
73688
|
-
}
|
|
73689
|
-
}
|
|
73690
|
-
},
|
|
73691
|
-
"description": "Forbidden (authenticated, but missing required context — e.g. no active organization)"
|
|
73692
|
-
},
|
|
73693
|
-
"404": {
|
|
73694
|
-
"content": {
|
|
73695
|
-
"application/json": {
|
|
73696
|
-
"schema": {
|
|
73697
|
-
"$ref": "#/components/schemas/ErrorResponse"
|
|
73698
|
-
}
|
|
73699
|
-
}
|
|
73700
|
-
},
|
|
73701
|
-
"description": "Not found"
|
|
73702
|
-
},
|
|
73703
|
-
"413": {
|
|
73704
|
-
"content": {
|
|
73705
|
-
"application/json": {
|
|
73706
|
-
"schema": {
|
|
73707
|
-
"$ref": "#/components/schemas/PayloadTooLarge"
|
|
73708
|
-
}
|
|
73709
|
-
}
|
|
73710
|
-
},
|
|
73711
|
-
"description": "Response payload too large — detail endpoint capped to fit Lambda response limits"
|
|
73712
|
-
},
|
|
73713
|
-
"503": {
|
|
73714
|
-
"content": {
|
|
73715
|
-
"application/json": {
|
|
73716
|
-
"schema": {
|
|
73717
|
-
"$ref": "#/components/schemas/SearchUnavailable"
|
|
73718
|
-
}
|
|
73719
|
-
}
|
|
73720
|
-
},
|
|
73721
|
-
"description": "Search timed out or the cluster is overloaded — retry after `Retry-After` seconds."
|
|
73722
|
-
}
|
|
73723
|
-
},
|
|
73724
|
-
"summary": "Search aggregated market data with filters",
|
|
73725
|
-
"tags": [
|
|
73726
|
-
"Market"
|
|
73727
|
-
]
|
|
73728
|
-
}
|
|
73729
|
-
},
|
|
73730
73468
|
"/v1/market/analytics/chart": {
|
|
73731
73469
|
"post": {
|
|
73732
73470
|
"operationId": "marketAnalyticsChart",
|