Developer Reference

API Reference

Access location intelligence programmatically. 43 data sources. 8 signal groups. Enrichment, predictions, webhooks, and ML exports in one platform.

Base URLhttps://axiomlocus.io/api

Authentication

The API supports three authentication methods. Most endpoints work without authentication (rate-limited by IP, 5 requests/day). Authenticated users get higher limits and access to protected endpoints.

1. API Key (recommended for programmatic access)

Generate an API key from Settings. Keys are prefixed with al_ and can be passed via either header:

# Option A: Authorization header
curl "https://axiomlocus.io/api/score?lat=37.77&lng=-122.41" \
  -H "Authorization: Bearer al_your_key_here"

# Option B: X-API-Key header
curl "https://axiomlocus.io/api/score?lat=37.77&lng=-122.41" \
  -H "X-API-Key: al_your_key_here"

2. Session Cookie (browser use)

When signed in via the browser, your session cookie is sent automatically. No additional headers needed.

3. Anonymous

No credentials required. Rate-limited to 5 requests/day by IP address. Some endpoints return truncated data for anonymous users.

Rate Limits

Requests are rate-limited per day based on your plan. The remaining quota is returned in the X-RateLimit-Remaining response header.

Plan	Lookups / Day	Bulk Scoring	Price
Anonymous	5	No	$0
Free	100	No	$0
Pro	5,000	Yes	$200/mo
Team	25,000	Yes	$500/mo

When rate-limited, the API returns 429 Too Many Requests. See Pricing for full plan details.

Core Scoring

GET/api/score

Score a location across all 8 signal groups.

Parameters

Name	Type	Required	Default	Description
`lat`	float	Yes	—	Latitude of the location.
`lng`	float	Yes	—	Longitude of the location.
`radius`	float	No	`1.0`	Radius in km (max 10).
`profile`	string	No	`general`	Scoring profile. One of: general, qsr, self_storage, retail, office.

Example Request

curl "https://axiomlocus.io/api/score?lat=37.7749&lng=-122.4194"

Example Response

{
  "composite": 78.4,
  "confidence": 0.92,
  "sourcesUsed": 36,
  "sourcesTotal": 43,
  "metro": "sf",
  "profile": "general",
  "groups": {
    "businessVitality": {
      "score": 82.1,
      "confidence": 1.0,
      "sourcesActive": 5,
      "sourcesTotal": 6,
      "subScores": [
        { "name": "Net Business Openings", "score": 71 },
        { "name": "Category Diversity", "score": 88 },
        { "name": "Rating Trajectory", "score": 79 }
      ]
    }
  }
}

Response Fields

Field	Type	Description
`composite`	float	Overall score from 0 to 100.
`confidence`	float	Data completeness ratio from 0.0 to 1.0.
`sourcesUsed`	int	Number of data sources that returned data.
`sourcesTotal`	int	Total possible data sources.
`metro`	string	Metro slug where the location was resolved.
`profile`	string	Scoring profile used.
`groups`	object	Per-signal-group breakdown with score, confidence, sourcesActive, sourcesTotal, and subScores.

POST/api/bulk-scoreAuth Required

Score up to 50 locations in a single request.

Request Body

Field	Type	Required	Description
`locations`	array	Yes	Array of { lat, lng } objects. Maximum 50.
`radius`	float	No	Radius in km (max 10). Applied to all locations.
`profile`	string	No	Scoring profile for all locations.

{
  "locations": [
    { "lat": 37.7749, "lng": -122.4194 },
    { "lat": 34.0522, "lng": -118.2437 }
  ],
  "radius": 1.0,
  "profile": "qsr"
}

Example Request

curl -X POST "https://axiomlocus.io/api/bulk-score" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -d '{"locations":[{"lat":37.77,"lng":-122.41},{"lat":34.05,"lng":-118.24}]}'

Example Response

{
  "results": [
    {
      "lat": 37.77,
      "lng": -122.41,
      "composite": 78.4,
      "confidence": 0.92,
      "groups": { "..." : "..." }
    },
    {
      "lat": 34.05,
      "lng": -118.24,
      "composite": 71.2,
      "confidence": 0.88,
      "groups": { "..." : "..." }
    }
  ]
}

Response Fields

Field	Type	Description
`results`	array	Array of score objects, one per input location.
`results[].composite`	float	Composite score (0-100) for the location.
`results[].confidence`	float	Data completeness ratio.
`results[].groups`	object	Signal group breakdown.

Enrichment

GET/api/v1/enrichAuth Required

Enrich any US address with scores, nearby POIs, permits, demographics, and risk data in a single call.

Parameters

Name	Type	Required	Default	Description
`address`	string	Yes	—	Full US street address to geocode and enrich.
`radius`	float	No	`1.0`	Search radius in km (max 10).
`profile`	string	No	`general`	Scoring profile: general, qsr, self_storage, retail, office.
`include`	string	No	`all`	Comma-separated sections: scores,pois,permits,demographics,risk. Use 'all' for everything.

