Rival Mode

Returns Dataset values for postcode's nearest neighbours

Endpoint: /api/rivalSearch/: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": "Sold Prices","metric_year": "2019","index": "0"}]')

Success Response 

{
    "data": {
        "Average Transfer Price for a Flat Property": {
            "five_nearest": "270998.26",
            "ten_nearest": "275379.76",
            "twenty_nearest": "286733.01",
            "fifty_nearest": "302548.01"
        },
        "Median Transfer Price for a Flat Property": {
            "five_nearest": "412008.39",
            "ten_nearest": "489949.82",
            "twenty_nearest": "344291.76",
            "fifty_nearest": "282277.43"
        },
        "Average Transfer Price for a Terrace Property": {
            "five_nearest": "510625.71",
            "ten_nearest": "506247.67",
            "twenty_nearest": "497093.41",
            "fifty_nearest": "523460.64"
        }
        ...
    }
}