housing_rental_analysis

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

Evaluate rental investment potential by address and zip code. Returns estimated rent, fair market rents, and CPI rent trends.

Parameters

NameTypeRequiredDescription
_attomKeystringyesATTOM API key
_hudKeystringnoHUD API token (optional — needed for fair market rents)
address1stringyesStreet address (e.g., “4529 Winona Court”)
address2stringyesCity, state ZIP (e.g., “Denver, CO 80212”)
state_codestringyesTwo-letter state code for HUD FMR lookup (e.g., “CO”)

Example call

Arguments

{
  "_attomKey": "your-housing-intel-api-key",
  "address1": "4529 Winona Court",
  "address2": "Denver, CO 80212",
  "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_rental_analysis","arguments":{"_attomKey":"your-housing-intel-api-key","address1":"4529 Winona Court","address2":"Denver, CO 80212","state_code":"CO"}}}'

TypeScript (@pipeworx/sdk)

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

const result = await pipeworx.call('housing_rental_analysis', {
  "_attomKey": "your-housing-intel-api-key",
  "address1": "4529 Winona Court",
  "address2": "Denver, CO 80212",
  "state_code": "CO"
});

More examples

{
  "_attomKey": "your-housing-intel-api-key",
  "_hudKey": "your-housing-intel-api-key",
  "address1": "1450 Peachtree Street",
  "address2": "Atlanta, GA 30309",
  "state_code": "GA"
}

Response shape

Always returns: property_rent_estimate, area_fair_market_rent, rent_cpi_trend

FieldTypeDescription
property_rent_estimateobject
area_fair_market_rentunknown
rent_cpi_trendunknown
Full JSON Schema
{
  "type": "object",
  "properties": {
    "property_rent_estimate": {
      "type": "object",
      "properties": {
        "monthly": {
          "type": [
            "number",
            "null"
          ],
          "description": "Estimated monthly rent"
        },
        "annual_yield": {
          "type": [
            "number",
            "null"
          ],
          "description": "Estimated annual yield (null if property value unavailable)"
        },
        "error": {
          "type": "string"
        }
      }
    },
    "area_fair_market_rent": {
      "oneOf": [
        {
          "type": "object",
          "properties": {
            "year": {
              "type": [
                "number",
                "string",
                "null"
              ]
            },
            "state": {
              "type": "string"
            },
            "areas": {
              "type": "array",
              "items": {
                "type": "object",
                "properties": {
                  "area_name": {
                    "type": [
                      "string",
                      "null"
                    ]
                  },
                  "efficiency": {
                    "type": [
                      "number",
                      "null"
                    ]
                  },
                  "1br": {
                    "type": [
                      "number",
                      "null"
                    ]
                  },
                  "2br": {
                    "type": [
                      "number",
                      "null"
                    ]
                  },
                  "3br": {
                    "type": [
                      "number",
                      "null"
                    ]
                  },
                  "4br": {
                    "type": [
                      "number",
                      "null"
                    ]
                  }
                }
              }
            },
            "total_areas": {
              "type": "number"
            }
          }
        },
        {
          "type": "object",
          "properties": {
            "area_name": {
              "type": [
                "string",
                "null"
              ]
            },
            "efficiency": {
              "type": [
                "number",
                "null"
              ]
            },
            "1br": {
              "type": [
                "number",
                "null"
              ]
            },
            "2br": {
              "type": [
                "number",
                "null"
              ]
            },
            "3br": {
              "type": [
                "number",
                "null"
              ]
            },
            "4br": {
              "type": [
                "number",
                "null"
              ]
            }
          }
        },
        {
          "type": "object",
          "properties": {
            "error": {
              "type": "string"
            }
          }
        }
      ]
    },
    "rent_cpi_trend": {
      "oneOf": [
        {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "date": {
                "type": "string"
              },
              "value": {
                "type": "number"
              }
            }
          }
        },
        {
          "type": "object",
          "properties": {
            "error": {
              "type": "string"
            }
          }
        }
      ]
    }
  },
  "required": [
    "property_rent_estimate",
    "area_fair_market_rent",
    "rent_cpi_trend"
  ]
}

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.

Regenerated from source · build May 9, 2026