Example Request

curl "https://axiomlocus.io/api/v1/enrich?address=123+Market+St+San+Francisco+CA" \
  -H "Authorization: Bearer al_your_key_here"

Example Response

{
  "address": "123 Market St, San Francisco, CA 94105",
  "lat": 37.7935,
  "lng": -122.3958,
  "metro": "sf",
  "scores": {
    "composite": 76.2,
    "confidence": 0.94,
    "groups": {
      "businessVitality": { "score": 82 },
      "populationMomentum": { "score": 71 },
      "demographics": { "score": 80 }
    }
  },
  "permits": {
    "total": 34,
    "total_value": 8200000,
    "recent": [
      { "id": "P-2025-5678", "type": "renovation", "value": 450000 }
    ]
  },
  "demographics": {
    "median_income": 112000,
    "population_density": 18200,
    "daytime_population_ratio": 3.4
  },
  "risk": {
    "flood_zone": false,
    "crime_index": 42,
    "air_quality_aqi": 38
  }
}

Response Fields

Field	Type	Description
`address`	string	Normalized address string.
`lat`	float	Geocoded latitude.
`lng`	float	Geocoded longitude.
`scores`	object	Full scoring breakdown with composite and signal groups.
`permits`	object	Nearby building permits with value aggregation.
`demographics`	object	Census and ACS demographic data.
`risk`	object	Environmental and safety risk indicators.

Predictions

GET/api/lead-lagAuth Required

Survival curve analysis showing how one signal leads or lags another. Useful for predicting which neighborhoods will gentrify, decline, or see permit surges.

Parameters

Name	Type	Required	Default	Description
`cause`	string	Yes	—	Leading signal group (e.g. businessVitality, populationMomentum).
`effect`	string	Yes	—	Lagging signal group (e.g. developmentPipeline, economicStrength).
`metro`	string	No	—	Metro slug filter. Omit for all metros.
`lag_months`	int	No	`12`	Maximum lag window in months (1-24).

Example Request

curl "https://axiomlocus.io/api/lead-lag?cause=businessVitality&effect=developmentPipeline&metro=sf" \
  -H "Authorization: Bearer al_your_key_here"

Example Response

{
  "cause": "businessVitality",
  "effect": "developmentPipeline",
  "metro": "sf",
  "peak_lag_months": 6,
  "peak_correlation": 0.72,
  "survival_curve": [
    { "month": 0, "correlation": 0.12 },
    { "month": 3, "correlation": 0.45 },
    { "month": 6, "correlation": 0.72 },
    { "month": 9, "correlation": 0.58 },
    { "month": 12, "correlation": 0.31 }
  ],
  "interpretation": "Business vitality changes lead development pipeline activity by ~6 months in SF."
}

Response Fields

Field	Type	Description
`peak_lag_months`	int	Month offset where correlation is strongest.
`peak_correlation`	float	Pearson correlation at peak lag (0-1).
`survival_curve`	array	Monthly correlation values over the lag window.
`interpretation`	string	Human-readable summary of the lead-lag relationship.

GET/api/permits/predictAuth Required

Sequence prediction for building permit activity at the H3 cell level. Uses historical permit patterns to forecast future issuance.

Parameters

Name	Type	Required	Default	Description
`h3_index`	string	Yes	—	H3 hex index at resolution 8.
`horizon`	int	No	`6`	Forecast horizon in months (1-12).

Example Request

curl "https://axiomlocus.io/api/permits/predict?h3_index=882a100d63fffff&horizon=6" \
  -H "Authorization: Bearer al_your_key_here"

Example Response

{
  "h3_index": "882a100d63fffff",
  "historical_avg_monthly": 4.2,
  "forecast": [
    { "month": "2026-04", "predicted_permits": 5, "confidence": 0.85 },
    { "month": "2026-05", "predicted_permits": 6, "confidence": 0.78 },
    { "month": "2026-06", "predicted_permits": 4, "confidence": 0.71 },
    { "month": "2026-07", "predicted_permits": 7, "confidence": 0.65 },
    { "month": "2026-08", "predicted_permits": 5, "confidence": 0.59 },
    { "month": "2026-09", "predicted_permits": 4, "confidence": 0.52 }
  ],
  "trend": "increasing",
  "model": "arima_h3_v2"
}

Response Fields

Field	Type	Description
`historical_avg_monthly`	float	Average monthly permits over the last 12 months.
`forecast`	array	Monthly predictions with confidence intervals.
`forecast[].predicted_permits`	int	Predicted permit count for the month.
`forecast[].confidence`	float	Model confidence (0-1), decreases with horizon.
`trend`	string	Overall trend direction: increasing, stable, or decreasing.

