`altos_inventory_trend`

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

Track weekly inventory changes for a region (e.g., “Austin, TX”). Returns trends in inventory, new listings, days on market, median price, and price reductions.

Parameters

Name	Type	Required	Description
`_altosKey`	string	yes	Altos Research API key
`region`	string	yes	Region code (e.g., “us_national”, “ca_los-angeles”)
`weeks`	number	no	Number of weeks to look back (default 12, max 52)

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_inventory_trend","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_inventory_trend', {
  "_altosKey": "your-altos-api-key",
  "region": "us_national"
});

More examples

{
  "_altosKey": "your-altos-api-key",
  "region": "ca_94105",
  "weeks": 24
}

Response shape

Always returns: region, weeks_requested, snapshots_fetched, trend

Field	Type	Description
`region`	string	Region code queried
`weeks_requested`	number	Number of weeks requested
`snapshots_fetched`	number	Number of weekly snapshots retrieved
`trend`	array	Weekly inventory trend snapshots

Full JSON Schema

{
  "type": "object",
  "properties": {
    "region": {
      "type": "string",
      "description": "Region code queried"
    },
    "weeks_requested": {
      "type": "number",
      "description": "Number of weeks requested"
    },
    "snapshots_fetched": {
      "type": "number",
      "description": "Number of weekly snapshots retrieved"
    },
    "trend": {
      "type": "array",
      "description": "Weekly inventory trend snapshots",
      "items": {
        "type": "object",
        "properties": {
          "date": {
            "type": "string",
            "description": "Friday snapshot date"
          },
          "inventory": {
            "type": "string",
            "description": "Total inventory count"
          },
          "new_listings": {
            "type": "string",
            "description": "New listings count"
          },
          "days_on_market": {
            "type": "string",
            "description": "Median days on market"
          },
          "price_median": {
            "type": "string",
            "description": "Median listing price"
          },
          "pct_price_decreased": {
            "type": "string",
            "description": "Percent listings with price decrease"
          }
        }
      }
    }
  },
  "required": [
    "region",
    "weeks_requested",
    "snapshots_fetched",
    "trend"
  ]
}

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.

altos_inventory_trend