Skip to main content

HouseCanary API MCP server

Project description

housecanary-mcp

An MCP wrapper for the HouseCanary Analytics and Portfolio Monitoring APIs. Access HouseCanary's proprietary analytics and public records data across multiple geographic levels—from individual properties to states—with support for v2 and v3 endpoints. Includes endpoints for property valuation, rental estimates, market analysis, disaster risk assessment, school information, and portfolio management.

Install

pip install housecanary-mcp

For local development in this repository:

pip install -e .

Authentication

You can provide credentials with CLI options or environment variables.

  • --username or HOUSECANARY_API_USERNAME (fallback: HOUSECANARY_API_KEY)
  • --password or HOUSECANARY_API_PASSWORD (fallback: HOUSECANARY_API_SECRET)

Both username and password must be provided together if either is set.

Usage (stdio default)

All commands in this section use the default MCP stdio transport.

housecanary-mcp

or:

housecanary-mcp --username "$HOUSECANARY_API_USERNAME" --password "$HOUSECANARY_API_PASSWORD"

Run with uv (no project download)

housecanary-mcp is also published to PyPI, you can run it directly with uv without cloning this repository.

These examples also use stdio transport by default.

One-off execution:

uvx housecanary-mcp

Equivalent command using uv run:

uv run --with housecanary-mcp housecanary-mcp

With credentials:

HOUSECANARY_API_USERNAME="$HOUSECANARY_API_USERNAME" HOUSECANARY_API_PASSWORD="$HOUSECANARY_API_PASSWORD" uvx housecanary-mcp

With credentials passed as CLI args:

uvx housecanary-mcp --username "$HOUSECANARY_API_USERNAME" --password "$HOUSECANARY_API_PASSWORD"

Equivalent uv run form with credential args:

uv run --with housecanary-mcp housecanary-mcp --username "$HOUSECANARY_API_USERNAME" --password "$HOUSECANARY_API_PASSWORD"

HTTP transport

To run the MCP server over HTTP instead of stdio, set FastMCP transport env vars.

Published package:

FASTMCP_TRANSPORT=http FASTMCP_HOST=127.0.0.1 FASTMCP_PORT=8000 FASTMCP_STREAMABLE_HTTP_PATH=/mcp uvx housecanary-mcp

Local project source:

FASTMCP_TRANSPORT=http FASTMCP_HOST=127.0.0.1 FASTMCP_PORT=8000 FASTMCP_STREAMABLE_HTTP_PATH=/mcp uv run --project /path/to/hcs-mcp housecanary-mcp

With credentials:

HOUSECANARY_API_USERNAME="$HOUSECANARY_API_USERNAME" HOUSECANARY_API_PASSWORD="$HOUSECANARY_API_PASSWORD" FASTMCP_TRANSPORT=http FASTMCP_HOST=127.0.0.1 FASTMCP_PORT=8000 FASTMCP_STREAMABLE_HTTP_PATH=/mcp uv run --project /path/to/hcs-mcp housecanary-mcp

Default HTTP endpoint URL:

  • http://127.0.0.1:8000/mcp

OpenAPI spec location

The canonical OpenAPI spec file is:

  • src/housecanary_mcp/openapi.yaml

Development checks

pytest
python -m build

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

housecanary_mcp-0.1.0.tar.gz (196.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

housecanary_mcp-0.1.0-py3-none-any.whl (204.9 kB view details)

Uploaded Python 3

File details

Details for the file housecanary_mcp-0.1.0.tar.gz.

File metadata

  • Download URL: housecanary_mcp-0.1.0.tar.gz
  • Upload date:
  • Size: 196.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.14.3

File hashes

Hashes for housecanary_mcp-0.1.0.tar.gz
Algorithm Hash digest
SHA256 727e85a182ed9541be9c93a57871bf3366fa6aaa4d08e29f01942798ec5b8bea
MD5 e4ffafa0ed17929c62232bf1f25c7a11
BLAKE2b-256 deed9961a4eeffadfa6cbd9bac80ca8fead276d79c3cbb08fff1dc7289a07cb4

See more details on using hashes here.

File details

Details for the file housecanary_mcp-0.1.0-py3-none-any.whl.

File metadata

File hashes

Hashes for housecanary_mcp-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 47a75b98f0fd6aaeece39dd6e96f2c233c366b424f6a63ff25f352858fcfbc1b
MD5 6ecacca195497e5b62a0cdb6ce7c97e4
BLAKE2b-256 1c1307fa421f74fb5b1f71f6435642bbab92f40913030a2d68a37687e1424e76

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page