Data scope:
Shared input: AnalyticsFilter
All five analytics tools accept a single required parameter — analytics_filter — containing an AnalyticsFilter object.
AnalyticsFilter
AnalyticsGeographyFilter
Geography types
Allgeography_type values must be lowercase.
geography_type_values accepts a list, so a single call can retrieve results for multiple geographies simultaneously (e.g., ["06037", "06059", "06065"]).
TimeRange
If time_range is provided, both from and to are required. Do not pass a partial object — omit time_range entirely to retrieve the latest data.
YearMonth
Example filter
Response envelope
All five tools return the same top-level envelope. All four fields are always present in every response.
The
data array contains a wrapper object with an analytics array. Each element in analytics groups results by geography and includes geographyType, geographyTypeValue, and a tool-specific data container (trends for the three trend tools, indices for the two HPI tools).
Do not assume response ordering. Always match results by reading the
geographyType and geographyTypeValue fields on each result object, not by position.Shared geography response fields
Every tool’s trend or index record includes the following geography and period fields. All fields are optional, nullable, and default tonull.
Reading numeric values
Analytics fields use consistent numeric conventions:pa-analytics_listing_trends_tool
Retrieve property listing trends data for analyzing inventory levels, pricing, and market velocity in the residential real estate market.
When to use:
- Monitoring new listings, pending sales, closed sales, or delisted properties
- Analyzing list prices, price reductions, or asking prices
- Tracking days on market, time to sell, or listing duration
- Evaluating market velocity, buyer/seller market indicators, or months of supply
- “How many active listings are there in Los Angeles County?”
- “What is the median days on market for sold listings in California?”
- “Show me buyer vs seller market indicators for CBSA 31080”
Input schema
All analytics tools accept the sharedAnalyticsFilter input.
Example request
Output schema
Theanalytics array contains elements with geographyType, geographyTypeValue, and a trends.listingTrends array.
Each listingTrends record includes the shared geography fields plus the fields below. All fields are optional, nullable, and default to null.
ActiveListings
All fields are optional, nullable, and default to null.
AllListings
Statistics across all listing statuses (active, pending, and closed). All fields are optional, nullable, and default to null.
ClosedListings
Listings that closed during the month, including both sold and delisted (cancellations, expirations, withdrawals). All fields are optional, nullable, and default to null.
NewListings
All fields are optional, nullable, and default to null.
PendingListings
All fields are optional, nullable, and default to null.
SoldListings
All fields are optional, nullable, and default to null.
Delisted
Listings removed from the market without selling (cancellations, expirations, withdrawals). All fields are optional, nullable, and default to null.
MarketIndicator
Buyer/seller market balance scores calculated as new listings ÷ 12-month moving average of sold listings. Values ≥ 1.5 indicate a buyer’s market, ≤ 1.0 indicate a seller’s market, and 1.0–1.5 indicate a balanced market.
All fields are optional, nullable, and default to null.
Understanding DOM and comparison fields
- Standard DOM: treats listings re-opened within 30 days as separate listings, tracking individual listing periods
- Cumulative DOM: treats listings re-opened within 30 days as the same listing, tracking total time on market
- Market Velocity: (active listings at month-end) ÷ (12-month moving average of sold listings)
- Five-Year Monthly Mean/Median: historical baseline using five-year averages for comparison
- Change-from-Prior: month-over-month, year-over-year, and five-year comparisons for trend analysis
Example response
pa-analytics_market_trends_tool
Retrieve residential real estate market trends data for analyzing sales activity, equity positions, foreclosures, and market health.
When to use:
- You need home sales volumes, prices, or trends (total sales, resales, new construction)
- Analyzing foreclosures, distressed properties, or REO/short sales
- Evaluating equity positions, negative equity, or loan-to-value ratios
- Assessing market conditions, housing stock, or delinquency rates
- “What are the total home sales in Los Angeles County this year?”
- “Show me the foreclosure pipeline for Florida”
- “Compare median sale prices across CBSAs 31080, 16980, and 35620”
Input schema
All analytics tools accept the sharedAnalyticsFilter input.
Example request
Output schema
Theanalytics array contains elements with geographyType, geographyTypeValue, and a trends.marketTrends array.
Each marketTrends record includes the shared geography fields plus the fields below.
TotalSales
Coverage is approximately 90%. All fields are optional, nullable, and default to null.
Resale
Previously constructed homes sold to unaffiliated third parties. Does not include REO or short sales. All fields are optional, nullable, and default to null.
NewConstructionSales
All fields are optional, nullable, and default to null.
ReoSales
Bank-owned properties sold to an unaffiliated third party. Coverage is approximately 50%. All fields are optional, nullable, and default to null.
ShortSales
Sales where proceeds fall short of the balance owed on the property’s loan. All fields are optional, nullable, and default to null.
OtherSales
Non-arms-length transactions not accounted for by resales, REO, or short sales. All fields are optional, nullable, and default to null.
Equity
Updated quarterly from September 2009. Monthly values between quarterly updates are interpolated by dividing the quarterly difference by three. All fields are optional, nullable, and default to null.
Foreclosure
Coverage is approximately 85% for foreclosures and 75–90% for 90+ day delinquency (varies by market). These are directional indicators, not complete tallies. All fields are optional, nullable, and default to null.
NonOwnerOccupied
Percentages based on origination month. All fields are optional, nullable, and default to null.
ResidentialMarketSales
All fields are optional, nullable, and default to null.
pa-analytics_rental_trends_tool
Retrieve rental market trends data for analyzing rental prices, inventory, vacancy rates, and capitalization rates in the residential rental sector.
When to use:
- You need rental prices, rent levels, or rental rate data (mean, median, min, max)
- Evaluating vacancy rates or rental availability
- Reviewing capitalization rates (cap rates) for rental properties
- Comparing rental trends by property type or bedroom count
- “What is the median rent for a 3-bedroom single-family home in CBSA 31080?”
- “Show me vacancy rates for ZIP code 98101”
- “Compare cap rates across New York state by property type”
Input schema
All analytics tools accept the sharedAnalyticsFilter input.
Example request
Output schema
Theanalytics array contains elements with geographyType, geographyTypeValue, and a trends.rentalTrends array.
Each rentalTrends record includes the shared geography fields plus the field below.
RentalTrendsDetails
Each element represents a specific combination of property type and bedroom count.
Property types include:
Single Family Detached(1–4 bedrooms)Single Family Attached(1–3 bedrooms)Single Family Combined(1–4 bedrooms)
Cap rate formula:
Net Operating Income = Total Rental Income − Total Operating Cost
Operating costs include property tax, property management fees, maintenance, lease/damages, liability insurance, and vacancy loss.
Example response
pa-analytics_corelogic_hpi_tool
Retrieve Cotality Home Price Index (HPI) data measuring changes in housing market prices from 1976 through the present.
The HPI uses a repeat-sales, value-weighted econometric model with base year 2000 = 100. In geographies with insufficient data, the index is infilled using state-level monthly growth rates.
When to use:
- You need current or historical home price index values
- Tracking home price appreciation or depreciation over time
- Analyzing market volatility, price stability, or standard deviation of prices
- Evaluating whether markets are overvalued or undervalued
- “What is the current HPI for California?”
- “Show me HPI trends for county 06037 from 2020 to 2025”
- “Is CBSA 31080 currently overvalued or undervalued?”
Input schema
All analytics tools accept the sharedAnalyticsFilter input.
Example request
Output schema
Theanalytics array contains elements with geographyType, geographyTypeValue, and an indices.corelogicHpi array.
Each corelogicHpi record includes the shared geography fields plus the fields below.
HpiTier
pa-analytics_corelogic_hpi_forecast_tool
Retrieve Cotality Home Price Index (HPI) forecast data providing predicted future index values for market analysis and planning.
The forecast model uses a two-stage error correction methodology combining equilibrium housing price with short-run price fluctuations affected by market momentum, mean reversion, and exogenous economic shocks.
When to use:
- You need predicted future home price index values
- Evaluating expected home price appreciation or depreciation
- Assessing forecast uncertainty or prediction confidence
- Planning around long-term price expectations or market projections
- “What is the HPI forecast for CBSA 31080 over the next 12 months?”
- “Show me the predicted market condition for California through 2026”
- “What is the forecast confidence interval for Chicago’s HPI?”
Input schema
All analytics tools accept the sharedAnalyticsFilter input.
Example request
Output schema
Theanalytics array contains elements with geographyType, geographyTypeValue, and an indices.corelogicHpiForecast array.
Each corelogicHpiForecast record includes the shared geography fields plus the field below.