Simple Search

List results for selected metrics

Endpoint: /api/mapSearches/:postcode

Request

Parameter Type Position Required Sample
Content-Type string Header Yes application/json
Accept string Header Yes application/json
Authorization string Header Yes Bearer eyJ0eXAiOiJKV1QiLCJhbGci...
query json Body Yes JSON.stringify('[{"metric":"air_quality", "years":["2017"]}]')

Success Response 

{
    "data": {
        "Details": {
            "Postcode": "BR1 1AA",
            "Longitude": "0.015415",
            "Latitude": "51.401546",
            "X": "1715.964796",
            "Y": "6692632.222",
            "Ward": "Bromley Town",
            "District": "Bromley",
            "Area Guide": "https://s3.us-east-2.amazonaws.com..."
        },
        "Air Quality": {
            "year_2017": {
                "metric_type": "normal",
                "metric_description": "Walulel's Air Quality Metric lets you know how clean the air is in your area",
                "show_marker": false,
                "summary": {
                    "Air Quality": {
                        "max": "18.39",
                        "min": "9.67"
                    },
                    "Harmonised Score": {
                        "max": "100",
                        "min": "1"
                    },
                    "Borough Median Air Quality": {
                        "max": "17.14",
                        "min": "10.41"
                    },
                    ...
                },
                "actual": [
                    {
                        "Air Quality": "12.41",
                        "Harmonised Score": "68.91",
                        "Borough Median Air Quality": "12.08",
                        ...
                    }
                ]
            }
        }
    }
}