> ## Documentation Index
> Fetch the complete documentation index at: https://docs.axiomancer.io/llms.txt
> Use this file to discover all available pages before exploring further.

# API overview

> Authentication, access tiers, rate limits, and conventions for the Axiom Locus REST API — the programmatic interface to cell scoring and territory intelligence.

The Axiom Locus API exposes 35+ endpoints for location intelligence — composite scoring, POIs, permits, traffic, jobs, predictions, ML exports, monitoring, and PDF report generation.

## Base URL

```
https://axiomlocus.io
```

(All endpoints are mounted directly under `/api/...` — there is no version prefix yet.)

## Authentication

The free tier `GET /api/score` and `GET /api/pois` work without auth. All other endpoints — bulk operations, webhooks, monitoring, PDF generation, ML exports — require a Bearer token:

```bash theme={null}
curl -H "Authorization: Bearer YOUR_TOKEN" \
  https://axiomlocus.io/api/bulk-score \
  -H "Content-Type: application/json" \
  -d '{"locations":[{"lat":37.77,"lng":-122.41}]}'
```

Generate tokens in **Settings → API Keys** in the Locus dashboard.

## Plans and access tiers

Locus is sold as part of the cross-product Axiom Platform. The plan you're on determines daily API call limits, which endpoint families are unlocked, and how many API keys and team members you can provision. See the [full pricing page](https://axiomlocus.io/pricing) for the latest list, including features that overlap with Overwatch (maritime) and Codex (data normalization).

| Plan         | Price         | API calls / day | API keys  | Team members |
| ------------ | ------------- | --------------- | --------- | ------------ |
| Explorer     | Free          | 50              | 1         | 1            |
| Analyst      | \$49/mo       | 500             | 1         | 1            |
| Professional | \$199/mo      | 5,000           | 1         | 1            |
| Team         | \$599/mo      | 25,000          | Multiple  | Unlimited    |
| Enterprise   | Contact sales | 100,000         | Unlimited | Unlimited    |

All paid plans include a 14-day free trial. Explorer requires no credit card.

### What unlocks at each tier

The free Explorer tier covers the unauthenticated reads (`GET /api/score`, `GET /api/pois`) and the Explorer map across all 22 metros — enough to evaluate a single location end-to-end. Paid tiers gate more advanced endpoints and exports:

* **Analyst** — 8 signal-group breakdowns on `/api/score`, [`/api/neighborhood-score-detailed`](/locus/api/location-data#post-apineighborhood-score-detailed), compare mode, heatmap overlays, and the full top 25 of composite [rankings](/locus/mcp-server) (the free tier shows only the top 3 rows of composite-tier lists).
* **Professional** — full 43-source enrichment, [webhooks](/locus/api/webhooks), score history and trends, congestion forecasting, sanctions screening, and government bid monitoring.
* **Team** — bulk CSV/JSON exports, [scheduled exports](/locus/api/scheduled-exports), [ML exports](/locus/api/ml-exports) (Croissant format), the [MCP server](/locus/mcp-server) with 32+ tools, and trade-flow analytics. Team is the entry point for shared workspaces.
* **Enterprise** — custom integrations, white-label PDF [reports](/locus/api/reports), cross-domain dashboards spanning Locus and Overwatch, dedicated SLA, and named account management.

When you exceed your tier's daily call limit the API returns `429 Too Many Requests` with a `Retry-After` header set to the seconds remaining until the next UTC midnight reset. Bulk endpoints count each location in a `locations[]` array as one call against your limit.

### Choosing a tier

Pick **Explorer** for ad-hoc lookups, demos, and prototyping a single integration. Move to **Analyst** as soon as you need signal-group breakdowns or are scoring more than \~50 locations a day. **Professional** is the right starting point for production use cases that depend on enrichment, webhooks, or score history. Choose **Team** when you need bulk exports, the MCP server, or more than one operator on the account. **Enterprise** is for custom data integrations and SLA-backed deployments.

```bash theme={null}
# Inspect the rate-limit headers on any authenticated request
curl -i -H "Authorization: Bearer YOUR_TOKEN" \
  "https://axiomlocus.io/api/score?lat=37.7749&lng=-122.4194"

# Response headers include:
#   X-RateLimit-Limit:     5000
#   X-RateLimit-Remaining: 4982
#   X-RateLimit-Reset:     1714435200
```

To upgrade, downgrade, or view current usage, open **Settings → Billing** in the Locus dashboard. Plan changes take effect immediately, and rate limits switch to the new tier on the next request.

## Scoring profiles

The composite score and many endpoints accept a `profile` 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.                    |
| `data_center`  | Data center siting — emphasis on broadband, power infrastructure, environmental risk.           |
| `industrial`   | Industrial and logistics — emphasis on road accessibility, workforce availability, zoning.      |

## Confidence

Every score includes a `confidence` 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:

1. **Business Vitality** (`businessVitality`) — net openings, category diversity, rating trajectory, license velocity, pioneer business presence
2. **Population Momentum** (`populationMomentum`) — net migration, income migration, population growth, vacancy trend
3. **Demographics** (`demographics`) — median income, population density, daytime population ratio, education, median age
4. **Economic Strength** (`economicStrength`) — employment growth, average wages, GDP growth, banking activity, small business lending
5. **Development Pipeline** (`developmentPipeline`) — permit activity, construction detection, land cover change, opportunity zones, permit velocity, permit valuation tier, permit scope quality
6. **Accessibility** (`accessibility`) — transit access, walkability, traffic flow, broadband, EV infrastructure, cell coverage
7. **Safety & Environment** (`safetyEnvironment`) — crime rate, flood risk (FEMA FIRM zones), flood loss history (FEMA NFIP claims), environmental risk, air quality, complaint density
8. **Amenity Demand** (`amenityDemand`) — job market, event density, school quality, food access, demand intent, competitive gravity

Use `GET /api/score` for the composite. Use the per-signal endpoints (`/api/pois`, `/api/permits`, `/api/traffic`, `/api/jobs`) for raw data.

## Quick start

```bash theme={null}
# 1. Score a single location (no auth)
curl "https://axiomlocus.io/api/score?lat=37.7749&lng=-122.4194"

# 2. Find nearby points of interest
curl "https://axiomlocus.io/api/pois?lat=37.7749&lng=-122.4194&radius=0.5"

# 3. Score 50 locations in a single bulk request (auth required)
curl -X POST -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"locations":[{"lat":37.77,"lng":-122.41},{"lat":34.05,"lng":-118.24}]}' \
  https://axiomlocus.io/api/bulk-score
```

## Where to from here

<Columns cols={2}>
  <Card title="Core Scoring" href="/locus/api/core-scoring">`/api/score` and bulk scoring</Card>
  <Card title="Location Data" href="/locus/api/location-data">POIs, permits, traffic, jobs</Card>
  <Card title="Predictions" href="/locus/api/predictions">Forward-looking territory forecasts</Card>
  <Card title="Reports" href="/locus/api/reports">Generate branded PDF reports</Card>
</Columns>