Analytics

GET/api/permits/hotspots

H3-aggregated building permit hotspots for a metro, ranked by permit density and total estimated cost.

Parameters

Name	Type	Required	Default	Description
`metro_slug`	string	Yes	—	Metro slug (e.g. sf, nyc, chi, la).
`days`	int	No	`90`	Lookback period in days.
`limit`	int	No	`25`	Max hotspot cells to return.

Example Request

curl "https://axiomlocus.io/api/permits/hotspots?metro_slug=sf&days=90&limit=10"

Example Response

{
  "metro": "sf",
  "days": 90,
  "hotspots": [
    {
      "h3_index": "882a100d63fffff",
      "center_lat": 37.7749,
      "center_lng": -122.4194,
      "permit_count": 47,
      "total_value": 12500000,
      "avg_value": 265957,
      "top_type": "new_construction"
    },
    {
      "h3_index": "882a100d65fffff",
      "center_lat": 37.7851,
      "center_lng": -122.4094,
      "permit_count": 32,
      "total_value": 8700000,
      "avg_value": 271875,
      "top_type": "renovation"
    }
  ]
}

Response Fields

Field	Type	Description
`hotspots`	array	H3 cells ranked by permit activity.
`hotspots[].permit_count`	int	Total permits in the lookback window.
`hotspots[].total_value`	float	Sum of estimated costs.
`hotspots[].top_type`	string	Most common permit type in this cell.

GET/api/crime/hotspots

Crime incident hotspots aggregated by H3 cell for a metro area.

Parameters

Name	Type	Required	Default	Description
`metro_slug`	string	Yes	—	Metro slug.
`days`	int	No	`90`	Lookback period in days.
`category`	string	No	—	Filter by crime category: property, violent, other.
`limit`	int	No	`25`	Max cells to return.

Example Request

curl "https://axiomlocus.io/api/crime/hotspots?metro_slug=sf&days=30&category=property"

Example Response

{
  "metro": "sf",
  "days": 30,
  "total_incidents": 1243,
  "hotspots": [
    {
      "h3_index": "882a100d63fffff",
      "incident_count": 89,
      "top_category": "property",
      "per_capita_rate": 12.4,
      "trend": "declining"
    }
  ]
}

Response Fields

Field	Type	Description
`total_incidents`	int	Total incidents across all cells in the lookback window.
`hotspots[].incident_count`	int	Number of incidents in this H3 cell.
`hotspots[].per_capita_rate`	float	Incidents per 1,000 residents.
`hotspots[].trend`	string	Trend vs prior period: increasing, stable, declining.

GET/api/commuter-flows

LEHD Origin-Destination commuter flow data for a Census tract. Shows where workers live and where residents work.

Parameters

Name	Type	Required	Default	Description
`tract`	string	Yes	—	Census tract GEOID (11 digits).
`direction`	string	No	`both`	inbound (workers coming in), outbound (residents leaving), or both.
`limit`	int	No	`20`	Top N connected tracts to return.

Example Request

curl "https://axiomlocus.io/api/commuter-flows?tract=06075010800&direction=inbound&limit=10"

Example Response

{
  "tract": "06075010800",
  "inbound": {
    "total_workers": 14200,
    "flows": [
      { "origin_tract": "06081611100", "workers": 890, "pct": 6.3, "origin_name": "Daly City" },
      { "origin_tract": "06001402100", "workers": 720, "pct": 5.1, "origin_name": "Oakland" }
    ]
  },
  "outbound": {
    "total_residents_working": 3400,
    "flows": [
      { "dest_tract": "06075017902", "workers": 210, "pct": 6.2, "dest_name": "SoMa" }
    ]
  }
}

Response Fields

Field	Type	Description
`inbound.total_workers`	int	Total workers commuting into this tract.
`inbound.flows`	array	Top origin tracts with worker counts.
`outbound.total_residents_working`	int	Total residents who commute out.
`outbound.flows`	array	Top destination tracts.

Location Data

GET/api/pois

Nearby points of interest with ratings and photos.

Parameters

Name	Type	Required	Default	Description
`lat`	float	Yes	—	Latitude.
`lng`	float	Yes	—	Longitude.
`radius`	float	No	`0.5`	Radius in km (max 10).
`limit`	int	No	`50`	Max results to return (max 200).

Example Request

curl "https://axiomlocus.io/api/pois?lat=37.7749&lng=-122.4194&radius=0.5"

Example Response

{
  "pois": [
    {
      "id": "abc123",
      "name": "Blue Bottle Coffee",
      "primary_type": "cafe",
      "rating": 4.5,
      "review_count": 342,
      "photo_reference": "Aap_uE...",
      "distance_m": 120
    }
  ]
}

Response Fields

