Get Residential Component Info

Retrieves detailed information for a residential property component, including all base component fields plus residential living units, expiring leases, and revenue analytics.

Key Details

• Extends Get Base Component Info with residential-specific data.
• livingUnitsInfo contains the residential unit mix — each livingUnits[] entry represents a unit type (bedrooms, bathrooms, size, unit count) with compsRevenue (market-derived rent) and concludedRevenue (analyst-concluded rent).
• expiringLeases breaks down lease expirations by year — useful for turnover risk analysis and re-leasing projections.
• marketVacancy is the third-party market-derived vacancy rate for comparable multi-family properties.
• concludedTotalRevenue represents the analyst's final determination of achievable annual revenue. compsTotalRevenue is derived from comparable property data.
• All monetary values are in USD. Revenue figures are annualized.
• Use this endpoint for Multi_Family_Apartments asset type.

Related Endpoints

• Get Base Component Info — common component fields and market data
• Get Commercial Component Info — for commercial components
• Get Hotel Component Info — for hotel components
• Get Residential Rentroll Info — tenant-level residential rent roll with unit types

Parameters

id string

Unique identifier for the residential component

Response

Status: 200

Type: application/json

Schema: ResidentialComponentInfoResponseDto

success boolean

Indicates whether the API request completed successfully

error ErrorDto

target string

Field or parameter that caused the error

code string(enum)

Error code (e.g., Duplicated, MissingMandatoryField, InvalidCreateValues, MissingEntity)

Available enum values: Duplicated, MissingMandatoryField, InvalidCreateValues, Existing, ValidationError, MissingEntity

message string

details array [ ErrorDto ]

id string

Unique identifier for this component

collateralId string

ID of the collateral property this component belongs to

selectedRentRollId string

ID of the primary rent roll used for revenue calculations

address AddressDto

fullAddress string

Complete street address validated by Google Places API (e.g., "1600 Amphitheatre Parkway, Mountain View, CA 94043")

placeId string

Google Places unique identifier for this address

geoLocation LatLng

lat number(double)

lng number(double)

zipCode string

number integer(int32)

street string

city string

county string

state string

country string

additionalFreeText string

Additional address information such as suite or unit number

assetType string(enum)

Residential property category (e.g., Multi_Family_Apartments)

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)

Property use classification: Residential

Available enum values: Unknown, Residential, Commercial, Hotel

marketTrendSummary MarketTrendSummaryDto

lastUpdated string(date-time)

Date and time of last update for market info

rent HighlightDto

title string

Title of REIS market summary section

bullets array [ string ]

sections array [ SectionDto ]

title string

taken directly from data source as is

para string

taken directly from data source as is

marketSummary MarketSummaryDto

weakness1 string

Weakness of the market

weakness2 string

Weakness of the market

weakness3 string

Weakness of the market

strength1 string

Strength of the market

strength2 string

Strength of the market

strength3 string

Strength of the market

marketData MarketDataDto

mainMarket MainMarketDto

marketId integer(int64)

Unique identifier for the metropolitan market

sectorId integer(int64)

Unique ID to identify the property sector of a given company under Green Street's coverage

gradeId number(double)

The ID number assigned to a letter grade

marketPublish string

Published name of a market

sectorPublish string

Property sector name

grade string

Relative long-term rent growth potential (A+ to D scale)

ageMedian number(double)

Median age of main market's population

assetValueMomentum number(double)

Compares the year-over-year and trailing-twelve month change in asset values

caprateEconomic number(double)

A property yield based on estimated economic NOI relative to current operating real estate values

commentary string

Market commentary in the market snapshots

commuteTimeMean number(double)

Mean commute time of main market's population

cppi number(double)

Time series of unleveraged U.S. commercial property values that captures the prices at which commercial real estate transactions are being negotiated and contracted

crimeRateQuintile string

Measures the level of crime in the main market. A higher number corresponds with more crime and is a simple average ofviolent crime and property crime indices based on FBI data

desirability number(double)

Measures how desirable a market is to live in. Takes into account the perception of corruption, population migration trends, and climate / pollution

