AddressQA Edge REST API & OpenAPI Reference

Stateless, CORS-enabled deterministic fixture and validation endpoints powered by Cloudflare Pages Functions. Download the machine-readable OpenAPI 3.1.0 schema below.

Download /openapi.json Open Workbench
Endpoint 01 · Deterministic Fixtures

GET /api/v1/fixtures

Query Parameters for GET /api/v1/fixtures
Parameter Default Allowed Values & Behavior
country US Any of 24 ISO codes or route slugs (US, GB/UK, JP, CA, DE, FR, AU, TW, SG, HK, KR, etc.)
state ALL Subdivision or US state code (DE, OR, NH, MT, AK, CA, NY, ON) or ALL
taxFree false When true with country=US, restricts pool to DE, OR, NH, MT, AK
phoneMode safe safe | mobile | landline | tollfree
boundary normal normal | leading_zero | long_street | unicode | punctuation_name | unit_suite
count 1 Integer 1..50
seed qa-checkout-01 Any deterministic Mulberry32 seed string
format json json | stripe | playwright | sql | csv
# 1. Fetch 3 deterministic New Hampshire leading-zero tax-free fixtures as JSON
curl -sS "https://addressqa.com/api/v1/fixtures?country=US&state=NH&boundary=leading_zero&count=3&seed=qa-nh-01" | jq .

# 2. Fetch ready-to-use Stripe Checkout payload for Delaware
curl -sS "https://addressqa.com/api/v1/fixtures?country=US&state=DE&seed=qa-stripe-de&format=stripe"

# 3. Export Excel-safe RFC 4180 CSV
curl -sS "https://addressqa.com/api/v1/fixtures?country=US&taxFree=true&count=10&format=csv" -o taxfree.csv
Endpoint 02 · Format Diagnostics

GET / POST /api/v1/validate

# GET query validation
curl -sS "https://addressqa.com/api/v1/validate?country=JP&postal=%E3%80%92%EF%BC%91%EF%BC%95%EF%BC%90%EF%BC%8D%EF%BC%90%EF%BC%90%EF%BC%90%EF%BC%91&phone=090-0000-4120" | jq .

# POST JSON validation
curl -sS -X POST "https://addressqa.com/api/v1/validate" \
  -H "Content-Type: application/json" \
  -d '{"country":"GB","postal":"SW1A 1AA","phone":"07700 900123"}' | jq .
FAQ

Edge API FAQ

Does /api/v1/fixtures require an API key or authentication token?
No. Both /api/v1/fixtures and /api/v1/validate are CORS-enabled public Edge endpoints on Cloudflare Pages Functions suitable for CI scripts and local developer tooling.
What serialization formats does GET /api/v1/fixtures support?
Pass format=json (default), format=stripe, format=playwright, format=sql, or format=csv (RFC 4180 Excel-safe with UTF-8 BOM and leading-zero guards).