`hud_chas`

Pack: hud · Endpoint: https://gateway.pipeworx.io/hud/mcp

Get housing affordability data by income level and family type. Returns household counts with cost burdens, overcrowding, and housing problems. Use for housing needs assessment.

Parameters

Name	Type	Required	Description
`state_code`	string	yes	Two-letter state code (e.g., “CA”, “NY”).
`entity_id`	string	no	FIPS code for a specific county or place. Omit to get state-level data.
`year`	number	no	Data year (e.g., 2020). Omit for the most recent available.
`_apiKey`	string	yes	HUD API token

Example call

Arguments

{
  "state_code": "NY",
  "_apiKey": "your-hud-api-key"
}

curl

curl -X POST https://gateway.pipeworx.io/hud/mcp \
  -H 'Content-Type: application/json' \
  -d '{"jsonrpc":"2.0","id":1,"method":"tools/call","params":{"name":"hud_chas","arguments":{"state_code":"NY","_apiKey":"your-hud-api-key"}}}'

TypeScript (@pipeworx/sdk)

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

const result = await pipeworx.call('hud_chas', {
  "state_code": "NY",
  "_apiKey": "your-hud-api-key"
});

More examples

{
  "state_code": "CA",
  "entity_id": "06001",
  "year": 2020,
  "_apiKey": "your-hud-api-key"
}

Response shape

Always returns: state, entity_id, year, data

Field	Type	Description
`state`	string	Two-letter state code provided in request
`entity_id`	string \| null	FIPS code if provided, null for state-level data
`year`	number \| string	Data year requested or ‘latest’
`data`	object	Housing affordability strategy data from HUD API

Full JSON Schema

{
  "type": "object",
  "properties": {
    "state": {
      "type": "string",
      "description": "Two-letter state code provided in request"
    },
    "entity_id": {
      "type": [
        "string",
        "null"
      ],
      "description": "FIPS code if provided, null for state-level data"
    },
    "year": {
      "type": [
        "number",
        "string"
      ],
      "description": "Data year requested or 'latest'"
    },
    "data": {
      "type": "object",
      "description": "Housing affordability strategy data from HUD API"
    }
  },
  "required": [
    "state",
    "entity_id",
    "year",
    "data"
  ]
}

Connect

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

{
  "mcpServers": {
    "hud": {
      "url": "https://gateway.pipeworx.io/hud/mcp"
    }
  }
}

See Getting Started for client-specific install steps.

hud_chas