Data Models ¶
AddressCreateDto¶
fullAddress string
Complete street address validated by Google Places API (e.g., "1600 Amphitheatre Parkway, Mountain View, CA 94043")
additionalFreeText string
Additional address information such as suite or unit number
placeId string
Google Places unique identifier. If provided, overrides fullAddress
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
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
AlternativeValuationDto¶
name string
valuationsInfoId string
ID of the parent valuation container
valuation number(double)
Alternative valuation amount (e.g., appraisal, broker opinion), in USD
description string
asOfDate string(date)
Date the valuation is effective as of (ISO 8601 format: YYYY-MM-DD)
parentId string
ID of the parent valuation, if this is a sub-valuation
descriptor string
CashFlowInfoDto¶
valuationsInfoId string
ID of the parent valuation container
fileId string
ID of the uploaded cash flow document
comment string
revenue FinancialTransactionInfoDto
total number(double)
totalByYear array [ number(double) ]
groupedTransactions array [ FinancialTransactionGroupDto ]
group string
totalAmount number(double)
Total amount for this transaction group, in USD
totalPerSf number(double)
Total amount per square foot, in USD
totalPerUnit number(double)
Total amount per unit, in USD
totalPercentageEGI number(double)
Total as a percentage of Effective Gross Income (EGI), expressed as a decimal
transactions array [ FinancialTransactionDto ]
description string
group string
amount number(double)
Transaction amount, in USD
measureType string(enum)
How the amount is calculated (e.g., PercentOfRevenue, Amount, AmountPerSf, AmountPerUnit)
Available enum values: Unspecified, PercentOfRentRollVacancy, PercentOfRevenue, PercentOfEffectiveIncome, PercentOfSalesCompValuation, PercentOfTotalOperatingExpenses, Amount, PercentOfComponentRevenues, AmountPerSf, AmountPerUnit
annualized number(double)
Annualized amount, in USD
annualizedPerSf number(double)
Annualized amount per square foot, in USD
annualizedPerUnit number(double)
Annualized amount per unit, in USD
annualizedPercentageEGI number(double)
Annualized amount as a percentage of Effective Gross Income (EGI), expressed as a decimal
annualizedByYear array [ number(double) ]
comment string
vacancyAndConcessions FinancialTransactionInfoDto
total number(double)
totalByYear array [ number(double) ]
groupedTransactions array [ FinancialTransactionGroupDto ]
group string
totalAmount number(double)
Total amount for this transaction group, in USD
totalPerSf number(double)
Total amount per square foot, in USD
totalPerUnit number(double)
Total amount per unit, in USD
totalPercentageEGI number(double)
Total as a percentage of Effective Gross Income (EGI), expressed as a decimal
transactions array [ FinancialTransactionDto ]
description string
group string
amount number(double)
Transaction amount, in USD
measureType string(enum)
How the amount is calculated (e.g., PercentOfRevenue, Amount, AmountPerSf, AmountPerUnit)
Available enum values: Unspecified, PercentOfRentRollVacancy, PercentOfRevenue, PercentOfEffectiveIncome, PercentOfSalesCompValuation, PercentOfTotalOperatingExpenses, Amount, PercentOfComponentRevenues, AmountPerSf, AmountPerUnit
annualized number(double)
Annualized amount, in USD
annualizedPerSf number(double)
Annualized amount per square foot, in USD
annualizedPerUnit number(double)
Annualized amount per unit, in USD
annualizedPercentageEGI number(double)
Annualized amount as a percentage of Effective Gross Income (EGI), expressed as a decimal
annualizedByYear array [ number(double) ]
comment string
otherIncome FinancialTransactionInfoDto
total number(double)
totalByYear array [ number(double) ]
groupedTransactions array [ FinancialTransactionGroupDto ]
group string
totalAmount number(double)
Total amount for this transaction group, in USD
totalPerSf number(double)
Total amount per square foot, in USD
totalPerUnit number(double)
Total amount per unit, in USD
totalPercentageEGI number(double)
Total as a percentage of Effective Gross Income (EGI), expressed as a decimal
transactions array [ FinancialTransactionDto ]
description string
group string
amount number(double)
Transaction amount, in USD
measureType string(enum)
How the amount is calculated (e.g., PercentOfRevenue, Amount, AmountPerSf, AmountPerUnit)
Available enum values: Unspecified, PercentOfRentRollVacancy, PercentOfRevenue, PercentOfEffectiveIncome, PercentOfSalesCompValuation, PercentOfTotalOperatingExpenses, Amount, PercentOfComponentRevenues, AmountPerSf, AmountPerUnit
annualized number(double)
Annualized amount, in USD
annualizedPerSf number(double)
Annualized amount per square foot, in USD
annualizedPerUnit number(double)
Annualized amount per unit, in USD
annualizedPercentageEGI number(double)
Annualized amount as a percentage of Effective Gross Income (EGI), expressed as a decimal
annualizedByYear array [ number(double) ]
comment string
operatingExpenses FinancialTransactionInfoDto
total number(double)
totalByYear array [ number(double) ]
groupedTransactions array [ FinancialTransactionGroupDto ]
group string
totalAmount number(double)
Total amount for this transaction group, in USD
totalPerSf number(double)
Total amount per square foot, in USD
totalPerUnit number(double)
Total amount per unit, in USD
totalPercentageEGI number(double)
Total as a percentage of Effective Gross Income (EGI), expressed as a decimal
transactions array [ FinancialTransactionDto ]
description string
group string
amount number(double)
Transaction amount, in USD
measureType string(enum)
How the amount is calculated (e.g., PercentOfRevenue, Amount, AmountPerSf, AmountPerUnit)
Available enum values: Unspecified, PercentOfRentRollVacancy, PercentOfRevenue, PercentOfEffectiveIncome, PercentOfSalesCompValuation, PercentOfTotalOperatingExpenses, Amount, PercentOfComponentRevenues, AmountPerSf, AmountPerUnit
annualized number(double)
Annualized amount, in USD
annualizedPerSf number(double)
Annualized amount per square foot, in USD
annualizedPerUnit number(double)
Annualized amount per unit, in USD
annualizedPercentageEGI number(double)
Annualized amount as a percentage of Effective Gross Income (EGI), expressed as a decimal
annualizedByYear array [ number(double) ]
comment string
belowTheLineExpense FinancialTransactionInfoDto
total number(double)
totalByYear array [ number(double) ]
groupedTransactions array [ FinancialTransactionGroupDto ]
group string
totalAmount number(double)
Total amount for this transaction group, in USD
totalPerSf number(double)
Total amount per square foot, in USD
totalPerUnit number(double)
Total amount per unit, in USD
totalPercentageEGI number(double)
Total as a percentage of Effective Gross Income (EGI), expressed as a decimal
transactions array [ FinancialTransactionDto ]
description string
group string
amount number(double)
Transaction amount, in USD
measureType string(enum)
How the amount is calculated (e.g., PercentOfRevenue, Amount, AmountPerSf, AmountPerUnit)
Available enum values: Unspecified, PercentOfRentRollVacancy, PercentOfRevenue, PercentOfEffectiveIncome, PercentOfSalesCompValuation, PercentOfTotalOperatingExpenses, Amount, PercentOfComponentRevenues, AmountPerSf, AmountPerUnit
annualized number(double)
Annualized amount, in USD
annualizedPerSf number(double)
Annualized amount per square foot, in USD
annualizedPerUnit number(double)
Annualized amount per unit, in USD
annualizedPercentageEGI number(double)
Annualized amount as a percentage of Effective Gross Income (EGI), expressed as a decimal
annualizedByYear array [ number(double) ]
comment string
effectiveIncome number(double)
Effective Gross Income (EGI) - total income minus vacancy and concessions, in USD
effectiveIncomeByYear array [ number(double) ]
totalExpenses number(double)
Total operating expenses, in USD
totalExpensesByYear array [ number(double) ]
netOperatingIncome number(double)
Net Operating Income (NOI) - effective income minus operating expenses, in USD
netOperatingIncomeByYear array [ number(double) ]
netIncome number(double)
Net income after operating expenses and below-the-line expenses, in USD
netIncomeByYear array [ number(double) ]
dcfModel DcfModelDto
discountRate number(double)
Discount rate used for present value calculations, expressed as a decimal (e.g., 0.08 = 8%)
revenueGrowth array [ number(double) ]
Annual revenue growth rate assumption, expressed as a decimal (e.g., 0.03 = 3%)
expenseGrowth array [ number(double) ]
Annual expense growth rate assumption, expressed as a decimal (e.g., 0.025 = 2.5%)
finalSale number(double)
presentValues array [ number(double) ]
netPresentValue number(double)
expenseRatio number(double)
Total operating expenses divided by effective gross income, expressed as a decimal (e.g., 0.35 = 35%)
CollateralCashFlowResponseDto¶
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 cash flow analysis
collateralId string
ID of the collateral property for this cash flow analysis
marketCapRate number(double)
Market-derived capitalization rate, expressed as a decimal (e.g., 0.055 = 5.5%)
mainIncomeValuationCapRate number(double)
Cap rate used in the primary income valuation, expressed as a decimal
marketValuation RevenueValuationDto
Property value using market cap rate, in USD
capRate number(double)
Capitalization rate used to calculate property value (NOI / Cap Rate), expressed as a decimal (e.g., 0.06 = 6%)
name string
valuationsInfoId string
ID of the parent valuation container
startDate string(date)
Valuation period start date (ISO 8601 format: YYYY-MM-DD)
endDate string(date)
Valuation period end date (ISO 8601 format: YYYY-MM-DD)
expensesSourceId string
ID of the expense source valuation
userValuationType string
comment string
revenueSource string(enum)
Source of revenue data (Market, SelectedRentRoll, ConcludedRent, or Alternative)
Available enum values: Market, SelectedRentRoll, Alternative, ConcludedRent
capRateSource string(enum)
Source of cap rate (Market or Manual)
Available enum values: Market, Manual
vacancySource string(enum)
Source of vacancy assumption (Market, RentRoll, or Manual)
Available enum values: Market, RentRoll, Manual
cashFlow CashFlowInfoDto
valuationsInfoId string
ID of the parent valuation container
fileId string
ID of the uploaded cash flow document
comment string
revenue FinancialTransactionInfoDto
total number(double)
totalByYear array [ number(double) ]
groupedTransactions array [ FinancialTransactionGroupDto ]
group string
totalAmount number(double)
Total amount for this transaction group, in USD
totalPerSf number(double)
Total amount per square foot, in USD
totalPerUnit number(double)
Total amount per unit, in USD
totalPercentageEGI number(double)
Total as a percentage of Effective Gross Income (EGI), expressed as a decimal
transactions array [ FinancialTransactionDto ]
description string
group string
amount number(double)
Transaction amount, in USD
measureType string(enum)
How the amount is calculated (e.g., PercentOfRevenue, Amount, AmountPerSf, AmountPerUnit)
Available enum values: Unspecified, PercentOfRentRollVacancy, PercentOfRevenue, PercentOfEffectiveIncome, PercentOfSalesCompValuation, PercentOfTotalOperatingExpenses, Amount, PercentOfComponentRevenues, AmountPerSf, AmountPerUnit
annualized number(double)
Annualized amount, in USD
annualizedPerSf number(double)
Annualized amount per square foot, in USD
annualizedPerUnit number(double)
Annualized amount per unit, in USD
annualizedPercentageEGI number(double)
Annualized amount as a percentage of Effective Gross Income (EGI), expressed as a decimal
annualizedByYear array [ number(double) ]
comment string
vacancyAndConcessions FinancialTransactionInfoDto
total number(double)
totalByYear array [ number(double) ]
groupedTransactions array [ FinancialTransactionGroupDto ]
group string
totalAmount number(double)
Total amount for this transaction group, in USD
totalPerSf number(double)
Total amount per square foot, in USD
totalPerUnit number(double)
Total amount per unit, in USD
totalPercentageEGI number(double)
Total as a percentage of Effective Gross Income (EGI), expressed as a decimal
transactions array [ FinancialTransactionDto ]
description string
group string
amount number(double)
Transaction amount, in USD
measureType string(enum)
How the amount is calculated (e.g., PercentOfRevenue, Amount, AmountPerSf, AmountPerUnit)
Available enum values: Unspecified, PercentOfRentRollVacancy, PercentOfRevenue, PercentOfEffectiveIncome, PercentOfSalesCompValuation, PercentOfTotalOperatingExpenses, Amount, PercentOfComponentRevenues, AmountPerSf, AmountPerUnit
annualized number(double)
Annualized amount, in USD
annualizedPerSf number(double)
Annualized amount per square foot, in USD
annualizedPerUnit number(double)
Annualized amount per unit, in USD
annualizedPercentageEGI number(double)
Annualized amount as a percentage of Effective Gross Income (EGI), expressed as a decimal
annualizedByYear array [ number(double) ]
comment string
otherIncome FinancialTransactionInfoDto
total number(double)
totalByYear array [ number(double) ]
groupedTransactions array [ FinancialTransactionGroupDto ]
group string
totalAmount number(double)
Total amount for this transaction group, in USD
totalPerSf number(double)
Total amount per square foot, in USD
totalPerUnit number(double)
Total amount per unit, in USD
totalPercentageEGI number(double)
Total as a percentage of Effective Gross Income (EGI), expressed as a decimal
transactions array [ FinancialTransactionDto ]
description string
group string
amount number(double)
Transaction amount, in USD
measureType string(enum)
How the amount is calculated (e.g., PercentOfRevenue, Amount, AmountPerSf, AmountPerUnit)
Available enum values: Unspecified, PercentOfRentRollVacancy, PercentOfRevenue, PercentOfEffectiveIncome, PercentOfSalesCompValuation, PercentOfTotalOperatingExpenses, Amount, PercentOfComponentRevenues, AmountPerSf, AmountPerUnit
annualized number(double)
Annualized amount, in USD
annualizedPerSf number(double)
Annualized amount per square foot, in USD
annualizedPerUnit number(double)
Annualized amount per unit, in USD
annualizedPercentageEGI number(double)
Annualized amount as a percentage of Effective Gross Income (EGI), expressed as a decimal
annualizedByYear array [ number(double) ]
comment string
operatingExpenses FinancialTransactionInfoDto
total number(double)
totalByYear array [ number(double) ]
groupedTransactions array [ FinancialTransactionGroupDto ]
group string
totalAmount number(double)
Total amount for this transaction group, in USD
totalPerSf number(double)
Total amount per square foot, in USD
totalPerUnit number(double)
Total amount per unit, in USD
totalPercentageEGI number(double)
Total as a percentage of Effective Gross Income (EGI), expressed as a decimal
transactions array [ FinancialTransactionDto ]
description string
group string
amount number(double)
Transaction amount, in USD
measureType string(enum)
How the amount is calculated (e.g., PercentOfRevenue, Amount, AmountPerSf, AmountPerUnit)
Available enum values: Unspecified, PercentOfRentRollVacancy, PercentOfRevenue, PercentOfEffectiveIncome, PercentOfSalesCompValuation, PercentOfTotalOperatingExpenses, Amount, PercentOfComponentRevenues, AmountPerSf, AmountPerUnit
annualized number(double)
Annualized amount, in USD
annualizedPerSf number(double)
Annualized amount per square foot, in USD
annualizedPerUnit number(double)
Annualized amount per unit, in USD
annualizedPercentageEGI number(double)
Annualized amount as a percentage of Effective Gross Income (EGI), expressed as a decimal
annualizedByYear array [ number(double) ]
comment string
belowTheLineExpense FinancialTransactionInfoDto
total number(double)
totalByYear array [ number(double) ]
groupedTransactions array [ FinancialTransactionGroupDto ]
group string
totalAmount number(double)
Total amount for this transaction group, in USD
totalPerSf number(double)
Total amount per square foot, in USD
totalPerUnit number(double)
Total amount per unit, in USD
totalPercentageEGI number(double)
Total as a percentage of Effective Gross Income (EGI), expressed as a decimal
transactions array [ FinancialTransactionDto ]
description string
group string
amount number(double)
Transaction amount, in USD
measureType string(enum)
How the amount is calculated (e.g., PercentOfRevenue, Amount, AmountPerSf, AmountPerUnit)
Available enum values: Unspecified, PercentOfRentRollVacancy, PercentOfRevenue, PercentOfEffectiveIncome, PercentOfSalesCompValuation, PercentOfTotalOperatingExpenses, Amount, PercentOfComponentRevenues, AmountPerSf, AmountPerUnit
annualized number(double)
Annualized amount, in USD
annualizedPerSf number(double)
Annualized amount per square foot, in USD
annualizedPerUnit number(double)
Annualized amount per unit, in USD
annualizedPercentageEGI number(double)
Annualized amount as a percentage of Effective Gross Income (EGI), expressed as a decimal
annualizedByYear array [ number(double) ]
comment string
effectiveIncome number(double)
Effective Gross Income (EGI) - total income minus vacancy and concessions, in USD
effectiveIncomeByYear array [ number(double) ]
totalExpenses number(double)
Total operating expenses, in USD
totalExpensesByYear array [ number(double) ]
netOperatingIncome number(double)
Net Operating Income (NOI) - effective income minus operating expenses, in USD
netOperatingIncomeByYear array [ number(double) ]
netIncome number(double)
Net income after operating expenses and below-the-line expenses, in USD
netIncomeByYear array [ number(double) ]
dcfModel DcfModelDto
discountRate number(double)
Discount rate used for present value calculations, expressed as a decimal (e.g., 0.08 = 8%)
revenueGrowth array [ number(double) ]
Annual revenue growth rate assumption, expressed as a decimal (e.g., 0.03 = 3%)
expenseGrowth array [ number(double) ]
Annual expense growth rate assumption, expressed as a decimal (e.g., 0.025 = 2.5%)
finalSale number(double)
presentValues array [ number(double) ]
netPresentValue number(double)
expenseRatio number(double)
Total operating expenses divided by effective gross income, expressed as a decimal (e.g., 0.35 = 35%)
totalValuation number(double)
Total property value calculated from this valuation scenario, in USD
parentId string
ID of the parent valuation, if this is a sub-valuation
descriptor string
archive boolean
componentsVacancies map { VacancyValueDto }
amountValue number(double)
Vacancy as a dollar amount, in USD
percentageValue number(double)
Vacancy as a percentage of revenue, expressed as a decimal (e.g., 0.05 = 5%)
componentsSelectedRentRolls map { string }
metrics array [ ValuationMetricsDto ]
dealId string
ID of the deal this valuation applies to
dscr number(double)
Debt Service Coverage Ratio for this valuation scenario. Values > 1.0 indicate income exceeds debt obligations
ltv number(double)
Loan-to-Value ratio for this valuation scenario, expressed as a decimal (e.g., 0.72 = 72%)
debtYield number(double)
Debt yield (NOI / Loan Amount) for this valuation scenario, expressed as a percentage
salesValuation number(double)
Property value from sales comparables, in USD
mainIncomeValuationId string
ID of the primary income-based valuation scenario
mainAlternativeValuationId string
ID of the primary alternative valuation (e.g., appraisal)
mainAlternativeValuation number(double)
Primary alternative valuation (e.g., appraisal), in USD
mainAlternativeValuationDate string(date)
Date of the primary alternative valuation (ISO 8601 format: YYYY-MM-DD)
capRateLastModifiedTime string(date)
rentRollRevenues map { number(double) }
componentTotals ComponentTotalsDto
componentsData array [ ComponentInfoDto ]
id string
Unique identifier for this component
assetType string(enum)
Property category (e.g., Multi_Family_Apartments, Office, Retail, Hotel)
Available enum values: None, Mixed, Hotel, Industrial, Multi_Family_Apartments, Office, Retail, Self_Storage, Land, Special_Purpose, Senior_Housing, Distribution_Warehouse, Flex_Office, Portfolio
totalSf number(double)
Total square footage of the component
totalUnits number(double)
Total units in the component
saleValue number(double)
Property value from sales comparables, in USD
totalMarketAnnualRevenue number(double)
Annual revenue based on market rents, in USD
totalRentRollAnnualRevenue number(double)
Annual revenue from the primary rent roll, in USD
marketVacancy number(double)
Market vacancy rate, expressed as a decimal (e.g., 0.06 = 6%)
rentRollVacancy number(double)
Vacancy rate from the rent roll, expressed as a decimal (e.g., 0.08 = 8%)
totalSaleValue number(double)
Total sales comparable valuation across all components, in USD
totalSf number(double)
Total square footage across all components
totalUnits number(double)
Total units across all components
revenueValuations array [ RevenueValuationDto ]
capRate number(double)
Capitalization rate used to calculate property value (NOI / Cap Rate), expressed as a decimal (e.g., 0.06 = 6%)
name string
valuationsInfoId string
ID of the parent valuation container
startDate string(date)
Valuation period start date (ISO 8601 format: YYYY-MM-DD)
endDate string(date)
Valuation period end date (ISO 8601 format: YYYY-MM-DD)
expensesSourceId string
ID of the expense source valuation
userValuationType string
comment string
revenueSource string(enum)
Source of revenue data (Market, SelectedRentRoll, ConcludedRent, or Alternative)
Available enum values: Market, SelectedRentRoll, Alternative, ConcludedRent
capRateSource string(enum)
Source of cap rate (Market or Manual)
Available enum values: Market, Manual
vacancySource string(enum)
Source of vacancy assumption (Market, RentRoll, or Manual)
Available enum values: Market, RentRoll, Manual
cashFlow CashFlowInfoDto
valuationsInfoId string
ID of the parent valuation container
fileId string
ID of the uploaded cash flow document
comment string
revenue FinancialTransactionInfoDto
total number(double)
totalByYear array [ number(double) ]
groupedTransactions array [ FinancialTransactionGroupDto ]
group string
totalAmount number(double)
Total amount for this transaction group, in USD
totalPerSf number(double)
Total amount per square foot, in USD
totalPerUnit number(double)
Total amount per unit, in USD
totalPercentageEGI number(double)
Total as a percentage of Effective Gross Income (EGI), expressed as a decimal
transactions array [ FinancialTransactionDto ]
description string
group string
amount number(double)
Transaction amount, in USD
measureType string(enum)
How the amount is calculated (e.g., PercentOfRevenue, Amount, AmountPerSf, AmountPerUnit)
Available enum values: Unspecified, PercentOfRentRollVacancy, PercentOfRevenue, PercentOfEffectiveIncome, PercentOfSalesCompValuation, PercentOfTotalOperatingExpenses, Amount, PercentOfComponentRevenues, AmountPerSf, AmountPerUnit
annualized number(double)
Annualized amount, in USD
annualizedPerSf number(double)
Annualized amount per square foot, in USD
annualizedPerUnit number(double)
Annualized amount per unit, in USD
annualizedPercentageEGI number(double)
Annualized amount as a percentage of Effective Gross Income (EGI), expressed as a decimal
annualizedByYear array [ number(double) ]
comment string
vacancyAndConcessions FinancialTransactionInfoDto
total number(double)
totalByYear array [ number(double) ]
groupedTransactions array [ FinancialTransactionGroupDto ]
group string
totalAmount number(double)
Total amount for this transaction group, in USD
totalPerSf number(double)
Total amount per square foot, in USD
totalPerUnit number(double)
Total amount per unit, in USD
totalPercentageEGI number(double)
Total as a percentage of Effective Gross Income (EGI), expressed as a decimal
transactions array [ FinancialTransactionDto ]
description string
group string
amount number(double)
Transaction amount, in USD
measureType string(enum)
How the amount is calculated (e.g., PercentOfRevenue, Amount, AmountPerSf, AmountPerUnit)
Available enum values: Unspecified, PercentOfRentRollVacancy, PercentOfRevenue, PercentOfEffectiveIncome, PercentOfSalesCompValuation, PercentOfTotalOperatingExpenses, Amount, PercentOfComponentRevenues, AmountPerSf, AmountPerUnit
annualized number(double)
Annualized amount, in USD
annualizedPerSf number(double)
Annualized amount per square foot, in USD
annualizedPerUnit number(double)
Annualized amount per unit, in USD
annualizedPercentageEGI number(double)
Annualized amount as a percentage of Effective Gross Income (EGI), expressed as a decimal
annualizedByYear array [ number(double) ]
comment string
otherIncome FinancialTransactionInfoDto
total number(double)
totalByYear array [ number(double) ]
groupedTransactions array [ FinancialTransactionGroupDto ]
group string
totalAmount number(double)
Total amount for this transaction group, in USD
totalPerSf number(double)
Total amount per square foot, in USD
totalPerUnit number(double)
Total amount per unit, in USD
totalPercentageEGI number(double)
Total as a percentage of Effective Gross Income (EGI), expressed as a decimal
transactions array [ FinancialTransactionDto ]
description string
group string
amount number(double)
Transaction amount, in USD
measureType string(enum)
How the amount is calculated (e.g., PercentOfRevenue, Amount, AmountPerSf, AmountPerUnit)
Available enum values: Unspecified, PercentOfRentRollVacancy, PercentOfRevenue, PercentOfEffectiveIncome, PercentOfSalesCompValuation, PercentOfTotalOperatingExpenses, Amount, PercentOfComponentRevenues, AmountPerSf, AmountPerUnit
annualized number(double)
Annualized amount, in USD
annualizedPerSf number(double)
Annualized amount per square foot, in USD
annualizedPerUnit number(double)
Annualized amount per unit, in USD
annualizedPercentageEGI number(double)
Annualized amount as a percentage of Effective Gross Income (EGI), expressed as a decimal
annualizedByYear array [ number(double) ]
comment string
operatingExpenses FinancialTransactionInfoDto
total number(double)
totalByYear array [ number(double) ]
groupedTransactions array [ FinancialTransactionGroupDto ]
group string
totalAmount number(double)
Total amount for this transaction group, in USD
totalPerSf number(double)
Total amount per square foot, in USD
totalPerUnit number(double)
Total amount per unit, in USD
totalPercentageEGI number(double)
Total as a percentage of Effective Gross Income (EGI), expressed as a decimal
transactions array [ FinancialTransactionDto ]
description string
group string
amount number(double)
Transaction amount, in USD
measureType string(enum)
How the amount is calculated (e.g., PercentOfRevenue, Amount, AmountPerSf, AmountPerUnit)
Available enum values: Unspecified, PercentOfRentRollVacancy, PercentOfRevenue, PercentOfEffectiveIncome, PercentOfSalesCompValuation, PercentOfTotalOperatingExpenses, Amount, PercentOfComponentRevenues, AmountPerSf, AmountPerUnit
annualized number(double)
Annualized amount, in USD
annualizedPerSf number(double)
Annualized amount per square foot, in USD
annualizedPerUnit number(double)
Annualized amount per unit, in USD
annualizedPercentageEGI number(double)
Annualized amount as a percentage of Effective Gross Income (EGI), expressed as a decimal
annualizedByYear array [ number(double) ]
comment string
belowTheLineExpense FinancialTransactionInfoDto
total number(double)
totalByYear array [ number(double) ]
groupedTransactions array [ FinancialTransactionGroupDto ]
group string
totalAmount number(double)
Total amount for this transaction group, in USD
totalPerSf number(double)
Total amount per square foot, in USD
totalPerUnit number(double)
Total amount per unit, in USD
totalPercentageEGI number(double)
Total as a percentage of Effective Gross Income (EGI), expressed as a decimal
transactions array [ FinancialTransactionDto ]
description string
group string
amount number(double)
Transaction amount, in USD
measureType string(enum)
How the amount is calculated (e.g., PercentOfRevenue, Amount, AmountPerSf, AmountPerUnit)
Available enum values: Unspecified, PercentOfRentRollVacancy, PercentOfRevenue, PercentOfEffectiveIncome, PercentOfSalesCompValuation, PercentOfTotalOperatingExpenses, Amount, PercentOfComponentRevenues, AmountPerSf, AmountPerUnit
annualized number(double)
Annualized amount, in USD
annualizedPerSf number(double)
Annualized amount per square foot, in USD
annualizedPerUnit number(double)
Annualized amount per unit, in USD
annualizedPercentageEGI number(double)
Annualized amount as a percentage of Effective Gross Income (EGI), expressed as a decimal
annualizedByYear array [ number(double) ]
comment string
effectiveIncome number(double)
Effective Gross Income (EGI) - total income minus vacancy and concessions, in USD
effectiveIncomeByYear array [ number(double) ]
totalExpenses number(double)
Total operating expenses, in USD
totalExpensesByYear array [ number(double) ]
netOperatingIncome number(double)
Net Operating Income (NOI) - effective income minus operating expenses, in USD
netOperatingIncomeByYear array [ number(double) ]
netIncome number(double)
Net income after operating expenses and below-the-line expenses, in USD
netIncomeByYear array [ number(double) ]
dcfModel DcfModelDto
discountRate number(double)
Discount rate used for present value calculations, expressed as a decimal (e.g., 0.08 = 8%)
revenueGrowth array [ number(double) ]
Annual revenue growth rate assumption, expressed as a decimal (e.g., 0.03 = 3%)
expenseGrowth array [ number(double) ]
Annual expense growth rate assumption, expressed as a decimal (e.g., 0.025 = 2.5%)
finalSale number(double)
presentValues array [ number(double) ]
netPresentValue number(double)
expenseRatio number(double)
Total operating expenses divided by effective gross income, expressed as a decimal (e.g., 0.35 = 35%)
totalValuation number(double)
Total property value calculated from this valuation scenario, in USD
parentId string
ID of the parent valuation, if this is a sub-valuation
descriptor string
archive boolean
componentsVacancies map { VacancyValueDto }
amountValue number(double)
Vacancy as a dollar amount, in USD
percentageValue number(double)
Vacancy as a percentage of revenue, expressed as a decimal (e.g., 0.05 = 5%)
componentsSelectedRentRolls map { string }
metrics array [ ValuationMetricsDto ]
dealId string
ID of the deal this valuation applies to
dscr number(double)
Debt Service Coverage Ratio for this valuation scenario. Values > 1.0 indicate income exceeds debt obligations
ltv number(double)
Loan-to-Value ratio for this valuation scenario, expressed as a decimal (e.g., 0.72 = 72%)
debtYield number(double)
Debt yield (NOI / Loan Amount) for this valuation scenario, expressed as a percentage
alternativeValuations array [ AlternativeValuationDto ]
name string
valuationsInfoId string
ID of the parent valuation container
valuation number(double)
Alternative valuation amount (e.g., appraisal, broker opinion), in USD
description string
asOfDate string(date)
Date the valuation is effective as of (ISO 8601 format: YYYY-MM-DD)
parentId string
ID of the parent valuation, if this is a sub-valuation
descriptor string
dcfModel DcfModelDto
discountRate number(double)
Discount rate used for present value calculations, expressed as a decimal (e.g., 0.08 = 8%)
revenueGrowth array [ number(double) ]
Annual revenue growth rate assumption, expressed as a decimal (e.g., 0.03 = 3%)
expenseGrowth array [ number(double) ]
Annual expense growth rate assumption, expressed as a decimal (e.g., 0.025 = 2.5%)
CollateralPropertyUpdateDto¶
property string(enum)
Available enum values: Name, Description, YearRenovated, YearBuilt, FloorAreaRatio, ParkingRatio, AssetClass
value string
CollateralSummaryDto¶
id string
Unique identifier for the collateral property
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
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
name string
netIncome number(double)
Net income after operating expenses and below-the-line expenses, in USD
netOperatingIncome number(double)
Net Operating Income (NOI) calculated as revenue minus operating expenses before debt service, in USD
incomeValuation number(double)
Property value derived from capitalizing NOI (NOI / Cap Rate), in USD
alternativeValuation number(double)
Alternative property value from appraisal, broker opinion, or other valuation method, in USD
salesValuation number(double)
Property value derived from sales comparable analysis, in USD
totalSF number(double)
Total square footage of the collateral property
totalUnit number(double)
Total number of units in the collateral property
yearBuilt number(double)
Year the property was originally constructed
CollateralSummaryResponseDto¶
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 ]
collateralSummaries array [ CollateralSummaryDto ]
id string
Unique identifier for the collateral property
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
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
name string
netIncome number(double)
Net income after operating expenses and below-the-line expenses, in USD
netOperatingIncome number(double)
Net Operating Income (NOI) calculated as revenue minus operating expenses before debt service, in USD
incomeValuation number(double)
Property value derived from capitalizing NOI (NOI / Cap Rate), in USD
alternativeValuation number(double)
Alternative property value from appraisal, broker opinion, or other valuation method, in USD
salesValuation number(double)
Property value derived from sales comparable analysis, in USD
totalSF number(double)
Total square footage of the collateral property
totalUnit number(double)
Total number of units in the collateral property
yearBuilt number(double)
Year the property was originally constructed
CollateralTotalsDto¶
alternativeValuation number(double)
Total alternative valuation across all collateral properties, in USD
incomeValuation number(double)
Total income-based valuation across all collateral properties, in USD
salesValuation number(double)
Total sales comparable valuation across all collateral properties, in USD
netOperatingIncome number(double)
Total NOI across all collateral properties, in USD
netIncome number(double)
Total net income across all collateral properties, in USD
userDebtService number(double)
debtServiceMethod string(enum)
Available enum values: Calculated, Manual
debtService number(double)
Total annual debt service across all loans, in USD
netCashFlow number(double)
Net cash flow after debt service (NOI - Debt Service), in USD
dscr number(double)
Overall Debt Service Coverage Ratio (NOI / Debt Service). Values > 1.0 indicate income exceeds debt obligations
debtYield number(double)
Overall debt yield (NOI / Loan Amount), expressed as a percentage. Lender-focused metric independent of property value
totalSF number(double)
Total square footage across all collateral properties
totalUnit number(double)
Total units across all collateral properties
CommercialComponentInfoResponseDto¶
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
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)
Commercial property category (e.g., Office, Retail, Industrial)
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: Commercial
Available enum values: Unknown, Residential, Commercial, Hotel
marketTrendSummary MarketTrendSummaryDto
lastUpdated string(date-time)
Date and time of last update for market info
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 CommercialLivingUnitsInfoDto
livingUnits array [ CommercialLivingUnitDto ]
id string
Unique identifier for this unit line item
description string
Commercial unit description
suite string
Commercial unit mix line item suite
floor number(double)
Commercial unit mix line item floor
unitSize number(double)
Square footage of the commercial unit
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
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 commercial properties, expressed as a decimal (e.g., 0.10 = 10%)
totalUnits number(double)
Total number of commercial units or suites
totalSf number(double)
Total square footage of commercial space
averageUnitSize number(double)
Average size per commercial unit, in square feet
averageSqft number(double)
Commercial average unit square foot
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) }
CommercialLivingUnitCreateDto¶
frontEndGridLineNumber string
Internal value used to order list
description string
Description of commercial unit mix line item
suite string
Suite of commercial unit mix line item
floor number(double)
Floor of commercial unit mix line item
unitSize number(double)
Total square footage for this commercial unit line item
CommercialLivingUnitDto¶
id string
Unique identifier for this unit line item
description string
Commercial unit description
suite string
Commercial unit mix line item suite
floor number(double)
Commercial unit mix line item floor
unitSize number(double)
Square footage of the commercial unit
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
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
CommercialLivingUnitsInfoDto¶
livingUnits array [ CommercialLivingUnitDto ]
id string
Unique identifier for this unit line item
description string
Commercial unit description
suite string
Commercial unit mix line item suite
floor number(double)
Commercial unit mix line item floor
unitSize number(double)
Square footage of the commercial unit
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
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 commercial properties, expressed as a decimal (e.g., 0.10 = 10%)
totalUnits number(double)
Total number of commercial units or suites
totalSf number(double)
Total square footage of commercial space
averageUnitSize number(double)
Average size per commercial unit, in square feet
averageSqft number(double)
Commercial average unit square foot
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
CommercialRentRollInfoResponseDto¶
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 rent roll
componentId string
ID of the property component this rent roll belongs to
name string
fileId string
ID of the uploaded rent roll document
effectiveDate string(date)
Date the rent roll data is effective as of
comment string
totalSf number(double)
Total square footage covered by the rent roll
totalUnits number(double)
Total units in the rent roll
totalMonthlyRevenue number(double)
Total monthly rent revenue, in USD
totalMonthlyRevenuePerSf number(double)
Average monthly rent per square foot, in USD
totalAnnualRevenue number(double)
Total annual rent revenue, in USD
totalAnnualRevenuePerSf number(double)
Average annual rent per square foot, in USD
vacancy number(double)
Vacancy rate calculated from the rent roll, expressed as a decimal (e.g., 0.10 = 10%)
tenantTurnover number(double)
Annual tenant turnover rate, expressed as a decimal (e.g., 0.20 = 20%)
expiringLeases map { number(double) }
rentRollItems array [ CommercialRentRollItemDto ]
id string
Unique identifier for this rent roll line item
unitNumber string
tenantName string
monthlyRent number(double)
Monthly base rent for this unit, in USD
unitSize number(double)
Square footage of this commercial unit
leaseStart string(date)
Lease start date (ISO 8601 format: YYYY-MM-DD)
leaseEnd string(date)
Lease end date (ISO 8601 format: YYYY-MM-DD)
annualRent number(double)
Annual base rent for this unit, in USD
monthlyRentPerSf number(double)
Monthly rent per square foot, in USD
annualRentPerSf number(double)
Annual rent per square foot, in USD
leaseType string(enum)
Type of commercial lease (e.g., TripleNet, FullService, ModifiedGross)
Available enum values: NA, FullService, ModifiedGross, SingleNet, DoubleNet, TripleNet, MonthToMonth
comment string
CommercialRentRollItemDto¶
id string
Unique identifier for this rent roll line item
unitNumber string
tenantName string
monthlyRent number(double)
Monthly base rent for this unit, in USD
unitSize number(double)
Square footage of this commercial unit
leaseStart string(date)
Lease start date (ISO 8601 format: YYYY-MM-DD)
leaseEnd string(date)
Lease end date (ISO 8601 format: YYYY-MM-DD)
annualRent number(double)
Annual base rent for this unit, in USD
monthlyRentPerSf number(double)
Monthly rent per square foot, in USD
annualRentPerSf number(double)
Annual rent per square foot, in USD
leaseType string(enum)
Type of commercial lease (e.g., TripleNet, FullService, ModifiedGross)
Available enum values: NA, FullService, ModifiedGross, SingleNet, DoubleNet, TripleNet, MonthToMonth
comment string
CompanyInfoResponseDto¶
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 the company
name string
description string
Company description
logo string(byte)
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
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
primaryEmail string
Company contact primary email
primaryPhoneNumber string
Company contact primary phone number
companyDebtService number(double)
Annual debt service obligations for the company entity, in USD
companyCashFlowAfterDebtService number(double)
Cash flow remaining after debt service payments, in USD
companyDSCR number(double)
Debt Service Coverage Ratio calculated as cash flow available for debt service divided by total debt service. Values > 1.0 indicate sufficient income to cover debt obligations
companyAssetSubtotal number(double)
Total assets of the company entity, in USD
companyLiabilitySubtotal number(double)
Total liabilities of the company entity, in USD
companyLiquidity number(double)
Liquid assets available to the company, in USD
contactId string
ID of the associated contact record
riskRating string
Internal risk rating assigned to the company (1-8 scale, where lower numbers indicate lower risk)
ComponentInfoDto¶
id string
Unique identifier for this component
assetType string(enum)
Property category (e.g., Multi_Family_Apartments, Office, Retail, Hotel)
Available enum values: None, Mixed, Hotel, Industrial, Multi_Family_Apartments, Office, Retail, Self_Storage, Land, Special_Purpose, Senior_Housing, Distribution_Warehouse, Flex_Office, Portfolio
totalSf number(double)
Total square footage of the component
totalUnits number(double)
Total units in the component
saleValue number(double)
Property value from sales comparables, in USD
totalMarketAnnualRevenue number(double)
Annual revenue based on market rents, in USD
totalRentRollAnnualRevenue number(double)
Annual revenue from the primary rent roll, in USD
marketVacancy number(double)
Market vacancy rate, expressed as a decimal (e.g., 0.06 = 6%)
rentRollVacancy number(double)
Vacancy rate from the rent roll, expressed as a decimal (e.g., 0.08 = 8%)
ComponentInfoResponseDto¶
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
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)
Property category (e.g., Multi_Family_Apartments, Office, Retail, Hotel)
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, Commercial, or Hotel
Available enum values: Unknown, Residential, Commercial, Hotel
marketTrendSummary MarketTrendSummaryDto
lastUpdated string(date-time)
Date and time of last update for market info
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
ComponentSummaryDto¶
id string
Unique identifier for this component
collateralId string
ID of the collateral property this component belongs to
componentType string(enum)
Property use classification: Residential, Commercial, or Hotel
Available enum values: Unknown, Residential, Commercial, Hotel
assetType string(enum)
Property category (e.g., Multi_Family_Apartments, Office, Retail, Hotel)
Available enum values: None, Mixed, Hotel, Industrial, Multi_Family_Apartments, Office, Retail, Self_Storage, Land, Special_Purpose, Senior_Housing, Distribution_Warehouse, Flex_Office, Portfolio
leaseToPreLeaseRatio number(double)
totalUnits number(double)
Total number of units (apartments, suites, or rooms) in the component
totalSf number(double)
Total square footage of the component
saleValue number(double)
Property value from sales comparables, in USD
totalMarketAnnualRevenue number(double)
Annual revenue based on market rents, in USD
totalConcludedRentAnnualRevenue number(double)
Annual revenue based on analyst-concluded achievable rents, in USD
marketVacancy number(double)
Market vacancy rate, expressed as a decimal (e.g., 0.06 = 6%)
selectedRentRollId string
ID of the primary rent roll used for revenue calculations
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%)
ComponentSummaryResponseDto¶
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 ]
componentSummary array [ ComponentSummaryDto ]
id string
Unique identifier for this component
collateralId string
ID of the collateral property this component belongs to
componentType string(enum)
Property use classification: Residential, Commercial, or Hotel
Available enum values: Unknown, Residential, Commercial, Hotel
assetType string(enum)
Property category (e.g., Multi_Family_Apartments, Office, Retail, Hotel)
Available enum values: None, Mixed, Hotel, Industrial, Multi_Family_Apartments, Office, Retail, Self_Storage, Land, Special_Purpose, Senior_Housing, Distribution_Warehouse, Flex_Office, Portfolio
leaseToPreLeaseRatio number(double)
totalUnits number(double)
Total number of units (apartments, suites, or rooms) in the component
totalSf number(double)
Total square footage of the component
saleValue number(double)
Property value from sales comparables, in USD
totalMarketAnnualRevenue number(double)
Annual revenue based on market rents, in USD
totalConcludedRentAnnualRevenue number(double)
Annual revenue based on analyst-concluded achievable rents, in USD
marketVacancy number(double)
Market vacancy rate, expressed as a decimal (e.g., 0.06 = 6%)
selectedRentRollId string
ID of the primary rent roll used for revenue calculations
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%)
ComponentTotalsDto¶
componentsData array [ ComponentInfoDto ]
id string
Unique identifier for this component
assetType string(enum)
Property category (e.g., Multi_Family_Apartments, Office, Retail, Hotel)
Available enum values: None, Mixed, Hotel, Industrial, Multi_Family_Apartments, Office, Retail, Self_Storage, Land, Special_Purpose, Senior_Housing, Distribution_Warehouse, Flex_Office, Portfolio
totalSf number(double)
Total square footage of the component
totalUnits number(double)
Total units in the component
saleValue number(double)
Property value from sales comparables, in USD
totalMarketAnnualRevenue number(double)
Annual revenue based on market rents, in USD
totalRentRollAnnualRevenue number(double)
Annual revenue from the primary rent roll, in USD
marketVacancy number(double)
Market vacancy rate, expressed as a decimal (e.g., 0.06 = 6%)
rentRollVacancy number(double)
Vacancy rate from the rent roll, expressed as a decimal (e.g., 0.08 = 8%)
totalSaleValue number(double)
Total sales comparable valuation across all components, in USD
totalSf number(double)
Total square footage across all components
totalUnits number(double)
Total units across all components
CreateCommercialDealDto¶
ownerId string
Blooma user ID (email address) of the deal owner
dealName string
address AddressCreateDto
fullAddress string
Complete street address validated by Google Places API (e.g., "1600 Amphitheatre Parkway, Mountain View, CA 94043")
additionalFreeText string
Additional address information such as suite or unit number
placeId string
Google Places unique identifier. If provided, overrides fullAddress
propertyType string(enum)
Commercial property category (e.g., Office, Retail, Industrial)
Available enum values: None, Mixed, Hotel, Industrial, Multi_Family_Apartments, Office, Retail, Self_Storage, Land, Special_Purpose, Senior_Housing, Distribution_Warehouse, Flex_Office, Portfolio
loanType string(enum)
Available enum values: Unknown, Acquisition, Acquisition_Construction, Refinance, Refinance_Construction, Construction, Stabilization, Bridge, Permanent
loanAmount number(double)
Requested or originated loan amount, in USD
loanTerm number(double)
Loan maturity term, in months
commercialLivingUnitCreateDto array [ CommercialLivingUnitCreateDto ]
frontEndGridLineNumber string
Internal value used to order list
description string
Description of commercial unit mix line item
suite string
Suite of commercial unit mix line item
floor number(double)
Floor of commercial unit mix line item
unitSize number(double)
Total square footage for this commercial unit line item
CreateHotelDealDto¶
ownerId string
Blooma user ID (email address) of the deal owner
dealName string
address AddressCreateDto
fullAddress string
Complete street address validated by Google Places API (e.g., "1600 Amphitheatre Parkway, Mountain View, CA 94043")
additionalFreeText string
Additional address information such as suite or unit number
placeId string
Google Places unique identifier. If provided, overrides fullAddress
propertyType string(enum)
Hotel property category
Available enum values: None, Mixed, Hotel, Industrial, Multi_Family_Apartments, Office, Retail, Self_Storage, Land, Special_Purpose, Senior_Housing, Distribution_Warehouse, Flex_Office, Portfolio
loanType string(enum)
Available enum values: Unknown, Acquisition, Acquisition_Construction, Refinance, Refinance_Construction, Construction, Stabilization, Bridge, Permanent
loanAmount number(double)
Requested or originated loan amount, in USD
loanTerm number(double)
Loan maturity term, in months
hotelLivingUnitCreateDto HotelLivingUnitCreateDto
numUnits number(double)
Total number of rooms in the hotel
adr number(double)
Stabilized Average Daily Rate (ADR), in USD
occupancy number(double)
Stabilized occupancy rate, expressed as a decimal (e.g., 0.72 = 72%)
sqFt number(double)
Total square footage of hotel rooms
CreateResidentialDealDto¶
ownerId string
Blooma user ID (email address) of the deal owner
dealName string
address AddressCreateDto
fullAddress string
Complete street address validated by Google Places API (e.g., "1600 Amphitheatre Parkway, Mountain View, CA 94043")
additionalFreeText string
Additional address information such as suite or unit number
placeId string
Google Places unique identifier. If provided, overrides fullAddress
propertyType 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
loanType string(enum)
Available enum values: Unknown, Acquisition, Acquisition_Construction, Refinance, Refinance_Construction, Construction, Stabilization, Bridge, Permanent
loanAmount number(double)
Requested or originated loan amount, in USD
loanTerm number(double)
Loan maturity term, in months
residentialLivingUnitCreateDto array [ ResidentialLivingUnitCreateDto ]
frontEndGridLineNumber string
Internal value used to order list
description string
Residentail unit mix line item description
bedrooms number(double)
Number of bedrooms for this unit type
bathrooms number(double)
Number of bathrooms for this unit type
unitSize number(double)
Average square footage for this unit type
numUnits number(double)
Number of units of this type (e.g., 20 one-bedroom units)
CreateResponseDto¶
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 ]
createdEntityId string
UUID of the newly created entity
CrossDealCollateralReportFilterDto¶
collateralIds array [ string ]
IDs of the collateral properties to include in the report
CrossDealCollateralReportResponseDto¶
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 ]
body array [ DealCollateralPairDto ]
collateralId string
Unique identifier for the collateral property
dealId string
Unique identifier for the deal
DcfModelDto¶
discountRate number(double)
Discount rate used for present value calculations, expressed as a decimal (e.g., 0.08 = 8%)
revenueGrowth array [ number(double) ]
Annual revenue growth rate assumption, expressed as a decimal (e.g., 0.03 = 3%)
expenseGrowth array [ number(double) ]
Annual expense growth rate assumption, expressed as a decimal (e.g., 0.025 = 2.5%)
DealCollateralPairDto¶
collateralId string
Unique identifier for the collateral property
dealId string
Unique identifier for the deal
DealFundsInfoResponseDto¶
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 the deal funds analysis
fundsLoansInfo FundsLoansInfoDto
loanFundsItems array [ FundsLoanItemDto ]
sourcesOfFunds string
amount number(double)
Loan amount for this funding source, in USD
loanPaymentStructure string(enum)
Available enum values: InterestOnly, P_I_Amortization
amortizationTerm number(double)
Amortization period for this loan, in months
interestRate number(double)
Interest rate for this loan, expressed as a decimal (e.g., 0.065 = 6.5%)
dealIncomeValuation number(double)
Total deal income-based valuation, in USD
dealNOI number(double)
Total deal Net Operating Income, in USD
debtYield number(double)
Debt yield for this loan (NOI / Loan Amount), expressed as a percentage
ltv number(double)
Loan-to-Value ratio for this loan, expressed as a decimal (e.g., 0.75 = 75%)
dscr number(double)
Debt Service Coverage Ratio for this loan. Values > 1.0 indicate income exceeds debt obligations
avgLTV number(double)
Weighted average LTV across all loans, expressed as a decimal
totalDSCR number(double)
Overall DSCR across all loans
totalDebtYield number(double)
Overall debt yield across all loans, expressed as a percentage
fundsSourcesInfo FundsSourcesInfoDto
fundSourceItems array [ FundSourceItemDto ]
id string
Unique identifier for this funding source line item
sourcesOfFunds string
amount number(double)
Amount from this funding source, in USD
loanPaymentStructure string(enum)
Available enum values: InterestOnly, P_I_Amortization
amortizationTerm number(double)
Amortization term if this source is a loan, in months
interestRate number(double)
Interest rate for this source if it's a loan, expressed as a decimal
dollarPerUnit number(double)
Amount per unit, in USD
dollarPerSF number(double)
Amount per square foot, in USD
percentOfTotal number(double)
Percentage of total sources, expressed as a decimal (e.g., 0.75 = 75%)
default boolean
isDefault boolean
totalAmount number(double)
Total funding from all sources, in USD
totalDollarPerUnit number(double)
Total funding per unit, in USD
totalDollarPerSF number(double)
Total funding per square foot, in USD
balanceBetweenUsesAndSources number(double)
Difference between total uses and total sources (should be near zero for balanced budgets), in USD
balanceName string
fundsUsesInfo FundsUsesInfoDto
fundUseItems array [ FundUseItemDto ]
id string
Unique identifier for this funding use line item
usesOfFunds string
amount number(double)
Amount allocated to this use, in USD
dollarPerUnit number(double)
Amount per unit, in USD
dollarPerSF number(double)
Amount per square foot, in USD
percentOfTotal number(double)
Percentage of total uses, expressed as a decimal (e.g., 0.60 = 60%)
default boolean
isDefault boolean
totalAmount number(double)
Total funding allocated to all uses, in USD
totalDollarPerUnit number(double)
Total uses per unit, in USD
totalDollarPerSF number(double)
Total uses per square foot, in USD
DealIdsResponseDto¶
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 ]
dealIds array [ string ]
List of all accessible deal IDs
DealPropertyUpdateDto¶
property string(enum)
The deal field to update. Only include properties that require changes — omit any properties where no update is needed.
Available enum values: State, Owner, LoanType, Status, Priority, SeedName, Note, MainImageFileId, ProjectTotalCost, GrossLoan, IsSyndicatedLoan, ParticipationGrossLoan, OriginatedLoanAmount, RateSpread, LoanPaymentStructure, IndexRate, InterestRateFloor, LoanTerm, ExtensionTerm, AmortizationTerm, Description, LoanId, RateIndex, OriginationDate, ClosingDate, RiskRating, ProfileName, UserSelectedLtv, ClosedDate, UserDebtService, DebtServiceMethod, RequestedLoanAmount, CustomField1, CustomField2, LoansPackageId
value string
The new value for the specified property. The expected format depends on the selected property — refer to Bulk Update Deals for accepted value types per property.
DealUpdateDto¶
id string
Identifier of the deal to update
updates array [ DealPropertyUpdateDto ]
property string(enum)
The deal field to update. Only include properties that require changes — omit any properties where no update is needed.
Available enum values: State, Owner, LoanType, Status, Priority, SeedName, Note, MainImageFileId, ProjectTotalCost, GrossLoan, IsSyndicatedLoan, ParticipationGrossLoan, OriginatedLoanAmount, RateSpread, LoanPaymentStructure, IndexRate, InterestRateFloor, LoanTerm, ExtensionTerm, AmortizationTerm, Description, LoanId, RateIndex, OriginationDate, ClosingDate, RiskRating, ProfileName, UserSelectedLtv, ClosedDate, UserDebtService, DebtServiceMethod, RequestedLoanAmount, CustomField1, CustomField2, LoansPackageId
value string
The new value for the specified property. The expected format depends on the selected property — refer to Bulk Update Deals for accepted value types per property.
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 ]
FinancialTransactionDto¶
description string
group string
amount number(double)
Transaction amount, in USD
measureType string(enum)
How the amount is calculated (e.g., PercentOfRevenue, Amount, AmountPerSf, AmountPerUnit)
Available enum values: Unspecified, PercentOfRentRollVacancy, PercentOfRevenue, PercentOfEffectiveIncome, PercentOfSalesCompValuation, PercentOfTotalOperatingExpenses, Amount, PercentOfComponentRevenues, AmountPerSf, AmountPerUnit
annualized number(double)
Annualized amount, in USD
annualizedPerSf number(double)
Annualized amount per square foot, in USD
annualizedPerUnit number(double)
Annualized amount per unit, in USD
annualizedPercentageEGI number(double)
Annualized amount as a percentage of Effective Gross Income (EGI), expressed as a decimal
annualizedByYear array [ number(double) ]
comment string
FinancialTransactionGroupDto¶
group string
totalAmount number(double)
Total amount for this transaction group, in USD
totalPerSf number(double)
Total amount per square foot, in USD
totalPerUnit number(double)
Total amount per unit, in USD
totalPercentageEGI number(double)
Total as a percentage of Effective Gross Income (EGI), expressed as a decimal
transactions array [ FinancialTransactionDto ]
description string
group string
amount number(double)
Transaction amount, in USD
measureType string(enum)
How the amount is calculated (e.g., PercentOfRevenue, Amount, AmountPerSf, AmountPerUnit)
Available enum values: Unspecified, PercentOfRentRollVacancy, PercentOfRevenue, PercentOfEffectiveIncome, PercentOfSalesCompValuation, PercentOfTotalOperatingExpenses, Amount, PercentOfComponentRevenues, AmountPerSf, AmountPerUnit
annualized number(double)
Annualized amount, in USD
annualizedPerSf number(double)
Annualized amount per square foot, in USD
annualizedPerUnit number(double)
Annualized amount per unit, in USD
annualizedPercentageEGI number(double)
Annualized amount as a percentage of Effective Gross Income (EGI), expressed as a decimal
annualizedByYear array [ number(double) ]
comment string
FinancialTransactionInfoDto¶
total number(double)
totalByYear array [ number(double) ]
groupedTransactions array [ FinancialTransactionGroupDto ]
group string
totalAmount number(double)
Total amount for this transaction group, in USD
totalPerSf number(double)
Total amount per square foot, in USD
totalPerUnit number(double)
Total amount per unit, in USD
totalPercentageEGI number(double)
Total as a percentage of Effective Gross Income (EGI), expressed as a decimal
transactions array [ FinancialTransactionDto ]
description string
group string
amount number(double)
Transaction amount, in USD
measureType string(enum)
How the amount is calculated (e.g., PercentOfRevenue, Amount, AmountPerSf, AmountPerUnit)
Available enum values: Unspecified, PercentOfRentRollVacancy, PercentOfRevenue, PercentOfEffectiveIncome, PercentOfSalesCompValuation, PercentOfTotalOperatingExpenses, Amount, PercentOfComponentRevenues, AmountPerSf, AmountPerUnit
annualized number(double)
Annualized amount, in USD
annualizedPerSf number(double)
Annualized amount per square foot, in USD
annualizedPerUnit number(double)
Annualized amount per unit, in USD
annualizedPercentageEGI number(double)
Annualized amount as a percentage of Effective Gross Income (EGI), expressed as a decimal
annualizedByYear array [ number(double) ]
comment string
FundSourceItemDto¶
id string
Unique identifier for this funding source line item
sourcesOfFunds string
amount number(double)
Amount from this funding source, in USD
loanPaymentStructure string(enum)
Available enum values: InterestOnly, P_I_Amortization
amortizationTerm number(double)
Amortization term if this source is a loan, in months
interestRate number(double)
Interest rate for this source if it's a loan, expressed as a decimal
dollarPerUnit number(double)
Amount per unit, in USD
dollarPerSF number(double)
Amount per square foot, in USD
percentOfTotal number(double)
Percentage of total sources, expressed as a decimal (e.g., 0.75 = 75%)
default boolean
isDefault boolean
FundUseItemDto¶
id string
Unique identifier for this funding use line item
usesOfFunds string
amount number(double)
Amount allocated to this use, in USD
dollarPerUnit number(double)
Amount per unit, in USD
dollarPerSF number(double)
Amount per square foot, in USD
percentOfTotal number(double)
Percentage of total uses, expressed as a decimal (e.g., 0.60 = 60%)
default boolean
isDefault boolean
FundsLoanItemDto¶
sourcesOfFunds string
amount number(double)
Loan amount for this funding source, in USD
loanPaymentStructure string(enum)
Available enum values: InterestOnly, P_I_Amortization
amortizationTerm number(double)
Amortization period for this loan, in months
interestRate number(double)
Interest rate for this loan, expressed as a decimal (e.g., 0.065 = 6.5%)
dealIncomeValuation number(double)
Total deal income-based valuation, in USD
dealNOI number(double)
Total deal Net Operating Income, in USD
debtYield number(double)
Debt yield for this loan (NOI / Loan Amount), expressed as a percentage
ltv number(double)
Loan-to-Value ratio for this loan, expressed as a decimal (e.g., 0.75 = 75%)
dscr number(double)
Debt Service Coverage Ratio for this loan. Values > 1.0 indicate income exceeds debt obligations
FundsLoansInfoDto¶
loanFundsItems array [ FundsLoanItemDto ]
sourcesOfFunds string
amount number(double)
Loan amount for this funding source, in USD
loanPaymentStructure string(enum)
Available enum values: InterestOnly, P_I_Amortization
amortizationTerm number(double)
Amortization period for this loan, in months
interestRate number(double)
Interest rate for this loan, expressed as a decimal (e.g., 0.065 = 6.5%)
dealIncomeValuation number(double)
Total deal income-based valuation, in USD
dealNOI number(double)
Total deal Net Operating Income, in USD
debtYield number(double)
Debt yield for this loan (NOI / Loan Amount), expressed as a percentage
ltv number(double)
Loan-to-Value ratio for this loan, expressed as a decimal (e.g., 0.75 = 75%)
dscr number(double)
Debt Service Coverage Ratio for this loan. Values > 1.0 indicate income exceeds debt obligations
avgLTV number(double)
Weighted average LTV across all loans, expressed as a decimal
totalDSCR number(double)
Overall DSCR across all loans
totalDebtYield number(double)
Overall debt yield across all loans, expressed as a percentage
FundsSourcesInfoDto¶
fundSourceItems array [ FundSourceItemDto ]
id string
Unique identifier for this funding source line item
sourcesOfFunds string
amount number(double)
Amount from this funding source, in USD
loanPaymentStructure string(enum)
Available enum values: InterestOnly, P_I_Amortization
amortizationTerm number(double)
Amortization term if this source is a loan, in months
interestRate number(double)
Interest rate for this source if it's a loan, expressed as a decimal
dollarPerUnit number(double)
Amount per unit, in USD
dollarPerSF number(double)
Amount per square foot, in USD
percentOfTotal number(double)
Percentage of total sources, expressed as a decimal (e.g., 0.75 = 75%)
default boolean
isDefault boolean
totalAmount number(double)
Total funding from all sources, in USD
totalDollarPerUnit number(double)
Total funding per unit, in USD
totalDollarPerSF number(double)
Total funding per square foot, in USD
balanceBetweenUsesAndSources number(double)
Difference between total uses and total sources (should be near zero for balanced budgets), in USD
balanceName string
FundsUsesInfoDto¶
fundUseItems array [ FundUseItemDto ]
id string
Unique identifier for this funding use line item
usesOfFunds string
amount number(double)
Amount allocated to this use, in USD
dollarPerUnit number(double)
Amount per unit, in USD
dollarPerSF number(double)
Amount per square foot, in USD
percentOfTotal number(double)
Percentage of total uses, expressed as a decimal (e.g., 0.60 = 60%)
default boolean
isDefault boolean
totalAmount number(double)
Total funding allocated to all uses, in USD
totalDollarPerUnit number(double)
Total uses per unit, in USD
totalDollarPerSF number(double)
Total uses per square foot, in USD
HighlightDto¶
title string
Title of REIS market summary section
bullets array [ string ]
HotelComponentInfoResponseDto¶
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
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)
Hotel property category
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: Hotel
Available enum values: Unknown, Residential, Commercial, Hotel
marketTrendSummary MarketTrendSummaryDto
lastUpdated string(date-time)
Date and time of last update for market info
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 (room) from sales comparables, in USD
salesCompSFValuation number(double)
Property valuation based on average price per square foot from sales comparables, in USD
livingUnitsInfo HotelLivingUnitsInfoDto
livingUnits array [ HotelLivingUnitDto ]
id string
Unique identifier for this unit line item
numUnits number(double)
Total number of rooms in the hotel
adr number(double)
Average Daily Rate (ADR) - average room revenue per occupied room per day, in USD
occupancy number(double)
Stabilized occupancy rate, expressed as a decimal (e.g., 0.72 = 72%)
sqFt number(double)
Total square footage of hotel rooms
roomNightsPerMonth number(double)
Total available room nights per month (rooms × days)
revPar number(double)
Revenue Per Available Room (RevPAR) calculated as ADR × Occupancy, in USD
monthlyRevenue number(double)
Total monthly room revenue, in USD
marketVacancy number(double)
Market vacancy rate for hotel properties, expressed as a decimal (e.g., 0.25 = 25% vacancy)
totalUnits number(double)
Total number of hotel rooms
totalSf number(double)
Total square footage of hotel space
totalMonthlyRevenue number(double)
Total monthly room revenue, in USD
totalAnnualRevenue number(double)
Total annual room revenue, in USD
averageUnitSize number(double)
Average room size, in square feet
serviceLevel string(enum)
Available enum values: LimitedService, FullService, Luxury
hotelFlag HotelFlag
Brand affiliation of the hotel (e.g., Marriott, Hilton, independent)
hotelFlag string
Brand the hotel operates under (e.g., Marriott, Hilton, Hyatt, or independent)
HotelFlag¶
hotelFlag string
Brand the hotel operates under (e.g., Marriott, Hilton, Hyatt, or independent)
HotelLivingUnitCreateDto¶
numUnits number(double)
Total number of rooms in the hotel
adr number(double)
Stabilized Average Daily Rate (ADR), in USD
occupancy number(double)
Stabilized occupancy rate, expressed as a decimal (e.g., 0.72 = 72%)
sqFt number(double)
Total square footage of hotel rooms
HotelLivingUnitDto¶
id string
Unique identifier for this unit line item
numUnits number(double)
Total number of rooms in the hotel
adr number(double)
Average Daily Rate (ADR) - average room revenue per occupied room per day, in USD
occupancy number(double)
Stabilized occupancy rate, expressed as a decimal (e.g., 0.72 = 72%)
sqFt number(double)
Total square footage of hotel rooms
roomNightsPerMonth number(double)
Total available room nights per month (rooms × days)
revPar number(double)
Revenue Per Available Room (RevPAR) calculated as ADR × Occupancy, in USD
monthlyRevenue number(double)
Total monthly room revenue, in USD
HotelLivingUnitsInfoDto¶
livingUnits array [ HotelLivingUnitDto ]
id string
Unique identifier for this unit line item
numUnits number(double)
Total number of rooms in the hotel
adr number(double)
Average Daily Rate (ADR) - average room revenue per occupied room per day, in USD
occupancy number(double)
Stabilized occupancy rate, expressed as a decimal (e.g., 0.72 = 72%)
sqFt number(double)
Total square footage of hotel rooms
roomNightsPerMonth number(double)
Total available room nights per month (rooms × days)
revPar number(double)
Revenue Per Available Room (RevPAR) calculated as ADR × Occupancy, in USD
monthlyRevenue number(double)
Total monthly room revenue, in USD
marketVacancy number(double)
Market vacancy rate for hotel properties, expressed as a decimal (e.g., 0.25 = 25% vacancy)
totalUnits number(double)
Total number of hotel rooms
totalSf number(double)
Total square footage of hotel space
totalMonthlyRevenue number(double)
Total monthly room revenue, in USD
totalAnnualRevenue number(double)
Total annual room revenue, in USD
averageUnitSize number(double)
Average room size, in square feet
LatLng¶
lat number(double)
lng number(double)
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
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
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
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
MarketTrendSummaryDto¶
lastUpdated string(date-time)
Date and time of last update for market info
sections array [ SectionDto ]
title string
taken directly from data source as is
para string
taken directly from data source as is
NAType¶
PersonInfoResponseDto¶
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 the person
contactId string
ID of the associated contact record
firstName string
middleName string
lastName string
description string
primaryPhoneNumber string
Person contact primary phone number
primaryEmail string
Person contact primary email address
image string(byte)
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
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
personalNetWorth number(double)
Total net worth of the individual, in USD
personalLiquidity number(double)
Liquid assets available to the individual, in USD
personalDSCR number(double)
Individual's Debt Service Coverage Ratio calculated as cash flow available for debt service divided by total debt service. Values > 1.0 indicate sufficient income to cover debt obligations
personalCashFlowAfterDebtService number(double)
Cash flow remaining after debt service payments, in USD
personDebtRatio number(double)
Total debt divided by total assets, expressed as a decimal (e.g., 0.35 = 35%)
RentRollUnitTypeSummaryDto¶
totalUnits number(double)
Total units of this unit type
bedrooms number(double)
Number of bedrooms for this unit type
bathrooms number(double)
Number of bathrooms for this unit type
avgSf number(double)
Average square footage for this unit type
avgMonthlyRevenuePerSf number(double)
Average monthly rent per square foot, in USD
avgMonthlyRevenuePerUnit number(double)
Average monthly rent per unit, in USD
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
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
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) }
ResidentialLivingUnitCreateDto¶
frontEndGridLineNumber string
Internal value used to order list
description string
Residentail unit mix line item description
bedrooms number(double)
Number of bedrooms for this unit type
bathrooms number(double)
Number of bathrooms for this unit type
unitSize number(double)
Average square footage for this unit type
numUnits number(double)
Number of units of this type (e.g., 20 one-bedroom units)
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
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
ResidentialRentRollInfoResponseDto¶
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 rent roll
componentId string
ID of the property component this rent roll belongs to
name string
fileId string
ID of the uploaded rent roll document
effectiveDate string(date)
Date the rent roll data is effective as of
comment string
totalSf number(double)
Total square footage covered by the rent roll
totalUnits number(double)
Total units in the rent roll
totalMonthlyRevenue number(double)
Total monthly rent revenue, in USD
totalMonthlyRevenuePerSf number(double)
Average monthly rent per square foot, in USD
totalAnnualRevenue number(double)
Total annual rent revenue, in USD
totalAnnualRevenuePerSf number(double)
Average annual rent per square foot, in USD
vacancy number(double)
Vacancy rate calculated from the rent roll, expressed as a decimal (e.g., 0.08 = 8%)
tenantTurnover number(double)
Annual tenant turnover rate, expressed as a decimal (e.g., 0.30 = 30%)
expiringLeases map { number(double) }
unitTypeSummaryTable array [ RentRollUnitTypeSummaryDto ]
totalUnits number(double)
Total units of this unit type
bedrooms number(double)
Number of bedrooms for this unit type
bathrooms number(double)
Number of bathrooms for this unit type
avgSf number(double)
Average square footage for this unit type
avgMonthlyRevenuePerSf number(double)
Average monthly rent per square foot, in USD
avgMonthlyRevenuePerUnit number(double)
Average monthly rent per unit, in USD
rentRollItems array [ ResidentialRentRollItemDto ]
id string
Unique identifier for this rent roll line item
unitNumber string
tenantName string
monthlyRent number(double)
Monthly rent for this unit, in USD
unitSize number(double)
Square footage of this unit
leaseStart string(date)
Lease start date (ISO 8601 format: YYYY-MM-DD)
leaseEnd string(date)
Lease end date (ISO 8601 format: YYYY-MM-DD)
annualRent number(double)
Annual rent for this unit, in USD
monthlyRentPerSf number(double)
Monthly rent per square foot, in USD
annualRentPerSf number(double)
Annual rent per square foot, in USD
unitType string
bedrooms number(double)
Number of bedrooms
bathrooms number(double)
Number of bathrooms
ResidentialRentRollItemDto¶
id string
Unique identifier for this rent roll line item
unitNumber string
tenantName string
monthlyRent number(double)
Monthly rent for this unit, in USD
unitSize number(double)
Square footage of this unit
leaseStart string(date)
Lease start date (ISO 8601 format: YYYY-MM-DD)
leaseEnd string(date)
Lease end date (ISO 8601 format: YYYY-MM-DD)
annualRent number(double)
Annual rent for this unit, in USD
monthlyRentPerSf number(double)
Monthly rent per square foot, in USD
annualRentPerSf number(double)
Annual rent per square foot, in USD
unitType string
bedrooms number(double)
Number of bedrooms
bathrooms number(double)
Number of bathrooms
RevenueDto¶
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
RevenueValuationDto¶
capRate number(double)
Capitalization rate used to calculate property value (NOI / Cap Rate), expressed as a decimal (e.g., 0.06 = 6%)
name string
valuationsInfoId string
ID of the parent valuation container
startDate string(date)
Valuation period start date (ISO 8601 format: YYYY-MM-DD)
endDate string(date)
Valuation period end date (ISO 8601 format: YYYY-MM-DD)
expensesSourceId string
ID of the expense source valuation
userValuationType string
comment string
revenueSource string(enum)
Source of revenue data (Market, SelectedRentRoll, ConcludedRent, or Alternative)
Available enum values: Market, SelectedRentRoll, Alternative, ConcludedRent
capRateSource string(enum)
Source of cap rate (Market or Manual)
Available enum values: Market, Manual
vacancySource string(enum)
Source of vacancy assumption (Market, RentRoll, or Manual)
Available enum values: Market, RentRoll, Manual
cashFlow CashFlowInfoDto
valuationsInfoId string
ID of the parent valuation container
fileId string
ID of the uploaded cash flow document
comment string
revenue FinancialTransactionInfoDto
total number(double)
totalByYear array [ number(double) ]
groupedTransactions array [ FinancialTransactionGroupDto ]
group string
totalAmount number(double)
Total amount for this transaction group, in USD
totalPerSf number(double)
Total amount per square foot, in USD
totalPerUnit number(double)
Total amount per unit, in USD
totalPercentageEGI number(double)
Total as a percentage of Effective Gross Income (EGI), expressed as a decimal
transactions array [ FinancialTransactionDto ]
description string
group string
amount number(double)
Transaction amount, in USD
measureType string(enum)
How the amount is calculated (e.g., PercentOfRevenue, Amount, AmountPerSf, AmountPerUnit)
Available enum values: Unspecified, PercentOfRentRollVacancy, PercentOfRevenue, PercentOfEffectiveIncome, PercentOfSalesCompValuation, PercentOfTotalOperatingExpenses, Amount, PercentOfComponentRevenues, AmountPerSf, AmountPerUnit
annualized number(double)
Annualized amount, in USD
annualizedPerSf number(double)
Annualized amount per square foot, in USD
annualizedPerUnit number(double)
Annualized amount per unit, in USD
annualizedPercentageEGI number(double)
Annualized amount as a percentage of Effective Gross Income (EGI), expressed as a decimal
annualizedByYear array [ number(double) ]
comment string
vacancyAndConcessions FinancialTransactionInfoDto
total number(double)
totalByYear array [ number(double) ]
groupedTransactions array [ FinancialTransactionGroupDto ]
group string
totalAmount number(double)
Total amount for this transaction group, in USD
totalPerSf number(double)
Total amount per square foot, in USD
totalPerUnit number(double)
Total amount per unit, in USD
totalPercentageEGI number(double)
Total as a percentage of Effective Gross Income (EGI), expressed as a decimal
transactions array [ FinancialTransactionDto ]
description string
group string
amount number(double)
Transaction amount, in USD
measureType string(enum)
How the amount is calculated (e.g., PercentOfRevenue, Amount, AmountPerSf, AmountPerUnit)
Available enum values: Unspecified, PercentOfRentRollVacancy, PercentOfRevenue, PercentOfEffectiveIncome, PercentOfSalesCompValuation, PercentOfTotalOperatingExpenses, Amount, PercentOfComponentRevenues, AmountPerSf, AmountPerUnit
annualized number(double)
Annualized amount, in USD
annualizedPerSf number(double)
Annualized amount per square foot, in USD
annualizedPerUnit number(double)
Annualized amount per unit, in USD
annualizedPercentageEGI number(double)
Annualized amount as a percentage of Effective Gross Income (EGI), expressed as a decimal
annualizedByYear array [ number(double) ]
comment string
otherIncome FinancialTransactionInfoDto
total number(double)
totalByYear array [ number(double) ]
groupedTransactions array [ FinancialTransactionGroupDto ]
group string
totalAmount number(double)
Total amount for this transaction group, in USD
totalPerSf number(double)
Total amount per square foot, in USD
totalPerUnit number(double)
Total amount per unit, in USD
totalPercentageEGI number(double)
Total as a percentage of Effective Gross Income (EGI), expressed as a decimal
transactions array [ FinancialTransactionDto ]
description string
group string
amount number(double)
Transaction amount, in USD
measureType string(enum)
How the amount is calculated (e.g., PercentOfRevenue, Amount, AmountPerSf, AmountPerUnit)
Available enum values: Unspecified, PercentOfRentRollVacancy, PercentOfRevenue, PercentOfEffectiveIncome, PercentOfSalesCompValuation, PercentOfTotalOperatingExpenses, Amount, PercentOfComponentRevenues, AmountPerSf, AmountPerUnit
annualized number(double)
Annualized amount, in USD
annualizedPerSf number(double)
Annualized amount per square foot, in USD
annualizedPerUnit number(double)
Annualized amount per unit, in USD
annualizedPercentageEGI number(double)
Annualized amount as a percentage of Effective Gross Income (EGI), expressed as a decimal
annualizedByYear array [ number(double) ]
comment string
operatingExpenses FinancialTransactionInfoDto
total number(double)
totalByYear array [ number(double) ]
groupedTransactions array [ FinancialTransactionGroupDto ]
group string
totalAmount number(double)
Total amount for this transaction group, in USD
totalPerSf number(double)
Total amount per square foot, in USD
totalPerUnit number(double)
Total amount per unit, in USD
totalPercentageEGI number(double)
Total as a percentage of Effective Gross Income (EGI), expressed as a decimal
transactions array [ FinancialTransactionDto ]
description string
group string
amount number(double)
Transaction amount, in USD
measureType string(enum)
How the amount is calculated (e.g., PercentOfRevenue, Amount, AmountPerSf, AmountPerUnit)
Available enum values: Unspecified, PercentOfRentRollVacancy, PercentOfRevenue, PercentOfEffectiveIncome, PercentOfSalesCompValuation, PercentOfTotalOperatingExpenses, Amount, PercentOfComponentRevenues, AmountPerSf, AmountPerUnit
annualized number(double)
Annualized amount, in USD
annualizedPerSf number(double)
Annualized amount per square foot, in USD
annualizedPerUnit number(double)
Annualized amount per unit, in USD
annualizedPercentageEGI number(double)
Annualized amount as a percentage of Effective Gross Income (EGI), expressed as a decimal
annualizedByYear array [ number(double) ]
comment string
belowTheLineExpense FinancialTransactionInfoDto
total number(double)
totalByYear array [ number(double) ]
groupedTransactions array [ FinancialTransactionGroupDto ]
group string
totalAmount number(double)
Total amount for this transaction group, in USD
totalPerSf number(double)
Total amount per square foot, in USD
totalPerUnit number(double)
Total amount per unit, in USD
totalPercentageEGI number(double)
Total as a percentage of Effective Gross Income (EGI), expressed as a decimal
transactions array [ FinancialTransactionDto ]
description string
group string
amount number(double)
Transaction amount, in USD
measureType string(enum)
How the amount is calculated (e.g., PercentOfRevenue, Amount, AmountPerSf, AmountPerUnit)
Available enum values: Unspecified, PercentOfRentRollVacancy, PercentOfRevenue, PercentOfEffectiveIncome, PercentOfSalesCompValuation, PercentOfTotalOperatingExpenses, Amount, PercentOfComponentRevenues, AmountPerSf, AmountPerUnit
annualized number(double)
Annualized amount, in USD
annualizedPerSf number(double)
Annualized amount per square foot, in USD
annualizedPerUnit number(double)
Annualized amount per unit, in USD
annualizedPercentageEGI number(double)
Annualized amount as a percentage of Effective Gross Income (EGI), expressed as a decimal
annualizedByYear array [ number(double) ]
comment string
effectiveIncome number(double)
Effective Gross Income (EGI) - total income minus vacancy and concessions, in USD
effectiveIncomeByYear array [ number(double) ]
totalExpenses number(double)
Total operating expenses, in USD
totalExpensesByYear array [ number(double) ]
netOperatingIncome number(double)
Net Operating Income (NOI) - effective income minus operating expenses, in USD
netOperatingIncomeByYear array [ number(double) ]
netIncome number(double)
Net income after operating expenses and below-the-line expenses, in USD
netIncomeByYear array [ number(double) ]
dcfModel DcfModelDto
discountRate number(double)
Discount rate used for present value calculations, expressed as a decimal (e.g., 0.08 = 8%)
revenueGrowth array [ number(double) ]
Annual revenue growth rate assumption, expressed as a decimal (e.g., 0.03 = 3%)
expenseGrowth array [ number(double) ]
Annual expense growth rate assumption, expressed as a decimal (e.g., 0.025 = 2.5%)
finalSale number(double)
presentValues array [ number(double) ]
netPresentValue number(double)
expenseRatio number(double)
Total operating expenses divided by effective gross income, expressed as a decimal (e.g., 0.35 = 35%)
totalValuation number(double)
Total property value calculated from this valuation scenario, in USD
parentId string
ID of the parent valuation, if this is a sub-valuation
descriptor string
archive boolean
componentsVacancies map { VacancyValueDto }
amountValue number(double)
Vacancy as a dollar amount, in USD
percentageValue number(double)
Vacancy as a percentage of revenue, expressed as a decimal (e.g., 0.05 = 5%)
componentsSelectedRentRolls map { string }
metrics array [ ValuationMetricsDto ]
dealId string
ID of the deal this valuation applies to
dscr number(double)
Debt Service Coverage Ratio for this valuation scenario. Values > 1.0 indicate income exceeds debt obligations
ltv number(double)
Loan-to-Value ratio for this valuation scenario, expressed as a decimal (e.g., 0.72 = 72%)
debtYield number(double)
Debt yield (NOI / Loan Amount) for this valuation scenario, expressed as a percentage
SectionDto¶
title string
taken directly from data source as is
para string
taken directly from data source as is
SeedInfoResponseDto¶
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 the deal
loanId string
Lender's internal loan identifier or tracking number
seedName string
Display name for the deal. Note: "seed" is legacy terminology for "deal"
loanType string(enum)
Available enum values: Unknown, Acquisition, Acquisition_Construction, Refinance, Refinance_Construction, Construction, Stabilization, Bridge, Permanent
maturityDate string(date)
Maturity date
riskRating string
Internal risk rating assigned to the loan (1-8 scale, where lower numbers indicate lower risk)
rateIndexType string(enum)
Available enum values: WSJ Prime, 1 M LIBOR, 3 M LIBOR, 6 M LIBOR, 1 YR LIBOR, 5 YR LIBOR, FHLB 3 YR, FHLB 5 YR, FHLB 7 YR, 1 YR T WKLY, 2 YR TREAS, 3 YR TREAS, 5 YR TREAS, 7 YR TREAS, 10 YR TREAS, 2 YR SWAP, 5 YR SWAP, 7 YR SWAP, 10 YR SWAP, CD Rate, Fixed, SOFR, 1 M TERM SOFR, 90 day SOFR, 180 DAY SOFR, AMERIBOR - Term 30, 1 M AVG SOFR
interestRate number(double)
Total note rate, expressed as a decimal (e.g., 0.0675 = 6.75%)
rateSpread number(double)
Spread added to the index rate to calculate the total note rate, expressed as a decimal (e.g., 0.0225 = 2.25%). For fixed-rate loans, this equals the total interest rate
loanPaymentStructure string(enum)
Available enum values: InterestOnly, P_I_Amortization
componentType 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
debtService number(double)
Annual debt service (principal + interest or interest-only payment), in USD
companyIds array [ string ]
IDs of the company entities associated with this deal
personIds array [ string ]
IDs of the person entities associated with this deal
originatedLoanAmount number(double)
Original loan amount at time of origination, in USD
originationDate string(date)
date-time of origination
grossLoan number(double)
Current loan amount (unpaid principal balance for portfolio loans, or requested amount for pipeline deals), in USD
participationGrossLoan number(double)
Participation loan amount for syndicated loans, in USD
ltc number(double)
Loan-to-Cost ratio, expressed as a decimal (e.g., 0.75 = 75%). Used for construction and renovation financing
ltv number(double)
Loan-to-Value ratio, expressed as a decimal (e.g., 0.72 = 72%)
amortizationTerm number(double)
Loan amortization period in months
loanTerm number(double)
Loan maturity term in months
interestRateFloor number(double)
Minimum interest rate for floating-rate loans, expressed as a decimal (e.g., 0.045 = 4.5%)
collateralTotals CollateralTotalsDto
alternativeValuation number(double)
Total alternative valuation across all collateral properties, in USD
incomeValuation number(double)
Total income-based valuation across all collateral properties, in USD
salesValuation number(double)
Total sales comparable valuation across all collateral properties, in USD
netOperatingIncome number(double)
Total NOI across all collateral properties, in USD
netIncome number(double)
Total net income across all collateral properties, in USD
userDebtService number(double)
debtServiceMethod string(enum)
Available enum values: Calculated, Manual
debtService number(double)
Total annual debt service across all loans, in USD
netCashFlow number(double)
Net cash flow after debt service (NOI - Debt Service), in USD
dscr number(double)
Overall Debt Service Coverage Ratio (NOI / Debt Service). Values > 1.0 indicate income exceeds debt obligations
debtYield number(double)
Overall debt yield (NOI / Loan Amount), expressed as a percentage. Lender-focused metric independent of property value
totalSF number(double)
Total square footage across all collateral properties
totalUnit number(double)
Total units across all collateral properties
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
UpdateCollateralRequestDto¶
propertiesToUpdates array [ CollateralPropertyUpdateDto ]
property string(enum)
Available enum values: Name, Description, YearRenovated, YearBuilt, FloorAreaRatio, ParkingRatio, AssetClass
value string
UpdateDealsRequestDto¶
itemsToUpdate array [ DealUpdateDto ]
id string
Identifier of the deal to update
updates array [ DealPropertyUpdateDto ]
property string(enum)
The deal field to update. Only include properties that require changes — omit any properties where no update is needed.
Available enum values: State, Owner, LoanType, Status, Priority, SeedName, Note, MainImageFileId, ProjectTotalCost, GrossLoan, IsSyndicatedLoan, ParticipationGrossLoan, OriginatedLoanAmount, RateSpread, LoanPaymentStructure, IndexRate, InterestRateFloor, LoanTerm, ExtensionTerm, AmortizationTerm, Description, LoanId, RateIndex, OriginationDate, ClosingDate, RiskRating, ProfileName, UserSelectedLtv, ClosedDate, UserDebtService, DebtServiceMethod, RequestedLoanAmount, CustomField1, CustomField2, LoansPackageId
value string
The new value for the specified property. The expected format depends on the selected property — refer to Bulk Update Deals for accepted value types per property.
UpdateDealsResponseDto¶
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 ]
errors array [ UpdateEngineError ]
id string
Identifier of the entity that failed to update
operation string(enum)
Available enum values: Create, Update, Delete
errorType string(enum)
Type of update error (e.g., IdNotFound, MissingMandatoryField, IllegalValue)
Available enum values: IdNotFound, MissingMandatoryField, IllegalValue
description string
fieldName string
updatedEntities array [ string ]
UpdateEngineError¶
id string
Identifier of the entity that failed to update
operation string(enum)
Available enum values: Create, Update, Delete
errorType string(enum)
Type of update error (e.g., IdNotFound, MissingMandatoryField, IllegalValue)
Available enum values: IdNotFound, MissingMandatoryField, IllegalValue
description string
fieldName string
UpdateResponseDto¶
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 ]
VacancyValueDto¶
amountValue number(double)
Vacancy as a dollar amount, in USD
percentageValue number(double)
Vacancy as a percentage of revenue, expressed as a decimal (e.g., 0.05 = 5%)
ValuationMetricsDto¶
dealId string
ID of the deal this valuation applies to
dscr number(double)
Debt Service Coverage Ratio for this valuation scenario. Values > 1.0 indicate income exceeds debt obligations
ltv number(double)
Loan-to-Value ratio for this valuation scenario, expressed as a decimal (e.g., 0.72 = 72%)
debtYield number(double)
Debt yield (NOI / Loan Amount) for this valuation scenario, expressed as a percentage