desirabilityQuintile string

Measures how desirable the main market is to live in. This metric takes into account millennial growth patterns, weather, taxes, walkability, school rating, crime, the general health of its population, and a foodie score

fiscalHealthTaxQuintile string

Measures the financial viability and solvency of a market. This quintile bucket indicates where an MSA scores relative to Green Street's Top-50 markets

homeownershipRate number(double)

The percentage of homes that are owned by their occupants

homeValueMedianCensus number(double)

Median home value (from census)

housingAffordability number(double)

A measure of affluence that combines the median home price and mortgage-to-rent ratio in the main market

housingAffordabilityQuintile string

The quintile associated with Housing Affordability

incomeHhiMedianCensus number(double)

Median household income based on census

inventory number(double)

The total inventory for the selected sector

inventoryGrowth5Yr number(double)

Annualized 5-year growth of inventory within a market

irrBetaQuintile string

Green Street's market betas measure the volatility of asset values and cash flows

irrLiquidityAdjustment number(double)

Liquidity adjustment is calculated based on historic transaction volume relative to Green Street's top 50 markets and applied to the risk-adjusted IRR

irrRiskAdjusted number(double)

This metric estimates the unlevered risk-adjusted returns that real estate investors expect to achieve by combining current cap rates, a cap-ex reserve, intermediate cash flow growth, and inflation expectations.

irrRiskPremium number(double)

The risk premium ascribed to Green Street's unlevered return expectations. The risk premium is determined based on market performance during the GFC

irrUnlevered number(double)

The discount rate that sets estimated discounted cash flows equal to the initial investment. By combining current cap rates, a cap-ex reserve, intermediate cash flow growth, and long-term growth expectations, it is possible to estimate the unlevered returns that real estate investors can expect to achieve. Green Street's unlevered IRR does not include adjustments for liquidity or market risk

latitude number(double)

The latitude of a given market

longitude number(double)

The longitude of a given market

marketAbbr string

The abbreviated market name

mrevpafGrowth number(double)

Annualized M-RevPAF (change in rent times the change in occupancy) forecast over the next five years

mrevpafGrowth5Yr number(double)

Annualized M-RevPAF (combination of rent and occupancy) growth forecast over the next five years

mrevpafGrowthYoyCredit number(double)

The year-over-year growth in M-RevPAF, which combines two key operating metrics (rent and occupancy) into a single value

noiGrowthLt number(double)

Green Street's estimate of NOI growth from year 6 of an investment horizon to perpetuity

occupancy number(double)

Market-wide occupancy rate, expressed as a decimal (e.g., 0.94 = 94%)

populationDegreeCollegeCensusPct number(double)

Percentage of population 25 or older with a bachelor's or advanced degree

rankGradeId integer(int64)

Ranking of Market Grades ID metric

rentEffective number(double)

Average effective rent per unit per month (net of concessions), in USD

rentGrossMedian number(double)

The median gross rent level of an area reported by the US Census Bureau. This figure provides information on the monthly housing costs for renters

strength1 string

Strength of the market

strength2 string

Strength of the market

strength3 string

Strength of the market

supplyBarrierQuintile string

The quintile associated with supply barriers

walkScoreDescription string

Walk Score® analyzes hundreds of walking routes to nearby amenities. Points are awarded based on the distance to amenities. Amenities within a 5 minute walk are given maximum points. A decay function is used to give points to more distant amenities up to a 30 minute walk

weakness1 string

Weakness of the market

weakness2 string

Weakness of the market

weakness3 string

Weakness of the market

timestampUpdate string

The date that data was last updated

subMarket SubMarketDto

marketId integer(int64)

Unique identifier for the metropolitan market

subMarketId integer(int64)

Unique identifier for this submarket within the metropolitan area

sectorId integer(int64)

Unique ID to identify the property sector of a given company under Green Street's coverage

marketPublish string

Published name of a market

subMarketPublish string

Submarket name

sectorPublish string

Property sector name

ageMedian number(double)

The median age of the population

capRateNominal number(double)

