housing_rental_analysis
Pack: housing-intel · Endpoint: https://gateway.pipeworx.io/housing-intel/mcp
No MCP client? Call it directly: GET https://gateway.pipeworx.io/v1/tools/housing_rental_analysis for the schema, then POST the same URL with its arguments for the data.
Evaluate rental investment potential by address and zip code. Returns estimated rent, fair market rents, and CPI rent trends.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
_attomKey | string | yes | ATTOM API key |
_hudKey | string | no | HUD API token (optional — needed for fair market rents) |
_blsKey | string | no | BLS registration key (optional — raises the shared quota; https://data.bls.gov/registrationEngine/) |
address1 | string | yes | Street address (e.g., “4529 Winona Court”) |
address2 | string | yes | City, state ZIP (e.g., “Denver, CO 80212”) |
state_code | string | yes | Two-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
| Field | Type | Description |
|---|---|---|
property_rent_estimate | object | |
area_fair_market_rent | unknown | |
rent_cpi_trend | unknown |
Full JSON Schema
{
"type": "object",
"properties": {
"property_rent_estimate": {
"type": "object",
"properties": {
"monthly": {
"type": [
"number",
"null"
],
"description": "Estimated monthly rent (USD)"
},
"annual_yield": {
"type": [
"number",
"null"
],
"description": "Annual yield percentage (if available)"
},
"error": {
"type": "string"
}
}
},
"area_fair_market_rent": {
"oneOf": [
{
"type": "object",
"properties": {
"year": {
"type": [
"string",
"null"
],
"description": "FMR year"
},
"state": {
"type": "string",
"description": "State code"
},
"areas": {
"type": "array",
"description": "List of metro/county FMR data (up to 10)",
"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",
"description": "Total number of areas in the state"
}
}
},
{
"type": "object",
"properties": {
"error": {
"type": "string"
}
}
}
]
},
"rent_cpi_trend": {
"oneOf": [
{
"type": "array",
"items": {
"type": "object",
"properties": {
"date": {
"type": "string",
"description": "ISO date"
},
"value": {
"type": "number",
"description": "Rent CPI value"
}
}
}
},
{
"type": "object",
"properties": {
"error": {
"type": "string"
}
}
}
]
}
}
}
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.