One composed document for an area
area_reportThe market for one area, as one document: sourcing readiness per strategy
from the coverage register, the commercial capital and rent indices with
rated stock, the planning decision record for the authority, and the live
listing stock.
THE TWO SCOPES ARE NOT INTERCHANGEABLE. Readiness, commercial stock and the
planning register are keyed on the LOCAL AUTHORITY (`lad_code`, a GSS code
— use `area_resolve` to get one); the live listing lane is keyed on
POSTCODE DISTRICT. Pass both to fill every section, and expect the
unsupplied half to read `not_available` with that reason rather than empty.
As with `property_report`, check `sections_degraded` before describing the
document as complete.
UK only. Costs 25 credits (25p).
Tool call template
This tool declares no required parameters. Add optional parameters from the input schema as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {},
"name": "area_report"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| sector | No | ALL | |
| lad_code | No | ||
| postcode_district | No |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||