Where a company lends — blended market footprint
The company's market footprint for a period: a units-weighted summary, the ZIP-level markets, and the city / county / state rollups, computed from the company's recorded transactions. Optionally narrow to a set of ZIP codes and/or a custom date window. Shares are percentages on a 0–100 scale. The summary also carries a Community Lending mix — what kind of neighborhood the book lands in, as U.S. Census tract-level aggregates describing whole neighborhoods, never individual or applicant attributes. Unfiltered, it is the company's own whole-period mix; any ZIP, date or transaction filter recomputes it over the markets in scope, and summary.communityLending.basis says which you got.
In: header
Path Parameters
Company NMLS ID
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/v1/companies/string/markets" \ -H "Content-Type: application/json" \ -d '{}'{
"nmlsId": "string",
"period": "string",
"rollups": {
"cities": [
{
"avgLoanAmount": 0,
"key": "string",
"name": "string",
"shareOfBook": 0,
"shareOfScope": 0,
"units": 0,
"volume": 0
}
],
"counties": [
{
"avgLoanAmount": 0,
"key": "string",
"name": "string",
"shareOfBook": 0,
"shareOfScope": 0,
"units": 0,
"volume": 0
}
],
"states": [
{
"avgLoanAmount": 0,
"key": "string",
"name": "string",
"shareOfBook": 0,
"shareOfScope": 0,
"units": 0,
"volume": 0
}
]
},
"source": {
"mode": "live",
"reasons": [
"string"
]
},
"summary": {
"avgLoanAmount": 0,
"bucketCount": 0,
"communityLending": {
"affordableHousingTractPct": 0,
"basis": "entityRollup",
"coveredProductionPct": 0,
"difficultDevelopmentAreaPct": 0,
"distressedTractPct": 0,
"floodHazardTractPct": 0,
"incomeLevelMix": {
"low": 0,
"middle": 0,
"moderate": 0,
"upper": 0
},
"loansWithCommunityData": 0,
"lowModIncomeTractPct": 0,
"majorityMinorityTractPct": 0,
"marketsInScope": 0,
"marketsWithCommunityData": 0,
"opportunityZonePct": 0,
"predominantIncomeLevel": "low",
"ruralTractPct": 0,
"usdaEligibleTractPct": 0
},
"shareOfBook": 0,
"shareOfMatchedVolume": 0,
"units": 0,
"unresolved": {
"bucketCount": 0,
"units": 0,
"volume": 0
},
"volume": 0
},
"totals": {
"avgLoanAmount": 0,
"excluded": 0,
"units": 0,
"volume": 0
},
"zips": [
{
"avgLoanAmount": 0,
"key": "string",
"name": "string",
"shareOfBook": 0,
"shareOfScope": 0,
"units": 0,
"volume": 0
}
]
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}{
"error": "string"
}{
"error": "string",
"limit": 0,
"size": 0
}