@model-match/api 3.64.0 → 3.66.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-DfABTGbR.d.mts → index-By1ZTmPp.d.mts} +211 -1
- package/dist/index.d.mts +2 -2
- package/dist/index.mjs +1 -1
- package/dist/slim/index.d.mts +14 -2
- package/dist/slim/index.mjs +38 -2
- package/dist/{src-BMY6S6hr.mjs → src-K4EJo0JN.mjs} +40 -0
- package/openapi.json +510 -1
- 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-K4EJo0JN.mjs";
|
|
2
2
|
//#region src/slim/sdk.gen.ts
|
|
3
3
|
/**
|
|
4
4
|
* Search agents with filters
|
|
@@ -2017,6 +2017,22 @@ const companyRetentionActiveListings = (options) => (options.client ?? client).g
|
|
|
2017
2017
|
...options
|
|
2018
2018
|
});
|
|
2019
2019
|
/**
|
|
2020
|
+
* Loans one LO captured from this company
|
|
2021
|
+
*
|
|
2022
|
+
* The loss rows (the LO report's `churnedLoans` shape) one capturing loan officer took from the company's borrowers in a stored snapshot's `period`, newest first, paged. Read live from that LO's parcels, so `total` matches the snapshot's count for the LO (give or take loans recorded since `computedAt`). 404 when the snapshot has not been computed.
|
|
2023
|
+
*/
|
|
2024
|
+
const companyRetentionCaptured = (options) => (options.client ?? client).get({
|
|
2025
|
+
security: [{
|
|
2026
|
+
name: "x-api-key",
|
|
2027
|
+
type: "apiKey"
|
|
2028
|
+
}, {
|
|
2029
|
+
scheme: "bearer",
|
|
2030
|
+
type: "http"
|
|
2031
|
+
}],
|
|
2032
|
+
url: "/v1/companies/{nmlsId}/retention/captured",
|
|
2033
|
+
...options
|
|
2034
|
+
});
|
|
2035
|
+
/**
|
|
2020
2036
|
* Loan originators sponsored by this company
|
|
2021
2037
|
*/
|
|
2022
2038
|
const companySponsoredIndividuals = (options) => (options.client ?? client).post({
|
|
@@ -5597,6 +5613,26 @@ const originatorRetention = (options) => (options.client ?? client).post({
|
|
|
5597
5613
|
}
|
|
5598
5614
|
});
|
|
5599
5615
|
/**
|
|
5616
|
+
* Loans one capturer took from this LO
|
|
5617
|
+
*
|
|
5618
|
+
* The loss rows (`churnedLoans` shape) one capturing loan officer — or company — took from this LO's borrowers in `start`–`end`, newest first, paged. Same classification as `originatorRetention`, so `total` matches that capturer's `count` there; unlike the report, it is not limited to the newest 500 rows overall.
|
|
5619
|
+
*/
|
|
5620
|
+
const originatorRetentionCaptured = (options) => (options.client ?? client).post({
|
|
5621
|
+
security: [{
|
|
5622
|
+
name: "x-api-key",
|
|
5623
|
+
type: "apiKey"
|
|
5624
|
+
}, {
|
|
5625
|
+
scheme: "bearer",
|
|
5626
|
+
type: "http"
|
|
5627
|
+
}],
|
|
5628
|
+
url: "/v1/originators/{nmlsId}/retention/captured",
|
|
5629
|
+
...options,
|
|
5630
|
+
headers: {
|
|
5631
|
+
"Content-Type": "application/json",
|
|
5632
|
+
...options.headers
|
|
5633
|
+
}
|
|
5634
|
+
});
|
|
5635
|
+
/**
|
|
5600
5636
|
* Search properties with filters
|
|
5601
5637
|
*
|
|
5602
5638
|
* Search and list individual properties/parcels with filters — one row per parcel. Filter by location (state, county, city, zip, address), owner name, property characteristics (beds, baths, square footage, year built, property type), value, ownership or transaction history, and occupancy (`ownerOccupancy: not_flagged` plus `absenteeOwner: true` targets likely investor / non-owner-occupied parcels — pair `absenteeOwner` with a geography filter), with sorting and cursor pagination. This is the discrete per-property record search: use it to find specific properties or build a filtered property list. (For a single property by its ID use the property detail endpoint.) If you only need how many properties match and not the records themselves, send the same request body to `countProperties`.
|
|
@@ -6223,4 +6259,4 @@ const getSearchToken = (options) => (options?.client ?? client).get({
|
|
|
6223
6259
|
...options
|
|
6224
6260
|
});
|
|
6225
6261
|
//#endregion
|
|
6226
|
-
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, listCrmContactMethods, 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 };
|
|
6262
|
+
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, companyRetentionCaptured, 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, listCrmContactMethods, 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, originatorRetentionCaptured, 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 };
|
|
@@ -2940,6 +2940,24 @@ var Companies = class {
|
|
|
2940
2940
|
});
|
|
2941
2941
|
}
|
|
2942
2942
|
/**
|
|
2943
|
+
* Loans one LO captured from this company
|
|
2944
|
+
*
|
|
2945
|
+
* The loss rows (the LO report's `churnedLoans` shape) one capturing loan officer took from the company's borrowers in a stored snapshot's `period`, newest first, paged. Read live from that LO's parcels, so `total` matches the snapshot's count for the LO (give or take loans recorded since `computedAt`). 404 when the snapshot has not been computed.
|
|
2946
|
+
*/
|
|
2947
|
+
static retentionCaptured(options) {
|
|
2948
|
+
return (options.client ?? client).get({
|
|
2949
|
+
security: [{
|
|
2950
|
+
name: "x-api-key",
|
|
2951
|
+
type: "apiKey"
|
|
2952
|
+
}, {
|
|
2953
|
+
scheme: "bearer",
|
|
2954
|
+
type: "http"
|
|
2955
|
+
}],
|
|
2956
|
+
url: "/v1/companies/{nmlsId}/retention/captured",
|
|
2957
|
+
...options
|
|
2958
|
+
});
|
|
2959
|
+
}
|
|
2960
|
+
/**
|
|
2943
2961
|
* Loan originators sponsored by this company
|
|
2944
2962
|
*/
|
|
2945
2963
|
static sponsoredIndividuals(options) {
|
|
@@ -6937,6 +6955,28 @@ var Originators = class {
|
|
|
6937
6955
|
}
|
|
6938
6956
|
});
|
|
6939
6957
|
}
|
|
6958
|
+
/**
|
|
6959
|
+
* Loans one capturer took from this LO
|
|
6960
|
+
*
|
|
6961
|
+
* The loss rows (`churnedLoans` shape) one capturing loan officer — or company — took from this LO's borrowers in `start`–`end`, newest first, paged. Same classification as `originatorRetention`, so `total` matches that capturer's `count` there; unlike the report, it is not limited to the newest 500 rows overall.
|
|
6962
|
+
*/
|
|
6963
|
+
static retentionCaptured(options) {
|
|
6964
|
+
return (options.client ?? client).post({
|
|
6965
|
+
security: [{
|
|
6966
|
+
name: "x-api-key",
|
|
6967
|
+
type: "apiKey"
|
|
6968
|
+
}, {
|
|
6969
|
+
scheme: "bearer",
|
|
6970
|
+
type: "http"
|
|
6971
|
+
}],
|
|
6972
|
+
url: "/v1/originators/{nmlsId}/retention/captured",
|
|
6973
|
+
...options,
|
|
6974
|
+
headers: {
|
|
6975
|
+
"Content-Type": "application/json",
|
|
6976
|
+
...options.headers
|
|
6977
|
+
}
|
|
6978
|
+
});
|
|
6979
|
+
}
|
|
6940
6980
|
};
|
|
6941
6981
|
var Properties = class {
|
|
6942
6982
|
/**
|
package/openapi.json
CHANGED
|
@@ -38409,6 +38409,254 @@
|
|
|
38409
38409
|
],
|
|
38410
38410
|
"type": "object"
|
|
38411
38411
|
},
|
|
38412
|
+
"OriginatorRetentionCaptured": {
|
|
38413
|
+
"properties": {
|
|
38414
|
+
"counts": {
|
|
38415
|
+
"description": "The capturer's rows by kind, ignoring `kind`.",
|
|
38416
|
+
"properties": {
|
|
38417
|
+
"refi": {
|
|
38418
|
+
"type": "number"
|
|
38419
|
+
},
|
|
38420
|
+
"second": {
|
|
38421
|
+
"type": "number"
|
|
38422
|
+
}
|
|
38423
|
+
},
|
|
38424
|
+
"required": [
|
|
38425
|
+
"refi",
|
|
38426
|
+
"second"
|
|
38427
|
+
],
|
|
38428
|
+
"type": "object"
|
|
38429
|
+
},
|
|
38430
|
+
"rows": {
|
|
38431
|
+
"items": {
|
|
38432
|
+
"properties": {
|
|
38433
|
+
"address": {
|
|
38434
|
+
"type": "string"
|
|
38435
|
+
},
|
|
38436
|
+
"borrower": {
|
|
38437
|
+
"type": "string"
|
|
38438
|
+
},
|
|
38439
|
+
"capturingAmount": {
|
|
38440
|
+
"type": "number"
|
|
38441
|
+
},
|
|
38442
|
+
"capturingCompany": {
|
|
38443
|
+
"type": "string"
|
|
38444
|
+
},
|
|
38445
|
+
"capturingCompanyNmlsId": {
|
|
38446
|
+
"type": "string"
|
|
38447
|
+
},
|
|
38448
|
+
"capturingLender": {
|
|
38449
|
+
"type": "string"
|
|
38450
|
+
},
|
|
38451
|
+
"capturingLoName": {
|
|
38452
|
+
"type": "string"
|
|
38453
|
+
},
|
|
38454
|
+
"capturingLoNmlsId": {
|
|
38455
|
+
"type": "string"
|
|
38456
|
+
},
|
|
38457
|
+
"capturingLoanType": {
|
|
38458
|
+
"type": "string"
|
|
38459
|
+
},
|
|
38460
|
+
"capturingRate": {
|
|
38461
|
+
"nullable": true,
|
|
38462
|
+
"type": "number"
|
|
38463
|
+
},
|
|
38464
|
+
"cashOut": {
|
|
38465
|
+
"type": "boolean"
|
|
38466
|
+
},
|
|
38467
|
+
"current": {
|
|
38468
|
+
"description": "What the parcel looks like today, when a scored snapshot newer than the event joined; null otherwise (unknown, never 'retained').",
|
|
38469
|
+
"nullable": true,
|
|
38470
|
+
"properties": {
|
|
38471
|
+
"currentBalance": {
|
|
38472
|
+
"nullable": true,
|
|
38473
|
+
"type": "number"
|
|
38474
|
+
},
|
|
38475
|
+
"currentLender": {
|
|
38476
|
+
"nullable": true,
|
|
38477
|
+
"type": "string"
|
|
38478
|
+
},
|
|
38479
|
+
"currentRate": {
|
|
38480
|
+
"nullable": true,
|
|
38481
|
+
"type": "number"
|
|
38482
|
+
},
|
|
38483
|
+
"lastSaleDate": {
|
|
38484
|
+
"nullable": true,
|
|
38485
|
+
"type": "number"
|
|
38486
|
+
},
|
|
38487
|
+
"loStillActive": {
|
|
38488
|
+
"type": "boolean"
|
|
38489
|
+
},
|
|
38490
|
+
"ownerChanged": {
|
|
38491
|
+
"nullable": true,
|
|
38492
|
+
"type": "boolean"
|
|
38493
|
+
}
|
|
38494
|
+
},
|
|
38495
|
+
"required": [
|
|
38496
|
+
"loStillActive",
|
|
38497
|
+
"ownerChanged",
|
|
38498
|
+
"lastSaleDate",
|
|
38499
|
+
"currentLender",
|
|
38500
|
+
"currentBalance",
|
|
38501
|
+
"currentRate"
|
|
38502
|
+
],
|
|
38503
|
+
"type": "object"
|
|
38504
|
+
},
|
|
38505
|
+
"daysToEvent": {
|
|
38506
|
+
"type": "number"
|
|
38507
|
+
},
|
|
38508
|
+
"eventDate": {
|
|
38509
|
+
"type": "number"
|
|
38510
|
+
},
|
|
38511
|
+
"kind": {
|
|
38512
|
+
"enum": [
|
|
38513
|
+
"refi",
|
|
38514
|
+
"second"
|
|
38515
|
+
],
|
|
38516
|
+
"type": "string"
|
|
38517
|
+
},
|
|
38518
|
+
"lane": {
|
|
38519
|
+
"enum": [
|
|
38520
|
+
"own_company",
|
|
38521
|
+
"servicer",
|
|
38522
|
+
"competitor"
|
|
38523
|
+
],
|
|
38524
|
+
"type": "string"
|
|
38525
|
+
},
|
|
38526
|
+
"originalAmount": {
|
|
38527
|
+
"type": "number"
|
|
38528
|
+
},
|
|
38529
|
+
"originalLender": {
|
|
38530
|
+
"type": "string"
|
|
38531
|
+
},
|
|
38532
|
+
"originalLoanDate": {
|
|
38533
|
+
"type": "number"
|
|
38534
|
+
},
|
|
38535
|
+
"originalLoanType": {
|
|
38536
|
+
"type": "string"
|
|
38537
|
+
},
|
|
38538
|
+
"originalRate": {
|
|
38539
|
+
"nullable": true,
|
|
38540
|
+
"type": "number"
|
|
38541
|
+
},
|
|
38542
|
+
"originalTransactionType": {
|
|
38543
|
+
"type": "string"
|
|
38544
|
+
},
|
|
38545
|
+
"propertyId": {
|
|
38546
|
+
"type": "string"
|
|
38547
|
+
},
|
|
38548
|
+
"sameBorrower": {
|
|
38549
|
+
"nullable": true,
|
|
38550
|
+
"type": "boolean"
|
|
38551
|
+
}
|
|
38552
|
+
},
|
|
38553
|
+
"required": [
|
|
38554
|
+
"kind",
|
|
38555
|
+
"lane",
|
|
38556
|
+
"propertyId",
|
|
38557
|
+
"address",
|
|
38558
|
+
"borrower",
|
|
38559
|
+
"originalLoanDate",
|
|
38560
|
+
"originalAmount",
|
|
38561
|
+
"originalLoanType",
|
|
38562
|
+
"originalTransactionType",
|
|
38563
|
+
"originalRate",
|
|
38564
|
+
"originalLender",
|
|
38565
|
+
"eventDate",
|
|
38566
|
+
"daysToEvent",
|
|
38567
|
+
"capturingAmount",
|
|
38568
|
+
"capturingLoanType",
|
|
38569
|
+
"capturingRate",
|
|
38570
|
+
"capturingLoNmlsId",
|
|
38571
|
+
"capturingLoName",
|
|
38572
|
+
"capturingCompanyNmlsId",
|
|
38573
|
+
"capturingCompany",
|
|
38574
|
+
"capturingLender",
|
|
38575
|
+
"cashOut",
|
|
38576
|
+
"sameBorrower",
|
|
38577
|
+
"current"
|
|
38578
|
+
],
|
|
38579
|
+
"type": "object"
|
|
38580
|
+
},
|
|
38581
|
+
"type": "array"
|
|
38582
|
+
},
|
|
38583
|
+
"status": {
|
|
38584
|
+
"description": "`timeout`: the book could not be read in time; `rows` is empty and the counts are zero.",
|
|
38585
|
+
"enum": [
|
|
38586
|
+
"ok",
|
|
38587
|
+
"timeout"
|
|
38588
|
+
],
|
|
38589
|
+
"type": "string"
|
|
38590
|
+
},
|
|
38591
|
+
"total": {
|
|
38592
|
+
"description": "Rows matching the capturer (and `kind`), all pages.",
|
|
38593
|
+
"type": "number"
|
|
38594
|
+
},
|
|
38595
|
+
"truncated": {
|
|
38596
|
+
"description": "A scan hit its row cap; counts cover the rows read.",
|
|
38597
|
+
"type": "boolean"
|
|
38598
|
+
}
|
|
38599
|
+
},
|
|
38600
|
+
"required": [
|
|
38601
|
+
"status",
|
|
38602
|
+
"truncated",
|
|
38603
|
+
"total",
|
|
38604
|
+
"counts",
|
|
38605
|
+
"rows"
|
|
38606
|
+
],
|
|
38607
|
+
"type": "object"
|
|
38608
|
+
},
|
|
38609
|
+
"OriginatorRetentionCapturedRequest": {
|
|
38610
|
+
"additionalProperties": false,
|
|
38611
|
+
"properties": {
|
|
38612
|
+
"capturingCompanyNmlsId": {
|
|
38613
|
+
"description": "The capturing company (a `capturingCompanies[].nmlsId`). Exactly one of the two capturer ids is required.",
|
|
38614
|
+
"pattern": "^\\d+$",
|
|
38615
|
+
"type": "string"
|
|
38616
|
+
},
|
|
38617
|
+
"capturingLoNmlsId": {
|
|
38618
|
+
"description": "The capturing loan officer (a `capturingOriginators[].nmlsId`).",
|
|
38619
|
+
"pattern": "^\\d+$",
|
|
38620
|
+
"type": "string"
|
|
38621
|
+
},
|
|
38622
|
+
"end": {
|
|
38623
|
+
"description": "Last day of the period (UTC, inclusive).",
|
|
38624
|
+
"example": "2025-08-15",
|
|
38625
|
+
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
|
|
38626
|
+
"type": "string"
|
|
38627
|
+
},
|
|
38628
|
+
"kind": {
|
|
38629
|
+
"description": "Only refinances or only second liens. Default both.",
|
|
38630
|
+
"enum": [
|
|
38631
|
+
"refi",
|
|
38632
|
+
"second"
|
|
38633
|
+
],
|
|
38634
|
+
"type": "string"
|
|
38635
|
+
},
|
|
38636
|
+
"limit": {
|
|
38637
|
+
"description": "Rows per page (default 100, at most 500).",
|
|
38638
|
+
"maximum": 500,
|
|
38639
|
+
"minimum": 1,
|
|
38640
|
+
"type": "integer"
|
|
38641
|
+
},
|
|
38642
|
+
"offset": {
|
|
38643
|
+
"description": "Rows to skip (newest first).",
|
|
38644
|
+
"minimum": 0,
|
|
38645
|
+
"type": "integer"
|
|
38646
|
+
},
|
|
38647
|
+
"start": {
|
|
38648
|
+
"description": "First day of the period (UTC).",
|
|
38649
|
+
"example": "2025-08-15",
|
|
38650
|
+
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
|
|
38651
|
+
"type": "string"
|
|
38652
|
+
}
|
|
38653
|
+
},
|
|
38654
|
+
"required": [
|
|
38655
|
+
"start",
|
|
38656
|
+
"end"
|
|
38657
|
+
],
|
|
38658
|
+
"type": "object"
|
|
38659
|
+
},
|
|
38412
38660
|
"OriginatorRetentionRequest": {
|
|
38413
38661
|
"additionalProperties": false,
|
|
38414
38662
|
"properties": {
|
|
@@ -45596,7 +45844,7 @@
|
|
|
45596
45844
|
"info": {
|
|
45597
45845
|
"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.",
|
|
45598
45846
|
"title": "ModelMatch API",
|
|
45599
|
-
"version": "3.
|
|
45847
|
+
"version": "3.132.0"
|
|
45600
45848
|
},
|
|
45601
45849
|
"openapi": "3.1.0",
|
|
45602
45850
|
"paths": {
|
|
@@ -56925,6 +57173,164 @@
|
|
|
56925
57173
|
]
|
|
56926
57174
|
}
|
|
56927
57175
|
},
|
|
57176
|
+
"/v1/companies/{nmlsId}/retention/captured": {
|
|
57177
|
+
"get": {
|
|
57178
|
+
"description": "The loss rows (the LO report's `churnedLoans` shape) one capturing loan officer took from the company's borrowers in a stored snapshot's `period`, newest first, paged. Read live from that LO's parcels, so `total` matches the snapshot's count for the LO (give or take loans recorded since `computedAt`). 404 when the snapshot has not been computed.",
|
|
57179
|
+
"operationId": "companyRetentionCaptured",
|
|
57180
|
+
"parameters": [
|
|
57181
|
+
{
|
|
57182
|
+
"description": "Company NMLS ID",
|
|
57183
|
+
"in": "path",
|
|
57184
|
+
"name": "nmlsId",
|
|
57185
|
+
"required": true,
|
|
57186
|
+
"schema": {
|
|
57187
|
+
"description": "Company NMLS ID",
|
|
57188
|
+
"type": "string"
|
|
57189
|
+
}
|
|
57190
|
+
},
|
|
57191
|
+
{
|
|
57192
|
+
"description": "The snapshot window whose `period` to use: `last12Months` (default) or `allTime`.",
|
|
57193
|
+
"in": "query",
|
|
57194
|
+
"name": "window",
|
|
57195
|
+
"required": false,
|
|
57196
|
+
"schema": {
|
|
57197
|
+
"default": "last12Months",
|
|
57198
|
+
"description": "The snapshot window whose `period` to use: `last12Months` (default) or `allTime`.",
|
|
57199
|
+
"enum": [
|
|
57200
|
+
"last12Months",
|
|
57201
|
+
"allTime"
|
|
57202
|
+
],
|
|
57203
|
+
"type": "string"
|
|
57204
|
+
}
|
|
57205
|
+
},
|
|
57206
|
+
{
|
|
57207
|
+
"description": "The capturing loan officer (a snapshot `capturingOriginators[].nmlsId`).",
|
|
57208
|
+
"in": "query",
|
|
57209
|
+
"name": "capturingLoNmlsId",
|
|
57210
|
+
"required": true,
|
|
57211
|
+
"schema": {
|
|
57212
|
+
"description": "The capturing loan officer (a snapshot `capturingOriginators[].nmlsId`).",
|
|
57213
|
+
"pattern": "^\\d+$",
|
|
57214
|
+
"type": "string"
|
|
57215
|
+
}
|
|
57216
|
+
},
|
|
57217
|
+
{
|
|
57218
|
+
"description": "Only refinances or only second liens. Default both.",
|
|
57219
|
+
"in": "query",
|
|
57220
|
+
"name": "kind",
|
|
57221
|
+
"required": false,
|
|
57222
|
+
"schema": {
|
|
57223
|
+
"description": "Only refinances or only second liens. Default both.",
|
|
57224
|
+
"enum": [
|
|
57225
|
+
"refi",
|
|
57226
|
+
"second"
|
|
57227
|
+
],
|
|
57228
|
+
"type": "string"
|
|
57229
|
+
}
|
|
57230
|
+
},
|
|
57231
|
+
{
|
|
57232
|
+
"description": "Rows per page (default 100, at most 500).",
|
|
57233
|
+
"in": "query",
|
|
57234
|
+
"name": "limit",
|
|
57235
|
+
"required": false,
|
|
57236
|
+
"schema": {
|
|
57237
|
+
"description": "Rows per page (default 100, at most 500).",
|
|
57238
|
+
"maximum": 500,
|
|
57239
|
+
"minimum": 1,
|
|
57240
|
+
"type": "integer"
|
|
57241
|
+
}
|
|
57242
|
+
},
|
|
57243
|
+
{
|
|
57244
|
+
"description": "Rows to skip (newest first).",
|
|
57245
|
+
"in": "query",
|
|
57246
|
+
"name": "offset",
|
|
57247
|
+
"required": false,
|
|
57248
|
+
"schema": {
|
|
57249
|
+
"description": "Rows to skip (newest first).",
|
|
57250
|
+
"minimum": 0,
|
|
57251
|
+
"nullable": true,
|
|
57252
|
+
"type": "integer"
|
|
57253
|
+
}
|
|
57254
|
+
}
|
|
57255
|
+
],
|
|
57256
|
+
"responses": {
|
|
57257
|
+
"200": {
|
|
57258
|
+
"content": {
|
|
57259
|
+
"application/json": {
|
|
57260
|
+
"schema": {
|
|
57261
|
+
"$ref": "#/components/schemas/OriginatorRetentionCaptured"
|
|
57262
|
+
}
|
|
57263
|
+
}
|
|
57264
|
+
},
|
|
57265
|
+
"description": "The capturer's loss rows"
|
|
57266
|
+
},
|
|
57267
|
+
"400": {
|
|
57268
|
+
"content": {
|
|
57269
|
+
"application/json": {
|
|
57270
|
+
"schema": {
|
|
57271
|
+
"$ref": "#/components/schemas/ErrorResponse"
|
|
57272
|
+
}
|
|
57273
|
+
}
|
|
57274
|
+
},
|
|
57275
|
+
"description": "Validation error"
|
|
57276
|
+
},
|
|
57277
|
+
"401": {
|
|
57278
|
+
"content": {
|
|
57279
|
+
"application/json": {
|
|
57280
|
+
"schema": {
|
|
57281
|
+
"$ref": "#/components/schemas/ErrorResponse"
|
|
57282
|
+
}
|
|
57283
|
+
}
|
|
57284
|
+
},
|
|
57285
|
+
"description": "Unauthorized"
|
|
57286
|
+
},
|
|
57287
|
+
"403": {
|
|
57288
|
+
"content": {
|
|
57289
|
+
"application/json": {
|
|
57290
|
+
"schema": {
|
|
57291
|
+
"$ref": "#/components/schemas/ErrorResponse"
|
|
57292
|
+
}
|
|
57293
|
+
}
|
|
57294
|
+
},
|
|
57295
|
+
"description": "Forbidden (authenticated, but missing required context — e.g. no active organization)"
|
|
57296
|
+
},
|
|
57297
|
+
"404": {
|
|
57298
|
+
"content": {
|
|
57299
|
+
"application/json": {
|
|
57300
|
+
"schema": {
|
|
57301
|
+
"$ref": "#/components/schemas/ErrorResponse"
|
|
57302
|
+
}
|
|
57303
|
+
}
|
|
57304
|
+
},
|
|
57305
|
+
"description": "Not found"
|
|
57306
|
+
},
|
|
57307
|
+
"413": {
|
|
57308
|
+
"content": {
|
|
57309
|
+
"application/json": {
|
|
57310
|
+
"schema": {
|
|
57311
|
+
"$ref": "#/components/schemas/PayloadTooLarge"
|
|
57312
|
+
}
|
|
57313
|
+
}
|
|
57314
|
+
},
|
|
57315
|
+
"description": "Response payload too large — detail endpoint capped to fit Lambda response limits"
|
|
57316
|
+
},
|
|
57317
|
+
"503": {
|
|
57318
|
+
"content": {
|
|
57319
|
+
"application/json": {
|
|
57320
|
+
"schema": {
|
|
57321
|
+
"$ref": "#/components/schemas/SearchUnavailable"
|
|
57322
|
+
}
|
|
57323
|
+
}
|
|
57324
|
+
},
|
|
57325
|
+
"description": "Search timed out or the cluster is overloaded — retry after `Retry-After` seconds."
|
|
57326
|
+
}
|
|
57327
|
+
},
|
|
57328
|
+
"summary": "Loans one LO captured from this company",
|
|
57329
|
+
"tags": [
|
|
57330
|
+
"Companies"
|
|
57331
|
+
]
|
|
57332
|
+
}
|
|
57333
|
+
},
|
|
56928
57334
|
"/v1/companies/{nmlsId}/sponsored-individuals": {
|
|
56929
57335
|
"post": {
|
|
56930
57336
|
"operationId": "companySponsoredIndividuals",
|
|
@@ -79952,6 +80358,109 @@
|
|
|
79952
80358
|
]
|
|
79953
80359
|
}
|
|
79954
80360
|
},
|
|
80361
|
+
"/v1/originators/{nmlsId}/retention/captured": {
|
|
80362
|
+
"post": {
|
|
80363
|
+
"description": "The loss rows (`churnedLoans` shape) one capturing loan officer — or company — took from this LO's borrowers in `start`–`end`, newest first, paged. Same classification as `originatorRetention`, so `total` matches that capturer's `count` there; unlike the report, it is not limited to the newest 500 rows overall.",
|
|
80364
|
+
"operationId": "originatorRetentionCaptured",
|
|
80365
|
+
"parameters": [
|
|
80366
|
+
{
|
|
80367
|
+
"description": "Originator NMLS ID",
|
|
80368
|
+
"in": "path",
|
|
80369
|
+
"name": "nmlsId",
|
|
80370
|
+
"required": true,
|
|
80371
|
+
"schema": {
|
|
80372
|
+
"description": "Originator NMLS ID",
|
|
80373
|
+
"type": "string"
|
|
80374
|
+
}
|
|
80375
|
+
}
|
|
80376
|
+
],
|
|
80377
|
+
"requestBody": {
|
|
80378
|
+
"content": {
|
|
80379
|
+
"application/json": {
|
|
80380
|
+
"schema": {
|
|
80381
|
+
"$ref": "#/components/schemas/OriginatorRetentionCapturedRequest"
|
|
80382
|
+
}
|
|
80383
|
+
}
|
|
80384
|
+
}
|
|
80385
|
+
},
|
|
80386
|
+
"responses": {
|
|
80387
|
+
"200": {
|
|
80388
|
+
"content": {
|
|
80389
|
+
"application/json": {
|
|
80390
|
+
"schema": {
|
|
80391
|
+
"$ref": "#/components/schemas/OriginatorRetentionCaptured"
|
|
80392
|
+
}
|
|
80393
|
+
}
|
|
80394
|
+
},
|
|
80395
|
+
"description": "The capturer's loss rows"
|
|
80396
|
+
},
|
|
80397
|
+
"400": {
|
|
80398
|
+
"content": {
|
|
80399
|
+
"application/json": {
|
|
80400
|
+
"schema": {
|
|
80401
|
+
"$ref": "#/components/schemas/ErrorResponse"
|
|
80402
|
+
}
|
|
80403
|
+
}
|
|
80404
|
+
},
|
|
80405
|
+
"description": "Validation error"
|
|
80406
|
+
},
|
|
80407
|
+
"401": {
|
|
80408
|
+
"content": {
|
|
80409
|
+
"application/json": {
|
|
80410
|
+
"schema": {
|
|
80411
|
+
"$ref": "#/components/schemas/ErrorResponse"
|
|
80412
|
+
}
|
|
80413
|
+
}
|
|
80414
|
+
},
|
|
80415
|
+
"description": "Unauthorized"
|
|
80416
|
+
},
|
|
80417
|
+
"403": {
|
|
80418
|
+
"content": {
|
|
80419
|
+
"application/json": {
|
|
80420
|
+
"schema": {
|
|
80421
|
+
"$ref": "#/components/schemas/ErrorResponse"
|
|
80422
|
+
}
|
|
80423
|
+
}
|
|
80424
|
+
},
|
|
80425
|
+
"description": "Forbidden (authenticated, but missing required context — e.g. no active organization)"
|
|
80426
|
+
},
|
|
80427
|
+
"404": {
|
|
80428
|
+
"content": {
|
|
80429
|
+
"application/json": {
|
|
80430
|
+
"schema": {
|
|
80431
|
+
"$ref": "#/components/schemas/ErrorResponse"
|
|
80432
|
+
}
|
|
80433
|
+
}
|
|
80434
|
+
},
|
|
80435
|
+
"description": "Not found"
|
|
80436
|
+
},
|
|
80437
|
+
"413": {
|
|
80438
|
+
"content": {
|
|
80439
|
+
"application/json": {
|
|
80440
|
+
"schema": {
|
|
80441
|
+
"$ref": "#/components/schemas/PayloadTooLarge"
|
|
80442
|
+
}
|
|
80443
|
+
}
|
|
80444
|
+
},
|
|
80445
|
+
"description": "Response payload too large — detail endpoint capped to fit Lambda response limits"
|
|
80446
|
+
},
|
|
80447
|
+
"503": {
|
|
80448
|
+
"content": {
|
|
80449
|
+
"application/json": {
|
|
80450
|
+
"schema": {
|
|
80451
|
+
"$ref": "#/components/schemas/SearchUnavailable"
|
|
80452
|
+
}
|
|
80453
|
+
}
|
|
80454
|
+
},
|
|
80455
|
+
"description": "Search timed out or the cluster is overloaded — retry after `Retry-After` seconds."
|
|
80456
|
+
}
|
|
80457
|
+
},
|
|
80458
|
+
"summary": "Loans one capturer took from this LO",
|
|
80459
|
+
"tags": [
|
|
80460
|
+
"Originators"
|
|
80461
|
+
]
|
|
80462
|
+
}
|
|
80463
|
+
},
|
|
79955
80464
|
"/v1/properties": {
|
|
79956
80465
|
"post": {
|
|
79957
80466
|
"description": "Search and list individual properties/parcels with filters — one row per parcel. Filter by location (state, county, city, zip, address), owner name, property characteristics (beds, baths, square footage, year built, property type), value, ownership or transaction history, and occupancy (`ownerOccupancy: not_flagged` plus `absenteeOwner: true` targets likely investor / non-owner-occupied parcels — pair `absenteeOwner` with a geography filter), with sorting and cursor pagination. This is the discrete per-property record search: use it to find specific properties or build a filtered property list. (For a single property by its ID use the property detail endpoint.) If you only need how many properties match and not the records themselves, send the same request body to `countProperties`.",
|