altos_pending_sales
Pack: altos · Endpoint: https://gateway.pipeworx.io/altos/mcp
Find properties under contract in a region (e.g., “Miami, FL”). Returns address, price, beds, baths, and days pending.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
_altosKey | string | yes | Altos Research API key |
region | string | yes | Region code (e.g., “ca_los-angeles”, “ca_94105”) |
date | string | no | Date (must be a Friday, YYYY-MM-DD). Defaults to most recent Friday. |
limit | number | no | Max rows to return (default 100) |
Example call
Arguments
{
"_altosKey": "your-altos-api-key",
"region": "ca_los-angeles"
}
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_pending_sales","arguments":{"_altosKey":"your-altos-api-key","region":"ca_los-angeles"}}}'
TypeScript (@pipeworx/sdk)
import { Pipeworx } from '@pipeworx/sdk';
const pipeworx = new Pipeworx();
const result = await pipeworx.call('altos_pending_sales', {
"_altosKey": "your-altos-api-key",
"region": "ca_los-angeles"
});
More examples
{
"_altosKey": "your-altos-api-key",
"region": "ca_94105",
"limit": 25
}
Response shape
Always returns: region, date, total_available, returned, pendings
| Field | Type | Description |
|---|---|---|
region | string | Region code queried |
date | string | Friday date (YYYY-MM-DD) for snapshot |
total_available | number | Total pending sales in region |
returned | number | Number of pending sales returned |
pendings | array | Properties under contract |
Full JSON Schema
{
"type": "object",
"properties": {
"region": {
"type": "string",
"description": "Region code queried"
},
"date": {
"type": "string",
"description": "Friday date (YYYY-MM-DD) for snapshot"
},
"total_available": {
"type": "number",
"description": "Total pending sales in region"
},
"returned": {
"type": "number",
"description": "Number of pending sales returned"
},
"pendings": {
"type": "array",
"description": "Properties under contract",
"items": {
"type": "object",
"description": "Raw CSV row data as key-value pairs"
}
}
},
"required": [
"region",
"date",
"total_available",
"returned",
"pendings"
]
}
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.