get_locality_insights

Aggregated insights for a Coimbatore locality — average price, supply, demand pulse, livability grade.

Endpoint POST https://api.avnester.com/public/v1/get_locality_insights

Parameters

The most-used parameters. Full schema in the OpenAPI document.

Name	Type	Required	Description
localityName	string	required	Locality / neighborhood name.
city	string	optional	Disambiguator. Defaults to Coimbatore.

Worked example

# get insights for Saravanampatti

curl -X POST https://api.avnester.com/public/v1/get_locality_insights \
  -H 'Content-Type: application/json' \
  -d '{
       "localityName": "Saravanampatti",
       "city": "Coimbatore"
     }'

Response

{
  "supported": true,
  "locality": "Saravanampatti",
  "avgPricePerSqft": 5400,
  "supplyCount": 142,
  "demandPulse": "high",
  "livabilityGrade": "A-",
  "investmentGrade": "A",
  "highlights": ["IT corridor", "strong rental demand"],
  "watchouts": ["traffic peaks 8–10am"],
  "priceTrends": [...],
  "strengthTags": ["it_proximity", "schools"],
  "disclaimer": "Livability + investment grades are AVnester estimates, not professional advice.",
  "attribution": "AVnester"
}

Rate limits

Anonymous

60/min

OAuth (Team)

600/min

Per-IP aggregate cap (across all tools): 60/min. OAuth registration lifts both the per-tool budget (10×) and removes the IP cap.

Common errors

200supported: false in body
Out-of-coverage queries are not HTTP errors — surface the scopeMessage from the response body to the user.
429Rate limit exceeded
Back off until the time in the Retry-After header; or authenticate with OAuth for the 10× tier.

Next steps

→ Try get_locality_insights in the playground (no signup, anon tier)
→ Register an OAuth client (10× rate budget)
→ Browse the other 6 tools
→ Full schema in the OpenAPI spec