Field	Type	Description
`pois`	array	Array of nearby point-of-interest objects.
`pois[].id`	string	Unique POI identifier.
`pois[].name`	string	Business name.
`pois[].primary_type`	string	Business type category.
`pois[].rating`	float	Average rating (0-5).
`pois[].review_count`	int	Total number of reviews.
`pois[].photo_reference`	string	Photo reference for use with /api/places-photo.
`pois[].distance_m`	float	Distance from query point in meters.

GET/api/permits

Building permits near a location with value aggregation.

Parameters

Name	Type	Required	Default	Description
`lat`	float	Yes	—	Latitude.
`lng`	float	Yes	—	Longitude.
`radius`	float	No	`1.0`	Radius in km (max 10).

Example Request

curl "https://axiomlocus.io/api/permits?lat=37.7749&lng=-122.4194"

Example Response

{
  "total_permits": 47,
  "total_value": 12500000,
  "by_type": {
    "new_construction": 12,
    "renovation": 28,
    "demolition": 7
  },
  "permits": [
    {
      "id": "P-2025-1234",
      "permit_type": "new_construction",
      "status": "issued",
      "address": "123 Market St",
      "estimated_cost": 2500000,
      "issue_date": "2025-11-15"
    }
  ]
}

Response Fields

Field	Type	Description
`total_permits`	int	Total number of permits in the radius.
`total_value`	float	Sum of estimated_cost across all permits.
`by_type`	object	Permit count grouped by type.
`permits`	array	Up to 10 most recent permit records.

GET/api/traffic

Real-time traffic flow data.

Parameters

Name	Type	Required	Default	Description
`lat`	float	Yes	—	Latitude.
`lng`	float	Yes	—	Longitude.

Example Request

curl "https://axiomlocus.io/api/traffic?lat=37.7749&lng=-122.4194"

Example Response

{
  "current_speed": 28,
  "free_flow_speed": 45,
  "congestion_ratio": 0.62,
  "congestion_level": "moderate",
  "road_category": "arterial"
}

Response Fields

Field	Type	Description
`current_speed`	int	Current speed in mph.
`free_flow_speed`	int	Free-flow speed in mph (no traffic).
`congestion_ratio`	float	Ratio of current to free-flow speed (0-1).
`congestion_level`	string	Human-readable congestion level.
`road_category`	string	Road type classification.

GET/api/jobs

Local job market data.

Parameters

Name	Type	Required	Default	Description
`lat`	float	Yes	—	Latitude.
`lng`	float	Yes	—	Longitude.

Example Request

curl "https://axiomlocus.io/api/jobs?lat=37.7749&lng=-122.4194"

Example Response

{
  "total_postings": 1243,
  "avg_salary": 95000,
  "top_categories": [
    { "name": "IT Jobs", "count": 412 },
    { "name": "Engineering", "count": 198 }
  ],
  "top_companies": [
    { "name": "Salesforce", "count": 87 },
    { "name": "Google", "count": 64 }
  ]
}

Response Fields

Field	Type	Description
`total_postings`	int	Total active job postings near this location.
`avg_salary`	float	Average listed salary in USD.
`top_categories`	array	Top job categories by count.
`top_companies`	array	Top hiring companies by posting count.

GET/api/cells

H3 heatmap cells for a metro area.

Parameters

Name	Type	Required	Default	Description
`metro`	string	No	`sf`	Metro slug (e.g. sf, nyc, la, chi, mia, atx).

Example Request

curl "https://axiomlocus.io/api/cells?metro=sf"

Example Response

{
  "cells": [
    {
      "h3_index": "882a100d63fffff",
      "priority": 0.85,
      "center_lat": 37.7749,
      "center_lng": -122.4194
    }
  ]
}

Response Fields

Field	Type	Description
`cells`	array	Array of H3 hexagonal cells.
`cells[].h3_index`	string	H3 hex index at resolution 8.
`cells[].priority`	float	Priority score for heatmap rendering (0-1).
`cells[].center_lat`	float	Latitude of the hex center.
`cells[].center_lng`	float	Longitude of the hex center.

Data

GET/api/ports

Container and cargo volume data for US ports. Includes TEU throughput, year-over-year trends, and vessel calls.

Parameters

Name	Type	Required	Default	Description
`port_slug`	string	Yes	—	Port slug (e.g. la-lb, savannah, houston, newark, oakland).
`months`	int	No	`12`	Months of historical data.

Example Request

curl "https://axiomlocus.io/api/ports?port_slug=la-lb&months=6"

Example Response

{
  "port_slug": "la-lb",
  "port_name": "Port of Los Angeles / Long Beach",
  "latest_teu": 892000,
  "yoy_change_pct": 8.4,
  "monthly": [
    { "month": "2026-03", "teu": 892000, "vessel_calls": 142 },
    { "month": "2026-02", "teu": 845000, "vessel_calls": 138 },
    { "month": "2026-01", "teu": 801000, "vessel_calls": 131 }
  ]
}

