BuildingType
| Value | Description |
|---|---|
CONDO | Condominium |
CO_OP | Co-operative |
RENTAL | Rental building |
TOWNHOUSE | Townhouse |
MULTI_FAMILY | Multi-family house |
HOUSE | Single-family house |
ListingStatus
| Value | Description |
|---|---|
ACTIVE | Currently available |
IN_CONTRACT | Under contract / offer accepted |
OFF_MARKET | No longer available |
SaleType
| Value | Description |
|---|---|
RESALE | Standard resale |
SPONSOR_UNIT | New development / sponsor sale |
FORECLOSURE | Foreclosure |
Sort
| Value | Description |
|---|---|
RECOMMENDED | Default relevance ranking |
PRICE | Sort by price |
LISTED_AT | Sort by listing date |
PRICE_PER_SQFT | Sort by price per square foot |
SortDirection
| Value | Description |
|---|---|
ASC | Ascending (low to high, oldest first) |
DESC | Descending (high to low, newest first) |
PriceEvent
| Value | Description |
|---|---|
LISTED | Initial listing |
PRICE_INCREASE | Price raised |
PRICE_DECREASE | Price reduced |
DELISTED | Removed from market |
RENTED | Rented |
SOLD | Sold |
ErrorCode
| Value | HTTP Status | Description |
|---|---|---|
INVALID_PARAMS | 400 | Invalid request parameters |
MISSING_API_KEY | 401 | No API key provided |
INVALID_API_KEY | 401 | Unrecognized API key |
EXPIRED_API_KEY | 401 | Subscription expired |
TIER_RESTRICTED | 403 | Higher tier required |
QUOTA_EXCEEDED | 429 | Monthly quota exceeded |
NOT_FOUND | 404 | Resource not found |
RATE_LIMIT_EXCEEDED | 429 | Rate limit exceeded |
INTERNAL_ERROR | 500 | Unexpected error |
UPSTREAM_ERROR | 502 | Data source error |
SERVICE_DISABLED | 503 | API temporarily disabled |
WebhookEvent
| Value | Description |
|---|---|
listing.created | New listing appeared |
listing.price_decreased | Price dropped >$25 |
listing.price_increased | Price raised >$25 |
listing.status_changed | Status changed |
listing.expired | Listing went off-market |