Property Rich List

Description: Retrieve richlist values for a specific area.
Access URI: https://api.zoopla.co.uk/api/v1/richlist

Input parameters

In addition to the standard area location parameters, the input parameters detailed below are also accepted.

Key name Description
area_type Type of list to request, which depends on the value of output_type below. If "output_type" is county and "area_type" is "street" then the list produced will be streets within the county. Valid values are below:
Value of output_type Possible values for area_type
outcode
  • streets
  • postcodes
area
  • streets
  • postcodes
town
  • streets
  • outcodes
county
  • areas
  • outcodes
  • streets
  • towns
country
  • areas
  • counties
  • outcodes
  • streets
  • towns

Generated output

In addition to the standard are location parameters, the output parameters detailed below are also generated.

Key name Description
richlist_url A link to the appropriate richlist page on www.zoopla.co.uk.
highest List of top 20 in descending order by average Zed-Index estimate, each item consisting of:
Key name Description
name Name associated with the type of output list request, e.g. requesting "streets" may produce "Downing Street".
zed_index Zed-Index estimate in GBP.
details_url A link to the appropriate page of www.zoopla.co.uk
lowest List of top 20 in ascending order by average Zed-Index estimate, each item consisting of:
Key name Description
name Name associated with the type of output list request, e.g. requesting "streets" may produce "Downing Street".
zed_index Zed-Index estimate in GBP.
details_url A link to the appropriate page of www.zoopla.co.uk.

Example XML output

<response>

    <area_name>Victoria Road, London NW10</area_name> 

    <street>Victoria Road</street> 

    <town>London</town> 

    <!-- this method only produces an outcode for postcode --> 

    <postcode>NW10</postcode> 

    <county>London</county> 

    <country>England</country> 

    <richlist_url>http://www.zoopla.co.uk/...</richlist_url> 

    <highest> 

        <name>Some Street</name> 

        <zed_index>123456</zed_index> 

        <details_url>http://www.zoopla.co.uk/...</details_url> 

    </highest> 

    <!-- more <highest> elements appear ... --> 

    <lowest> 

        <name>Some Street</name> 

        <zed_index>123456</zed_index> 

        <details_url>http://www.zoopla.co.uk/...</details_url> 

    </lowest> 

    <!-- more <lowest> elements appear ... --> 


<response>

Example JSON output

{ 

    "area_name":"Victoria Road, London NW10", 

    "street":"Victoria Road", 

    "town":"London", 

    "postcode":"NW10", 

    "county":"London", 

    "country":"England", 

    "richlist_url":"http://www.zoopla.co.uk/...", 

    "highest":[ 

        {

            "name":"Some Street", 

            "zed_index":"123456", 

            "details_url":"http://www.zoopla.co.uk/...", 

        }, 

    ], 

    "lowest":[ 

        { 

            "name":"Some Street", 

            "zed_index":"12345", 

            "details_url":"http://www.zoopla.co.uk/...", 

        }, 

    ], 

}