Finder Mode

Find postcodes that fall within a set of specified parameters

Endpoint: /api/finderMode

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('[{ "dataset": "Air Quality", "max_range": "15", "metric": "Air Quality", "metric_year": "2017", "min_range": "2" }]')

Success Response

{
    "Message": "Finder endpoint called.",
    "Data": [
        {
            "Postcodes": "{"EN10 7AY","BR1 1AE","BR1 1BW","BR1 1DD","BR1 1DJ","BR1 1DS"...}
        }
    ] 
}