Response Fields

Field	Type	Description
`latest_teu`	int	Most recent month's TEU (twenty-foot equivalent unit) volume.
`yoy_change_pct`	float	Year-over-year percentage change.
`monthly`	array	Monthly volume breakdown.
`monthly[].vessel_calls`	int	Number of vessel arrivals that month.

GET/api/construction

Satellite-detected construction activity in a metro. Uses change detection on Sentinel-2 imagery to identify active sites.

Parameters

Name	Type	Required	Default	Description
`metro_slug`	string	Yes	—	Metro slug.
`days`	int	No	`30`	Lookback window in days.
`min_area_sqft`	int	No	`5000`	Minimum detected site area in sq ft.

Example Request

curl "https://axiomlocus.io/api/construction?metro_slug=austin&days=60"

Example Response

{
  "metro": "austin",
  "days": 60,
  "total_detections": 34,
  "detections": [
    {
      "h3_index": "882a107a0bfffff",
      "center_lat": 30.2672,
      "center_lng": -97.7431,
      "estimated_area_sqft": 45000,
      "confidence": 0.91,
      "first_detected": "2026-02-15",
      "last_detected": "2026-03-28",
      "nearest_permit_id": "P-2025-9876"
    }
  ]
}

Response Fields

Field	Type	Description
`total_detections`	int	Number of detected active construction sites.
`detections[].estimated_area_sqft`	int	Estimated site footprint in square feet.
`detections[].confidence`	float	Detection confidence score (0-1).
`detections[].nearest_permit_id`	string	Cross-referenced building permit if matched.

Discovery & Intelligence

GET/api/discover

Filter locations by score thresholds across all metros.

Parameters

Name	Type	Required	Default	Description
`metro`	string	No	—	Metro slug filter.
`compositeMin`	int	No	—	Minimum composite score.
`businessMin`	int	No	—	Minimum Business Vitality.
`safetyMin`	int	No	—	Minimum Safety score.
`limit`	int	No	`50`	Max results.

Example Request

curl "https://axiomlocus.io/api/discover?metro=sf&compositeMin=60&safetyMin=50"

Response

Returns ranked locations matching all filter criteria.

{ "total": 12, "results": [{ "h3_index": "...", "metro_slug": "sf", "location_name": "Mission District", "composite": 74 }] }

Response Fields

Field	Type	Description
`total`	number	Number of matching locations
`results[].composite`	number	Composite score 0-100
`results[].location_name`	string	Neighborhood name

GET/api/nearby

Everything we know near a location — permits, POIs, schools, clinical trials, FDA events, zoning.

Parameters

Name	Type	Required	Default	Description
`lat`	float	Yes	—	Latitude.
`lng`	float	Yes	—	Longitude.

Example Request

curl "https://axiomlocus.io/api/nearby?lat=37.7749&lng=-122.4194"

Response

Cross-source facility intelligence query.

{ "summary": { "permits": 45, "pois": 120, "schools": 3, "clinical_trials": 8 }, "recent": { ... } }

Response Fields

Field	Type	Description
`summary`	object	Count of records per data type within ~1km
`recent`	object	Recent records from each data type

GET/api/score-trends

Historical score trends for a metro or specific location.

Parameters

Name	Type	Required	Default	Description
`metro`	string	No	—	Metro slug for aggregate trends.
`h3_index`	string	No	—	Specific H3 cell for detailed trends.
`days`	int	No	`90`	Lookback period.

Example Request

curl "https://axiomlocus.io/api/score-trends?metro=sf&days=30"

Response

Requires score_history to be populated by nightly cron.

{ "metro": "sf", "days": 30, "trend": [{ "date": "2026-03-30", "avg_composite": 42, "cells": 20 }] }

Response Fields

Field	Type	Description
`trend[].date`	string	Snapshot date
`trend[].avg_composite`	number	Average composite score for that date

GET/api/schools

Nearby school quality ratings (1-10 scale).

Parameters

Name	Type	Required	Default	Description
`lat`	float	Yes	—	Latitude.
`lng`	float	Yes	—	Longitude.
`radius`	float	No	`2`	Radius in miles.
`limit`	int	No	`10`	Max results.

Example Request

curl "https://axiomlocus.io/api/schools?lat=37.7749&lng=-122.4194&radius=1"

Response

Uses SchoolDigger when API key is set, falls back to NCES-derived scores.

{ "total": 5, "schools": [{ "name": "Lincoln Elementary", "rating": 8, "enrollment": 450 }] }

Response Fields

Field	Type	Description
`schools[].rating`	number	Quality score 1-10
`schools[].enrollment`	number	Student enrollment

GET/api/life-sciences

Clinical trials and FDA enforcement data by state or sponsor.

