NAV Navbar
shell
  • Introduction
  • Match API
  • Intelligence API
  • Data Dictionary
  • Lookup Tables
  • General
  • Errors
  • Introduction

    Addresscloud helps organisations in the UK and Ireland unlock the power of location in their data to better understand their customers and evaluate risk. Our simple to use Match API can match even the poorest quality address to a location. We work with premium and open data providers to deliver a full geographic assessment via our Intelligence API in less than a second.

    Match API

    The Addresscloud Match API supports the following use cases: "Geocoding" which is converting an address or place into geographic coordinates and "Reverse Geocoding" which turns geographic coordinates into addresses or place names

    In addition to these primary use cases the following supporting services are available:

    All of the Match API calls follow the same basic format:

    https://api.addresscloud.com/match/v1/[target]/[operation]

    Where the [operation] is either geocode, lookup or suggest and the target is one of the following:

    Geocode

    Simple request for an address (building number and postcode):

    curl "https://api.addresscloud.com/match/v1/address/geocode?query=74+EX12PP"
      -H "x-api-key: YOUR_API_KEY"
      -H "x-client-id: YOUR_CLIENT_ID"
    

    The result is an exact match:

    {
      "match_status": "MATCH",
      "found": 1,
      "max_score": 4.223874,
      "results": [
        {
          "dataset": "abprem",
          "location_type": "address",
          "id": "pNYczEFvSHAzp82kS0jm6g",
          "description": "74 Ladysmith Road, Exeter EX1 2PP",
          "score": 4.223874,
          "properties": {
            "building_number": "74",
            "primary_street": "Ladysmith Road",
            "locality": "Exeter",
            "postcode": "EX1 2PP",
            "country": "gb",
            "dataset_id": "ABP:100040220317",
            "uprn": 100040220317,
            "udprn": 8745312,
            "address_type": "DPA",
            "delivery_point": true
          },
          "geometry": {
            "type": "Point",
            "crs": "EPSG:4326",
            "coordinates": {
              "lon": -3.5081921,
              "lat": 50.7262865
            },
            "geo_accuracy": "rooftop"
          }
        }
      ]
    }
    

    Simple request for a postcode:

    curl "https://api.addresscloud.com/match/v1/address/geocode?query=EX12PP"
      -H "x-api-key: YOUR_API_KEY"
      -H "x-client-id: YOUR_CLIENT_ID"
    

    The default behaviour is to return a "picklist" of addresses. A second call is needed to the /lookup/byId service to pull back the full results for an address (see the Lookup section below):

    {
      "match_status": "MULTIMATCH",
      "found": 53,
      "max_score": 1,
      "results": [
        {
          "dataset": "abprem",
          "location_type": "address",
          "id": "W32ZiVzNz2ZdCudF8GQNrA",
          "description": "66 Ladysmith Road, Exeter EX1 2PP",
          "score": 1
        },
        {
          "dataset": "abprem",
          "location_type": "address",
          "id": "HfV0kCPynL7Sz10EQjD23A",
          "description": "66A Ladysmith Road, Exeter EX1 2PP",
          "score": 1
        },
        {
          "dataset": "abprem",
          "location_type": "address",
          "id": "WDQAYWkjO8KRpeRS9qBuvQ",
          "description": "68 Ladysmith Road, Exeter EX1 2PP",
          "score": 1
        },
        {
          "dataset": "abprem",
          "location_type": "address",
          "id": "I9FC5bKVc6xJYEToTuQYdA",
          "description": "70 Ladysmith Road, Exeter EX1 2PP",
          "score": 1
        },
        {
          "dataset": "abprem",
          "location_type": "address",
          "id": "YJUrbgpVAqBf_Xdjik9rDw",
          "description": "72 Ladysmith Road, Exeter EX1 2PP",
          "score": 1
        },
        {
          "dataset": "abprem",
          "location_type": "address",
          "id": "pNYczEFvSHAzp82kS0jm6g",
          "description": "74 Ladysmith Road, Exeter EX1 2PP",
          "score": 1
        },
        {
          "dataset": "abprem",
          "location_type": "address",
          "id": "Vgn62wF1omnUDPL2mYfKRA",
          "description": "76 Ladysmith Road, Exeter EX1 2PP",
          "score": 1
        },
        {
          "dataset": "abprem",
          "location_type": "address",
          "id": "jRnVB8trISyoVpUID7-LLA",
          "description": "78 Ladysmith Road, Exeter EX1 2PP",
          "score": 1
        },
    
        // results continue....
    
        {
          "dataset": "abprem",
          "location_type": "address",
          "id": "FNgk3hf0hGY4PwAEvCLkqg",
          "description": "147 Ladysmith Road, Exeter EX1 2PP",
          "score": 1
        },
        {
          "dataset": "abprem",
          "location_type": "address",
          "id": "JPwOeIPtHpxj2_P9mQ-Blg",
          "description": "149A Ladysmith Road, Exeter EX1 2PP",
          "score": 1
        },
        {
          "dataset": "abprem",
          "location_type": "address",
          "id": "7CFFujfDYGo6unWe8N7ekg",
          "description": "149B Ladysmith Road, Exeter EX1 2PP",
          "score": 1
        }
      ]
    }
    

    If we do not want a picklist and just want to find the "best" possible match we can use the best mode. This is very useful for batch scenarios where there is no user present:

    curl "https://api.addresscloud.com/match/v1/address/geocode?query=EX12PP&multimatch=best"
      -H "x-api-key: YOUR_API_KEY"
      -H "x-client-id: YOUR_CLIENT_ID"
    

    The result is an exact match at postcode level:

    {
      "match_status": "MATCH",
      "found": 1,
      "max_score": null,
      "results": [
        {
          "dataset": "abprem",
          "location_type": "postcode1",
          "id": "xQCg96IzByXv73ttPljYIw",
          "description": "EX1 2PP",
          "properties": {
            "postcode": "EX1 2PP",
            "country": "gb",
            "dataset_id": "ABP:PCO:ex12pp"
          },
          "geometry": {
            "type": "Point",
            "crs": "EPSG:4326",
            "coordinates": {
              "lon": -3.5078067,
              "lat": 50.7258397
            },
            "geo_accuracy": "postcode1"
          }
        }
      ]
    }
    

    Reverse geocoding example (NOTE: coordinates are lon,lat and not lat,lon):

    curl "https://api.addresscloud.com/match/v1/address/geocode?coordinates=-3.5081921,50.7262865&radius=10"
      -H "x-api-key: YOUR_API_KEY"
      -H "x-client-id: YOUR_CLIENT_ID"
    

    The result is a list of addresses ranked by closest first:

    {
      "match_status": "MULTIMATCH",
      "found": 4,
      "max_score": null,
      "results": [
        {
          "dataset": "abprem",
          "location_type": "address",
          "id": "pNYczEFvSHAzp82kS0jm6g",
          "description": "74 Ladysmith Road, Exeter EX1 2PP",
          "score": null
        },
        {
          "dataset": "abprem",
          "location_type": "address",
          "id": "YJUrbgpVAqBf_Xdjik9rDw",
          "description": "72 Ladysmith Road, Exeter EX1 2PP",
          "score": null
        },
        {
          "dataset": "abprem",
          "location_type": "address",
          "id": "Vgn62wF1omnUDPL2mYfKRA",
          "description": "76 Ladysmith Road, Exeter EX1 2PP",
          "score": null
        },
        {
          "dataset": "abprem",
          "location_type": "address",
          "id": "jRnVB8trISyoVpUID7-LLA",
          "description": "78 Ladysmith Road, Exeter EX1 2PP",
          "score": null
        }
      ]
    }
    

    "Geocoding" is the process of converting an address or place into geographic coordinates and "Reverse Geocoding" turns geographic coordinates into addresses or place names. The Addresscloud geocode service will function perfectly well as an address matching service as the address needs to be matched in order for the coordinates to be returned.

    HTTP Request

    GET https://api.addresscloud.com/match/v1/<target>/geocode

    URL Parameters

    Parameter Description
    target What kind of location are we trying to retrieve? (one of address, postcode1, building_group, street, postcode2, locality, postcode3, subregion, postcode4, region)

    Query Parameters

    Parameter Default Description
    query Query expressed as a single string (recommended option for most use cases) e.g. 74 EX1 2PP or pipe separated key:value pairs using structured fields
    country Which country is the location in. The code must be an ISO 3166 2-character country code - note that gb includes Northern Ireland in these codes. Since it is possible that im, je and gg records will be encoded as gb these will be included in gb searches.
    postcode_match auto Strategy for postcodes where exact means the postcode must match exactly or no results are returned, fuzzy allows for mistakes except in the first half (outcode for UK) of the postcode, auto performs fuzzy searches for postcodes which do not exist or where no exact match can be found otherwise treats them as exact (one of exact, fuzzy, auto)
    delivery_point_only true For address types only delivery points (i.e. those addresses which receive mail) will be returned when this is true. If false all records of type 'address' may be returned including Objects Without Postal Address (OWPAs) such as telephone boxes, ATMs etc (one of true or false)
    multimatch picklist If multiple candidates are found, return none of them, all of them, the first or the best match drilling up to a higher level of detail as defined by the min_match field. Note that best address matching works on the concept of shared parents. The system will look for a common parent among the address matches and if present will return this. Note that the best address setting will ignore the delivery_point_only as a parent address is unlikely to be a delivery_point_only e.g. the master address for a building where there are multiple delivery points (flats/units), a postcode etc. The picklist option returns just the description and identifier i.e. no address fields or geographic coordinates. This is useful for customers who licence data on a transactional basis and therefore pay for each complete record returned (one of none, best, first, picklist)
    min_match region If an exact match cannot be found for the specified type and a best match is acceptable to which level should the search drill back (one of address, postcode1, building_group, street, postcode2, locality, postcode3, subregion, postcode4, region)
    min_accuracy region What is the minimum level of accuracy acceptable for a geocode? i.e. an address may be found but the associated geocode is only at postcode1 level (one of rooftop, interpolated, grid, postcode1, building_group, street, postcode2, locality, postcode3, subregion, postcode4, region)
    fuzzy 1 The level of fuzzy matching which will be applied to the address. An address is treated as a series of tokens separated by space or punctuation. The system assumes that there will not be a mistake in the first 2 characters of any token. A setting of 1 will allow for 1 'replacement' (typo) in the remainder of the token, a setting of 2 will allow for 2 'replacements' in the remainder of the token. By default fuzzy logic is set to 0 (disabled) and this is recommended for most use cases. Fuzzy logic increases the number of terms that must be compared and will therefore result in longer response times and increase overall load on the system (one of 0, 1 or 2)
    crs 4326 Co-ordinate reference system to return the results in. Must be a valid Spatial Reference System Identifier (SRID) - numeric part only (one of 3857, 4269, 4326, 27700, 29902, 900913)
    coordinates lon,lat coordinates to search by (must be in WGS84 - CRS EPSG:4326) - NOTE the use of lon,lat (x,y) which is longitude,latitude - not lat,lon as sometimes used for coordinates e.g. -0.141587,51.501008
    radius 50 Radius in metres to search within when performing an x,y point search (must be between 1 and 100 metres)
    max_results 250 Max number of addresses to be returned in the event of a multi match (must be between 1 and 250
    show_alts false Addresscloud uses alternate and historical addresses linked to the master address to help improve match rates, by default these are not displayed however setting this field to true will display them (options are true or false)

    Lookup by ID

    A simple lookup for an address by ID:

    curl "https://api.addresscloud.com/match/v1/address/lookup/byId/HfV0kCPynL7Sz10EQjD23A"
      -H "x-api-key: YOUR_API_KEY"
      -H "x-client-id: YOUR_CLIENT_ID"
    

    The result is an exact match:

    {
      "found": true,
      "result": {
        "dataset": "abprem",
        "location_type": "address",
        "id": "HfV0kCPynL7Sz10EQjD23A",
        "description": "66A Ladysmith Road, Exeter EX1 2PP",
        "properties": {
          "building_number": "66A",
          "primary_street": "Ladysmith Road",
          "locality": "Exeter",
          "postcode": "EX1 2PP",
          "country": "gb",
          "dataset_id": "ABP:10013038059",
          "uprn": 10013038059,
          "udprn": 53579726,
          "address_type": "DPA",
          "delivery_point": true
        },
        "geometry": {
          "type": "Point",
          "crs": "EPSG:4326",
          "coordinates": {
            "lat": 50.7264645,
            "lon": -3.5083395
          },
          "geo_accuracy": "rooftop"
        }
      }
    }
    

    If we supply an invalid identifier:

    curl "https://api.addresscloud.com/match/v1/address/lookup/byId/blahblahblahblahblahbl"
      -H "x-api-key: YOUR_API_KEY"
      -H "x-client-id: YOUR_CLIENT_ID"
    

    The result is an HTTP 404 with the following message:

    {
      "message": "No address found with id blahblahblahblahblahbl"
    }
    

    Used for retrieving the full details of a location based on its Addresscloud ID. Often used in response to a geocode request that returns a picklist (see above).

    HTTP Request

    GET https://api.addresscloud.com/match/v1/[target]/lookup/byId/[id]

    URL Parameters

    Parameter Description
    target What kind of location are we trying to retrieve? (one of address, postcode1, building_group, street, postcode2, locality, postcode3, subregion, postcode4, region)
    id Addresscloud 22 character identifier to lookup e.g. Xc6RwAapNLlmqIm_7qvXoQ

    Lookup by Dataset ID

    A simple lookup for an address by Dataset ID:

    curl "https://api.addresscloud.com/match/v1/address/lookup/byDatasetId/ABP:10013038059"
      -H "x-api-key: YOUR_API_KEY"
      -H "x-client-id: YOUR_CLIENT_ID"
    

    The result is the same as for the lookup by Id request (see above)

    This method allows retrieval of a location based on its dataset_id - the combination of a 3 character (case sensitive) suffix code describing where the data come from and the unique identifier associated with the dataset e.g. ABP:10033544614 is from AddressBase Premium and 10033544614 is the UPRN (unique identifier for GB addresses) associated with it.

    HTTP Request

    GET https://api.addresscloud.com/match/v1/[target]/lookup/byDatasetId/[dataset_id]

    URL Parameters

    Parameter Description
    target What kind of location are we trying to retrieve? (one of address, postcode1, building_group, street, postcode2, locality, postcode3, subregion, postcode4, region)
    dataset_id Compound identifier describing the location to lookup e.g. ABP:10033544614

    Lookup by UPRN

    A simple lookup for an address by UPRN:

    curl "https://api.addresscloud.com/match/v1/address/lookup/byUPRN/10013038059"
      -H "x-api-key: YOUR_API_KEY"
      -H "x-client-id: YOUR_CLIENT_ID"
    

    The result is the same as for the lookup by Id request (see above)

    This method allows retrieval of a location based on its UPRN - a unique address identifier specific to the UK.

    HTTP Request

    GET https://api.addresscloud.com/match/v1/[target]/lookup/byUPRN/[uprn]

    URL Parameters

    Parameter Description
    target What kind of location are we trying to retrieve? (one of address, postcode1, building_group, street, postcode2, locality, postcode3, subregion, postcode4, region)
    uprn UPRN of the the location to lookup e.g. 10033544614

    Address Schema

    Addresscloud has been designed to support international addresses however we wanted to retain some of the rich and unique attributes that we use in addressing in the UK and Ireland. Our address fields are listed below:

    Field Description Example
    department Department within an organisation Child Services
    organisation Name of organisation Cope Foundation
    sub_building Sub building (e.g. unit or flat) Unit 4
    building_number Primary addressable building identifier 23
    building_name Name of building e.g. a block of flats Crown House
    building_group Used frequently in Ireland, often the name of a housing estate or shopping centre Midleton Retail Park
    secondary_street Sub-division within a street Holly Close
    primary_street The primary street Old Cork Road
    sub_locality Sub-division within a locality e.g. a hamlet Midleton
    locality Primary locality Cork
    subregion Sub-division within a region e.g. a US county
    region UK or Irish county or US state Co. Cork
    postcode Postal code P25 R275
    country Lowercase iso-3166-2 country code ie

    Data Sources

    Addresscloud uses the following data sources:

    Country Dataset(s)
    GB Mainland AddressBase Premium (ABP)
    Northern Ireland Pointer (PTR) or AddressBase Islands (ABI)
    Republic of Ireland Eircode (EIR)
    Channel Islands AddressBase Islands (ABI)
    Isle of Man AddressBase Islands (ABI)

    For every record matched in Addresscloud a dataset ID is returned which is prefixed with on of the 3 character dataset codes above plus the unique identifier associated with the dataset. For AddressBase Premium (ABP) records this is the UPRN

    Geo Accuracy

    Addresscloud uses a standard list of geo_accuracy codes to describe how accurate a geocode is. Geocodes can come from several sources and not every address will be accurate to rooftop level. A description of each accuracy level is provided below for reference with examples where appropriate.

    Intelligence API

    All of the Intelligence API calls follow the same basic format:

    curl "https://api.addresscloud.com/intel/v1/address/[target]/[operation]"
      -H "x-api-key: YOUR_API_KEY"
      -H "x-client-id: YOUR_CLIENT_ID"
    

    Responses from the Addresscloud Intelligence API follow a standard structure:

    {
      "intel_status": "<OVERALL STATUS OF RESPONSE>",
      "found": "<NO OF DATASETS FOUND>",
      "results": {
        "<DATASET>": {
          "<LAYER 1>": {
            "status": "<STATUS FOR LAYER 1>",
            "results": [ "<ARRAY OF RESULTS FOR LAYER 1 ORDERED AS PER CLIENT CONFIG" ],
            "stats": {
              "<FIELD>": {
                "<STATISTIC>": "<IF CONFIGURED SUMMARY STATS FOR FIELD x ON LAYER 1>"
              }
            }
          },
          "<LAYER n>": {
            "status": "<STATUS FOR LAYER n>",
            "results": [ "<ARRAY OF RESULTS FOR LAYER n ORDERED AS PER CLIENT CONFIG" ]
          }
        },
        "<DATASET n>": {
          "<LAYER n>": {
    
          }
        }
      }
    }
    

    The Addresscloud Intelligence API will return a geographic assessment from any of our supported datasets.

    All of the Intelligence API calls follow the same basic format:

    https://api.addresscloud.com/intel/v1/[target]/[operation]

    Where the [operation] is always intel and the target is one of the following:

    The Intelligence API will support the following lookups:

    The following header parameters are required:

    Status Codes

    An Intelligence API call may be calling multiple simultaneous calls internally, each of which could yield a different status. The API will return an overall intel_status as well status for each intelligence layer. The following status codes are supported:

    Intel by ID

    Retrieve intelligence by Addresscloud ID

    curl "https://api.addresscloud.com/intel/v1/address/intel/byId/HfV0kCPynL7Sz10EQjD23A"
      -H "x-api-key: YOUR_API_KEY"
      -H "x-client-id: YOUR_CLIENT_ID"
    

    The result is an exact match:

    {
      "intel_status": "OK",
      "found": 10,
      "results": {
        "ukcrim": {
          "ukburg": {
            "status": "OK",
            "results": [
              {
                "burg_score": 11,
                "burg_class": 2,
                "burg_trend": 0
              }
            ]
          },
          "ukcrda": {
              "status": "OK",
              "results": [
                {
                  "crda_score": 24,
                  "crda_class": 3,
                  "crda_trend": 0
                }
              ]
            }
          }
        }
      }
    }
    

    Used for retrieving intelligence data by Addresscloud ID.

    HTTP Request

    GET https://api.addresscloud.com/intel/v1/[target]/intel/byID/[id]

    URL Parameters

    Parameter Description
    target What kind of location are we trying to retrieve intelligence for? (one of address, postcode1)
    id Addresscloud 22 character identifier to lookup e.g. HfV0kCPynL7Sz10EQjD23A
    datasets Comma separated list of datasets (optional). By default all datasets associated with your account will be returned, this option allows you to limit the list

    Intel by UPRN

    Retrieve intelligence by UPRN

    curl "https://api.addresscloud.com/intel/v1/address/intel/byUPRN/10013038059"
      -H "x-api-key: YOUR_API_KEY"
      -H "x-client-id: YOUR_CLIENT_ID"
    

    The result is the same as for the intelligence by Id request (see above)

    Used for retrieving intelligence data by UPRN.

    HTTP Request

    GET https://api.addresscloud.com/intel/v1/[target]/intel/byUPRN/[uprn]

    URL Parameters

    Parameter Description
    target What kind of location are we trying to retrieve intelligence for? (one of address, postcode1)
    uprn UPRN of the the location to lookup e.g. 10013038059
    datasets Comma separated list of datasets (optional). By default all datasets associated with your account will be returned, this option allows you to limit the list

    Intel by Point

    Retrieve intelligence by Point (lon,lat)

    curl "https://api.addresscloud.com/intel/v1/address/intel/byPoint/-3.5081921,50.7262865"
      -H "x-api-key: YOUR_API_KEY"
      -H "x-client-id: YOUR_CLIENT_ID"
    

    The result is the same as for the intelligence by Id request (see above)

    Used for retrieving intelligence data by Point (lon,lat).

    HTTP Request

    GET https://api.addresscloud.com/intel/v1/[target]/intel/byPoint/[coordinates]

    URL Parameters

    Parameter Description
    target What kind of location are we trying to retrieve intelligence for? (one of address, postcode1)
    coordinates Point coordinates to lookup e.g. -3.5081921,50.7262865 (NOTE: lon,lat and not lat,lon)
    datasets Comma separated list of datasets (optional). By default all datasets associated with your account will be returned, this option allows you to limit the list

    Intel by WKT

    Retrieve intelligence by Well Known Text (WKT) geometry

    curl "https://api.addresscloud.com/intel/v1/address/intel/byWKT/POLYGON%20((-3.507561316886523%2050.72666513145259,%20-3.507781258031457%2050.72730014009565,%20-3.506247034474285%2050.72758198609321,%20-3.505656948486859%2050.726811150246476,%20-3.5061772970371123%2050.72642742547086,%20-3.507561316886523%2050.72666513145259))"
      -H "x-api-key: YOUR_API_KEY"
      -H "x-client-id: YOUR_CLIENT_ID"
    

    The result is the same as for the intelligence by Id request (see above)

    Used for retrieving intelligence data by Well Known Text (WKT) encoded geometry.

    HTTP Request

    GET https://api.addresscloud.com/intel/v1/[target]/intel/byWKT/[wkt]

    URL Parameters

    Parameter Description
    target What kind of location are we trying to retrieve intelligence for? (one of address, postcode1)
    wkt Well Known Text (WKT) string representing a valid geometry
    datasets Comma separated list of datasets (optional). By default all datasets associated with your account will be returned, this option allows you to limit the list

    Data Dictionary

    Addresscloud supports a range of datasets, these are listed below together with the last updated date:

    Dataset Code Provider Dataset Update Frequency Last Updated
    abprem Addressbase Premium Ordnance Survey 6 Weekly 08/2019
    acloud Addresscloud Property Addresscloud Adhoc 10/2019
    bgsgip British Geological Survey GeoSure Insurance Product Annual 08/2019
    bluntm Bluesky International National Tree Model Annual 06/2018
    cranpd Cranfield Natural Perils Database Annual 10/2018
    eahfld Environment Agency Recorded Flood Outlines Annual 09/2019
    eahlfl Environment Agency Historic Landfill Annual 09/2019
    epcbui Ministry of Housing, Communities & Local Government Energy Performance of Buildings Adhoc 09/2019
    hiseng Historic England Conservation Areas Adhoc 03/2019
    fenfhl FEMA National Flood Hazard Layer Annual 10/2017
    firest Addresscloud(1) Fire Station Proximity Annual 10/2019
    jbafgb JBA Risk UK Flood Maps Annual 11/2018
    jbafie JBA Risk Irish Flood Maps Annual 12/2017
    noaslo NOAA Sea, Lake, and Overland Surges from Hurricanes (SLOSH) Annual 10/2017
    noharm Anchor Point NoHARM US Wildfire Annual 09/2018
    oprvrs Addresscloud(2) River Proximity Annual 11/2018
    ostopo Ordnance Survey MasterMap Topography Bi-Annual 10/2019
    prpaid Addresscloud(3) Property Prices Monthly 10/2019
    ukcrim Addresscloud(4) UK Crime Annual 09/2019
    voarat VOA(4) Business Rating Quarterly 11/2019

    Addressbase Premium (abprem)

    A sample result:

    {
        "abprem": {
            "abprem": {
                "status": "OK",
                "results": [{
                    "classification_code": "CR08",
                    "multi_occ": false
                }]
            }
        }
    }
    

    Addressbase Premium (abprem)

    Field Description Data Type Lookup
    classification_code Classification Code Text Addressbase Classification
    multi_occ Multi occupancy? Boolean

    Addresscloud Property (acloud)

    A sample result:

    {
        "acloud": {
            "acloud": {
                "status": "OK",
                "results": [{
                    "type": "F",
                    "type_accuracy": "A",
                    "style": "FM",
                    "style_accuracy": "A",
                    "year_built": 1988,
                    "year_built_accuracy": "A",
                    "period_built": "E",
                    "period_built_accuracy": "A",
                    "bedrooms": 2,
                    "bedrooms_accuracy": "A",
                    "receptions": 2,
                    "receptions_accuracy": "A",
                    "bathrooms": 2,
                    "bathrooms_accuracy": "A",
                    "est_value": 395000,
                    "est_value_accuracy": "A",
                    "floor_level": 1,
                    "floor_level_accuracy": "A",
                    "above_ground": true,
                    "above_ground_accuracy": "A",
                    "storeys": 4,
                    "storeys_accuracy": "A"
                }]
            }
        }
    }
    

    Addresscloud Property (acloud)

    Field Description Data Type Lookup
    type Property Type Text Addresscloud Type
    type_accuracy Property Type Accuracy Text Addresscloud Accuracy
    style Property Style Text Addresscloud style
    style_accuracy Property Style Accuracy Text Addresscloud Accuracy
    year_built Year Built Numeric
    year_built_accuracy Year Built Accuracy Text Addresscloud Accuracy
    period_built Period Built Text Addresscloud period_built
    period_built_accuracy Period Built Accuracy Text Addresscloud Accuracy
    listed_grade Listed Grade Text Listed Grade
    listed_grade_accuracy Listed Grade Accuracy Text Addresscloud Accuracy
    bedrooms Bedrooms Numeric
    bedrooms_accuracy Bedrooms Accuracy Text Addresscloud Accuracy
    receptions Receptions Numeric
    receptions_accuracy Receptions Accuracy Text Addresscloud Accuracy
    bathrooms Bathrooms Numeric
    bathrooms_accuracy Bathrooms Accuracy Text Addresscloud Accuracy
    est_value Estimated Value Numeric
    est_value_accuracy Estimated Value Accuracy Text Addresscloud Accuracy
    floor_level Floor Level Numeric
    floor_level_accuracy Floor Level Accuracy Text Addresscloud Accuracy
    above_ground Above Ground Boolean
    above_ground_accuracy Above Ground Accuracy Text Addresscloud Accuracy
    storeys Storeys Numeric
    storeys_accuracy Storeys Accuracy Text Addresscloud Accuracy

    BGS GeoSure Insurance Product (bgsgip)

    A sample result:

    {
      "bgsgip": {
        "geogld": {
          "status": "OK",
          "results": [
            {
              "class": 1,
              "sswell_score": 0,
              "sswell_class": 0,
              "landslide_score": 35,
              "landslide_class": 1,
              "comp_score": 0,
              "comp_class": 0,
              "collaps_score": 3,
              "collaps_class": 1,
              "rsand_score": 0,
              "rsand_class": 0,
              "solub_score": 0,
              "solub_class": 0,
              "total_score": 38
            }
          ]
        }
      }
    }
    

    GeoSure Insurance Product (Gold) (geogld)

    Field Description Data Type Lookup
    class Risk Classification Numeric Classification
    sswell_score Shrink Swell Score Numeric
    sswell_class Shrink Swell Classification Numeric Classification
    landslide_score Landslides Score Numeric
    landslide_class Landslides Classification Numeric Classification
    comp_score Compressible Ground Score Numeric
    comp_class Collapsible Deposits Classification Numeric Classification
    collaps_score Collapsible Deposits Score Numeric
    collaps_class Collapsible Deposits Classification Numeric Classification
    rsand_score Running Sands Score Numeric
    rsand_class Running Sands Classification Numeric Classification
    solub_score Soluble Rocks Score Numeric
    solub_class Soluble Rocks Classification Numeric Classification

    Bluesky National Tree Model (bluntm)

    A sample result:

    {
      "bluntm": {
        "trersk": {
          "status": "OK",
          "results": [
            {
              "count": 0,
              "score": 0,
              "class": 1
            }
          ]
        }
      }
    }
    

    Tree Risk (trersk)

    Field Description Data Type Lookup
    count Count of Trees within 20m Numeric
    max Max Tree Height within 20m Numeric
    score Tree Risk Score (/9) Numeric
    class Classification Numeric Classification

    Cranfield Natural Perils Database (cranpd)

    A sample result:

    {
      "cranpd": {
        "natpdb": {
          "status": "OK",
          "results": [
            {
              "worst_class": 3,
              "clay_worst": 4,
              "best_class": 2,
              "clay_best": 3,
              "sand": 1,
              "peat": 0,
              "soft": 0,
              "silt": 0,
              "coal_area": false,
              "brine_area": false,
              "flood": 0,
              "exposure": 1
            }
          ]
        }
      }
    }
    

    Natural Perils Database (natpdb)

    Field Description Data Type Lookup
    worst_class Classification (Worst Case) Numeric Classification
    clay_worst Clay Score (Worst Case) Numeric
    best_class Classification (Best Case) Numeric Classification
    clay_best Clay Best (Best Case) Numeric
    sand Sand Score Numeric
    peat Peat Score Numeric
    soft Soft Soils Score Numeric
    silt Silt Score Numeric
    coal_area Coal Area? Boolean
    brine_area Brine Area? Boolean
    flood Flood Score Numeric
    exposure Exposure Score Numeric

    EA Recorded Flood Outlines (eahfld)

    A sample result:

    {
      "eahfld": {
        "eahfld": {
          "status": "OK",
          "results": [
            {
              "event_code": "2806",
              "outline_co": "25728",
              "name": "07307B100_FEB1953_The Swale_Sittingbourne",
              "start_date": "1953-02-01",
              "end_date": "1953-02-05",
              "bndry_src": "visual",
              "flood_src": "sea",
              "flood_caus": "overtopping of defences",
              "fluvial_in": false,
              "tidal_ind": true,
              "coastal_in": false,
              "hfm_ind": 2
            }
          ]
        }
      }
    }
    

    Recorded Flood Outlines (eahfld)

    Field Description Data Type Lookup
    event_code Event Code Text
    outline_co Outline Code Text
    name Event Name Text
    start_date Start Date Date
    end_date End Date Date
    bndry_src Boundary Source Text
    flood_src Flood Source Text
    flood_caus Flood Cause Text
    fluvial_in Fluvial? Boolean
    tidal_ind Tidal? Boolean
    coastal_in Coastal? Boolean
    hfm_ind Historic Flood Map Indicator Numeric

    EA Historic Landfill (eahlfl)

    A sample result:

    {
      "eahlfl": {
        "eahlfl": {
          "status": "OK",
          "results": [
            {
              "hld_ref": "EAHLD19368",
              "site_name": "Castlemaine Avenue",
              "site_add": "Castlemaine Avenue, Kent",
              "ea_wmlr": 0,
              "wrc_ref": "2200/7118",
              "site_ref": "G36",
              "os_prefix": "TQ",
              "easting": 578500,
              "northing": 168700,
              "ea_region": "SO",
              "ea_area": "Kent SO",
              "lic_issue": "1976-01-01",
              "firstinput": "1982-12-31",
              "inert": true,
              "gascontrol": true,
              "licenced": true
            }
          ]
        }
      }
    }
    

    Historic Landfill (eahlfl)

    Field Description Data Type Lookup
    hld_ref HLD Reference Text
    site_name Site Name Text
    site_add Site Address Text
    firstinput Date of First Input Date
    lastinput Date of Last Input Date
    inert Inert waste? Boolean
    industrial Industrial waste? Boolean
    commercial Commercial waste? Boolean
    household Household waste? Boolean
    special Special waste? Boolean
    liqsludge Liquid Sludge waste? Boolean
    wasteunk Unknown Waste? Boolean
    gascontrol Gas Control Measures? Boolean
    leachatcnt Leachate Control Measures? Boolean
    licenced Licenced? Boolean
    nolicreq No Licence Required? Boolean
    exempt Exempt from Licensing? Boolean

    Energy Performance of Buildings (epcbui)

    A sample result:

    {
        "intel_status": "OK",
        "found": 1,
        "results": {
            "epcbui": {
                "survey": {
                    "status": "OK",
                    "results": [{
                        "type": "FL",
                        "form": "ET",
                        "floor_area": 76,
                        "floor_height": 2,
                        "level": "1",
                        "storeys": 4,
                        "top_storey": false,
                        "rooms": 3,
                        "windows": "DB",
                        "extensions": 0,
                        "fireplaces": 0,
                        "mains_gas": true,
                        "rating": "C",
                        "ptl_rating": "B",
                        "lmk_key": "148549899802010092919574753002318",
                        "insp_date": "2010-09-29"
                    }]
                }
            }
        }
    }
    

    EPC Survey (survey)

    Field Description Data Type Lookup
    type Property Type Text EPC Type
    form Built Form Text EPC Form
    floor_area Total Floor Area Numeric
    floor_height Floor Height Numeric
    level Floor Level Text EPC Floor Level
    storeys No of Storeys Numeric
    top_storey Top Storey? Boolean
    rooms Number of Habitable Rooms Numeric
    windows Window Type Text EPC Windows
    walls Wall Type Text EPC Walls
    roof Roof Type Text EPC Roof
    floor Floor Type Text EPC Floor
    extensions Number of Extensions Numeric
    fireplaces Number of Open Fireplaces Numeric
    mains_gas Mains Gas? Boolean
    rating Current Energy Rating Text
    ptl_rating Potential Energy Rating Text
    lmk_key Individual lodgement identifier Text
    insp_date Inspection Date Date

    Historic England Conservation Areas (hiseng)

    A sample result:

    {
      "hiseng": {
        "consrv": {
          "status": "OK",
          "results": [
            {
              "exists": true,
              "uid": 273,
              "name": "Highgate Village",
              "date_designated": "01/05/1968",
              "date_updated": "01/02/1992 extended",
              "scale": "MasterMap",
              "lpa": "Camden"
            }
          ]
        }
      }
    }
    

    Conservation Areas (consrv)

    Field Description Data Type Lookup
    uid Unique reference number from the Conservation Areas at Risk Survey Numeric
    name Name of Conservation Area Text
    date_designated Designation date of the Conservation Area Text
    date_updated Date on which the Conservation Area boundary was amended Text
    scale Scale at which the spatial representation of the Conservation Area was captured Text
    lpa Local Planning Authority responsible for the Conservation Area Text

    Fire Station Proximity (firest)

    A sample result:

    {
      "firest": {
        "fidist": {
          "status": "OK",
          "results": [
            {
              "count_5k": 3,
              "uprn": 100062630458,
              "name": "Medway Fire Station",
              "dist": 3,
              "drive_dist": 4,
              "drive_time": 6,
              "drive_time_traffic": 8,
              "class_best": 3,
              "class_worst": 3
            }
          ]
        }
      }
    }
    

    Distance to Fire Station (fidist)

    Field Description Data Type Lookup
    count_5k Count of fire stations within 5km (crow flies) Numeric
    uprn UPRN of nearest fire station Numeric
    name Name of nearest fire station Text
    dist Distance to nearest fire station (km, crow flies) Numeric
    drive_dist Driving distance to nearest fire station (km) Numeric
    drive_time Driving time to nearest fire station (mins) Numeric
    drive_time_traffic Driving time to nearest fire station (with traffic, mins) Numeric
    class_best Remoteness Classification (Best Case) Numeric Classification
    class_worst Remoteness Classification (Worst Case) Numeric Classification

    JBA UK Flood Maps (jbafgb)

    A sample result:

    {
      "jbafgb": {
        "fldudf": {
          "status": "OK",
          "results": [
            {
              "rmax20": 0,
              "rmax75": 0,
              "rmax100": 0,
              "rmax200": 0,
              "rmax1000": 0,
              "cudmax75": 0,
              "cudmax100": 0,
              "cudmax200": 0,
              "cudmax1000": 0,
              "swmax75": 0,
              "swmax200": 0,
              "swmax1000": 0,
              "canal_failure": "-999",
              "dam_break": "0",
              "idb": "-999",
              "groundwater_chalk": "0",
              "r20matrix": 0,
              "r75matrix": 0,
              "r100matrix": 0,
              "r200matrix": 0,
              "r1000matrix": 0,
              "river_floodscore_ud": 0,
              "cud75matrix": 0,
              "cud100matrix": 0,
              "cud200matrix": 0,
              "cud1000matrix": 0,
              "coastal_floodscore_ud": 0,
              "sw75matrix": 0,
              "sw200matrix": 0,
              "sw1000matrix": 0,
              "surfacewater_floodscore_ud": 0,
              "groundwaterchalk_floodscore": "0",
              "floodscore_ud": 0
            }
          ]
        },
        "flddef": {
          "status": "OK",
          "results": [
            {
              "rmax20": 0,
              "rmax75": 0,
              "rmax100": 0,
              "rmax200": 0,
              "rmax1000": 0,
              "sop_ri": 0,
              "cdefmax75": 0,
              "cdefmax100": 0,
              "cdefmax200": 0,
              "cdefmax1000": 0,
              "swmax75": 0,
              "swmax200": 0,
              "swmax1000": 0,
              "sop_sw": 0,
              "canal_failure": "-999",
              "dam_break": 0,
              "idb": "-999",
              "groundwater_chalk": 0,
              "r20matrix": 0,
              "r20matrix_def": 0,
              "r75matrix": 0,
              "r75matrix_def": 0,
              "r100matrix": 0,
              "r100matrix_def": 0,
              "r200matrix": 0,
              "r200matrix_def": 0,
              "r1000matrix": 0,
              "r1000matrix_def": 0,
              "river_floodscore_def": 0,
              "cdef75matrix": 0,
              "cdef100matrix": 0,
              "cdef200matrix": 0,
              "cdef1000matrix": 0,
              "coastal_floodscore_def": 0,
              "sw75matrix": 0,
              "sw75matrix_def": 0,
              "sw200matrix": 0,
              "sw200matrix_def": 0,
              "sw1000matrix": 0,
              "sw1000matrix_def": 0,
              "surfacewater_floodscore_def": 0,
              "groundwaterchalk_floodscore": 0,
              "floodscore_def": 0
            }
          ]
        }
      }
    }
    

    Undefended Flood Risk (fldudf)

    Field Description Data Type Lookup
    rmax20 River Flood Depth 1 in 20 Yr Numeric JBA Flood Depth
    rmax75 River Flood Depth 1 in 75 Yr Numeric JBA Flood Depth
    rmax100 River Flood Depth 1 in 100 Yr Numeric JBA Flood Depth
    rmax200 River Flood Depth 1 in 200 Yr Numeric JBA Flood Depth
    rmax1000 River Flood Depth 1 in 1000 Yr Numeric JBA Flood Depth
    cudmax75 Coastal Flood Depth 1 in 75 Yr Numeric JBA Flood Depth
    cudmax100 Coastal Flood Depth 1 in 100 Yr Numeric JBA Flood Depth
    cudmax200 Coastal Flood Depth 1 in 200 Yr Numeric JBA Flood Depth
    cudmax1000 Coastal Flood Depth 1 in 1000 Yr Numeric JBA Flood Depth
    swmax75 Surface Water Flood Depth 1 in 75 Yr Numeric JBA Flood Depth
    swmax200 Surface Water Flood Depth 1 in 200 Yr Numeric JBA Flood Depth
    swmax1000 Surface Water Flood Depth 1 in 1000 Yr Numeric JBA Flood Depth
    canal_failure Canal Failure Risk Numeric JBA Yes/No
    dam_break Dam Break Risk Numeric JBA Yes/No
    idb Internal Drainage Board Numeric JBA Yes/No
    groundwater_chalk Groundwater Chalk Return Period Numeric JBA Yes/No
    r20matrix River Flood Score 1 in 20 Yr Numeric
    r75matrix River Flood Score 1 in 75 Yr Numeric
    r100matrix River Flood Score 1 in 100 Yr Numeric
    r200matrix River Flood Score 1 in 200 Yr Numeric
    r1000matrix River Flood Score 1 in 1000 Yr Numeric
    river_floodscore_ud River Flood Score Numeric
    cud75matrix Coastal Flood Score 1 in 75 Yr Numeric
    cud100matrix Coastal Flood Score 1 in 100 Yr Numeric
    cud200matrix Coastal Flood Score 1 in 200 Yr Numeric
    cud1000matrix Coastal Flood Score 1 in 1000 Yr Numeric
    coastal_floodscore_ud Coastal Flood Score Numeric
    sw75matrix Surface Water Flood Score 1 in 75 Yr Numeric
    sw200matrix Surface Water Flood Score 1 in 200 Yr Numeric
    sw1000matrix Surface Water Flood Score 1 in 1000 Yr Numeric
    surfacewater_floodscore_ud Surface Water Flood Score Numeric
    groundwaterchalk_floodscore Groundwater Chalk Flood Score Numeric
    floodscore_ud Overall Flood Score Numeric

    Defended Flood Risk (flddef)

    Field Description Data Type Lookup
    rmax20 River Flood Depth 1 in 20 Yr Numeric JBA Flood Depth
    rmax75 River Flood Depth 1 in 75 Yr Numeric JBA Flood Depth
    rmax100 River Flood Depth 1 in 100 Yr Numeric JBA Flood Depth
    rmax200 River Flood Depth 1 in 200 Yr Numeric JBA Flood Depth
    rmax1000 River Flood Depth 1 in 1000 Yr Numeric JBA Flood Depth
    sop_ri River Defences Standard of Protection Numeric
    cdefmax75 Coastal Flood Depth 1 in 75 Yr (Def) Numeric JBA Flood Depth
    cdefmax100 Coastal Flood Depth 1 in 100 Yr (Def) Numeric JBA Flood Depth
    cdefmax200 Coastal Flood Depth 1 in 200 Yr (Def) Numeric JBA Flood Depth
    cdefmax1000 Coastal Flood Depth 1 in 1000 Yr (Def) Numeric JBA Flood Depth
    swmax75 Surface Water Flood Depth 1 in 75 Yr Numeric JBA Flood Depth
    swmax200 Surface Water Flood Depth 1 in 200 Yr Numeric JBA Flood Depth
    swmax1000 Surface Water Flood Depth 1 in 1000 Yr Numeric JBA Flood Depth
    sop_sw Surface Water Defences Standard of Protection Numeric
    canal_failure Canal Failure Risk Numeric JBA Yes/No
    dam_break Dam Break Risk Numeric JBA Yes/No
    idb Internal Drainage Board Numeric JBA Yes/No
    groundwater_chalk Groundwater Chalk Return Period Numeric JBA Yes/No
    r20matrix River Flood Score 1 in 20 Yr Numeric
    r20matrix_def River Flood Score 1 in 20 Yr (Def) Numeric
    r75matrix River Flood Score 1 in 75 Yr Numeric
    r75matrix_def River Flood Score 1 in 75 Yr (Def) Numeric
    r100matrix River Flood Score 1 in 100 Yr Numeric
    r100matrix_def River Flood Score 1 in 100 Yr (Def) Numeric
    r200matrix River Flood Score 1 in 200 Yr Numeric
    r200matrix_def River Flood Score 1 in 200 Yr (Def) Numeric
    r1000matrix River Flood Score 1 in 1000 Yr Numeric
    r1000matrix_def River Flood Score 1 in 1000 Yr (Def) Numeric
    river_floodscore_def River Flood Score (Def) Numeric
    cdef75matrix Coastal Flood Score 1 in 75 Yr (Def) Numeric
    cdef100matrix Coastal Flood Score 1 in 100 Yr (Def) Numeric
    cdef200matrix Coastal Flood Score 1 in 200 Yr (Def) Numeric
    cdef1000matrix Coastal Flood Score 1 in 1000 Yr (Def) Numeric
    coastal_floodscore_def Coastal Flood Score (Def) Numeric
    sw75matrix Surface Water Flood Score 1 in 75 Yr Numeric
    sw75matrix_def Surface Water Flood Score 1 in 75 Yr (Def) Numeric
    sw200matrix Surface Water Flood Score 1 in 200 Yr Numeric
    sw200matrix_def Surface Water Flood Score 1 in 200 Yr (Def) Numeric
    sw1000matrix Surface Water Flood Score 1 in 1000 Yr Numeric
    sw1000matrix_def Surface Water Flood Score 1 in 1000 Yr (Def) Numeric
    surfacewater_floodscore_def Surface Water Flood Score (Def) Numeric
    groundwaterchalk_floodscore Groundwater Chalk Flood Score Numeric
    floodscore_def Overall Flood Score (Def) Numeric

    JBA Irish Flood Maps (jbafie)

    A sample result:

    {
      "jbafie": {
        "fldudf": {
          "status": "OK",
          "results": [
            {
              "rmax20": 0,
              "rmax75": 0,
              "rmax100": 0,
              "rmax200": 0,
              "rmax1000": 0,
              "cudmax75": 4,
              "cudmax100": 4,
              "cudmax200": 4,
              "cudmax1000": 4,
              "swmax75": 0,
              "swmax200": 0,
              "swmax1000": 0,
              "r20matrix": 0,
              "r75matrix": 0,
              "r100matrix": 0,
              "r200matrix": 0,
              "r1000matrix": 0,
              "river_floodscore_ud": 0,
              "cud75matrix": 17,
              "cud100matrix": 12,
              "cud200matrix": 7,
              "cud1000matrix": 2,
              "coastal_floodscore_ud": 17,
              "sw75matrix": 0,
              "sw200matrix": 0,
              "sw1000matrix": 0,
              "surfacewater_floodscore_ud": 0,
              "floodscore_ud": 17
            }
          ]
        },
        "flddef": {
          "status": "OK",
          "results": [
            {
              "rmax20": 0,
              "rmax75": 0,
              "rmax100": 0,
              "rmax200": 0,
              "rmax1000": 0,
              "sop_ri": 0,
              "cudmax75": 4,
              "cudmax100": 4,
              "cudmax200": 4,
              "cudmax1000": 5,
              "swmax75": 0,
              "swmax200": 0,
              "swmax1000": 0,
              "r20matrix": 0,
              "r20matrix_def": 0,
              "r75matrix": 0,
              "r75matrix_def": 0,
              "r100matrix": 0,
              "r100matrix_def": 0,
              "r200matrix": 0,
              "r200matrix_def": 0,
              "r1000matrix": 0,
              "r1000matrix_def": 0,
              "river_floodscore_def": 0,
              "cud75matrix": 17,
              "cud100matrix": 12,
              "cud200matrix": 7,
              "cud1000matrix": 3,
              "coastal_floodscore_ud": 17,
              "sw75matrix": 0,
              "sw200matrix": 0,
              "sw1000matrix": 0,
              "surfacewater_floodscore_ud": 0,
              "floodscore_def": 17
            }
          ]
        }
      }
    }
    

    Undefended Flood Risk (fldudf)

    Field Description Data Type Lookup
    rmax20 River Flood Depth 1 in 20 Yr Numeric JBA Flood Depth
    rmax75 River Flood Depth 1 in 75 Yr Numeric JBA Flood Depth
    rmax100 River Flood Depth 1 in 100 Yr Numeric JBA Flood Depth
    rmax200 River Flood Depth 1 in 200 Yr Numeric JBA Flood Depth
    rmax1000 River Flood Depth 1 in 1000 Yr Numeric JBA Flood Depth
    cudmax75 Coastal Flood Depth 1 in 75 Yr Numeric JBA Flood Depth
    cudmax100 Coastal Flood Depth 1 in 100 Yr Numeric JBA Flood Depth
    cudmax200 Coastal Flood Depth 1 in 200 Yr Numeric JBA Flood Depth
    cudmax1000 Coastal Flood Depth 1 in 1000 Yr Numeric JBA Flood Depth
    swmax75 Surface Water Flood Depth 1 in 75 Yr Numeric JBA Flood Depth
    swmax200 Surface Water Flood Depth 1 in 200 Yr Numeric JBA Flood Depth
    swmax1000 Surface Water Flood Depth 1 in 1000 Yr Numeric JBA Flood Depth
    r20matrix River Flood Score 1 in 20 Yr Numeric
    r75matrix River Flood Score 1 in 75 Yr Numeric
    r100matrix River Flood Score 1 in 100 Yr Numeric
    r200matrix River Flood Score 1 in 200 Yr Numeric
    r1000matrix River Flood Score 1 in 1000 Yr Numeric
    river_floodscore_ud River Flood Score Numeric
    cud75matrix Coastal Flood Score 1 in 75 Yr Numeric
    cud100matrix Coastal Flood Score 1 in 100 Yr Numeric
    cud200matrix Coastal Flood Score 1 in 200 Yr Numeric
    cud1000matrix Coastal Flood Score 1 in 1000 Yr Numeric
    coastal_floodscore_ud Coastal Flood Score Numeric
    sw75matrix Surface Water Flood Score 1 in 75 Yr Numeric
    sw200matrix Surface Water Flood Score 1 in 200 Yr Numeric
    sw1000matrix Surface Water Flood Score 1 in 1000 Yr Numeric
    surfacewater_floodscore_ud Surface Water Flood Score Numeric
    floodscore_ud Overall Flood Score Numeric

    Defended Flood Risk (flddef)

    Field Description Data Type Lookup
    rmax20 River Flood Depth 1 in 20 Yr Numeric JBA Flood Depth
    rmax75 River Flood Depth 1 in 75 Yr Numeric JBA Flood Depth
    rmax100 River Flood Depth 1 in 100 Yr Numeric JBA Flood Depth
    rmax200 River Flood Depth 1 in 200 Yr Numeric JBA Flood Depth
    rmax1000 River Flood Depth 1 in 1000 Yr Numeric JBA Flood Depth
    sop_ri River Defences Standard of Protection Numeric
    cdefmax75 Coastal Flood Depth 1 in 75 Yr (Def) Numeric JBA Flood Depth
    cdefmax100 Coastal Flood Depth 1 in 100 Yr (Def) Numeric JBA Flood Depth
    cdefmax200 Coastal Flood Depth 1 in 200 Yr (Def) Numeric JBA Flood Depth
    cdefmax1000 Coastal Flood Depth 1 in 1000 Yr (Def) Numeric JBA Flood Depth
    swmax75 Surface Water Flood Depth 1 in 75 Yr Numeric JBA Flood Depth
    swmax200 Surface Water Flood Depth 1 in 200 Yr Numeric JBA Flood Depth
    swmax1000 Surface Water Flood Depth 1 in 1000 Yr Numeric JBA Flood Depth
    r20matrix River Flood Score 1 in 20 Yr Numeric
    r20matrix_def River Flood Score 1 in 20 Yr (Def) Numeric
    r75matrix River Flood Score 1 in 75 Yr Numeric
    r75matrix_def River Flood Score 1 in 75 Yr (Def) Numeric
    r100matrix River Flood Score 1 in 100 Yr Numeric
    r100matrix_def River Flood Score 1 in 100 Yr (Def) Numeric
    r200matrix River Flood Score 1 in 200 Yr Numeric
    r200matrix_def River Flood Score 1 in 200 Yr (Def) Numeric
    r1000matrix River Flood Score 1 in 1000 Yr Numeric
    r1000matrix_def River Flood Score 1 in 1000 Yr (Def) Numeric
    river_floodscore_def River Flood Score (Def) Numeric
    cud75matrix Coastal Flood Score 1 in 75 Yr Numeric
    cud100matrix Coastal Flood Score 1 in 100 Yr Numeric
    cud200matrix Coastal Flood Score 1 in 200 Yr Numeric
    cud1000matrix Coastal Flood Score 1 in 1000 Yr Numeric
    coastal_floodscore_ud Coastal Flood Score Numeric
    sw75matrix Surface Water Flood Score 1 in 75 Yr Numeric
    sw75matrix_def Surface Water Flood Score 1 in 75 Yr (Def) Numeric
    sw200matrix Surface Water Flood Score 1 in 200 Yr Numeric
    sw200matrix_def Surface Water Flood Score 1 in 200 Yr (Def) Numeric
    sw1000matrix Surface Water Flood Score 1 in 1000 Yr Numeric
    sw1000matrix_def Surface Water Flood Score 1 in 1000 Yr (Def) Numeric
    surfacewater_floodscore_def Surface Water Flood Score (Def) Numeric
    floodscore_def Overall Flood Score (Def) Numeric

    Anchor Point NoHARM (noharm)

    A sample result:

    {
      "intel_status": "OK",
      "found": 1,
      "results": {
        "noharm": {
          "noharm": {
            "status": "OK",
            "results": [
              {
                "riskdesc": "Intermix High",
                "risk50": 29,
                "severity": 19,
                "frequency": 24,
                "pastfires": 49,
                "fstatprox": 3,
                "totpts": -0.6,
                "aspect": 2,
                "crownfire": 2,
                "vegcover": 1,
                "foehn": 3,
                "golfcourse": 3,
                "continuity": 2,
                "roaddist": 1,
                "slope": 2,
                "waterdist": 1,
                "statecode": "CA"
              }
            ],
            "stats": {
              "riskdesc": {
                "split": {
                  "Intermix High": 0.87,
                  "Interface Moderate": 0.07,
                  "Intermix Moderate": 0.04,
                  "Interface High": 0.02,
                  "Interface Low": 0
                }
              }
            }
          }
        }
      }
    }
    

    NoHARM Wildfire Risk (noharm)

    Field Description Data Type Lookup
    riskdesc Wildfire Risk Text
    risk50 Overall Risk Rating Numeric
    severity Predicted Severity of Widlfire Numeric
    frequency Predicted Frequency of Widlfire Occurrence Numeric
    pastfires Historic Fire Presence Numeric
    fstatprox Proximity to Nearest Fire Station Numeric
    nonburn Non-burnable Proportion Numeric
    totpts Additional Influence Score Numeric
    aspect Aspect Numeric NoHARM
    crownfire Crown Fire Numeric NoHARM
    vegcover Vegetation Cover Numeric NoHARM
    foehn Presence of Foehn Winds Numeric NoHARM
    golfcourse Presence of Nearby Golf Course Numeric NoHARM
    continuity Fuel Continuity Numeric NoHARM
    roaddist Distance to Nearest Collector Road Numeric NoHARM
    slope Slope Numeric NoHARM
    waterdist Distance to Nearest Water Source Numeric NoHARM
    statecode State Code Text

    River Proximity (oprvrs)

    A sample result:

    {
      "oprvrs": {
        "ridist": {
          "status": "OK",
          "results": [
            {
              "form": "tidalRiver",
              "name": "River Medway",
              "distance": 1583
            }
          ]
        }
      }
    }
    

    Distance to River (ridist)

    Field Description Data Type Lookup
    form Form of River Text
    name Name of River Text
    distance Distance in metres (crow flies) Numeric

    MasterMap Topography (ostopo)

    A sample result:

    {
        "ostopo": {
            "ostopo": {
                "status": "OK",
                "results": [{
                    "toid": "osgb1000001441847",
                    "calculatedarea": 56.5,
                    "versiondate": "2001-11-11",
                    "changedate": [
                        "1986-04-10"
                    ],
                    "reasonforchange": [
                        "New"
                    ],
                    "bha_processdate": "2018-10-15",
                    "abshmin": 16.8,
                    "absh2": 22,
                    "abshmax": 26.2,
                    "relh2": 5.2,
                    "relhmax": 9.4,
                    "bha_conf": 99
                }]
            }
        }
    }
    

    MasterMap Topography (ostopo)

    Field Description Data Type Lookup
    toid OS TOpographic IDentifier Text
    calculatedarea Building Area (Footprint in m2) Text
    versiondate Version Date Date
    changedate Changed Date Date
    reasonforchange Reason for Change Text
    bha_processdate Building Height Process Date Date
    abshmin Absolute Height Minimum Numeric
    absh2 Absolute Height 2 (Principle Building) Numeric
    abshmax Absolute Height Maximum Numeric
    relh2 Relative Height 2 (Principle Building) Numeric
    relhmax Relative Height Maximum Numeric
    bha_conf Building Height Confidence Text

    Property Prices (prpaid)

    A sample result:

    {
      "prpaid": {
        "psales": {
          "status": "OK",
          "results": [
            {
              "txn_uq_id": "{23B6165E-68B8-FCF4-E050-A8C0620577FA}",
              "price": 228000,
              "date_of_transfer": "2015-09-25",
              "property_type": "T",
              "old_new": "N",
              "ppd_cat_type": "A",
              "record_status": "A"
            },
            {
              "txn_uq_id": "{D59B7B9C-4FE3-4EF6-AC3B-B48448473E02}",
              "price": 185000,
              "date_of_transfer": "2008-04-18",
              "property_type": "S",
              "old_new": "N",
              "ppd_cat_type": "A",
              "record_status": "A"
            }
          ]
        },
        "pvalue": {
          "status": "OK",
          "results": [
            {
              "est_value": 288608,
              "flat": 166743,
              "terraced": 240897,
              "semi": 294674,
              "detached": 401066
            }
          ]
        }
      }
    }
    

    Property Sales (psales)

    Field Description Data Type Lookup
    txn_uq_id Unique Transaction ID Text
    price Price Paid Numeric
    date_of_transfer Date of Transfer Date
    duration Tenure Text
    property_type Property Type Text
    old_new New Build Text

    Property Values (pvalue) by Postcode Sector

    Field Description Data Type Lookup
    est_value Estimated Value Numeric
    flat Flat Average Value Numeric
    terrace Terraced Average Value Numeric
    semi Semi-Detached Average Value Numeric
    detached Detached Average Value Numeric

    UK Crime (ukcrim)

    A sample result:

    {
      "ukcrim": {
        "ukburg": {
          "status": "OK",
          "results": [
            {
              "burg_score": 7,
              "burg_class": 3,
              "burg_trend": 1
            }
          ]
        },
        "ukcrda": {
          "status": "OK",
          "results": [
            {
              "crda_score": 24,
              "crda_class": 3,
              "crda_trend": 0
            }
          ]
        }
      }
    }
    

    Burglaries by Postcode Sector (ukburg)

    Field Description Data Type Lookup
    burg_score Burglary Score Numeric
    burg_class Burglary Classification Numeric Classification
    burg_trend Burglary Trend Numeric Crime Trend

    Criminal Damage & Arson by Postcode Sector (ukcrda)

    Field Description Data Type Lookup
    crda_score Criminal Damage & Arson Score Numeric
    crda_class Criminal Damage & Arson Classification Numeric Classification
    crda_trend Criminal Damage & Arson Trend Numeric Crime Trend

    Business Rating (voarat)

    A sample result:

    {
        "voarat": {
            "results": [{
                "uarn": 382409065,
                "occupier": "Currys Ltd",
                "primary_code": "CS",
                "primary_description": "Shop & Premises",
                "scat_code": "249",
                "scat_description": "Shops",
                "detailed_description": "Shops",
                "sector": "Retail",
                "sub_sector": "RETAIL - SHOPS",
                "risk_rating": 2,
                "fire_block_rating": 5,
                "total_area": 174,
                "measurement": "NIA",
                "rating_date": "2017-04-01",
                "num_occ_floors": 2,
                "min_occ_floor": -1,
                "basement": true,
                "mezzanine": false,
                "mixed_use": true,
                "line_items": [{
                        "floor": "Ground",
                        "description": "Retail Zone B",
                        "area": 20.8,
                        "pct_area": 0.12
                    },
                    {
                        "floor": "Basement",
                        "description": "Internal Storage",
                        "area": 10,
                        "pct_area": 0.06
                    },
                    {
                        "floor": "Ground",
                        "description": "Retail Zone A",
                        "area": 27.1,
                        "pct_area": 0.16
                    },
                    {
                        "floor": "Ground",
                        "description": "Remaining Retail Zone",
                        "area": 26.3,
                        "pct_area": 0.15
                    },
                    {
                        "floor": "Basement",
                        "description": "Retail Area",
                        "area": 31.6,
                        "pct_area": 0.18
                    },
                    {
                        "floor": "Basement",
                        "description": "Internal Storage",
                        "area": 30.6,
                        "pct_area": 0.18
                    },
                    {
                        "floor": "Ground",
                        "description": "Retail Zone C",
                        "area": 27.1,
                        "pct_area": 0.16
                    }
                ]
            }]
        }
    }
    

    Business Rating (voarat)

    Field Description Data Type Lookup
    uarn Unique Address Reference Number Numeric
    occupier Occupier Text
    primary_code Primary Code Text
    primary_description Primary Description Text
    scat_code SCAT Code Text
    scat_description SCAT Description Text
    total_area Total Area (square metres) Numeric
    measurement Unit of Measurement Text VOA Measurement
    rating_date Rating Date Date
    num_occ_floors Number of Occupied Floors Numeric
    min_occ_floor Minimum Occupied Floor Numeric
    max_occ_floor Maximum Occupied Floor Numeric
    basement Basement? Boolean
    mezzanine Mezzanine? Boolean
    mixed_use Mixed Use (incl Residential)? Boolean
    parking_spaces No. of Parking Spaces Numeric

    Lookup Tables

    The lookup tables support the data dictionary

    Lookup: Addresscloud Accuracy

    Code Value
    A Address
    B Building
    C Postcode
    D Multi-Postcode

    Lookup: Addresscloud Type

    Code Value
    B Bungalow
    F Flat
    H House
    M Maisonette
    O Other
    R Room Bedsit

    Lookup: Addresscloud Style

    Code Value
    CM Caravan / mobile
    DT Detached
    FB Basement Flat
    FG Ground Floor Flat
    FL Flat
    FM Mid Floor Flat
    FU Upper Floor Flat
    HB House Boat
    RM Room
    SA Sheltered Accommodation
    SD Semi-detached
    TE End terraced
    TM Mid terraced
    TR Terraced

    Lookup: Addresscloud Use

    Code Value
    C Commercial
    R Residential
    M Mixed
    U Unknown

    Lookup: Addresscloud Period Built

    Code Value
    A Pre 1919
    B 1919 - 1944
    C 1945 - 1964
    D 1965 - 1982
    E 1983 - 1992
    F 1993 - 1999
    G 2000 - 2009
    H Post 2010

    Lookup: Classification

    Code Value
    0 N/A
    1 Negligible
    2 Low
    3 Moderate
    4 High
    5 Extreme

    Lookup: EPC Type

    Code Value
    BU Bungalow
    FL Flat
    HS House
    MA Maisonette
    PH Park home

    Lookup: EPC Form

    Code Value
    DT Detached
    EE Enclosed End-Terrace
    EM Enclosed Mid-Terrace
    ET End-Terrace
    MT Mid-Terrace
    SD Semi-Detached

    Lookup: EPC Floor Level

    Code Value
    B Basement
    G Ground Floor
    M Mid Floor
    T Top Floor
    1 1st Floor
    2 2nd Floor
    3 3rd Floor
    4 4th Floor
    5 5th Floor
    6 6th Floor
    7 7th Floor
    8 8th Floor
    9 9th Floor
    10 10th Floor
    11 11th Floor
    12 12th Floor
    13 13th Floor
    14 14th Floor
    15 15th Floor
    16 16th Floor
    17 17th Floor
    18 18th Floor
    19 19th Floor
    20 20th Floor
    21 21st Floor or above

    Lookup: EPC Windows

    Code Value
    SI Single Gazing
    SC Secondary Gazing
    DB Double Gazing
    TR Triple Gazing
    MU Multiple Gazing
    PS Partial Secondary Gazing
    PD Partial Double Gazing
    PT Partial Triple Gazing
    PM Partial Multiple Gazing
    HP High Performance Gazing

    Lookup: EPC Walls

    Code Value
    BR Brick
    CV Cavity Wall
    ST Stone
    LS Limestone
    SS Sandstone
    WS Whinstone

    Lookup: EPC Roof

    Code Value
    PH Park Home
    PI Pitched
    FL Flat
    TH Thatched
    DW Dwelling Above

    Lookup: EPC Floor

    Code Value
    SL Solid
    SU Suspended

    Lookup: JBA Yes No

    Code Value
    0 No
    1 Yes
    -999 Not Modelled

    Lookup: JBA Flood Depth

    Code Value
    -1 No Risk
    0 Negligible Hazard
    1 0.01m <= x <= 0.05m
    2 0.05m < x <= 0.1m
    3 0.1m < x <= 0.3m
    4 0.3m < x <= 1.0m
    5 x > 1.0m

    Lookup: Land Reg Tenure

    Code Value
    F Freehold
    L Leasehold

    Lookup: Land Reg Type

    Code Value
    D Detached
    S Semi-Detached
    T Terraced
    F Flats/Maisonettes
    O Other

    Lookup: Land Reg New Build

    Code Value
    Y Newly Built Property
    N Established Residential Building

    Lookup: Crime Trend

    Code Value
    -1 Decreasing
    0 Unchanged
    1 Increasing

    Lookup: NoHARM

    Code Value
    1 Low
    2 Medium
    3 High

    Lookup: VOA Measurement

    Code Value
    GIA Gross Internal Area
    NIA Net Internal Area

    Lookup: Addressbase Classification

    Code Value
    C Commercial
    CA Agricultural
    CA01 Farm / Non-Residential Associated Building
    CA02 Fishery
    CA02FF Fish Farming
    CA02FH Fish Hatchery
    CA02FP Fish Processing
    CA02OY Oyster / Mussel Bed
    CA03 Horticulture
    CA03SH Smallholding
    CA03VY Vineyard
    CA03WB Watercress Bed
    CA04 Slaughter House / Abattoir
    CB Ancillary Building
    CC Community Services
    CC02 Law Court
    CC03 Prison
    CC03HD HM Detention Centre
    CC03PR HM Prison Service
    CC03SC Secure Residential Accommodation
    CC04 Public / Village Hall / Other Community Facility
    CC04YR Youth Recreational / Social Club
    CC05 Public Convenience
    CC06 Cemetery / Crematorium / Graveyard. In Current Use.
    CC06CB Columbarium
    CC06CR Chapel Of Rest
    CC06CN Crematorium
    CC06CY Cemetery
    CC06MC Military Cemetery
    CC06MY Mortuary
    CC07 Church Hall / Religious Meeting Place / Hall
    CC08 Community Service Centre / Office
    CC09 Public Household Waste Recycling Centre (HWRC)
    CC10 Recycling Site
    CC11 CCTV
    CC12 Job Centre
    CE Education
    CE01 College
    CE01FE Further Education
    CE01HE Higher Education
    CE02 Childrenís Nursery / CrËche
    CE03 Preparatory / First / Primary / Infant / Junior / Middle School
    CE03FS First School
    CE03IS Infant School
    CE03JS Junior School
    CE03MS Middle School
    CE03NP Non State Primary / Preparatory School
    CE03PS Primary School
    CE04 Secondary / High School
    CE04NS Non State Secondary School
    CE04SS Secondary School
    CE05 University
    CE06 Special Needs Establishment.
    CE07 Other Educational Establishment
    CH Hotel / Motel / Boarding / Guest House
    CH01 Boarding / Guest House / Bed And Breakfast / Youth Hostel
    CH01YH Youth Hostel
    CH02 Holiday Let/Accomodation/Short-Term Let Other Than CH01
    CH03 Hotel/Motel
    CI Industrial Applicable to manufacturing, engineering, maintenance, storage / wholesale distribution and extraction sites
    CI01 Factory/Manufacturing
    CI01AW Aircraft Works
    CI01BB Boat Building
    CI01BR Brick Works
    CI01BW Brewery
    CI01CD Cider Manufacture
    CI01CM Chemical Works
    CI01CW Cement Works
    CI01DA Dairy Processing
    CI01DY Distillery
    CI01FL Flour Mill
    CI01FO Food Processing
    CI01GW Glassworks
    CI01MG Manufacturing
    CI01OH Oast House
    CI01OR Oil Refining
    CI01PG Pottery Manufacturing
    CI01PM Paper Mill
    CI01PW Printing Works
    CI01YD Shipyard
    CI01SR Sugar Refinery
    CI01SW Steel Works
    CI01TL Timber Mill
    CI01WN Winery
    CI02 Mineral / Ore Working / Quarry / Mine
    CI02MA Mineral Mining / Active
    CI02MD Mineral Distribution / Storage
    CI02MP Mineral Processing
    CI02OA Oil / Gas Extraction / Active
    CI02QA Mineral Quarrying / Open Extraction / Active
    CI03 Workshop / Light Industrial
    CI03GA Servicing Garage
    CI04 Warehouse / Store / Storage Depot
    CI04CS Crop Handling / Storage
    CI04PL Postal Sorting / Distribution
    CI04SO Solid Fuel Storage
    CI04TS Timber Storage
    CI05 Wholesale Distribution
    CI05SF Solid Fuel Distribution
    CI05TD Timber Distribution
    CI06 Recycling Plant
    CI07 Incinerator / Waste Transfer Station
    CI08 Maintenance Depot
    CL Leisure - Applicable to recreational sites and enterprises
    CL01 Amusements
    CL01LP Leisure Pier
    CL02 Holiday / Campsite
    CL02CG Camping
    CL02CV Caravanning
    CL02HA Holiday Accommodation
    CL02HO Holiday Centre
    CL02YC Youth Organisation Camp
    CL03 Library
    CL03RR Reading Room
    CL04 Museum / Gallery
    CL04AC Art Centre / Gallery
    CL04AM Aviation Museum
    CL04HG Heritage Centre
    CL04IM Industrial Museum
    CL04MM Military Museum
    CL04SM Science Museum
    CL04TM Transport Museum
    CL04NM Maritime Museum
    CL06 Indoor / Outdoor Leisure / Sporting Activity / Centre
    CL06AH Athletics Facility
    CL06BF Bowls Facility
    CL06CK Cricket Facility
    CL06CU Curling Facility
    CL06YF Cycling Sports Facility
    CL06DS Diving / Swimming Facility
    CL06EQ Equestrian Sports Facility
    CL06FB Football Facility
    CL06FI Fishing / Angling Facility
    CL06GF Golf Facility
    CL06GL Gliding Facility
    CL06GR Greyhound Racing Facility
    CL06HF Hockey Facility
    CL06HR Horse Racing Facility
    CL06HV Historic Vessel / Aircraft / Vehicle
    CL06LS Activity / Leisure / Sports Centre
    CL06ME Model Sports Facility
    CL06MF Motor Sports Facility
    CL06PF Playing Field
    CL06QS Racquet Sports Facility
    CL06RF Rugby Facility
    CL06RG Recreation Ground
    CL06SI Shinty Facility
    CL06SK Skateboarding Facility
    CL06SX Civilian Firing Facility
    CL06TB Tenpin Bowling Facility
    CL06TN Public Tennis Court
    CL06WA Water Sports Facility
    CL06WP Winter Sports Facility
    CL06WY Wildlife Sports Facility
    CL07 Bingo Hall / Cinema / Conference / Exhibition Centre / Theatre / Concert Hall
    CL07TH Theatre
    CL07CI Cinema
    CL07EN Entertainment Complex
    CL07EX Conference / Exhibition Centre
    CL08 Zoo / Theme Park
    CL08AK Amusement Park
    CL08MX Model Village Site
    CL08WZ Wildlife / Zoological Park
    CL08AQ Aquatic Attraction
    CL09 Beach Hut (Recreational, Non-Residential Use Only)
    CL10 Licensed Private Membersí Club
    CL10RE Recreational / Social Club
    CL11 Arena / Stadium
    CL11SD Stadium
    CL11SJ Showground
    CM Medical
    CM01 Dentist
    CM02 General Practice Surgery / Clinic
    CM02HL Health Care Services
    CM02HC Health Centre
    CM03 Hospital / Hospice
    CM03HI Hospice
    CM03HP Hospital
    CM04 Medical / Testing / Research Laboratory
    CM05 Professional Medical Service
    CM05ZS Assessment / Development Services
    CN Animal Centre
    CN01 Cattery / Kennel
    CN02 Animal Services
    CN02AX Animal Quarantining
    CN03 Equestrian
    CN03HB Horse Racing / Breeding Stable
    CN03SB Commercial Stabling / Riding
    CN04 Vet / Animal Medical Treatment
    CN05 Animal / Bird / Marine Sanctuary
    CN05AN Animal Sanctuary
    CN05MR Marine Sanctuary
    CO Office
    CO01 Office / Work Studio
    CO01EM Embassy /, High Commission / Consulate
    CO01FM Film Studio
    CO01GV Central Government Service
    CO01LG Local Government Service
    CO02 Broadcasting (TV / Radio)
    CR Retail
    CR01 Bank / Financial Service
    CR02 Retail Service Agent
    CR02PO Post Office
    CR04 Market (Indoor / Outdoor)
    CR04FK Fish Market
    CR04FV Fruit / Vegetable Market
    CR04LV Livestock Market
    CR05 Petrol Filling Station
    CR06 Public House / Bar / Nightclub
    CR07 Restaurant / Cafeteria
    CR08 Shop / Showroom
    CR08GC Garden Centre
    CR09 Other Licensed Premise / Vendor
    CR10 Fast Food Outlet / Takeaway (Hot / Cold)
    CR11 Automated Teller Machine (ATM)
    CS Storage Land
    CS01 General Storage Land
    CS02 Buildersí Yard
    CT Transport
    CT01 Airfield / Airstrip / Airport / Air Transport Infrastructure Facility
    CT01AF Airfield
    CT01AY Air Passenger Terminal
    CT01AI Air Transport Infrastructure Services
    CT01AP Airport
    CT01HS Helicopter Station
    CT01HT Heliport / Helipad
    CT02 Bus Shelter
    CT03 Car / Coach / Commercial Vehicle / Taxi Parking / Park And Ride Site
    CT03PK Public Park And Ride
    CT03PP Public Car Parking
    CT03PU Public Coach Parking
    CT03VP Public Commercial Vehicle Parking
    CT04 Goods Freight Handling / Terminal
    CT04AE Air Freight Terminal
    CT04CF Container Freight
    CT04RH Road Freight Transport
    CT04RT Rail Freight Transport
    CT05 Marina
    CT06 Mooring
    CT07 Railway Asset
    CT08 Station / Interchange / Terminal / Halt
    CT08BC Bus / Coach Station
    CT08RS Railway Station
    CT08VH Vehicular Rail Terminal
    CT09 Transport Track / Way
    CT09CL Cliff Railway
    CT09CX Chair Lift / Cable Car / Ski Tow
    CT09MO Monorail
    CT10 Vehicle Storage
    CT10BG Boat Storage
    CT10BU Bus / Coach Depot
    CT11 Transport Related Infrastructure
    CT11AD Aqueduct
    CT11LK Lock
    CT11WE Weir
    CT11WG Weighbridge / Load Gauge
    CT12 Overnight Lorry Park
    CT13 Harbour / Port / Dock / Dockyard / Slipway / Landing Stage / Pier / Jetty / Pontoon / Terminal / Berthing / Quay
    CT13FR Passenger Ferry Terminal
    CT13NB Non-Tanker Nautical Berthing
    CT13NF Nautical Refuelling Facility
    CT13SA Slipway
    CT13SP Ship Passenger Terminal
    CT13TK Tanker Berthing
    CT13VF Vehicular Ferry Terminal
    CU Utility
    CU01 Electricity Sub-Station
    CU02 Landfill
    CU03 Power Station / Energy Production
    CU03ED Electricity Distribution Facility
    CU03EP Electricity Production Facility
    CU03WF Wind Farm
    CU03WU Wind Turbine
    CU04 Pump House / Pumping Station / Water Tower
    CU04WC Water Controlling / Pumping
    CU04WD Water Distribution / Pumping
    CU04WM Water Quality Monitoring
    CU04WS Water Storage
    CU04WW Waste Water Distribution / Pumping
    CU06 Telecommunication
    CU06TE Telecommunications Mast
    CU06TX Telephone Exchange
    CU07 Water / Waste Water / Sewage Treatment Works
    CU07WR Waste Water Treatment
    CU07WT Water Treatment
    CU08 Gas / Oil Storage / Distribution
    CU08GG Gas Governor
    CU08GH Gas Holder
    CU08OT Oil Terminal
    CU09 Other Utility Use
    CU09OV Observatory
    CU09RA Radar Station
    CU09SE Satellite Earth Station
    CU09CQ Cable Terminal Station
    CU10 Waste Management
    CU11 Telephone Box
    CU11OP Other Public Telephones
    CU12 Dam
    CX Emergency / Rescue Service
    CX01 Police / Transport Police / Station
    CX01PT Police Training
    CX02 Fire Station
    CX02FT Fire Service Training
    CX03 Ambulance Station
    CX03AA Air Sea Rescue / Air Ambulance
    CX04 Lifeboat Services / Station
    CX05 Coastguard Rescue / Lookout / Station
    CX06 Mountain Rescue Station
    CX07 Lighthouse
    CX08 Police Box / Kiosk
    CZ Information
    CZ01 Advertising Hoarding
    CZ02 Tourist Information Signage
    CZ02VI Visitor Information
    CZ03 Traffic Information Signage
    L Land
    LA Agricultural - Applicable to land in farm ownership and not run as a separate business enterprise
    LA01 Grazing Land
    LA02 Permanent Crop / Crop Rotation
    LA02OC Orchard
    LB Ancillary Building
    LB99AV Aviary / Dovecot / Cage
    LB99BD Bandstand
    LB99PI Pavilion / Changing Room
    LB99SV Sports Viewing Structure
    LC Burial Ground
    LC01 Historic / Disused Cemetery / Graveyard
    LD Development
    LD01 Development Site
    LD01CC Commercial Construction Site
    LD01CO Community Construction Site
    LD01RN Residential Construction Site
    LD01TC Transport Construction Site
    LF Forestry
    LF02 Forest / Arboretum / Pinetum (Managed / Unmanaged)
    LF02AU Arboretum
    LF03 Woodland
    LL Allotment
    LM Amenity - Open areas not attracting visitors
    LM01 Landscaped Roundabout
    LM02 Verge / Central Reservation
    LM02NV Natural Central Reservation
    LM02VE Natural Verge
    LM03 Maintained Amenity Land
    LM04 Maintained Surfaced Area
    LM04MV Made Central Reservation
    LM04PV Pavement
    LO Open Space
    LO01 Heath / Moorland
    LP Park
    LP01 Public Park / Garden
    LP02 Public Open Space / Nature Reserve
    LP03 Playground
    LP03PA Play Area
    LP03PD Paddling Pool
    LP04 Private Park / Garden
    LU Unused Land
    LU01 Vacant / Derelict Land
    LW Water
    LW01 Lake / Reservoir
    LW01BP Balancing Pond
    LW01BV Buried Reservoir
    LW02 Named Pond
    LW02DE Dew Pond
    LW02DP Decoy Pond
    LW02IW Static Water
    LW03 Waterway
    LW03LR Leats / Races
    LW03DR Drain
    M Military
    MA Army
    MA99AR Army Military Range
    MA99AS Army Site
    MA99AT Army Military Training
    MA99AG Army Military Storage
    MB Ancillary Building
    MB99TG Military Target
    MF Air Force
    MF99UG Air Force Military Storage
    MF99UR Air Force Military Range
    MF99US Air Force Site
    MF99UT Air Force Military Training
    MG Defence Estates
    MN Navy
    MN99VG Naval Military Storage
    MN99VR Naval Military Range
    MN99VS Naval Site
    MN99VT Naval Military Training
    O Other (Ordnance Survey Only)
    OA Aid To Navigation
    OA01 Aid To Aeronautical Navigation
    OA01AL Aeronautical Navigation Beacon / Light
    OA01LL Landing Light
    OA01SQ Signal Square
    OA01WK Wind Sock / Wind Tee
    OA02 Aid To Nautical Navigation
    OA02DM Daymark
    OA02FG Fog Horn Warning
    OA02NL Nautical Navigation Beacon / Light
    OA03 Aid To Road Navigation
    OA03GP Guide Post
    OC Coastal Protection / Flood Prevention
    OC01 Boulder Wall / Sea Wall
    OC02 Flood Gate / Flood Sluice Gate / Flood Valve
    OC03 Groyne
    OC04 Rip-Rap
    OE Emergency Support
    OE01 Beach Office / First Aid Facility
    OE02 Emergency Telephone (Non Motorway)
    OE03 Fire Alarm Structure / Fire Observation Tower / Fire Beater Facility
    OE04 Emergency Equipment Point / Emergency Siren / Warning Flag
    OE05 Lifeguard Facility
    OE06 LIfe / Belt / Buoy / Float / Jacket / Safety Rope
    OF Street Furniture
    OG Agricultural Support Objects
    OG01 Fish Ladder / Lock / Pen / Trap
    OG02 Livestock Pen / Dip
    OG03 Currick
    OG04 Slurry Bed / Pit
    OH Historical Site / Object
    OH01 Historic Structure / Object
    OI Industrial Support
    OI01 Adit / Incline / Level
    OI02 Caisson / Dry Dock / Grid
    OI03 Channel / Conveyor / Conduit / Pipe
    OI04 Chimney / Flue
    OI05 Crane / Hoist / Winch / Material Elevator
    OI06 Flare Stack
    OI07 Hopper / Silo / Cistern / Tank
    OI08 Grab / Skip / Other Industrial Waste Machinery / Discharging
    OI09 Kiln / Oven / Smelter
    OI10 Manhole / Shaft
    OI11 Industrial Overflow / Sluice / Valve / Valve Housing
    OI12 Cooling Tower
    OI13 Solar Panel / Waterwheel
    OI14 Telephone Pole / Post
    OI15 Electricity Distribution Pole / Pylon
    ON Significant Natural Object
    ON01 Boundary / Significant / Historic Tree / Pollard
    ON02 Boundary / Significant Rock / Boulder
    ON03 Natural Hole (Blow / Shake / Swallow)
    OO Ornamental / Cultural Object
    OO02 Mausoleum / Tomb / Grave
    OO03 Simple Ornamental Object
    OO04 Maze
    OP Sport / Leisure Support
    OP01 Butt / Hide
    OP02 Gallop / Ride
    OP03 Miniature Railway
    OR Royal Mail Infrastructure
    OR01 Postal Box
    OR02 Postal Delivery Box / Pouch
    OR03 PO Box
    OR04 Additional Mail / Packet Addressee
    OS Scientific / Observation Support
    OS01 Meteorological Station / Equipment
    OS02 Radar / Satellite Infrastructure
    OS03 Telescope / Observation Infrastructure / Astronomy
    OT Transport Support
    OT01 Cattle Grid / Ford
    OT02 Elevator / Escalator / Steps
    OT03 Footbridge / Walkway
    OT04 Pole / Post / Bollard (Restricting Vehicular Access)
    OT05 Subway / Underpass
    OT06 Customs Inspection Facility
    OT07 Lay-By
    OT08 Level Crossing
    OT09 Mail Pick Up
    OT10 Railway Pedestrian Crossing
    OT11 Railway Buffer
    OT12 Rail Drag
    OT13 Rail Infrastructure Services
    OT14 Rail Kilometre Distance Marker
    OT15 Railway Lighting
    OT16 Rail Mile Distance Marker
    OT17 Railway Turntable
    OT18 Rail Weighbridge
    OT19 Rail Signalling
    OT20 Railway Traverse
    OT21 Goods Tramway
    OT22 Road Drag
    OT23 Vehicle Dip
    OT24 Road Turntable
    OT25 Road Mile Distance Marker
    OT26 Road Kilometre Distance Marker
    OT27 Road Infrastructure Services
    OU Unsupported Site
    OU01 Cycle Parking Facility
    OU04 Picnic / Barbeque Site
    OU05 Travelling Persons Site
    OU08 Shelter (Not Including Bus Shelter)
    P Parent Shell
    PP Property Shell
    PS Street Record
    R Residential
    RB Ancillary Building
    RC Car Park Space
    RC01 Allocated Parking
    RD Dwelling
    RD01 Caravan
    RD02 Detached
    RD03 Semi-Detached
    RD04 Terraced
    RD06 Self Contained Flat (Includes Maisonette / Apartment)
    RD07 House Boat
    RD08 Sheltered Accommodation
    RD10 Privately Owned Holiday Caravan / Chalet
    RG Garage
    RG02 Lock-Up Garage / Garage Court
    RH House In Multiple Occupation
    RH01 HMO Parent
    RH02 HMO Bedsit / Other Non Self Contained Accommodation
    RH03 HMO Not Further Divided
    RI Residential Institution
    RI01 Care / Nursing Home
    RI02 Communal Residence
    RI02NC Non-Commercial Lodgings
    RI02RC Religious Community
    RI03 Residential Education
    U Unclassified
    UC Awaiting Classification
    UP Pending Internal Investigation
    X Dual Use
    Z Object of Interest
    ZA Archaeological Dig Site
    ZM Monument
    ZM01 Obelisk / Milestone / Standing Stone
    ZM01OB Obelisk
    ZM01ST Standing Stone
    ZM02 Memorial / Market Cross
    ZM03 Statue
    ZM04 Castle / Historic Ruin
    ZM05 Other Structure
    ZM05BS Boundary Stone
    ZM05PN Permanent Art Display / Sculpture
    ZM05CE Cascade / Fountain
    ZM05WI Windmill (Inactive)
    ZS Stately Home
    ZU Underground Feature
    ZU01 Cave
    ZU04 Pothole / Natural Hole
    ZV Other Underground Feature
    ZV01 Cellar
    ZV02 Disused Mine
    ZV02MI Mineral Mining / Inactive
    ZV02OI Oil And / Gas Extraction/ Inactive
    ZV02QI Mineral Quarrying And / Open Extraction / Inactive
    ZV03 Well / Spring
    ZV03SG Spring
    ZV03WL Well
    ZW Place Of Worship
    ZW99AB Abbey
    ZW99CA Cathedral
    ZW99CH Church
    ZW99CP Chapel
    ZW99GU Gurdwara
    ZW99KH Kingdom Hall
    ZW99MQ Mosque
    ZW99MT Minster
    ZW99SU Stupa
    ZW99SY Synagogue
    ZW99TP Temple
    ZW99LG Lych Gate

    General

    Authentication

    To authorize, use this code:

    # With shell, you can just pass the correct header with each request
    curl "api_endpoint_here"
      -H "x-api-key: YOUR_API_KEY"
      -H "x-client-id: YOUR_CLIENT_ID"
    

    Make sure to replace YOUR_API_KEY and YOUR_CLIENT_ID with your supplied credentials.

    Access to Addresscloud web services requires a valid API key and Client ID that connects API requests to your account. The example requests in this documentation don't include these credentials API key, you will need to supply one using the x-api-key and x-client-id header parameters.

    If you are an existing customer you can find your access key by logging in to your account. If you are a new customer you can signup by contacting our sales team who will be happy to set you up with a trial key.

    Versioning

    Each Addresscloud API is versioned with a version string specified in the base URL that can be incremented independently from other APIs.

    These changes are considered backwards compatible and will not require the version string to be incremented:

    These changes are considered backwards incompatible and will require the version string to be incremented:

    Rate limits

    Addresscloud APIs have rate limits that cap the number of requests that can be made against an endpoint. If you exceed a rate limit, your request will be throttled and you will receive HTTP 429 Too Many Requests responses from the API.

    CORS

    Addresscloud web services support Cross-Origin Requests with no domain restrictions to allow for ease of integration into browser based applications.

    HTTPS

    Access to all Addresscloud APIs over HTTPS is mandatory. Requests initiated over HTTP are automatically upgraded to HTTPS.

    Coordinates

    Addresscloud APIs use GeoJSON formatting wherever possible to represent geospatial data. The default spatial reference system used is WGS84. Our Match API does support returning of coordinates using other reference systems via the optional crs parameter.

    Content Types

    By default Addresscloud returns JSON for all calls and expects any POST requests to supply JSON formatted bodies unless otherwise advised. UTF-8 encoding is used on all requests and responses.

    Examples

    The APIs all feature worked examples with sample HTTPS calls. As we need to pass authentication headers to Addresscloud to be able to connect we cannot run these in a web browser. Each example shows a cURL command which is available on Windows, Max or Linux. Note you will need to insert your own API key for these to work.

    Errors

    Addresscloud uses the standard HTTP Status Codes to communicate errors together with a json formatted error message giving more information as to the root cause of the error. The main codes used are as follows:

    4xx Errors

    Errors starting with a 4 generally indicate a client side issue that must be resolved before re-querying the service such as:

    Error Code Meaning
    400 Bad Request -- Normally caused by an incorrect query parameter e.g. child "country" fails because "country" must be one of [gb, im, je, gg, ie]
    403 Forbidden -- The API key is incorrect for the endpoint being called
    404 Not Found -- The resource was not found, this may indicate an incorrect endpoint or trying to retrieve a record for example, an address, which does not exist
    429 Too Many Requests -- You have exceeded your per second or per day quota of requests

    5xx Errors

    Errors starting with a 5 generally indicate a server side fault and should be reported to our support staff immediately:

    Error Code Meaning
    500 Internal Server Error -- A catch-all error indicating that something has failed server side
    503 Service Unavailable -- The service is down and cannot respond to requests