`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

Always returns: mortgage_rate, median_home_price, median_home_price_note, case_shiller_index, avg_hourly_earnings, estimated_monthly_payment, income_needed, income_needed_note, hud_income_limits

Field	Type	Description
`mortgage_rate`	number \| null	Current 30-year mortgage rate (%)
`median_home_price`	number \| null	National median home price in dollars
`median_home_price_note`	string
`metro_hpi`	object
`case_shiller_index`	number \| null
`avg_hourly_earnings`	number \| null	Average hourly earnings
`estimated_monthly_payment`	number \| null	Estimated monthly payment (20% down, 30yr fixed)
`income_needed`	number \| null	Annual income needed for DTI 28%
`income_needed_note`	string
`hud_income_limits`	object

Full JSON Schema

{
  "type": "object",
  "properties": {
    "mortgage_rate": {
      "type": [
        "number",
        "null"
      ],
      "description": "Current 30-year mortgage rate (%)"
    },
    "median_home_price": {
      "type": [
        "number",
        "null"
      ],
      "description": "National median home price in dollars"
    },
    "median_home_price_note": {
      "type": "string"
    },
    "metro_hpi": {
      "type": "object",
      "properties": {
        "metro": {
          "type": "string"
        },
        "series": {
          "type": "string"
        },
        "current": {
          "type": "number"
        },
        "trend": {
          "type": "string",
          "enum": [
            "rising",
            "falling",
            "stable"
          ]
        }
      }
    },
    "case_shiller_index": {
      "type": [
        "number",
        "null"
      ]
    },
    "avg_hourly_earnings": {
      "type": [
        "number",
        "null"
      ],
      "description": "Average hourly earnings"
    },
    "estimated_monthly_payment": {
      "type": [
        "number",
        "null"
      ],
      "description": "Estimated monthly payment (20% down, 30yr fixed)"
    },
    "income_needed": {
      "type": [
        "number",
        "null"
      ],
      "description": "Annual income needed for DTI 28%"
    },
    "income_needed_note": {
      "type": "string"
    },
    "hud_income_limits": {
      "type": "object",
      "properties": {
        "state": {
          "type": "string"
        },
        "year": {
          "type": [
            "number",
            "null"
          ]
        },
        "median_income": {
          "type": [
            "number",
            "null"
          ]
        },
        "very_low_4person": {
          "type": [
            "number",
            "null"
          ]
        },
        "low_4person": {
          "type": [
            "number",
            "null"
          ]
        },
        "extremely_low_4person": {
          "type": [
            "number",
            "null"
          ]
        },
        "note": {
          "type": "string"
        },
        "error": {
          "type": "string"
        },
        "raw_response": {
          "type": "object"
        }
      }
    }
  },
  "required": [
    "mortgage_rate",
    "median_home_price",
    "median_home_price_note",
    "case_shiller_index",
    "avg_hourly_earnings",
    "estimated_monthly_payment",
    "income_needed",
    "income_needed_note",
    "hud_income_limits"
  ]
}

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