Get residential component¶
Get the details of a residential component, identified by its id.
Parameters¶
id string
The unique identifier of the component that you want to retrieve.
Response¶
Type: application/json
Schema: ResidentialComponentInfoResponseDto
success boolean
Indicates whether the request completed successfully.
error ErrorDto
id string
collateralId string
selectedRentRollId string
address AddressDto
assetType string(enum)
Available enum values: None, Mixed, Hotel, Industrial, Multi_Family_Apartments, Office, Retail, Self_Storage, Land, Special_Purpose, Senior_Housing, Distribution_Warehouse, Flex_Office, Portfolio
componentType string(enum)
Available enum values: Unknown, Residential, Commercial, Hotel
marketTrendSummary MarketTrendSummaryDto
marketSummary MarketSummaryDto
marketData MarketDataDto
marketForecast MarketForecastDto
leaseToPreLeaseRatio number(double)
totalRentRollAnnualRevenue number(double)
Total annual revenue from primary rent roll
rentRollVacancy number(double)
rentRollsOrder array [ string ]
saleValueComputationType string(enum)
Available enum values: ByUnit, BySf
salesCompUnitValuation number(double)
Valuation based on the average dollar per unit times the component units
salesCompSFValuation number(double)
Valuation based on the average dollar per square foot of sales comps times the component square foot
livingUnitsInfo ResidentialLivingUnitsInfoDto
expiringLeases map { number(double) }
{
"success": true,
"error": {
"target": "string",
"code": "Duplicated",
"message": "string",
"details": ["string"]
},
"id": "string",
"collateralId": "string",
"selectedRentRollId": "string",
"address": {
"fullAddress": "string",
"placeId": "string",
"geoLocation": {
"lat": 0,
"lng": 0
},
"zipCode": "string",
"number": 0,
"street": "string",
"city": "string",
"county": "string",
"state": "string",
"country": "string",
"additionalFreeText": "string"
},
"assetType": "None",
"componentType": "Unknown",
"marketTrendSummary": {
"lastUpdated": "2025-11-04T20:32:18.057Z",
"rent": {
"title": "string",
"bullets": ["string"]
},
"sections": [
{
"title": "string",
"para": "string"
}
]
},
"marketSummary": {
"weakness1": "string",
"weakness2": "string",
"weakness3": "string",
"strength1": "string",
"strength2": "string",
"strength3": "string"
},
"marketData": {
"mainMarket": {
"marketId": 0,
"sectorId": 0,
"gradeId": 0,
"marketPublish": "string",
"sectorPublish": "string",
"grade": "string",
"ageMedian": 0,
"assetValueMomentum": 0,
"caprateEconomic": 0,
"commentary": "string",
"commuteTimeMean": 0,
"cppi": 0,
"crimeRateQuintile": "string",
"desirability": 0,
"desirabilityQuintile": "string",
"fiscalHealthTaxQuintile": "string",
"homeownershipRate": 0,
"homeValueMedianCensus": 0,
"housingAffordability": 0,
"housingAffordabilityQuintile": "string",
"incomeHhiMedianCensus": 0,
"inventory": 0,
"inventoryGrowth5Yr": 0,
"irrBetaQuintile": "string",
"irrLiquidityAdjustment": 0,
"irrRiskAdjusted": 0,
"irrRiskPremium": 0,
"irrUnlevered": 0,
"latitude": 0,
"longitude": 0,
"marketAbbr": "string",
"mrevpafGrowth": 0,
"mrevpafGrowth5Yr": 0,
"mrevpafGrowthYoyCredit": 0,
"noiGrowthLt": 0,
"occupancy": 0,
"populationDegreeCollegeCensusPct": 0,
"rankGradeId": 0,
"rentEffective": 0,
"rentGrossMedian": 0,
"strength1": "string",
"strength2": "string",
"strength3": "string",
"supplyBarrierQuintile": "string",
"walkScoreDescription": "string",
"weakness1": "string",
"weakness2": "string",
"weakness3": "string",
"timestampUpdate": "string"
},
"subMarket": {
"marketId": 0,
"subMarketId": 0,
"sectorId": 0,
"marketPublish": "string",
"subMarketPublish": "string",
"sectorPublish": "string",
"ageMedian": 0,
"capRateNominal": 0,
"commuteTimeMean": 0,
"crimeRateQuintile": "string",
"desirability": 0,
"desirabilityQuintile": "string",
"employmentGrowthCivilian": 0,
"grade": "string",
"homeValueMedianCensus": 0,
"housingAffordability": 0,
"housingAffordabilityQuintile": "string",
"incomeHhiMedianCensus": 0,
"occupancy": 0,
"populationDegreeCollegeCensusPct": 0,
"rankGradeId": 0,
"rentEffective": 0,
"rentGrossMedian": 0,
"supplyBarrierQuintile": "string",
"walkScoreDescription": "string",
"timeStampUpdate": "string"
}
},
"marketForecast": {
"marketId": 0,
"dateFcReleaseId": 0,
"scenarioId": 0,
"sectorId": 0,
"fcPublish": "string",
"marketPublish": "string",
"scenarioPublish": "string",
"sectorPublish": "string",
"dateFcRelease": "2025-11-04",
"date": "2025-11-04",
"caprateNominal": 0,
"cppiIndex": 0,
"demandGrowth": 0,
"mrevpafGrowth": 0,
"ncfGrowth": 0,
"noiGrowth": 0,
"occupancy": 0,
"rentGrowth": 0,
"supplyGrowth": 0,
"timestampUpdate": "string"
},
"leaseToPreLeaseRatio": 0,
"totalRentRollAnnualRevenue": 0,
"rentRollVacancy": 0,
"rentRollsOrder": ["string"],
"saleValueComputationType": "ByUnit",
"salesCompUnitValuation": 0,
"salesCompSFValuation": 0,
"livingUnitsInfo": {
"livingUnits": [
{
"id": "string",
"description": "string",
"bedrooms": 0,
"bathrooms": 0,
"unitSize": 0,
"numUnits": 0,
"compsRevenue": {
"monthly": 0,
"monthlyPerSf": 0,
"monthlyPerUnit": 0,
"annual": 0,
"annualPerSf": 0,
"annualPerUnit": 0
},
"concludedRevenue": {
"monthly": 0,
"monthlyPerSf": 0,
"monthlyPerUnit": 0,
"annual": 0,
"annualPerSf": 0,
"annualPerUnit": 0
}
}
],
"marketVacancy": 0,
"totalSf": 0,
"totalUnits": 0,
"averageUnitSize": 0,
"concludedTotalRevenue": {
"monthly": 0,
"monthlyPerSf": 0,
"monthlyPerUnit": 0,
"annual": 0,
"annualPerSf": 0,
"annualPerUnit": 0
},
"compsTotalRevenue": {
"monthly": 0,
"monthlyPerSf": 0,
"monthlyPerUnit": 0,
"annual": 0,
"annualPerSf": 0,
"annualPerUnit": 0
}
},
"expiringLeases": {
"additionalProp1": 0,
"additionalProp2": 0,
"additionalProp3": 0
}
}