Parameters

Name	Type	Required	Default	Description
`state`	string	No	—	US state name.
`sponsor`	string	No	—	Sponsor name (partial match).
`type`	string	No	`all`	Filter: trials, fda, or all.
`limit`	int	No	`50`	Max results.

Example Request

curl "https://axiomlocus.io/api/life-sciences?state=Massachusetts&type=trials&limit=10"

Response

Part of the life sciences vertical overlay.

{ "trials": { "total": 10, "data": [{ "nct_id": "NCT05754281", "sponsor": "Joslin Diabetes Center" }] } }

Response Fields

Field	Type	Description
`trials.data[].nct_id`	string	ClinicalTrials.gov trial ID
`trials.data[].sponsor`	string	Lead sponsor organization

GET/api/zoning

Zoning district rules — allowed uses, height limits, FAR, setbacks.

Parameters

Name	Type	Required	Default	Description
`metro`	string	Yes	—	Metro slug.
`code`	string	No	—	Specific district code.
`category`	string	No	—	Filter: residential, commercial, industrial, mixed_use.

Example Request

curl "https://axiomlocus.io/api/zoning?metro=denver&category=commercial"

Response

Requires zoning data to be loaded via the zoning AI parser.

{ "metro": "denver", "total": 8, "districts": [{ "district_code": "C-MX-5", "max_height_ft": 65, "max_far": 3.0 }] }

Response Fields

Field	Type	Description
`districts[].district_code`	string	Zoning designation code
`districts[].max_height_ft`	number	Maximum building height in feet
`districts[].max_far`	number	Floor area ratio

GET/api/exportAuth Required

Export scored location data as CSV or JSON. Requires Pro or Team plan.

Parameters

Name	Type	Required	Default	Description
`metro`	string	No	—	Metro slug filter.
`format`	string	No	`csv`	csv or json.
`limit`	int	No	`1000`	Max rows (5000 max).

Example Request

curl "https://axiomlocus.io/api/export?metro=sf&format=csv" -H "X-API-Key: al_xxx"

Response

Returns a downloadable CSV file. Requires authenticated Pro/Team user.

h3_index,metro_slug,location_name,composite,...
88283082e7fffff,sf,Mission District,74,...

ML Exports

GET/api/exports/croissantAuth Required

ML-ready dataset metadata in Croissant (schema.org/Dataset) format for use with TensorFlow Datasets, Hugging Face, and other ML frameworks.

Parameters

Name	Type	Required	Default	Description
`dataset`	string	Yes	—	Dataset name: scores, permits, pois, crime, demographics.
`metro`	string	No	—	Metro slug filter.

Example Request

curl "https://axiomlocus.io/api/exports/croissant?dataset=scores&metro=sf" \
  -H "Authorization: Bearer al_your_key_here"

Example Response

{
  "@context": "https://schema.org",
  "@type": "Dataset",
  "name": "axiom-locus-scores-sf",
  "description": "Location intelligence scores for San Francisco metro area",
  "license": "https://axiomlocus.io/terms",
  "distribution": [
    {
      "@type": "DataDownload",
      "encodingFormat": "application/jsonl",
      "contentUrl": "https://axiomlocus.io/api/exports/training-data?dataset=scores&metro=sf&format=jsonl"
    }
  ],
  "variableMeasured": [
    { "name": "composite", "description": "Overall score 0-100" },
    { "name": "businessVitality", "description": "Business vitality signal 0-100" }
  ]
}

Response Fields

Field	Type	Description
`@type`	string	Always 'Dataset' (schema.org).
`distribution`	array	Available download formats and URLs.
`variableMeasured`	array	Feature descriptions for ML consumption.

GET/api/exports/training-dataAuth Required

Download training data in JSONL or CSV format for ML pipelines. Each row is one H3 cell with all features.

Parameters

Name	Type	Required	Default	Description
`dataset`	string	Yes	—	Dataset name: scores, permits, pois, crime, demographics.
`format`	string	No	`jsonl`	Output format: jsonl or csv.
`metro`	string	No	—	Metro slug filter.
`limit`	int	No	`10000`	Max rows (50,000 max for Team plan).
`since`	string	No	—	Only records updated since this ISO date.

Example Request

curl "https://axiomlocus.io/api/exports/training-data?dataset=scores&format=jsonl&metro=sf&limit=1000" \
  -H "Authorization: Bearer al_your_key_here" -o training.jsonl

Response

Returns newline-delimited JSON (JSONL). Each line is one complete JSON object. Use -o to save to file.

{"h3_index": "882a100d63fffff","metro": "sf","composite": 76.2,"businessVitality": 82,"populationMomentum": 71,"demographics": 80,"economicStrength": 74,"developmentPipeline": 78,"accessibility": 69,"safety": 65,"amenity": 72}
{"h3_index": "882a100d65fffff","metro": "sf","composite": 71.8,"businessVitality": 75,"populationMomentum": 68,"demographics": 77,"economicStrength": 70,"developmentPipeline": 72,"accessibility": 65,"safety": 62,"amenity": 69}