Expected first-year property yield (Nominal NOI / Property Value), expressed as a decimal (e.g., 0.055 = 5.5%)

commuteTimeMean number(double)

The mean commute time in minutes

crimeRateQuintile string

Measures the level of crime. A higher number corresponds with more crime and is a simple average of violent crime and property crime indices based on FBI data

desirability number(double)

Measures how desirable a market is to live in. Takes into account the perception of corruption, population migration trends, and climate / pollution

desirabilityQuintile string

Measures how desirable a market is to live in. This metric takes into account millennial growth patterns, weather, taxes, walkability, school rating, crime, the general health of its population, and a foodie score

employmentGrowthCivilian number(double)

Annualized job growth for civilians

grade string

Relative long-term rent growth potential for this submarket (A+ to D scale)

homeValueMedianCensus integer(int64)

Estimate of how much the property (house and lot) would sell for

housingAffordability number(double)

A measure of affluence that combines the median home price and mortgage-to-rent ratio

housingAffordabilityQuintile string

The quintile associated with Housing Affordability

incomeHhiMedianCensus number(double)

Median household income

occupancy number(double)

Submarket occupancy rate, expressed as a decimal (e.g., 0.95 = 95%)

populationDegreeCollegeCensusPct number(double)

Percentage of population 25 or older with a bachelor's or advanced degree

rankGradeId integer(int64)

Ranking of Market Grades ID metric

rentEffective number(double)

Average effective rent per unit per month (net of concessions) in this submarket, in USD

rentGrossMedian number(double)

The median gross rent level of an area reported by the US Census Bureau. This figure provides information on the monthly housing costs for renters

supplyBarrierQuintile string

The quintile associated with Green Street's Supply Barriers Score

walkScoreDescription string

Walk Score® analyzes hundreds of walking routes to nearby amenities. Points are awarded based on the distance to amenities. Amenities within a 5 minute walk are given maximum points. A decay function is used to give points to more distant amenities up to a 30 minute walk

timeStampUpdate string

The date that data was last updated

marketForecast MarketForecastDto

marketId integer(int64)

Identification number assigned to each market

dateFcReleaseId integer(int64)

A unique identifier to denote a specific Forecast Scenarios release

scenarioId integer(int64)

A unique identifier to indicate which of Green Street's Forecast Scenarios the corresponding data refers to

sectorId integer(int64)

Unique ID to identify the property sector of a given company under Green Street's coverage

fcPublish string

Indicates which Forecast Release (date) is being referenced

marketPublish string

Published name of a market

scenarioPublish string

Indicates which of Green Street's Forecast Scenarios the corresponding data refers to

sectorPublish string

Property sector name

dateFcRelease string(date)

Indicates the quarter in which this specific release of Forecast Scenario data relate to

date string(date)

Date of Market forecast

caprateNominal number(double)

Represents the expected first year yield a property buyer expects to realize on their investment, calculated as: Nominal Net Operating Income (NOI) / Property Value

cppiIndex number(double)

Time series of unleveraged U.S. commercial property values that captures the prices at which commercial real estate transactions are being negotiated and contracted.

demandGrowth number(double)

Net absorption within a market. Measures the total space that became physically occupied minus the portion which became physically vacant

mrevpafGrowth number(double)

Annualized M-RevPAF (change in rent times the change in occupancy) forecast over the next five years

ncfGrowth number(double)

Net cash flow growth

noiGrowth number(double)

NOI growth

occupancy number(double)

Percentage of total unit count that is physically occupied

rentGrowth number(double)

Green Street's forecasted rent growth expectations

supplyGrowth number(double)

Year-over-year growth of inventory

timestampUpdate string

The date that data was last updated

leaseToPreLeaseRatio number(double)

totalRentRollAnnualRevenue number(double)

Total annual revenue from the primary rent roll, in USD

rentRollVacancy number(double)

Vacancy rate derived from the primary rent roll, expressed as a decimal (e.g., 0.08 = 8%)

rentRollsOrder array [ string ]

saleValueComputationType string(enum)

Available enum values: ByUnit, BySf

