case_shiller_metro_compare

Pack: housing-intel · Endpoint: https://gateway.pipeworx.io/housing-intel/mcp

Compare Case-Shiller home price indices across multiple US metros in one call (the 20-city composite). For each metro returns latest level, 3-month change, 12-month change, all-time peak, drawdown from peak, and a softening flag. Output also ranks metros softest → strongest. Use for “which metros are softening”, “Case-Shiller for [list of cities]”, “compare housing prices in X, Y, Z” queries — picks the right per-metro FRED series IDs (DNXRSA, PHXRSA, TPXRSA, etc.) so callers don’t have to. Available metros: Atlanta, Boston, Charlotte, Chicago, Cleveland, Dallas, Denver, Detroit, Las Vegas, Los Angeles, Miami, Minneapolis, New York, Phoenix, Portland, San Diego, San Francisco, Seattle, Tampa, Washington DC.

Parameters

NameTypeRequiredDescription
_fredKeystringnoFRED API key (https://fred.stlouisfed.org/docs/api/api_key.html). Platform key used if omitted.
metrosarrayyesMetro names, case-insensitive. Example: [“Denver”, “Phoenix”, “Tampa”, “Charlotte”]. Pass any subset of the 20-city composite.
itemsstringno

Example call

Arguments

{
  "metros": [
    "Denver",
    "Phoenix",
    "Tampa",
    "Charlotte"
  ]
}

curl

curl -X POST https://gateway.pipeworx.io/housing-intel/mcp \
  -H 'Content-Type: application/json' \
  -d '{"jsonrpc":"2.0","id":1,"method":"tools/call","params":{"name":"case_shiller_metro_compare","arguments":{"metros":["Denver","Phoenix","Tampa","Charlotte"]}}}'

TypeScript (@pipeworx/sdk)

import { Pipeworx } from '@pipeworx/sdk';
const pipeworx = new Pipeworx();

const result = await pipeworx.call('case_shiller_metro_compare', {
  "metros": [
    "Denver",
    "Phoenix",
    "Tampa",
    "Charlotte"
  ]
});

More examples

{
  "metros": [
    "San Francisco",
    "Los Angeles",
    "Seattle"
  ],
  "_fredKey": "your-housing-intel-api-key"
}

Response shape

FieldTypeDescription
snapshot_datestringToday’s date in YYYY-MM-DD format
metrosarrayRanked metros from softest to strongest
errorstringError message if request failed
Full JSON Schema
{
  "type": "object",
  "properties": {
    "snapshot_date": {
      "type": "string",
      "description": "Today's date in YYYY-MM-DD format"
    },
    "metros": {
      "type": "array",
      "description": "Ranked metros from softest to strongest",
      "items": {
        "type": "object",
        "properties": {
          "metro": {
            "type": "string",
            "description": "Metro name"
          },
          "series_id": {
            "type": "string",
            "description": "FRED series ID (e.g., DNXRSA)"
          },
          "current": {
            "type": "number",
            "description": "Latest Case-Shiller index value"
          },
          "trend": {
            "type": "string",
            "enum": [
              "rising",
              "falling",
              "stable"
            ],
            "description": "Trend label based on recent values"
          },
          "change_3mo": {
            "type": "number",
            "description": "3-month change in index points"
          },
          "pct_change_3mo": {
            "type": "number",
            "description": "3-month percent change"
          },
          "change_12mo": {
            "type": "number",
            "description": "12-month change in index points"
          },
          "pct_change_12mo": {
            "type": "number",
            "description": "12-month percent change"
          },
          "all_time_peak": {
            "type": "number",
            "description": "Highest value ever recorded"
          },
          "drawdown_from_peak": {
            "type": "number",
            "description": "Percent decline from all-time peak"
          },
          "softening": {
            "type": "boolean",
            "description": "True if 12-month change is negative"
          }
        }
      }
    },
    "error": {
      "type": "string",
      "description": "Error message if request failed"
    }
  }
}

Connect

Add this to your MCP client config, or use one-click install buttons:

{
  "mcpServers": {
    "housing-intel": {
      "url": "https://gateway.pipeworx.io/housing-intel/mcp"
    }
  }
}

See Getting Started for client-specific install steps.

Regenerated from source · build July 6, 2026