Response Fields

Field	Type	Description
`h3_index`	string	H3 cell identifier at resolution 8.
`composite`	float	Overall composite score.
`[signal_group]`	float	Individual signal group scores (8 total).

Monitoring

GET/api/monitorsAuth Required

List your monitored locations.

Example Request

curl "https://axiomlocus.io/api/monitors" \
  -H "Authorization: Bearer YOUR_TOKEN"

Example Response

{
  "monitors": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "name": "Mission District HQ",
      "lat": 37.7599,
      "lng": -122.4148,
      "created_at": "2025-12-01T08: 00: 00Z"
    }
  ]
}

Response Fields

Field	Type	Description
`monitors`	array	Array of monitored location objects.
`monitors[].id`	uuid	Unique monitor identifier.
`monitors[].name`	string	User-provided location name.
`monitors[].lat`	float	Latitude.
`monitors[].lng`	float	Longitude.

POST/api/monitorsAuth Required

Add a new monitored location.

Request Body

Field	Type	Required	Description
`name`	string	Yes	A name for this monitored location.
`lat`	float	Yes	Latitude.
`lng`	float	Yes	Longitude.

{
  "name": "Mission District HQ",
  "lat": 37.7599,
  "lng": -122.4148
}

Example Request

curl -X POST "https://axiomlocus.io/api/monitors" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -d '{"name":"Mission District HQ","lat":37.7599,"lng":-122.4148}'

Example Response

{
  "monitor": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "name": "Mission District HQ",
    "lat": 37.7599,
    "lng": -122.4148,
    "user_id": "...",
    "created_at": "2025-12-01T08: 00: 00Z"
  }
}

Response Fields

Field	Type	Description
`monitor`	object	The newly created monitor object.

DELETE/api/monitorsAuth Required

Remove a monitored location.

Parameters

Name	Type	Required	Default	Description
`id`	uuid	Yes	—	The monitor ID to delete.

Example Request

curl -X DELETE "https://axiomlocus.io/api/monitors?id=550e8400-e29b-41d4-a716-446655440000" \
  -H "Authorization: Bearer YOUR_TOKEN"

Example Response

{
  "success": true
}

Response Fields

Field	Type	Description
`success`	boolean	Whether the deletion succeeded.

GET/api/alerts/historyAuth Required

View alert history for your monitored locations.

Example Request

curl "https://axiomlocus.io/api/alerts/history" \
  -H "Authorization: Bearer YOUR_TOKEN"

Example Response

{
  "alerts": [
    {
      "id": "a1b2c3d4",
      "monitor_id": "550e8400-...",
      "type": "score_change",
      "message": "Composite score dropped from 78 to 65",
      "created_at": "2025-12-15T14: 30: 00Z"
    }
  ]
}

Response Fields

Field	Type	Description
`alerts`	array	Array of alert history objects.
`alerts[].type`	string	Alert type (score_change, source_change, etc.).
`alerts[].message`	string	Human-readable alert description.

Webhooks

POST/api/v1/webhooksAuth Required

Register a webhook to receive real-time notifications when scores change, new permits are filed, or monitored locations trigger alerts.

Request Body

Field	Type	Required	Description
`url`	string	Yes	HTTPS endpoint to receive webhook POST requests.
`events`	array	Yes	Events to subscribe to: score.changed, permit.filed, alert.triggered, monitor.report.
`secret`	string	No	Signing secret for HMAC-SHA256 payload verification.

{
  "url": "https://your-app.com/hooks/axiom",
  "events": ["score.changed", "permit.filed", "alert.triggered"],
  "secret": "whsec_your_signing_secret"
}

Example Request

curl -X POST "https://axiomlocus.io/api/v1/webhooks" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer al_your_key_here" \
  -d '{"url":"https://your-app.com/hooks/axiom","events":["score.changed","permit.filed"]}'

Example Response

{
  "webhook": {
    "id": "wh_abc123def456",
    "url": "https://your-app.com/hooks/axiom",
    "events": ["score.changed", "permit.filed"],
    "active": true,
    "created_at": "2026-03-31T12: 00: 00Z"
  }
}

Response Fields

Field	Type	Description
`webhook.id`	string	Unique webhook identifier (prefixed wh_).
`webhook.events`	array	Subscribed event types.
`webhook.active`	boolean	Whether the webhook is currently active.

GET/api/v1/webhooksAuth Required

List all registered webhooks for your account.

Example Request

curl "https://axiomlocus.io/api/v1/webhooks" \
  -H "Authorization: Bearer al_your_key_here"

Example Response

