`housing_affordability_check`

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

Check housing affordability in a market. Returns mortgage rate, median price, monthly payment, required income, and HUD limits. Optionally specify metro (e.g., “Denver”).

Parameters

Name	Type	Required	Description
`_fredKey`	string	yes	FRED API key
`_hudKey`	string	no	HUD API token (optional — needed for income limits)
`metro_name`	string	no	Metro name for metro-level FHFA HPI (e.g., “Denver”, “Savannah”). Optional.
`state_code`	string	yes	Two-letter state code for HUD income limits (e.g., “CO”)
`zip_code`	string	no	ZIP code for more specific HUD data (optional)

Example call

Arguments

{
  "_fredKey": "your-housing-intel-api-key",
  "state_code": "CO"
}

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":"housing_affordability_check","arguments":{"_fredKey":"your-housing-intel-api-key","state_code":"CO"}}}'

TypeScript (@pipeworx/sdk)

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

const result = await pipeworx.call('housing_affordability_check', {
  "_fredKey": "your-housing-intel-api-key",
  "state_code": "CO"
});

More examples

{
  "_fredKey": "your-housing-intel-api-key",
  "_hudKey": "your-housing-intel-api-key",
  "metro_name": "Denver",
  "state_code": "CO",
  "zip_code": "80212"
}

Response shape

Field	Type	Description
`affordability_date`	string	Today’s date in YYYY-MM-DD format
`market`	string	Market identifier (metro or ‘National’)
`mortgage_rate`	number \| null	Current 30-year mortgage rate (percent)
`median_home_price`	number \| null	Median home price (USD)
`estimated_monthly_payment`	number \| null	Estimated monthly PITI (20% down, 30yr fixed)
`annual_income_needed`	number \| null	Required annual income (at 28% housing expense ratio)
`avg_hourly_earnings`	number \| null	Average hourly earnings for production/nonsup workers (USD)
`hud_income_limits`	unknown
`metro_hpi`	object

Full JSON Schema

{
  "type": "object",
  "properties": {
    "affordability_date": {
      "type": "string",
      "description": "Today's date in YYYY-MM-DD format"
    },
    "market": {
      "type": "string",
      "description": "Market identifier (metro or 'National')"
    },
    "mortgage_rate": {
      "type": [
        "number",
        "null"
      ],
      "description": "Current 30-year mortgage rate (percent)"
    },
    "median_home_price": {
      "type": [
        "number",
        "null"
      ],
      "description": "Median home price (USD)"
    },
    "estimated_monthly_payment": {
      "type": [
        "number",
        "null"
      ],
      "description": "Estimated monthly PITI (20% down, 30yr fixed)"
    },
    "annual_income_needed": {
      "type": [
        "number",
        "null"
      ],
      "description": "Required annual income (at 28% housing expense ratio)"
    },
    "avg_hourly_earnings": {
      "type": [
        "number",
        "null"
      ],
      "description": "Average hourly earnings for production/nonsup workers (USD)"
    },
    "hud_income_limits": {
      "oneOf": [
        {
          "type": "object",
          "properties": {
            "year": {
              "type": "string",
              "description": "Income limit year"
            },
            "state": {
              "type": "string",
              "description": "State code"
            },
            "areas": {
              "type": "array",
              "description": "HUD income limit areas (metro/county, up to 10)",
              "items": {
                "type": "object",
                "properties": {
                  "area_name": {
                    "type": [
                      "string",
                      "null"
                    ]
                  },
                  "ami_percent": {
                    "type": [
                      "number",
                      "null"
                    ],
                    "description": "Area median income percentage"
                  },
                  "ami": {
                    "type": [
                      "number",
                      "null"
                    ],
                    "description": "Area median income (USD)"
                  },
                  "limit_30": {
                    "type": [
                      "number",
                      "null"
                    ],
                    "description": "30% AMI income limit (USD)"
                  },
                  "limit_50": {
                    "type": [
                      "number",
                      "null"
                    ],
                    "description": "50% AMI income limit (USD)"
                  },
                  "limit_80": {
                    "type": [
                      "number",
                      "null"
                    ],
                    "description": "80% AMI income limit (USD)"
                  },
                  "limit_120": {
                    "type": [
                      "number",
                      "null"
                    ],
                    "description": "120% AMI income limit (USD)"
                  }
                }
              }
            }
          }
        },
        {
          "type": "object",
          "properties": {
            "error": {
              "type": "string"
            }
          }
        }
      ]
    },
    "metro_hpi": {
      "type": "object",
      "properties": {
        "series": {
          "type": "string",
          "description": "FRED FHFA HPI series ID"
        },
        "current": {
          "type": "number",
          "description": "Latest metro HPI value"
        },
        "trend": {
          "type": "string",
          "enum": [
            "rising",
            "falling",
            "stable"
          ]
        },
        "error": {
          "type": "string"
        }
      }
    }
  }
}

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.

housing_affordability_check