salesCompUnitValuation number(double)

Property valuation based on average price per unit from sales comparables, in USD

salesCompSFValuation number(double)

Property valuation based on average price per square foot from sales comparables, in USD

livingUnitsInfo ResidentialLivingUnitsInfoDto

livingUnits array [ ResidentialLivingUnitDto ]

id string

Unique identifier for this unit line item

description string

Unit description in multifamily unit mix

bedrooms number(double)

Number of bedrooms in the unit

bathrooms number(double)

Number of bathrooms in the unit

unitSize number(double)

Square footage of the unit

numUnits number(double)

Number of units of this unit type in the unit mix

compsRevenue RevenueDto

Revenue projections based on comparable properties

monthly number(double)

Monthly revenue, in USD

monthlyPerSf number(double)

Monthly revenue per square foot, in USD

monthlyPerUnit number(double)

Monthly revenue per unit, in USD

annual number(double)

Annual revenue, in USD

annualPerSf number(double)

Annual revenue per square foot, in USD

annualPerUnit number(double)

Annual revenue per unit, in USD

concludedRevenue RevenueDto

Analyst-concluded achievable rent for this unit type

monthly number(double)

Monthly revenue, in USD

monthlyPerSf number(double)

Monthly revenue per square foot, in USD

monthlyPerUnit number(double)

Monthly revenue per unit, in USD

annual number(double)

Annual revenue, in USD

annualPerSf number(double)

Annual revenue per square foot, in USD

annualPerUnit number(double)

Annual revenue per unit, in USD

marketVacancy number(double)

Market vacancy rate for multi-family properties, expressed as a decimal (e.g., 0.05 = 5%)

totalSf number(double)

Total square footage of residential space

totalUnits number(double)

Total number of residential units

averageUnitSize number(double)

Average size per residential unit, in square feet

concludedTotalRevenue RevenueDto

Total annual revenue based on analyst-concluded achievable rents, in USD

monthly number(double)

Monthly revenue, in USD

monthlyPerSf number(double)

Monthly revenue per square foot, in USD

monthlyPerUnit number(double)

Monthly revenue per unit, in USD

annual number(double)

Annual revenue, in USD

annualPerSf number(double)

Annual revenue per square foot, in USD

annualPerUnit number(double)

Annual revenue per unit, in USD

compsTotalRevenue RevenueDto

Total annual revenue based on comparable property data, in USD

monthly number(double)

Monthly revenue, in USD

monthlyPerSf number(double)

Monthly revenue per square foot, in USD

monthlyPerUnit number(double)

Monthly revenue per unit, in USD

annual number(double)

Annual revenue, in USD

annualPerSf number(double)

Annual revenue per square foot, in USD

annualPerUnit number(double)

Annual revenue per unit, in USD

expiringLeases map { number(double) }

GET

/api/apiGateway/getResidentialComponentInfo/{id}

Response