{
  "webhooks": [
    {
      "id": "wh_abc123def456",
      "url": "https://your-app.com/hooks/axiom",
      "events": ["score.changed", "permit.filed"],
      "active": true,
      "created_at": "2026-03-31T12: 00: 00Z",
      "last_delivery": "2026-03-31T14: 22: 00Z",
      "delivery_success_rate": 0.98
    }
  ]
}

Response Fields

Field	Type	Description
`webhooks`	array	All registered webhook objects.
`webhooks[].delivery_success_rate`	float	Success rate of recent deliveries (0-1).
`webhooks[].last_delivery`	string	Timestamp of last delivery attempt.

DELETE/api/v1/webhooksAuth Required

Delete a webhook registration.

Parameters

Name	Type	Required	Default	Description
`id`	string	Yes	—	Webhook ID (prefixed wh_).

Example Request

curl -X DELETE "https://axiomlocus.io/api/v1/webhooks?id=wh_abc123def456" \
  -H "Authorization: Bearer al_your_key_here"

Example Response

{ "success": true }

Response Fields

Field	Type	Description
`success`	boolean	Whether the webhook was successfully deleted.

Integrations

POST/api/v1/integrations/salesforceAuth Required

Push enriched location data to Salesforce CRM. Creates or updates custom objects with scores, permits, and demographics.

Request Body

Field	Type	Required	Description
`action`	string	Yes	Action: sync, test_connection, or list_objects.
`object_type`	string	No	Salesforce custom object type.
`records`	array	No	Array of location records to sync (required for sync action).

{
  "action": "sync",
  "object_type": "Location__c",
  "records": [
    {
      "address": "123 Market St, San Francisco, CA",
      "lat": 37.7935,
      "lng": -122.3958
    }
  ]
}

Example Request

curl -X POST "https://axiomlocus.io/api/v1/integrations/salesforce" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer al_your_key_here" \
  -d '{"action":"test_connection"}'

Response

Requires Salesforce OAuth connection configured in Settings.

{
  "connected": true,
  "org_id": "00D5f000000XXXX",
  "user": "sam@axiomlocus.io",
  "available_objects": ["Location__c", "Account", "Lead"]
}

Response Fields

Field	Type	Description
`connected`	boolean	Whether the Salesforce connection is active.
`org_id`	string	Salesforce org identifier.

POST/api/v1/keysAuth Required

Create and manage API keys programmatically. Keys are prefixed with al_ and can be scoped to specific endpoints.

Request Body

Field	Type	Required	Description
`action`	string	Yes	Action: create, list, or revoke.
`name`	string	No	Human-readable key name (required for create).
`scopes`	array	No	Endpoint scopes. Omit for full access.
`key_id`	string	No	Key ID to revoke (required for revoke action).

{
  "action": "create",
  "name": "Production Key",
  "scopes": ["score", "enrich", "permits"]
}

Example Request

curl -X POST "https://axiomlocus.io/api/v1/keys" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer al_your_key_here" \
  -d '{"action":"create","name":"Production Key","scopes":["score","enrich"]}'

Response

The full token is only returned on creation. Store it securely.

{
  "key": {
    "id": "key_abc123",
    "name": "Production Key",
    "token": "al_live_abc123def456ghi789",
    "scopes": ["score", "enrich"],
    "created_at": "2026-03-31T12: 00: 00Z"
  }
}

Response Fields

Field	Type	Description
`key.id`	string	Key identifier for management operations.
`key.token`	string	Full API key (only shown once on creation).
`key.scopes`	array	Endpoint scopes this key can access.

Reports

GET/api/reportAuth Required

Generate a branded PDF location report.

Parameters

Name	Type	Required	Default	Description
`lat`	float	Yes	—	Latitude.
`lng`	float	Yes	—	Longitude.
`name`	string	No	`Location Report`	Report title / location name.
`profile`	string	No	`general`	Scoring profile.
`client`	string	No	`Client`	Client name for the report header.

Example Request

curl "https://axiomlocus.io/api/report?lat=37.7749&lng=-122.4194&name=Mission+District" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -o report.pdf

Response

Returns a PDF binary. Use -o to save to a file.

# Binary PDF response
Content-Type: application/pdf
Content-Disposition: attachment; filename="axiom-locus-report-mission-district.pdf"

GET/api/places-photo

Proxy for business photos.

Parameters

Name	Type	Required	Default	Description
`ref`	string	Yes	—	Photo reference string from POI data.
`w`	int	No	`100`	Image width in pixels.

Example Request

curl "https://axiomlocus.io/api/places-photo?ref=Aap_uE...&w=200" -o photo.jpg

Response

Returns a JPEG image binary.

# Binary JPEG response
Content-Type: image/jpeg

Interactive

Try It

Enter coordinates to see a live response from the scoring API. Rate limits apply.