US Address SaaS Working name
Developer preview. The API is not available. Everything on these pages describes a local prototype that returns simulated data; no real address data provider is connected.
Local prototype · simulated data

System API

Operational endpoints.

GET /health

Liveness check

Local prototype · simulated data

Authentication

No API key. Requests must come from an allowed website origin and are rate-limited per client.

Responses

  • 200 Service is running.
  • 429 Rate limit exceeded. — Error
Response fields (200)
Response fields
FieldTypeRequiredDescription
statusstring (always "ok")Yes
sourceenum: "simulated", "live"Yes

simulated for mock data. live is reserved and is never produced by this version.

Example

cURL
curl "http://localhost:8787/health"
JavaScript
// Server-side (Node 18+). Never ship a secret key to a browser.
const res = await fetch("http://localhost:8787/health");
const body = await res.json();
if (!res.ok) throw new Error(body.error.code);
Python
import requests

res = requests.get(
    "http://localhost:8787/health",
    timeout=10,
)
res.raise_for_status()
print(res.json())

Response 200 from the local prototype (simulated data):

JSON
{
  "status": "ok",
  "source": "simulated"
}

US Address SaaS is a working project name, not a registered company or trademark. All data shown is simulated.