Page Comparison

...

Performing this request will return JSON formatted results with all the first N addresses contained within that postcode (N being the pagesize, in this case 10).

Code Block

{
    "name": "tempLocSearch",
    "columns": [
        "UniqueId",
        "Parent",
        "DisplayName",
        "Type",
        "X",
        "Y",
        "Rank",
        "Name",
        "Zoom",
        "bs7666_organisation",
        "bs7666_sao_text",
        "bs7666_sao_start_number",
        "bs7666_sao_start_suffix",
        "bs7666_sao_end_number",
        "bs7666_sao_end_suffix",
        "bs7666_pao_text",
        "bs7666_pao_start_number",
        "bs7666_pao_start_suffix",
        "bs7666_pao_end_number",
        "bs7666_pao_end_suffix",
        "bs7666_street_description",
        "bs7666_locality",
        "bs7666_town_name",
        "bs7666_administrative_area",
        "bs7666_postcode_locator",
        "bs7666_saon",
        "bs7666_paon",
        "local_custodian_code",
        "authority"
    ],
    "data": [ 
        [ "10033529251", "8401123", "Bay Oil Supply Co Ltd, Baker Street, London, NW1 6XE", "Property", "527845", "182149", "15%", "Bay Oil Supply Co Ltd, Baker Street, London, NW1 6XE", "100", "", "", "", "", "", "", "BAY OIL SUPPLY CO LTD", "", "", "", "", "BAKER STREET", "", "LONDON", "", "NW1 6XE", "", "BAY OIL SUPPLY CO LTD", "5990", "City of Westminster" ] , 
        [ "10033619968", "8401123", "Sweet & Liberty, 215 Baker Street, London, NW1 6XE", "Property", "527870.4", "182081.17", "15%", "Sweet & Liberty, 215 Baker Street, London, NW1 6XE", "100", "SWEET & LIBERTY", "", "", "", "", "", "", "215", "", "", "", "BAKER STREET", "", "LONDON", "", "NW1 6XE", "", "215", "5990", "City of Westminster" ] , 
        [ "10033619969", "8401123", "219 Baker Street, London, NW1 6XE", "Property", "527868.08", "182090.78", "23%", "219 Baker Street, London, NW1 6XE", "100", "", "", "", "", "", "", "", "219", "", "", "", "BAKER STREET", "", "LONDON", "", "NW1 6XE", "", "219", "5990", "City of Westminster" ] , 
        [ "10033619971", "8401123", "Flat 1, 219 Baker Street, London, NW1 6XE", "Property", "527868.08", "182090.78", "19%", "Flat 1, 219 Baker Street, London, NW1 6XE", "100", "", "FLAT 1", "", "", "", "", "", "219", "", "", "", "BAKER STREET", "", "LONDON", "", "NW1 6XE", "FLAT 1", "219", "5990", "City of Westminster" ] , 
        [ "10033619980", "8401123", "Flat 10, 219 Baker Street, London, NW1 6XE", "Property", "527868.08", "182090.78", "19%", "Flat 10, 219 Baker Street, London, NW1 6XE", "100", "", "FLAT 10", "", "", "", "", "", "219", "", "", "", "BAKER STREET", "", "LONDON", "", "NW1 6XE", "FLAT 10", "219", "5990", "City of Westminster" ] , 
        [ "10033619981", "8401123", "Flat 11, 219 Baker Street, London, NW1 6XE", "Property", "527868.08", "182090.78", "19%", "Flat 11, 219 Baker Street, London, NW1 6XE", "100", "", "FLAT 11", "", "", "", "", "", "219", "", "", "", "BAKER STREET", "", "LONDON", "", "NW1 6XE", "FLAT 11", "219", "5990", "City of Westminster" ] , 
        [ "10033619982", "8401123", "Flat 12, 219 Baker Street, London, NW1 6XE", "Property", "527868.08", "182090.78", "19%", "Flat 12, 219 Baker Street, London, NW1 6XE", "100", "", "FLAT 12", "", "", "", "", "", "219", "", "", "", "BAKER STREET", "", "LONDON", "", "NW1 6XE", "FLAT 12", "219", "5990", "City of Westminster" ] , 
        [ "10033619983", "8401123", "Flat 13, 219 Baker Street, London, NW1 6XE", "Property", "527868.08", "182090.78", "19%", "Flat 13, 219 Baker Street, London, NW1 6XE", "100", "", "FLAT 13", "", "", "", "", "", "219", "", "", "", "BAKER STREET", "", "LONDON", "", "NW1 6XE", "FLAT 13", "219", "5990", "City of Westminster" ] , 
        [ "10033619984", "8401123", "Flat 14, 219 Baker Street, London, NW1 6XE", "Property", "527868.08", "182090.78", "19%", "Flat 14, 219 Baker Street, London, NW1 6XE", "100", "", "FLAT 14", "", "", "", "", "", "219", "", "", "", "BAKER STREET", "", "LONDON", "", "NW1 6XE", "FLAT 14", "219", "5990", "City of Westminster" ] , 
        [ "10033619985", "8401123", "Flat 15, 219 Baker Street, London, NW1 6XE", "Property", "527868.08", "182090.78", "19%", "Flat 15, 219 Baker Street, London, NW1 6XE", "100", "", "FLAT 15", "", "", "", "", "", "219", "", "", "", "BAKER STREET", "", "LONDON", "", "NW1 6XE", "FLAT 15", "219", "5990", "City of Westminster" ] 
    ], 
    "total": 111 
}

Input Parameters

The following Parameters can be passed into the Search Requests:

Parameter Name	Requirement	Description
`pagesize`	mandatory	This is the number of results that you wish to return
`startnum`	mandatory	This would be 1 the first time that you made a call and then, if the maximum number of results requested were returned you would then make another call with the same information only specifying a startnum = pagesize +1 etc.
`location`	mandatory	The address that you wish to search for or a UPRN. In the above example we wish to return all addresses that contain NW1 6XE
`gettotals`	optional	`false` (default) or `true` : Whether to include the total number of results returned by the search, requests with totals will be significantly slower. When false, the search will still include the `totals` field, but with a value of `0` (zero).

Output Columns

The following columns are returned in the results

Name	Description
`UniqueId`	The Unique Property Reference Number (UPRN) from Address Base
`Parent`	The Unique Street Reference Number (USRN) from Address Base for the street the address is located on.
`DisplayName`	The formatted address string. Display name includes a <b> HTML element to highlight the input search term.
`Type`	The type of address.
`X`	The Easting in British National Grid coordinates
`Y`	The Northing in British National Grid coordinates
`Rank`	The accuracy of the match. The higher the higher the percentage match of output string to input string
`Name`	The formatted address string.
`Zoom`	A zoom level. This can be ignored (as it is included for historic reasons) and for the national search which will always return 100.
BS7666 fields	Standard BS7666 fields are also returned with the results: `bs7666_organisation` `bs7666_sao_text` `bs7666_sao_start_number` `bs7666_sao_start_suffix` `bs7666_sao_end_number` `bs7666_sao_end_suffix` `bs7666_pao_text` `bs7666_pao_start_number` `bs7666_pao_start_suffix` `bs7666_pao_end_number` `bs7666_pao_end_suffix` `bs7666_street_description` `bs7666_locality` `bs7666_town_name` `bs7666_administrative_area` `bs7666_postcode_locator` `bs7666_saon` `bs7666_paon`

Other Examples

Using Postcode

...

Versions Compared

Old Version 4

New Version 5

Key

Input Parameters

Output Columns

Other Examples

Using Postcode