`housing_market_screen`

Pack: housing-intel · Connect: https://pipeworx.io/mcp (see Connect below for a single-pack URL)

No MCP client? Call it directly: GET https://gateway.pipeworx.io/v1/tools/housing_market_screen for the schema, then POST the same URL with its arguments for the data.

Rank US metros for rental cash flow in ONE call — the “which markets are best for a landlord” view. Returns metros sorted by gross rent yield = (Zillow median monthly rent × 12) ÷ Zillow typical home value. No per-metro orchestration and no API key. Use for “best/worst rental markets”, “highest-yield metros”, “where does rent go furthest vs. home prices”. Tune with direction (top = highest yield / best cash flow, bottom = lowest), limit, and optional home-value bounds. rent_as_of and home_value_as_of are two independent Zillow queries and can land on different months; freshness says whether they matched this call.

Parameters

Name	Type	Required	Description
`direction`	string	no	top = highest gross yield (best cash flow), bottom = lowest. Default top.
`limit`	number	no	Metros to return (default 25, max 100).
`min_home_value`	number	no	Optional: only metros with typical home value ≥ this (USD).
`max_home_value`	number	no	Optional: only metros with typical home value ≤ this (USD).

Example call

Arguments

{
  "direction": "top",
  "limit": 25
}

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_market_screen","arguments":{"direction":"top","limit":25}}}'

TypeScript (@pipeworx/sdk)

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

const result = await pipeworx.call('housing_market_screen', {
  "direction": "top",
  "limit": 25
});

More examples

{
  "direction": "bottom",
  "limit": 10,
  "min_home_value": 300000,
  "max_home_value": 500000
}

Response shape

Field	Type	Description
`analysis`	string
`ranked_by`	string
`direction`	string
`rent_as_of`	string \| null
`home_value_as_of`	string \| null
`metros_evaluated`	number
`markets`	array
`note`	string
`freshness`	object

Full JSON Schema

{
  "type": "object",
  "properties": {
    "analysis": {
      "type": "string"
    },
    "ranked_by": {
      "type": "string"
    },
    "direction": {
      "type": "string"
    },
    "rent_as_of": {
      "type": [
        "string",
        "null"
      ]
    },
    "home_value_as_of": {
      "type": [
        "string",
        "null"
      ]
    },
    "metros_evaluated": {
      "type": "number"
    },
    "markets": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "metro": {
            "type": "string"
          },
          "monthly_rent": {
            "type": "number"
          },
          "typical_home_value": {
            "type": [
              "number",
              "null"
            ]
          },
          "gross_rent_yield_pct": {
            "type": "number"
          }
        }
      }
    },
    "note": {
      "type": "string"
    },
    "freshness": {
      "type": "object",
      "properties": {
        "as_of": {
          "type": "string"
        },
        "dates_match": {
          "type": "boolean"
        },
        "statement": {
          "type": "string"
        }
      }
    }
  }
}

Connect

Add this to your MCP client config — every tool in the catalog, including this one — or use one-click install buttons:

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

Connect to just the housing-intel pack

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

See Getting Started for client-specific install steps.

housing_market_screen