Overview
The Neighborhood Insights API provides comprehensive data about a property’s location, including accessibility, commute & traffic, lifestyle amenities, environment, essential services, and safety & community metrics. This endpoint returns detailed scores, descriptions, and insights across 24+ individual metrics organized into 6 main categories.To obtain an API key, please contact our sales team.
Authorization
Your API key for authentication
Query Parameters
The street address (e.g., “123 Main St”)
The city name (e.g., “San Francisco”)
The state code (e.g., “CA”)
The ZIP/postal code (e.g., “94102”)
The country name (e.g., “USA”)
Response Structure
The response includes:Meta Information
api_version
: Current API versionrequest_id
: Unique identifier for this requestgenerated_at_utc
: Timestamp when data was generatedttl_seconds
: Time-to-live for cached dataetag
: Entity tag for cache validation
Context
address
: Complete address breakdown
Coverage
latest_update_days
: Days since last data updatedata_sources
: List of data sources used
Score Summary
loka_score
: Overall neighborhood score (0-100)neighborhood_metrics
: Array of 6 main category metrics, each containing:- Category score (weighted average of submetrics)
- Category-level insight and loka_tip
- Submetrics array with individual scores, descriptions, and metadata
Main Categories
The API returns data for 6 main categories:- Neighborhood Accessibility - Walkability, bikeability, parking, main roads, airport access
- Commute & Traffic - Transit access, traffic flow, driving convenience, road conditions, crosswalk safety
- Lifestyle Amenities - Dining, shopping, recreation, nightlife, arts & culture, sports
- Environment & Surroundings - Environmental quality, green spaces, air quality, quietness, disaster safety
- Essential Services - Education, healthcare, daily errands, waste management, EV charging
- Safety & Community - Neighborhood safety, community vibe, pet amenities, cell signal coverage
Notes
- Scores range from 0-10 for individual metrics (0-100 for overall loka_score)
- Higher scores indicate better performance
- Descriptions are contextual based on score level (high ≥ 7, medium ≥ 4, low < 4)
- The address must exist in the FindLoka database with pre-calculated analytics
- Make sure to URL-encode query parameters when making requests