Data Models ¶
AddressCreateDto¶
fullAddress string
The street address, must be a validated address by Google (e.g. 1600 Amphitheatre Parkway, Mountain View, CA).
additionalFreeText string
Additional address information, such as suite number
placeId string
The Google unique identity of the deal place in the Google Places database and on Google Maps, if used it will override the fullAddress.
latLng LatLng
AddressDto¶
fullAddress string
The street address, must be a validated address by Google (e.g. 1600 Amphitheatre Parkway, Mountain View, CA).
placeId string
The Google unique identity of the deal place in the Google Places database and on Google Maps.
geoLocation LatLng
zipCode string
number integer(int32)
street string
city string
county string
state string
country string
additionalFreeText string
Secondary Address data (like unit # or suite)
CollateralSummaryDto¶
id string
address AddressDto
name string
netIncome number(double)
netOperatingIncome number(double)
incomeValuation number(double)
alternativeValuation number(double)
salesValuation number(double)
Sum of primary sales comp valuations for all collaterals on deal
totalSF number(double)
Collateral total square footage
totalUnit number(double)
Total # of units of collateral
CollateralSummaryResponseDto¶
success boolean
Indicates whether the request completed successfully.
collateralSummaries array [ CollateralSummaryDto ]
CommercialComponentInfoResponseDto¶
success boolean
Indicates whether the request completed successfully.
id string
collateralId string
selectedRentRollId string
address AddressDto
assetType string(enum)
Available enum values: None, Mixed, Hotel, Industrial, Multi_Family_Apartments, Office, Retail, Self_Storage, Land, Special_Purpose, Senior_Housing, Distribution_Warehouse, Flex_Office, Portfolio
componentType string(enum)
Available enum values: Unknown, Residential, Commercial, Hotel
marketTrendSummary MarketTrendSummaryDto
marketSummary MarketSummaryDto
marketData MarketDataDto
marketForecast MarketForecastDto
leaseToPreLeaseRatio number(double)
totalRentRollAnnualRevenue number(double)
Total annual revenue from primary rent roll
rentRollVacancy number(double)
Vacancy percentage from primary rent roll
rentRollsOrder array [ string ]
saleValueComputationType string(enum)
Available enum values: ByUnit, BySf
salesCompUnitValuation number(double)
Valuation based on the average dollar per unit times the component units
salesCompSFValuation number(double)
Valuation based on the average dollar per square foot of sales comps times the component square foot
livingUnitsInfo CommercialLivingUnitsInfoDto
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 to be used for Commerial properties unit mix
CommercialLivingUnitDto¶
id string
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)
Commercial unit size
compsRevenue RevenueDto
concludedRevenue RevenueDto
CommercialLivingUnitsInfoDto¶
livingUnits array [ CommercialLivingUnitDto ]
marketVacancy number(double)
Commercial market vacancy
totalUnits number(double)
Commercial total units
totalSf number(double)
Commercial total square feet
averageUnitSize number(double)
Commercial average unit size
averageSqft number(double)
Commercial average unit square foot
concludedTotalRevenue RevenueDto
compsTotalRevenue RevenueDto
CommercialRentRollInfoResponseDto¶
success boolean
Indicates whether the request completed successfully.
id string
componentId string
name string
fileId string
effectiveDate string(date)
comment string
totalSf number(double)
total square footage
totalUnits number(double)
totalMonthlyRevenue number(double)
Rent roll total monthly revenue
totalMonthlyRevenuePerSf number(double)
Rent roll total monthly revenue per SF
totalAnnualRevenue number(double)
totalAnnualRevenuePerSf number(double)
vacancy number(double)
tenantTurnover number(double)
Tenant turnover percentage
expiringLeases map { number(double) }
rentRollItems array [ CommercialRentRollItemDto ]
CommercialRentRollItemDto¶
id string
unitNumber string
tenantName string
monthlyRent number(double)
unitSize number(double)
leaseStart string(date)
Rent Roll line item lease start date
leaseEnd string(date)
Rent roll line item lease end date
annualRent number(double)
commercial annual rent
monthlyRentPerSf number(double)
annualRentPerSf number(double)
commercial rent roll annual rent per sf
leaseType string(enum)
Available enum values: NA, FullService, ModifiedGross, SingleNet, DoubleNet, TripleNet, MonthToMonth
comment string
CompanyInfoResponseDto¶
success boolean
Indicates whether the request completed successfully.
id string
name string
description string
Company description
logo array [ string(byte) ]
address AddressDto
primaryEmail string
Company contact primary email
primaryPhoneNumber string
Company contact primary phone number
companyDebtService number(double)
companyCashFlowAfterDebtService number(double)
companyDSCR number(double)
companyAssetSubtotal number(double)
companyLiabilitySubtotal number(double)
companyLiquidity number(double)
contactId string
riskRating string
Risk rating of the company contact
ein string
The company EIN
ComponentInfoResponseDto¶
success boolean
Indicates whether the request completed successfully.
id string
collateralId string
selectedRentRollId string
address AddressDto
assetType string(enum)
Available enum values: None, Mixed, Hotel, Industrial, Multi_Family_Apartments, Office, Retail, Self_Storage, Land, Special_Purpose, Senior_Housing, Distribution_Warehouse, Flex_Office, Portfolio
componentType string(enum)
Available enum values: Unknown, Residential, Commercial, Hotel
marketTrendSummary MarketTrendSummaryDto
marketSummary MarketSummaryDto
marketData MarketDataDto
marketForecast MarketForecastDto
leaseToPreLeaseRatio number(double)
totalRentRollAnnualRevenue number(double)
Total annual revenue from primary rent roll
rentRollVacancy number(double)
rentRollsOrder array [ string ]
saleValueComputationType string(enum)
Available enum values: ByUnit, BySf
salesCompUnitValuation number(double)
Valuation based on the average dollar per unit times the component units
salesCompSFValuation number(double)
Valuation based on the average dollar per square foot of sales comps times the component square foot
ComponentSummaryDto¶
id string
collateralId string
componentType string(enum)
Available enum values: Unknown, Residential, Commercial, Hotel
assetType string(enum)
Available enum values: None, Mixed, Hotel, Industrial, Multi_Family_Apartments, Office, Retail, Self_Storage, Land, Special_Purpose, Senior_Housing, Distribution_Warehouse, Flex_Office, Portfolio
leaseToPreLeaseRatio number(double)
totalUnits number(double)
totalSf number(double)
component total square feet
saleValue number(double)
totalMarketAnnualRevenue number(double)
totalConcludedRentAnnualRevenue number(double)
marketVacancy number(double)
selectedRentRollId string
totalRentRollAnnualRevenue number(double)
Total annual revenue from primary rent roll
rentRollVacancy number(double)
ComponentSummaryResponseDto¶
success boolean
Indicates whether the request completed successfully.
componentSummary array [ ComponentSummaryDto ]
CreateCommercialDealDto¶
ownerId string
The owner of the deal within Blooma.
dealName string
address AddressCreateDto
propertyType 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
loanType string(enum)
Available enum values: Unknown, Acquisition, Acquisition_Construction, Refinance, Refinance_Construction, Construction, Stabilization, Bridge, Permanent
loanAmount number(double)
loanTerm number(double)
commercialLivingUnitCreateDto array [ CommercialLivingUnitCreateDto ]
CreateHotelDealDto¶
ownerId string
The owner of the deal within Blooma.
dealName string
address AddressCreateDto
propertyType string(enum)
Hotel property type
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)
Hotel loan amount
loanTerm number(double)
Hotel loan term
hotelLivingUnitCreateDto HotelLivingUnitCreateDto
CreateResidentialDealDto¶
ownerId string
The owner of the deal within Blooma.
dealName string
address AddressCreateDto
propertyType string(enum)
Residential property type
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)
Residential loan amount
loanTerm number(double)
Residential loan term
residentialLivingUnitCreateDto array [ ResidentialLivingUnitCreateDto ]
CreateResponseDto¶
success boolean
Indicates whether the request completed successfully.
createdEntityId string
The id of the entity that was created.
CrossDealCollateralReportFilterDto¶
collateralIds array [ string ]
CrossDealCollateralReportResponseDto¶
success boolean
Indicates whether the request completed successfully.
body array [ DealCollateralPairDto ]
DealCollateralPairDto¶
collateralId string
dealId string
DealIdsResponseDto¶
success boolean
Indicates whether the request completed successfully.
dealIds array [ string ]
DealPropertyUpdateDto¶
property string(enum)
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
DealUpdateDto¶
id string
updates array [ DealPropertyUpdateDto ]
ErrorDto¶
target string
code string(enum)
Available enum values: Duplicated, MissingMandatoryField, InvalidCreateValues, Existing, ValidationError, MissingEntity
message string
details array [ ErrorDto ]
HighlightDto¶
title string
Title of REIS market summary section
bullets array [ string ]
HotelComponentInfoResponseDto¶
success boolean
Indicates whether the request completed successfully.
id string
collateralId string
selectedRentRollId string
address AddressDto
assetType string(enum)
Available enum values: None, Mixed, Hotel, Industrial, Multi_Family_Apartments, Office, Retail, Self_Storage, Land, Special_Purpose, Senior_Housing, Distribution_Warehouse, Flex_Office, Portfolio
componentType string(enum)
Available enum values: Unknown, Residential, Commercial, Hotel
marketTrendSummary MarketTrendSummaryDto
marketSummary MarketSummaryDto
marketData MarketDataDto
marketForecast MarketForecastDto
leaseToPreLeaseRatio number(double)
totalRentRollAnnualRevenue number(double)
Total annual revenue from primary rent roll
rentRollVacancy number(double)
rentRollsOrder array [ string ]
saleValueComputationType string(enum)
Available enum values: ByUnit, BySf
salesCompUnitValuation number(double)
Valuation based on the average dollar per unit times the component units
salesCompSFValuation number(double)
Valuation based on the average dollar per square foot of sales comps times the component square foot
livingUnitsInfo HotelLivingUnitsInfoDto
serviceLevel string(enum)
Available enum values: LimitedService, FullService, Luxury
hotelFlag HotelFlag
HotelFlag¶
hotelFlag string
The brand the hotel operates under
HotelLivingUnitCreateDto¶
numUnits number(double)
Number of Rooms within the Hotel Unit Mix
adr number(double)
Stabilized Average Daily Rate (ADR) of the Hotel Unit Mix
occupancy number(double)
Stabilized occupancy percentage of the Hotel Unit Mix
sqFt number(double)
Total square footage of the Hotel Unit Mix
HotelLivingUnitDto¶
id string
numUnits number(double)
Total number of units in the hotel unit mix
adr number(double)
Hotel ADR
occupancy number(double)
Occupancy percentage in the hotel unit mix
sqFt number(double)
Hotel unit mix total square foot
roomNightsPerMonth number(double)
Number of room nights per month
revPar number(double)
Revenue per available room is equal to the total room revenue divided by the number of available rooms
monthlyRevenue number(double)
Monthly revenue based on the hotel unit mix (calculation)
HotelLivingUnitsInfoDto¶
livingUnits array [ HotelLivingUnitDto ]
marketVacancy number(double)
Hotel unit mix line item market vacancy
totalUnits number(double)
Total units from hotel unit mix
totalSf number(double)
Total square foot from hotel unit mix
totalMonthlyRevenue number(double)
Hotel unit mix line item total monthly revenue
totalAnnualRevenue number(double)
Hotel unit mix line item total annual revenue
averageUnitSize number(double)
Average unit size of hotel units
LatLng¶
lat number(double)
lng number(double)
MainMarketDto¶
marketId integer(int64)
Identification number assigned to each 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 in the main market
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)
Percentage of total unit count that is physically occupied
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 ($ / unit / month) within market. Value is net of free rent and prorated discounts
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
subMarket SubMarketDto
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
rent HighlightDto
sections array [ SectionDto ]
NAType¶
PersonInfoResponseDto¶
success boolean
Indicates whether the request completed successfully.
id string
contactId string
firstName string
middleName string
lastName string
socialSecurityNumber string
Person contact social security number
description string
primaryPhoneNumber string
Person contact primary phone number
primaryEmail string
Person contact primary email address
image array [ string(byte) ]
address AddressDto
personalNetWorth number(double)
personalLiquidity number(double)
The total liquidity of the person
personalDSCR number(double)
Person DSCR
personalCashFlowAfterDebtService number(double)
Person cash flow after debt service
personDebtRatio number(double)
RentRollUnitTypeSummaryDto¶
totalUnits number(double)
bedrooms number(double)
Number of bedroms in multifamily unit
bathrooms number(double)
Number of bathrooms in multifamily unit
avgSf number(double)
Rent Roll average SF
avgMonthlyRevenuePerSf number(double)
Rent Roll average monthly revenue per SF
avgMonthlyRevenuePerUnit number(double)
Rent roll average monthly revenue per unit
ResidentialComponentInfoResponseDto¶
success boolean
Indicates whether the request completed successfully.
id string
collateralId string
selectedRentRollId string
address AddressDto
assetType string(enum)
Available enum values: None, Mixed, Hotel, Industrial, Multi_Family_Apartments, Office, Retail, Self_Storage, Land, Special_Purpose, Senior_Housing, Distribution_Warehouse, Flex_Office, Portfolio
componentType string(enum)
Available enum values: Unknown, Residential, Commercial, Hotel
marketTrendSummary MarketTrendSummaryDto
marketSummary MarketSummaryDto
marketData MarketDataDto
marketForecast MarketForecastDto
leaseToPreLeaseRatio number(double)
totalRentRollAnnualRevenue number(double)
Total annual revenue from primary rent roll
rentRollVacancy number(double)
rentRollsOrder array [ string ]
saleValueComputationType string(enum)
Available enum values: ByUnit, BySf
salesCompUnitValuation number(double)
Valuation based on the average dollar per unit times the component units
salesCompSFValuation number(double)
Valuation based on the average dollar per square foot of sales comps times the component square foot
livingUnitsInfo ResidentialLivingUnitsInfoDto
expiringLeases map { number(double) }
ResidentialLivingUnitCreateDto¶
frontEndGridLineNumber string
Internal value used to order list
description string
Residentail unit mix line item description
bedrooms number(double)
Number of bedroms in multifamily unit
bathrooms number(double)
Number of bathrooms in multifamily unit
unitSize number(double)
Average square footage of a multifamily unit. This value is combined with number of bedrooms for multifamily unit mix. Ex: unitSize = 800 AND bedrooms = 0 for the average square footage of studio units as 800 sqft.
numUnits number(double)
Number of residential units. This value is combined with bedrooms for multifamily unit mix purposes. Ex: numUnits = 20.00 AND bedrooms = 1.00 for a multifamily property with 20 1 bedroom units.
ResidentialLivingUnitDto¶
id string
description string
Unit description in multifamily unit mix
bedrooms number(double)
Number of bedroms in multifamily unit
bathrooms number(double)
Number of bathrooms in multifamily unit
unitSize number(double)
Unit size (SF) of multifamily unit mix
numUnits number(double)
Number of units in multifamily unit mix
compsRevenue RevenueDto
concludedRevenue RevenueDto
ResidentialLivingUnitsInfoDto¶
livingUnits array [ ResidentialLivingUnitDto ]
marketVacancy number(double)
Multifamily market vacancy
totalSf number(double)
Multifamily total SF
totalUnits number(double)
Multifamily total units
averageUnitSize number(double)
Average unit size of multifamily unit mix
concludedTotalRevenue RevenueDto
compsTotalRevenue RevenueDto
ResidentialRentRollInfoResponseDto¶
success boolean
Indicates whether the request completed successfully.
id string
componentId string
name string
fileId string
effectiveDate string(date)
comment string
totalSf number(double)
Multifamily total SF
totalUnits number(double)
totalMonthlyRevenue number(double)
Rent roll total monthly revenue
totalMonthlyRevenuePerSf number(double)
Rent roll total monthly revenue per SF
totalAnnualRevenue number(double)
totalAnnualRevenuePerSf number(double)
vacancy number(double)
tenantTurnover number(double)
Tenant turnover percentage
expiringLeases map { number(double) }
unitTypeSummaryTable array [ RentRollUnitTypeSummaryDto ]
rentRollItems array [ ResidentialRentRollItemDto ]
ResidentialRentRollItemDto¶
id string
unitNumber string
tenantName string
monthlyRent number(double)
unitSize number(double)
leaseStart string(date)
Rent Roll line item lease start date
leaseEnd string(date)
Rent roll line item lease end date
annualRent number(double)
Residential rent roll annual rent
monthlyRentPerSf number(double)
annualRentPerSf number(double)
Residential rent roll annual rent per sf
unitType string
bedrooms number(double)
Number of bedroms in multifamily unit
bathrooms number(double)
Number of bathrooms in multifamily unit
RevenueDto¶
monthly number(double)
monthlyPerSf number(double)
monthlyPerUnit number(double)
annual number(double)
Annual revenue
annualPerSf number(double)
Annual revenue per square foot
annualPerUnit number(double)
Annual revenue per unit
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 request completed successfully.
id string
loanId string
Identifying value for the loan in a client's internal system(s)
seedName string
loanType string(enum)
Available enum values: Unknown, Acquisition, Acquisition_Construction, Refinance, Refinance_Construction, Construction, Stabilization, Bridge, Permanent
maturityDate string(date)
Maturity date
riskRating string
Risk rating assigned to the loan in internal systems. This number is restricted to a number from 1-8.
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)
rateSpread number(double)
The rate percentage added to the Index Rate used as an input to calculate the full note rate. If the Rate Type is Fixed, then the Interest Rate Spread will be the total note 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)
companyIds array [ string ]
personIds array [ string ]
originatedLoanAmount number(double)
Loan amount at time of origination
originationDate string(date)
date-time of origination
grossLoan number(double)
Loan amount (if in pipeline) or unpaid principal balance (if in portfolio)
participationGrossLoan number(double)
The participation loan amount for syndicated loans.
ltc number(double)
Loan to cost
SubMarketDto¶
marketId integer(int64)
Identification number assigned to each market
subMarketId integer(int64)
The ID assigned to a given submarket
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)
Represents the expected first year yield a property buyer expects to realize on their investment, calculated as: Nominal Net Operating Income (NOI) / Property Value
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.
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)
Percentage of total unit count that is physically occupied.
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 ($ / unit / month) within market. Value is net of free rent and prorated discounts.
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
UpdateDealsRequestDto¶
itemsToUpdate array [ DealUpdateDto ]
UpdateDealsResponseDto¶
success boolean
Indicates whether the request completed successfully.
errors array [ UpdateEngineError ]
updatedEntities array [ string ]
UpdateEngineError¶
id string
operation string(enum)
Available enum values: Create, Update, Delete
errorType string(enum)
Available enum values: IdNotFound, MissingMandatoryField, IllegalValue
description string
fieldName string