Base URL
/api/... — there is no version prefix yet.)
Authentication
The free tierGET /api/score and GET /api/pois work without auth. All other endpoints — bulk operations, webhooks, monitoring, PDF generation, ML exports — require a Bearer token:
Scoring profiles
The composite score and many endpoints accept aprofile parameter that adjusts signal weights for the use case:
| Profile | Optimized for |
|---|---|
general | Default. Balanced across all signal groups. |
qsr | Quick-service restaurants — emphasis on foot traffic, demographics, competitor density. |
self_storage | Self-storage facilities — emphasis on housing turnover, population density, road accessibility. |
retail | Retail spaces — emphasis on foot traffic, parking, complementary tenants. |
office | Office leasing — emphasis on transit, daytime population, business vitality. |
Confidence
Every score includes aconfidence field (0.0–1.0) representing the ratio of data sources that returned data for the location. Coverage varies by metro and by signal — rural areas often have lower confidence than urban ones.
Composite vs sub-scores
Composite scores roll up 8 signal groups:- Business Vitality — net openings, category diversity, rating trajectory
- Demographics — population, income, age distribution
- Foot Traffic — visit volume, dwell time
- Real Estate — pricing trends, transaction velocity
- Permits — building activity (new construction, renovation, demolition)
- Traffic — vehicle flow, congestion patterns
- Jobs — employment density, wage trends
- Risk — crime, weather, environmental hazards
GET /api/score for the composite. Use the per-signal endpoints (/api/pois, /api/permits, /api/traffic, /api/jobs) for raw data.
Quick start
Where to from here
Core Scoring
/api/score and bulk scoringLocation Data
POIs, permits, traffic, jobs
Predictions
Forward-looking territory forecasts
Reports
Generate branded PDF reports