Check live listings in a city
check_city_supplyRead-onlyIdempotent
Count the live rental listings Socials Homes currently sees in a supported city and, if a monthly budget in EUR is given, how many are at or under it. Says plainly when live counts are unavailable instead of reporting zero. Read-only; the count comes from a cache refreshed about every 10 minutes.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| city | Yes | The city, as a slug from list_cities ("the_hague") or a name ("The Hague"). | |
| budget_max_eur | No | Maximum monthly rent in EUR, a whole number from 50 to 20000. |
Output Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| city | Yes | ||
| supply | Yes | ||
| signup_url | Yes |