{
  "success": true,
  "error": {
    "target": "string",
    "code": "Duplicated",
    "message": "string",
    "details": [
      {}
    ]
  },
  "id": "string",
  "collateralId": "string",
  "selectedRentRollId": "string",
  "address": {
    "fullAddress": "string",
    "placeId": "string",
    "geoLocation": {
      "lat": 0.0,
      "lng": 0.0
    },
    "zipCode": "string",
    "number": 0,
    "street": "string",
    "city": "string",
    "county": "string",
    "state": "string",
    "country": "string",
    "additionalFreeText": "string"
  },
  "assetType": "None",
  "componentType": "Unknown",
  "marketTrendSummary": {
    "lastUpdated": "2025-01-01T00:00:00",
    "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.0,
      "marketPublish": "string",
      "sectorPublish": "string",
      "grade": "string",
      "ageMedian": 0.0,
      "assetValueMomentum": 0.0,
      "caprateEconomic": 0.0,
      "commentary": "string",
      "commuteTimeMean": 0.0,
      "cppi": 0.0,
      "crimeRateQuintile": "string",
      "desirability": 0.0,
      "desirabilityQuintile": "string",
      "fiscalHealthTaxQuintile": "string",
      "homeownershipRate": 0.0,
      "homeValueMedianCensus": 0.0,
      "housingAffordability": 0.0,
      "housingAffordabilityQuintile": "string",
      "incomeHhiMedianCensus": 0.0,
      "inventory": 0.0,
      "inventoryGrowth5Yr": 0.0,
      "irrBetaQuintile": "string",
      "irrLiquidityAdjustment": 0.0,
      "irrRiskAdjusted": 0.0,
      "irrRiskPremium": 0.0,
      "irrUnlevered": 0.0,
      "latitude": 0.0,
      "longitude": 0.0,
      "marketAbbr": "string",
      "mrevpafGrowth": 0.0,
      "mrevpafGrowth5Yr": 0.0,
      "mrevpafGrowthYoyCredit": 0.0,
      "noiGrowthLt": 0.0,
      "occupancy": 0.0,
      "populationDegreeCollegeCensusPct": 0.0,
      "rankGradeId": 0,
      "rentEffective": 0.0,
      "rentGrossMedian": 0.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.0,
      "capRateNominal": 0.0,
      "commuteTimeMean": 0.0,
      "crimeRateQuintile": "string",
      "desirability": 0.0,
      "desirabilityQuintile": "string",
      "employmentGrowthCivilian": 0.0,
      "grade": "string",
      "homeValueMedianCensus": 0,
      "housingAffordability": 0.0,
      "housingAffordabilityQuintile": "string",
      "incomeHhiMedianCensus": 0.0,
      "occupancy": 0.0,
      "populationDegreeCollegeCensusPct": 0.0,
      "rankGradeId": 0,
      "rentEffective": 0.0,
      "rentGrossMedian": 0.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-01-01",
    "date": "2025-01-01",
    "caprateNominal": 0.0,
    "cppiIndex": 0.0,
    "demandGrowth": 0.0,
    "mrevpafGrowth": 0.0,
    "ncfGrowth": 0.0,
    "noiGrowth": 0.0,
    "occupancy": 0.0,
    "rentGrowth": 0.0,
    "supplyGrowth": 0.0,
    "timestampUpdate": "string"
  },
  "leaseToPreLeaseRatio": 0.0,
  "totalRentRollAnnualRevenue": 0.0,
  "rentRollVacancy": 0.0,
  "rentRollsOrder": [
    "string"
  ],
  "saleValueComputationType": "ByUnit",
  "salesCompUnitValuation": 0.0,
  "salesCompSFValuation": 0.0,
  "livingUnitsInfo": {
    "livingUnits": [
      {
        "id": "string",
        "description": "string",
        "bedrooms": 0.0,
        "bathrooms": 0.0,
        "unitSize": 0.0,
        "numUnits": 0.0,
        "compsRevenue": {
          "monthly": 0.0,
          "monthlyPerSf": 0.0,
          "monthlyPerUnit": 0.0,
          "annual": 0.0,
          "annualPerSf": 0.0,
          "annualPerUnit": 0.0
        },
        "concludedRevenue": {
          "monthly": 0.0,
          "monthlyPerSf": 0.0,
          "monthlyPerUnit": 0.0,
          "annual": 0.0,
          "annualPerSf": 0.0,
          "annualPerUnit": 0.0
        }
      }
    ],
    "marketVacancy": 0.0,
    "totalSf": 0.0,
    "totalUnits": 0.0,
    "averageUnitSize": 0.0,
    "concludedTotalRevenue": {
      "monthly": 0.0,
      "monthlyPerSf": 0.0,
      "monthlyPerUnit": 0.0,
      "annual": 0.0,
      "annualPerSf": 0.0,
      "annualPerUnit": 0.0
    },
    "compsTotalRevenue": {
      "monthly": 0.0,
      "monthlyPerSf": 0.0,
      "monthlyPerUnit": 0.0,
      "annual": 0.0,
      "annualPerSf": 0.0,
      "annualPerUnit": 0.0
    }
  },
  "expiringLeases": {
    "key": 0.0
  }
}