altos_market_stats

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

Get current market snapshot for a region (e.g., “San Francisco, CA”). Returns inventory count, new listings, median price, days on market, and market action index.

Parameters

NameTypeRequiredDescription
_altosKeystringyesAltos Research API key
regionstringyesRegion code (e.g., “us_national”, “ca_los-angeles”, “ca_94105”)
datestringnoDate (must be a Friday, YYYY-MM-DD). Defaults to most recent Friday.
res_typestringnoResidential type filter: “single_family” or “multi_family”. Default: single_family.
quartilestringnoPrice quartile: “ALL”, “FIRST”, “SECOND”, “THIRD”, “FOURTH”. Default: ALL.

Example call

Arguments

{
  "_altosKey": "your-altos-api-key",
  "region": "us_national"
}

curl

curl -X POST https://gateway.pipeworx.io/altos/mcp \
  -H 'Content-Type: application/json' \
  -d '{"jsonrpc":"2.0","id":1,"method":"tools/call","params":{"name":"altos_market_stats","arguments":{"_altosKey":"your-altos-api-key","region":"us_national"}}}'

TypeScript (@pipeworx/sdk)

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

const result = await pipeworx.call('altos_market_stats', {
  "_altosKey": "your-altos-api-key",
  "region": "us_national"
});

More examples

{
  "_altosKey": "your-altos-api-key",
  "region": "ca_los-angeles",
  "date": "2024-01-12",
  "res_type": "single_family",
  "quartile": "FIRST"
}

Response shape

Always returns: region, date, res_type, quartile, stats

FieldTypeDescription
regionstringRegion code queried
datestringFriday date (YYYY-MM-DD) for snapshot
res_typestringResidential type filter applied
quartilestringPrice quartile filter applied
statsarrayMarket statistics rows
Full JSON Schema
{
  "type": "object",
  "properties": {
    "region": {
      "type": "string",
      "description": "Region code queried"
    },
    "date": {
      "type": "string",
      "description": "Friday date (YYYY-MM-DD) for snapshot"
    },
    "res_type": {
      "type": "string",
      "description": "Residential type filter applied"
    },
    "quartile": {
      "type": "string",
      "description": "Price quartile filter applied"
    },
    "stats": {
      "type": "array",
      "description": "Market statistics rows",
      "items": {
        "type": "object",
        "properties": {
          "date": {
            "type": "string",
            "description": "Snapshot date"
          },
          "inventory_total": {
            "type": "string",
            "description": "Total inventory count"
          },
          "new_listings_total": {
            "type": "string",
            "description": "New listings added"
          },
          "listings_absorbed_total": {
            "type": "string",
            "description": "Listings absorbed"
          },
          "days_on_market_median": {
            "type": "string",
            "description": "Median days on market"
          },
          "price_median": {
            "type": "string",
            "description": "Median listing price"
          },
          "percent_price_decreased_median": {
            "type": "string",
            "description": "Median percent price decrease"
          },
          "market_action_median": {
            "type": "string",
            "description": "Market action index"
          },
          "months_of_inventory_median": {
            "type": "string",
            "description": "Months of inventory supply"
          },
          "estimated_sales_total": {
            "type": "string",
            "description": "Estimated sales count"
          }
        }
      }
    }
  },
  "required": [
    "region",
    "date",
    "res_type",
    "quartile",
    "stats"
  ]
}

Connect

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

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

See Getting Started for client-specific install steps.

Regenerated from source · build May 9, 2026