AreaIQ API

Authorization: Bearer aiq_your_api_key_here

{
  "id": "rpt_1709834567_a1b2c3",
  "report": {
    "area": "Shoreditch, London",
    "intent": "business",
    "areaiq_score": 74,
    "sub_scores": [
      {
        "label": "Foot Traffic & Demand",
        "score": 82,
        "summary": "45,000 daily commuters via Liverpool Street station. 23 restaurants within 500m suggests strong baseline footfall."
      },
      {
        "label": "Competition Landscape",
        "score": 68,
        "summary": "High density of similar businesses in EC2A. 12 direct competitors identified within 1km radius."
      },
      {
        "label": "Transport Accessibility",
        "score": 79,
        "summary": "4 tube/rail stations within 15-minute walk. Bus routes along Old Street and Shoreditch High Street."
      },
      {
        "label": "Spending Power",
        "score": 71,
        "summary": "IMD decile 6 for income. Mixed demographic with high disposable income among tech workers."
      },
      {
        "label": "Operating Costs",
        "score": 62,
        "summary": "Commercial rents averaging £55-70/sqft. Above London average but justified by footfall density."
      }
    ],
    "summary": "Shoreditch scores 74/100 for business viability. Strong foot traffic and transport links offset higher operating costs. The area's tech-driven economy creates consistent demand.",
    "sections": [
      {
        "title": "Location & Demographics",
        "content": "Shoreditch sits within the London Borough of Hackney...",
        "data_points": [
          { "label": "Ward", "value": "Hoxton East & Shoreditch" },
          { "label": "Constituency", "value": "Hackney South and Shoreditch" },
          { "label": "IMD Decile", "value": "6 (mid-range)" }
        ]
      },
      {
        "title": "Safety & Crime",
        "content": "276 crimes recorded in the last 3 months within 1 mile...",
        "data_points": [
          { "label": "Total crimes (3 months)", "value": "276" },
          { "label": "Most common", "value": "Theft (34%)" },
          { "label": "Trend", "value": "Stable" }
        ]
      }
    ],
    "recommendations": [
      "Consider locations east of Shoreditch High Street for 15-20% lower rents with comparable footfall",
      "Target the lunch trade: 45,000 weekday commuters create peak demand 12:00-14:00",
      "Monitor the Bishopsgate Goodsyard redevelopment for potential uplift in foot traffic by 2027"
    ],
    "data_sources": [
      "postcodes.io",
      "police.uk",
      "IMD 2025",
      "OpenStreetMap",
      "Environment Agency",
      "HM Land Registry",
      "Ofsted"
    ],
    "generated_at": "2026-03-07T12:34:56.789Z"
  }
}

// Error response format
{
  "error": "Missing required field: area (string)"
}

<!-- Add this where you want the widget to appear -->
<div
  data-areaiq-postcode="SW1A 1AA"
  data-areaiq-intent="moving"
></div>

<!-- Add this before </body> -->
<script src="https://www.area-iq.co.uk/widget.js"></script>

<div data-areaiq-postcode="E1 6AN" data-areaiq-intent="investing"></div>
<div data-areaiq-postcode="SW11 1AA" data-areaiq-intent="moving"></div>
<div data-areaiq-postcode="M1 1AD" data-areaiq-intent="business" data-areaiq-theme="light"></div>

<script src="https://www.area-iq.co.uk/widget.js"></script>

curl -X POST https://www.area-iq.co.uk/api/v1/report \
  -H "Authorization: Bearer aiq_your_api_key" \
  -H "Content-Type: application/json" \
  -d '{
    "area": "Shoreditch",
    "intent": "business"
  }'

const response = await fetch("https://www.area-iq.co.uk/api/v1/report", {
  method: "POST",
  headers: {
    "Authorization": "Bearer aiq_your_api_key",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    area: "Camden",
    intent: "investing",
  }),
});

const { id, report } = await response.json();

console.log(report.areaiq_score);       // 72
console.log(report.sub_scores.length);  // 5
console.log(report.recommendations);    // ["Consider...", ...]

import requests

response = requests.post(
    "https://www.area-iq.co.uk/api/v1/report",
    headers={"Authorization": "Bearer aiq_your_api_key"},
    json={"area": "Camden", "intent": "investing"},
)

data = response.json()
report = data["report"]

print(f"Score: {report['areaiq_score']}/100")
print(f"Dimensions: {len(report['sub_scores'])}")

for sub in report["sub_scores"]:
    print(f"  {sub['label']}: {sub['score']}/100")

payload := map[string]string{
    "area":   "Manchester",
    "intent": "moving",
}

body, _ := json.Marshal(payload)
req, _ := http.NewRequest("POST", "https://www.area-iq.co.uk/api/v1/report", bytes.NewBuffer(body))
req.Header.Set("Authorization", "Bearer aiq_your_api_key")
req.Header.Set("Content-Type", "application/json")

resp, _ := http.DefaultClient.Do(req)
defer resp.Body.Close()

var result map[string]interface{}
json.NewDecoder(resp.Body).Decode(&result)