zillow_top_markets

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

Ranked list of regions by a housing metric. sort_by=“value” (default) ranks by the latest value: metric=zhvi direction=top → most expensive metros, direction=bottom → cheapest. sort_by=“growth” ranks by percent change over a trailing window (growth_window_months, default 12): direction=top → FASTEST-GROWING / fastest-appreciating metros, direction=bottom → biggest decliners. metric defaults to zhvi (home values). Returns up to 100 rows.

Parameters

NameTypeRequiredDescription
metricstringnoOne of: ${METRICS.join(’ | ’)} (default zhvi)
region_typestringnometro | state | national (default metro)
limitnumberno1-100 (default 10)
directionstringnotop | bottom (default top)
sort_bystringnovalue (latest level, default) | growth (percent change over growth_window_months)
growth_window_monthsnumbernoTrailing window for sort_by=growth, in months (default 12).

Example call

Arguments

{
  "metric": "zhvi",
  "limit": 10,
  "direction": "top"
}

curl

curl -X POST https://gateway.pipeworx.io/zillow/mcp \
  -H 'Content-Type: application/json' \
  -d '{"jsonrpc":"2.0","id":1,"method":"tools/call","params":{"name":"zillow_top_markets","arguments":{"metric":"zhvi","limit":10,"direction":"top"}}}'

TypeScript (@pipeworx/sdk)

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

const result = await pipeworx.call('zillow_top_markets', {
  "metric": "zhvi",
  "limit": 10,
  "direction": "top"
});

More examples

{
  "metric": "zori",
  "region_type": "metro",
  "limit": 5,
  "direction": "bottom"
}

Response shape

Full JSON Schema
{
  "oneOf": [
    {
      "type": "object",
      "properties": {
        "error": {
          "type": "string",
          "enum": [
            "no_data"
          ],
          "description": "No data for metric/region_type"
        },
        "message": {
          "type": "string",
          "description": "Error message"
        }
      },
      "required": [
        "error",
        "message"
      ]
    },
    {
      "type": "object",
      "properties": {
        "metric": {
          "type": "string",
          "description": "Metric queried"
        },
        "region_type": {
          "type": "string",
          "description": "Region type (metro/state/national)"
        },
        "observation_date": {
          "type": "string",
          "description": "Latest observation date"
        },
        "direction": {
          "type": "string",
          "enum": [
            "top",
            "bottom"
          ],
          "description": "Sort direction"
        },
        "results": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "region_id": {
                "type": "number",
                "description": "Region ID"
              },
              "region_name": {
                "type": "string",
                "description": "Region name"
              },
              "state_name": {
                "type": [
                  "string",
                  "null"
                ],
                "description": "State name if applicable"
              },
              "value": {
                "type": [
                  "number",
                  "null"
                ],
                "description": "Metric value"
              }
            }
          }
        }
      },
      "required": [
        "metric",
        "region_type",
        "observation_date",
        "direction",
        "results"
      ]
    }
  ]
}

Connect

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

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

See Getting Started for client-specific install steps.

Regenerated from source · build July 7, 2026