{
  "info": {
    "name": "HomePortfolio Property Intelligence API",
    "description": "Complete UK property intelligence — 435M+ data points, 379 fields per property, 15+ official government sources.\n\nhttps://api.homeportfolio.com",
    "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json",
    "_exporter_id": "homeportfolio"
  },
  "auth": {
    "type": "apikey",
    "apikey": [
      {"key": "key", "value": "X-API-Key", "type": "string"},
      {"key": "value", "value": "{{api_key}}", "type": "string"},
      {"key": "in", "value": "header", "type": "string"}
    ]
  },
  "variable": [
    {"key": "base_url", "value": "https://api.homeportfolio.com", "type": "string"},
    {"key": "api_key", "value": "YOUR_API_KEY_HERE", "type": "string"},
    {"key": "uprn", "value": "100030048320", "type": "string"}
  ],
  "item": [
    {
      "name": "Property Lookup",
      "item": [
        {
          "name": "Full Property Intelligence",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{base_url}}/v1/property/{{uprn}}",
              "host": ["{{base_url}}"],
              "path": ["v1", "property", "{{uprn}}"]
            },
            "description": "Returns all 379 fields across 19 intelligence sections for a single property. Includes valuation, EPC, risk, demographics, crime, schools, broadband, mobile, planning, ownership, and more."
          }
        },
        {
          "name": "Property Section — Valuation",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{base_url}}/v1/property/{{uprn}}/valuation",
              "host": ["{{base_url}}"],
              "path": ["v1", "property", "{{uprn}}", "valuation"]
            },
            "description": "Returns only the valuation section (27 fields): AVM estimate, confidence band, rental yield, comparable sales, area averages."
          }
        },
        {
          "name": "Property Section — EPC",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{base_url}}/v1/property/{{uprn}}/epc",
              "host": ["{{base_url}}"],
              "path": ["v1", "property", "{{uprn}}", "epc"]
            },
            "description": "Returns EPC energy performance data (24 fields): ratings, efficiency scores, heating type, insulation, recommendations."
          }
        },
        {
          "name": "Property Section — Risk",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{base_url}}/v1/property/{{uprn}}/risk",
              "host": ["{{base_url}}"],
              "path": ["v1", "property", "{{uprn}}", "risk"]
            },
            "description": "Returns risk intelligence (12 fields): flood zones, radon, subsidence, noise, air quality."
          }
        },
        {
          "name": "Property Section — Crime",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{base_url}}/v1/property/{{uprn}}/crime",
              "host": ["{{base_url}}"],
              "path": ["v1", "property", "{{uprn}}", "crime"]
            },
            "description": "Returns neighbourhood crime data (14 fields): rates by category, trends, safety scores."
          }
        }
      ]
    },
    {
      "name": "Search",
      "item": [
        {
          "name": "Text Search (Address)",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{base_url}}/v1/search?q=10 Downing Street London&limit=5",
              "host": ["{{base_url}}"],
              "path": ["v1", "search"],
              "query": [
                {"key": "q", "value": "10 Downing Street London"},
                {"key": "limit", "value": "5"}
              ]
            },
            "description": "Search for properties by address text. Returns matched addresses with UPRNs."
          }
        },
        {
          "name": "Postcode Search",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{base_url}}/v1/search?postcode=SW1A 2AA&limit=10",
              "host": ["{{base_url}}"],
              "path": ["v1", "search"],
              "query": [
                {"key": "postcode", "value": "SW1A 2AA"},
                {"key": "limit", "value": "10"}
              ]
            },
            "description": "Search for properties by UK postcode. Returns all addresses in that postcode."
          }
        },
        {
          "name": "Spatial Search (Lat/Lon)",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{base_url}}/v1/search?lat=51.5074&lon=-0.1278&radius=500&limit=20",
              "host": ["{{base_url}}"],
              "path": ["v1", "search"],
              "query": [
                {"key": "lat", "value": "51.5074"},
                {"key": "lon", "value": "-0.1278"},
                {"key": "radius", "value": "500"},
                {"key": "limit", "value": "20"}
              ]
            },
            "description": "Search for properties within a radius (metres) of a geographic point."
          }
        }
      ]
    },
    {
      "name": "Area Intelligence",
      "item": [
        {
          "name": "Area Stats by Postcode",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{base_url}}/v1/area/SW1A 2AA",
              "host": ["{{base_url}}"],
              "path": ["v1", "area", "SW1A 2AA"]
            },
            "description": "Returns area-level intelligence for a postcode: demographics, crime summary, average prices, school ratings, broadband speeds."
          }
        }
      ]
    },
    {
      "name": "Compare & Bulk",
      "item": [
        {
          "name": "Compare Properties",
          "request": {
            "method": "POST",
            "header": [{"key": "Content-Type", "value": "application/json"}],
            "body": {
              "mode": "raw",
              "raw": "{\n  \"uprns\": [\"100030048320\", \"100030048321\"]\n}"
            },
            "url": {
              "raw": "{{base_url}}/v1/compare",
              "host": ["{{base_url}}"],
              "path": ["v1", "compare"]
            },
            "description": "Compare two or more properties side by side. Returns key fields for each property."
          }
        },
        {
          "name": "Bulk Lookup (up to 100)",
          "request": {
            "method": "POST",
            "header": [{"key": "Content-Type", "value": "application/json"}],
            "body": {
              "mode": "raw",
              "raw": "{\n  \"uprns\": [\"100030048320\", \"100030048321\", \"100030048322\"]\n}"
            },
            "url": {
              "raw": "{{base_url}}/v1/bulk",
              "host": ["{{base_url}}"],
              "path": ["v1", "bulk"]
            },
            "description": "Batch lookup up to 100 UPRNs in a single request. Pro plan and above."
          }
        }
      ]
    },
    {
      "name": "System",
      "item": [
        {
          "name": "API Stats",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{base_url}}/v1/stats",
              "host": ["{{base_url}}"],
              "path": ["v1", "stats"]
            },
            "description": "Returns database statistics: total records, table counts, data freshness."
          }
        },
        {
          "name": "Health Check",
          "request": {
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{base_url}}/health",
              "host": ["{{base_url}}"],
              "path": ["health"]
            },
            "description": "Service health check — DB connectivity, Redis status, uptime."
          }
        }
      ]
    }
  ]
}