Introduction

Addresscloud helps organisations worldwide 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.

Terms of Use

This documentation site is provided for Addresscloud users only. Use is subject to our Website Terms and Conditions. In continuing to use this site, you agree to these terms.

Use of Addresscloud API Services is subject to our API Terms of Use. In continuing to use our Services, you agree to these terms.

Getting Started

Run in Postman

The easiest way to get started is using the excellent free Postman tool. You can download Postman at Get Postman. The button below will get you started, you will just need to replace {{API_KEY}} and {{CLIENT_ID}} with your supplied credentials. 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.

Tutorials

The Addresscloud team have prepared a number of tutorial blogs for common use cases, links can be found below:

If you need any more help please reach out to our support team who will be happy to assist with any questions.

Intelligence Views

We have recently built logic for a new concept we call Views. This functionality allows a customer to configure one or more "views" of their Intelligence data and supports the following functionality:

Flexible structure, a view can be created for anything
Unlimited views per customer e.g. a customer could have a view by distribution channel (different views for direct vs coverholder vs softwarehouse for example)
Values can be mapped from multiple datasets (e.g. JBA flood can be from GB, NI and ROI layers, these are currently all separate)
Human readable field names
Configurable RAG (red, amber, green) classifications for underwriting rules (e.g. a flood score of 12+ is red, amber is 6+, otherwise green)
Decode from lookup tables on the fly, no more having to decode values client-side (e.g. the API will return “1983 - 1992” rather than “E”

Going Live

Once you are ready to go-live please contact your account manager who will be happy to set you up with a commercial plan. You can use the same credentials for both Production and Sandbox environments however it is very important that you update any API calls to use the Production environment https://api.addresscloud.com to ensure your usage is correctly billed and is compliant with your contract and data provider requirements.

Getting Help

If you need any more help please reach out to our support team who will be happy to assist with any questions.

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

Both of these operations are supported by the same Geocode endpoint

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

Lookup for displaying the full details of a location based on it's Addresscloud id, dataset_id or UPRN
Suggest for supporting auto-complete (aka typeahead) address lookups

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:

address a full address which may or may not also be a delivery point
postcode1 smallest postcode category e.g. postcode unit in the UK or Eircode in Ireland
building_group a collection of buildings with a collective name, located on or near the same thoroughfare (Ireland only)
street either a primary or secondary (dependent) street
postcode2 the next largest postcode category after postcode1 that is created by aggregating postcode1 areas e.g. postcode sector in the UK
locality the most common population centre data element within a country e.g. UK City/Town/Village
postcode3 the next largest postcode category after postcode2 that is created by aggregating postcode2 areas e.g. postcode district in the UK
subregion smallest geographic data element within a country e.g. post towns in Ireland
postcode4 the next largest postcode category after postcode3 that is created by aggregating postcode3 areas e.g. postcode area in the UK
region most common geographic data element within a country e.g. UK or Irish County

Getting Started

We have produced a series of tutorial articles which are great for new developers getting started with Addresscloud APIs:

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": "adfrst",
      "location_type": "address",
      "id": "8e195b4636cb48f:g_q2bg",
      "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": "adfrst",
      "location_type": "address",
      "id": "8e195b4636ca297:v-yLUP",
      "description": "66A Ladysmith Road, Exeter EX1 2PP",
      "score": 1
    },
    {
      "dataset": "adfrst",
      "location_type": "address",
      "id": "8e195b4636ca297:FQ9Rgs",
      "description": "66 Ladysmith Road, Exeter EX1 2PP",
      "score": 1
    },
    {
      "dataset": "adfrst",
      "location_type": "address",
      "id": "8e195b4636ca2c7:Fq3i48",
      "description": "68 Ladysmith Road, Exeter EX1 2PP",
      "score": 1
    },
    {
      "dataset": "adfrst",
      "location_type": "address",
      "id": "8e195b4636cb597:FkrhlZ",
      "description": "70 Ladysmith Road, Exeter EX1 2PP",
      "score": 1
    },
    {
      "dataset": "adfrst",
      "location_type": "address",
      "id": "8e195b4636cb4a7:0J4uiH",
      "description": "72 Ladysmith Road, Exeter EX1 2PP",
      "score": 1
    },
    {
      "dataset": "adfrst",
      "location_type": "address",
      "id": "8e195b4636cb48f:g_q2bg",
      "description": "74 Ladysmith Road, Exeter EX1 2PP",
      "score": 1
    },
    {
      "dataset": "adfrst",
      "location_type": "address",
      "id": "8e195b4636cb4df:TYnb1-",
      "description": "76 Ladysmith Road, Exeter EX1 2PP",
      "score": 1
    },
    {
      "dataset": "adfrst",
      "location_type": "address",
      "id": "8e195b445d64b67:meDdTJ",
      "description": "78 Ladysmith Road, Exeter EX1 2PP",
      "score": 1
    },

    // results continue....

    {
      "dataset": "adfrst",
      "location_type": "address",
      "id": "8e195b445993daf:frkEPF",
      "description": "147 Ladysmith Road, Exeter EX1 2PP",
      "score": 1
    },
    {
      "dataset": "adfrst",
      "location_type": "address",
      "id": "8e195b445993d47:LkwvCM",
      "description": "149A Ladysmith Road, Exeter EX1 2PP",
      "score": 1
    },
    {
      "dataset": "adfrst",
      "location_type": "address",
      "id": "8e195b445993d47:ajcQQk",
      "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": "adfrst",
      "location_type": "postcode1",
      "id": "UtoDmhw5VprD1qsvdvV9-g",
      "description": "EX1 2PP",
      "properties": {
        "postcode": "EX1 2PP",
        "country": "gb",
        "dataset_id": "ABP:PCO:ex1_2pp"
      },
      "geometry": {
        "type": "Point",
        "crs": "EPSG:4326",
        "coordinates": {
          "lon": -3.5078067,
          "lat": 50.7258397
        },
        "geo_accuracy": "postcode1"
      }
    }
  ]
}

Kerbside example:

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

The result is an address with additional parameter in the geometry indicating whether a kerbside location has been found:

{
    "match_status": "MATCH",
    "found": 1,
    "max_score": 1,
    "results": [{
        "dataset": "adfrst",
        "location_type": "address",
        "id": "8e195b4636cb48f:g_q2bg",
        "description": "74 Ladysmith Road, Exeter EX1 2PP",
        "score": 1,
        "properties": {
            "building_number": "74",
            "primary_street": "Ladysmith Road",
            "locality": "Exeter",
            "postcode": "EX1 2PP",
            "country": "gb",
            "dataset_id": "ADF:8745312",
            "uprn": 100040220317,
            "udprn": 8745312,
            "address_type": "MAI",
            "delivery_point": true
        },
        "geometry": {
            "type": "Point",
            "crs": "EPSG:4326",
            "coordinates": {
                "lon": -3.508041,
                "lat": 50.7263202
            },
            "geo_accuracy": "rooftop",
            "kerbside": true
        }
    }]
}

Label example:

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

The result is an address with additional label object showing the address formatted as line_1, line_2 etc:

{
    "match_status": "MATCH",
    "found": 1,
    "max_score": 1,
    "results": [{
        "dataset": "adfrst",
        "location_type": "address",
        "id": "8e195b4636cb48f:g_q2bg",
        "description": "74 Ladysmith Road, Exeter EX1 2PP",
        "score": 1,
        "properties": {
            "building_number": "74",
            "primary_street": "Ladysmith Road",
            "locality": "Exeter",
            "postcode": "EX1 2PP",
            "country": "gb",
            "dataset_id": "ADF:8745312",
            "uprn": 100040220317,
            "udprn": 8745312,
            "address_type": "MAI",
            "delivery_point": true
        },
        "label": {
            "line_1": "74 Ladysmith Road",
            "line_2": "Exeter",
            "postcode": "EX1 2PP"
        },
        "geometry": {
            "type": "Point",
            "crs": "EPSG:4326",
            "coordinates": {
                "lon": -3.5081921,
                "lat": 50.7262865
            },
            "geo_accuracy": "rooftop"
        }
    }]
}

Intel example:

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

The result is an address with additional label object showing the address formatted as line_1, line_2 etc:

{
    "match_status": "MATCH",
    "found": 1,
    "max_score": 1,
    "results": [{
        "dataset": "adfrst",
        "location_type": "address",
        "id": "8e195b4636cb48f:g_q2bg",
        "description": "74 Ladysmith Road, Exeter EX1 2PP",
        "score": 1,
        "properties": {
            "building_number": "74",
            "primary_street": "Ladysmith Road",
            "locality": "Exeter",
            "postcode": "EX1 2PP",
            "country": "gb",
            "dataset_id": "ADF:MAI:8745312",
            "uprn": 100040220317,
            "udprn": 8745312,
            "address_type": "MAI",
            "delivery_point": true
        },
        "geometry": {
            "type": "Point",
            "crs": "EPSG:4326",
            "coordinates": {
                "lon": -3.5081921,
                "lat": 50.7262865
            },
            "geo_accuracy": "rooftop"
        },
        "intel": {
            "intel_status": "OK",
            "found": 14,
            "results": {
                "opflod": {
                    "ridist": {
                        "status": "OK",
                        "results": [{
                            "name": "Mincinglake Stream",
                            "distance": 651
                        }]
                    }
                },
                "prpaid": {
                    "psales": {
                        "status": "OK",
                        "results": [{
                            "date_of_transfer": "2006-10-27",
                            "old_new": "N",
                            "ppd_cat_type": "A",
                            "price": 209950,
                            "property_type": "T",
                            "record_status": "A",
                            "txn_uq_id": "{6D8F5B4F-4C7C-4FE5-AD9B-2A7452B2E117}"
                        }]
                    }
                }
            }
        }
    }]
}

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": 1,
  "results": [
    {
      "dataset": "adfrst",
      "location_type": "address",
      "id": "8e195b4636cb48f:g_q2bg",
      "description": "74 Ladysmith Road, Exeter EX1 2PP",
      "score": 1
    },
    {
      "dataset": "adfrst",
      "location_type": "address",
      "id": "8e195b4636cb4a7:0J4uiH",
      "description": "72 Ladysmith Road, Exeter EX1 2PP",
      "score": 1
    },
    {
      "dataset": "adfrst",
      "location_type": "address",
      "id": "8e195b4636cb4df:TYnb1-",
      "description": "76 Ladysmith Road, Exeter EX1 2PP",
      "score": 1
    },
    {
      "dataset": "adfrst",
      "location_type": "address",
      "id": "8e195b445d64b67:meDdTJ",
      "description": "78 Ladysmith Road, Exeter EX1 2PP",
      "score": 1
    }
  ]
}

"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`
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`, `102100`, `102113`, `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`)
kerbside	`false`	Return kerbside coordinates (i.e. the nearest road access point) rather than rooftop, where available (options are `true` or `false`)
show_label	`false`	Return an optional label object including the address formatted as line_1, line_2 etc + postcode (options are `true` or `false`)
intel	`false`	Combine an Intelligence API call with a match call returning a single object (options are `true` or `false`)
intel_view		Present the intel results using a pre-configured "view"

Lookup by ID

A simple lookup for an address by ID:

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

The result is an exact match:

{
  "found": true,
  "result": {
    "dataset": "adfrst",
    "location_type": "address",
    "id": "8e195b4636ca297:v-yLUP",
    "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. `8e195b4636cb48f:g_q2bg`
crs	`4326`
show_alts	`false`
kerbside	`false`
show_label	`false`

Lookup by UDPRN

A simple lookup for an address by UDPRN:

curl "https://api.addresscloud.com/match/v1/address/lookup/byUDPRN/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 UDPRN (Unique Delivery Point Reference Number) - a unique address identifier specific to the UK Royal Mail.

HTTP Request

GET https://api.addresscloud.com/match/v1/[target]/lookup/byUDPRN/[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	UDPRN of the the location to lookup e.g. `14858893`
crs	`4326`
show_alts	`false`
kerbside	`false`
show_label	`false`

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`
crs	`4326`
show_alts	`false`
kerbside	`false`
show_label	`false`

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.

rooftop - surveyed rooftop level geocode
interpolated - assumed rooftop using interpolation (not used currently for UK/I however this is is a technique regularly used by search engine geocoders such as Google and Bing)
grid - grid level (for OS this is the SW Corner of referenced 100m grid square)
postcode1 - full postcode for UK, Eircode for Ireland
building_group - used in Ireland e.g. a housing estate or shopping centre
street - street level, could be centroid or start/end depending on the data source, for GB this will be the start of the street
postcode2 - postcode sector (UK) centroid (calculated by grouping all addresses in the sector and calculating the centroid)
locality - locality centroid (calculated by grouping all addresses in the locality and calculating the centroid)
postcode3 - postcode district (UK) centroid (calculated by grouping all addresses in the district and calculating the centroid)
subregion - nor used in UK, in Ireland this will be the Dublin postal code or postal town
postcode4 - postcode area (UK) centroid (calculated by grouping all addresses in the area and calculating the centroid)
region - geographic centre of ceremonial county as derived from OS Boundary Line

Note that location_type and geo_accuracy are not the same concept. A location_type describes "what" we are looking for whereas geo_accuracy is how accurately" this can be displayed on a map. Take, for example, a UK address where the address is complete and has been assigned a postcode by the Royal Mail but the Ordnance Survey have not yet surveyed the property and therefore geo_accuracy='street'. Such a record will have a location_type of address but a geo_accuracy of street. There are around a million such addresses in AddressBase Premium and therefore applying a strict filter of geo_accuracy='rooftop' would mean that no result will be returned for this address. We therefore recommend not using a filter on geo_accuracy for most use cases and instead have logic to deal with lower geo_accuracy levels on the client side.

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:

address a full address which may or may not also be a delivery point
postcode1 smallest postcode category e.g. postcode unit in the UK or Eircode in Ireland

The Intelligence API will support the following lookups:

byId retrieve intelligence by Addresscloud ID
byAddress retrieve intelligence for an address
byUDPRN retrieve intelligence by UDPRN (UK only)
byUPRN retrieve intelligence by UPRN (UK only)
byPoint retrieve intelligence by lon,lat pair (Global, WGS84 only)
byWKT retrieve intelligence by Well Known Text (WKT) string (Global, WGS84 only)
byDatasetId retrieve intelligence for a specific dataset using that dataset's natural primary key

The following header parameters are required:

x-api-key your Addresscloud API key
x-client-id your supplied Client ID

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:

OK: The call executed successfully and results were found
ERROR: An error occurred with the call / layer
ZERO_RESULTS: The call completed successfully but no results were found for the layer

Intel by ID

Retrieve intelligence by Addresscloud ID

curl "https://api.addresscloud.com/intel/v1/address/intel/byId/8e195b4636ca297:v-yLUP"
  -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. `8e195b4636ca297:v-yLUP`
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 Address

Retrieve intelligence by an address

curl "https://api.addresscloud.com/intel/v1/address/intel/byAddress?query=66A Ladysmith Road, Exeter EX1 2PP&country=gb"
  -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. Will either return data if the address yields an exact match or no result if there is no match or ambiguity. The address matched is not returned. See Match API with intel=true to match an address and return intelligence.

HTTP Request

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

URL Parameters

Parameter	Description
target	What kind of location are we trying to retrieve intelligence for? (one of `address`, `postcode1`)
query	Query expressed as a single string (recommended option for most use cases) e.g. `74 EX1 2PP`
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.
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 UDPRN

Retrieve intelligence by UDPRN (UK only)

curl "https://api.addresscloud.com/intel/v1/address/intel/byUDPRN/53579726"
  -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 UDPRN.

HTTP Request

GET https://api.addresscloud.com/intel/v1/[target]/intel/byUDPRN/[udprn]

URL Parameters

Parameter	Description
target	What kind of location are we trying to retrieve intelligence for? (one of `address`, `postcode1`)
udprn	UDPRN of the the location to lookup e.g. `53579726`
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 (UK only)

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

Intel by Dataset ID

Retrieve intelligence for a specific dataset using that dataset's natural primary key

curl "https://api.addresscloud.com/intel/v1/address/intel/byDatasetId/fd016497-78a2-4b38-a5df-9fa65be15c39?dataset=flodre"
  -H "x-api-key: YOUR_API_KEY"
  -H "x-client-id: YOUR_CLIENT_ID"

The result is an exact match:

{
    "intel_status": "OK",
    "found": 1,
    "results": {
        "flodre": {
            "eligib": {
                "status": "OK",
                "results": [{
                    "delete_effective_date": "2020-03-27",
                    "eligibility_category": "B",
                    "eligibility_criteria": "1",
                    "eligibility_effective_date": "2019-03-22",
                    "frid": "fd016497-78a2-4b38-a5df-9fa65be15c39",
                    "source": "1",
                    "strike_claim_count": 0
                }]
            }
        }
    }
}

Used for retrieving intelligence for a specific dataset using that dataset's natural primary key.

HTTP Request

GET https://api.addresscloud.com/intel/v1/[target]/intel/byDatasetId/[datasetId]?dataset=[dataset]

URL Parameters

Parameter	Description
target	What kind of location are we trying to retrieve intelligence for? (one of `address`, `postcode1`)
datasetId	Natural key of the target dataset e.g. `fd016497-78a2-4b38-a5df-9fa65be15c39`
dataset	Required: The dataset we wish to retrieve intelligence for (note only datasets with natural primary keys are supported)

Data Dictionary (UK/I)

Addresscloud supports a range of datasets, these are listed below together with the update frequency:

Dataset Code	Provider	Dataset	Update Frequency
acloud	Addresscloud⁽⁵⁾	Addresscloud Property	Monthly
rebuil	Addresscloud	Addresscloud Rebuild	Monthly
ukcrim	Addresscloud⁽⁴⁾	Addresscloud Crime	Annual
firest	Addresscloud⁽⁵⁾	Addresscloud Fire	Quarterly
opflod	Addresscloud⁽⁶⁾	Addresscloud Open Flood	Adhoc
acland	Addresscloud⁽⁶⁾	Addresscloud Open Land	Adhoc
bgsgip	British Geological Survey	GeoSure Insurance Product	Adhoc
bluntm	Bluesky International	National Tree Model	Adhoc
cranpd	Cranfield	Natural Perils Database	Adhoc
epcbui	Ministry of Housing, Communities & Local Government	EPC (Energy Performance) Certificates	Adhoc
ifeuws	Aon IF	European Windstorm	Annual
flodre	FloodRe	FloodRe Eligibility	Quarterly
jbafgb	JBA Risk	UK Flood Maps	Annual
jbafie	JBA Risk	Irish Flood Maps	Annual
jbafni	JBA Risk	Northern Ireland Flood Maps	Annual
jbacgb	JBA Risk	UK Climate Data	Annual
mplsky	MapleSky	MapleSky Subsidence Model	Annual
ostopo	Ordnance Survey	MasterMap Topography	Bi-Annual
prpaid	Land Registry	Price Paid	Monthly
tfngrm	Terrafirma	National Ground Risk Model	Adhoc
voarat	VOA⁽⁵⁾	Business Rating	Adhoc

⁽¹⁾ Contains Ordnance Survey Points of Interest data
⁽²⁾ Contains Ordnance Survey Open Rivers data
⁽³⁾ Contains Land Registry and Office of National Statistics data
⁽⁴⁾ Contains Police and Office of National Statistics data
⁽⁵⁾ Requires an OS AddressBase Premium licence
⁽⁶⁾ Contains Environment Agency data
⁽⁷⁾ Contains Quality Care Commission data

Addresscloud Property (acloud)

A sample result:

{
    "acloud": {
        "acloud": {
            "status": "OK",
            "results": [{
                "bathrooms": 2,
                "bathrooms_accuracy": "A",
                "bedrooms": 2,
                "bedrooms_accuracy": "A",
                "building_use": "R",
                "epc_rating": "C",
                "epc_rating_accuracy": "A",
                "est_value": 395000,
                "est_value_accuracy": "A",
                "flat_roof_pc": 8.8,
                "floor_area": 76,
                "floor_area_accuracy": "A",
                "floor_level": 1,
                "floor_level_accuracy": "A",
                "top_floor": false,
                "top_floor_accuracy": "A",
                "footprint": 356,
                "form": "FP",
                "form_accuracy": "A",
                "habitable_rooms": 4,
                "habitable_rooms_accuracy": "A",
                "height": 13.2,
                "mainheat": "MG",
                "mainheat_accuracy": "A",
                "mixed_use": false,
                "multi_occ": 20,
                "period_built": "E",
                "period_built_accuracy": "A",
                "receptions": 2,
                "receptions_accuracy": "A",
                "roof": "PI",
                "roof_accuracy": "A",
                "site_address_count": 20,
                "site_area": 2299,
                "site_building_count": 1,
                "site_building_footprint": 356,
                "site_classification": 240,
                "site_inspireid": "0046686769",
                "site_use": "R",
                "storeys": 4,
                "storeys_accuracy": "A",
                "style": "FL",
                "style_accuracy": "A",
                "tenure": "FH",
                "tenure_accuracy": "A",
                "type": "F",
                "type_accuracy": "A",
                "use": "R",
                "walls": "BR",
                "walls_accuracy": "A",
                "year_built": 1988,
                "year_built_accuracy": "A"
            }]
        },
        "aclabi": {
            "status": "OK",
            "results": [{
                "type": "45",
                "type_accuracy": "A",
                "walls": "2",
                "walls_accuracy": "A"
            }]
        }
    }
}

Addresscloud Property (acloud)

Field	Description	Data Type	Lookup
use	Property Use	Text	Addresscloud Use
mixed_use	Mixed Use	Boolean
classification	Commercial Classification	Text	Addresscloud Classification
multi_occ	Multiple Occupancy (number of occupiers in property)	Numeric
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
form	Property Form	Text	Addresscloud Form
form_accuracy	Property Form Accuracy	Text	Addresscloud Accuracy
period_built	Period Built	Text	Addresscloud Period Built
period_built_accuracy	Period Built Accuracy	Text	Addresscloud Accuracy
year_built	Year Built	Numeric
year_built_accuracy	Year Built Accuracy	Text	Addresscloud Accuracy
listed_grade	Listed Grade	Text
listed_grade_accuracy	Listed Grade Accuracy	Text	Addresscloud Accuracy
bedrooms	Bedrooms	Numeric
bedrooms_accuracy	Bedrooms Accuracy	Text	Addresscloud Accuracy
bathrooms	Bathrooms	Numeric
bathrooms_accuracy	Bathrooms Accuracy	Text	Addresscloud Accuracy
receptions	Receptions	Numeric
receptions_accuracy	Receptions Accuracy	Text	Addresscloud Accuracy
habitable_rooms	Habitable Rooms	Numeric
habitable_rooms_accuracy	Habitable Rooms Accuracy	Text	Addresscloud Accuracy
height	Building (Ridge) Height (m)	Numeric
basement	Is Basement?	Boolean
has_basement	Has Basement?	Boolean
has_basement_accuracy	Has Basement Accuracy	Text	Addresscloud Accuracy
walls	Wall Type	Text	Addresscloud Wall Type
walls_accuracy	Wall Type Accuracy	Text	Addresscloud Accuracy
roof	Roof Type	Text	Addresscloud Roof Type
roof_accuracy	Roof Type Accuracy	Text	Addresscloud Accuracy
flat_roof_pc	Flat Roof %	Numeric
social	Social Housing?	Boolean
footprint	Property Footprint (m2)	Numeric
floor_area	Internal Floor Area (m2)	Numeric
floor_area_accuracy	Floor Area Accuracy	Text	Addresscloud Accuracy
storeys	Number of Storeys	Numeric
storeys_accuracy	Storeys Accuracy	Text	Addresscloud Accuracy
floor_level	Floor Level	Numeric
floor_level_accuracy	Floor Level Accuracy	Text	Addresscloud Accuracy
top_floor	Top Floor	Boolean
top_floor_accuracy	Top Floor Accuracy	Text	Addresscloud Accuracy
tenure	Tenure	Text	Addresscloud Tenure
tenure_accuracy	Tenure Accuracy	Text	Addresscloud Accuracy
epc_rating	EPC Rating	Text
epc_rating_accuracy	EPC Rating Accuracy	Text	Addresscloud Accuracy
mainheat	Main Heat Source	Text	Addresscloud Heat Source
mainheat_accuracy	Main Heat Source Accuracy	Text	Addresscloud Accuracy
conservation	Conservation Area?	Boolean
est_value	Estimated Value	Numeric
est_value_accuracy	Estimated Value Accuracy	Text	Addresscloud Accuracy
building_use	Building Use	Text	Addresscloud Use
building_classification	Building Classification	Text	Addresscloud Classification
building_classifications	Building Classifications (with counts)	Text	Addresscloud Classification
site_address_count	Site Address Count	Numeric
site_area	Site Area (m2)	Numeric
site_building_count	Site Building Count	Numeric
site_building_footprint	Site Building Footprint (m2)	Numeric
site_classification	Site Classification	Text	Addresscloud Site Classification
site_use	Site Use	Text	Addresscloud Use
site_inspireid	Site INSPIRE ID	Text	Land Registry INSPIRE ID Lookup

Addresscloud Property (ABI encoded*) (aclabi)

Field	Description	Data Type	Lookup
type	Property Type	Text	ABI Codelist 400
type_accuracy	Property Type Accuracy	Text	Addresscloud Accuracy
walls	Wall Type	Text	ABI Codelist 407
walls_accuracy	Wall Type Accuracy	Text	Addresscloud Accuracy
roof	Roof Type	Text	ABI Codelist 408
roof_accuracy	Roof Type Accuracy	Text	Addresscloud Accuracy
listed_grade	Listed Grade	Text	ABI Codelist 418
listed_grade_accuracy	Listed Grade Accuracy	Text	Addresscloud Accuracy

^* Requires an active licence for Polaris Standards

Addresscloud Rebuild (rebuil)

A sample result:

{
    "rebuil": {
        "rbresi": {
            "status": "OK",
            "results": [{
                "basement": 0,
                "main_house": 200000,
                "rebuild_accuracy": "A",
                "rebuild_cost": 200000
            }]
        }
    }
}

Residential Rebuild (rbresi)

Field	Description	Data Type	Lookup
basement	Basement Cost	Numeric
main_house	Main House Cost	Numeric
rebuild_accuracy	Rebuild Accuracy	Text	Addresscloud Accuracy
rebuild_cost	Total Rebuild Cost	Numeric

Addresscloud 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
        }
      ]
    },
    "ukvehc": {
      "status": "OK",
      "results": [
        {
          "vehc_score": 4,
          "vehc_class": 2,
          "vehc_trend": 1
        }
      ]
    }
  }
}

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

Vehicle Crime by Postcode Sector (ukvehc)

Field	Description	Data Type	Lookup
vehc_score	Vehicle Crime Score	Numeric
vehc_class	Vehicle Crime Classification	Numeric	Classification
vehc_trend	Vehicle Crime Trend	Numeric	Crime Trend

Addresscloud Fire (firest)

A sample result:

{
    "firest": {
        "fidist": {
            "status": "OK",
            "results": [{
                "count_5k": 3,
                "uprn": 100062630458,
                "name": "Medway Fire Station",
                "dist": 2,
                "drive_dist": 5,
                "drive_time": 9,
                "drive_time_traffic": 10,
                "class_best": 4,
                "class_worst": 4
            }]
        },
        "firisk": {
            "status": "OK",
            "results": [{
                "classification": "C249",
                "risk_rating": 2,
                "fire_block_id": "211798055551556077",
                "fire_block_risk_classification": "C409",
                "fire_block_risk_classifications": [
                    {
                        "C249": 9
                    },
                    {
                        "C234": 3
                    },
                    {
                        "C417": 2
                    },
                    {
                        "C409": 1
                    }
                ],
                "fire_block_rating": 5
            }]
        }
    }
}

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

Fire Risk (firisk)

Field	Description	Data Type	Lookup
classification	Classification	Text	Addresscloud Classification
risk_rating	Risk Rating	Numeric	Classification
fire_block_id	Fire Block ID	Text
fire_block_risk_classification	Fire Block Risk Classification	Text	Addresscloud Classification
fire_block_risk_classifications	Fire Block Risk Risk Classifications (with counts)	Text	Addresscloud Classification
fire_block_rating	Fire Block Rating	Numeric	Classification

Addresscloud Open Flood (opflod)

A sample result:

{
    "opflod": {
        "eahfld": {
            "status": "OK",
            "results": [{
                "bndry_src": "Survey",
                "coastal_in": false,
                "data_prov": "Environment Agency",
                "data_qual": "Fair",
                "end_date": "1965-11-30",
                "event_code": 2198,
                "flood_caus": "channel capacity exceeded (no raised defences)",
                "flood_src": "main river",
                "fluvial_in": true,
                "fm_status": "considered and accepted",
                "hfm_status": "considered and accepted",
                "name": "06NovemberWinter1965",
                "outline_co": 6525,
                "start_date": "1965-11-01",
                "tidal_ind": false
            }]
        },
        "eahist": {
            "status": "OK",
            "results": [{
                "coastal_10yr": 0,
                "coastal_all": 0,
                "count_10yr": 0,
                "count_all": 1,
                "fluvial_10yr": 0,
                "fluvial_all": 1,
                "last_flood_date": "1965-11-01",
                "tidal_10yr": 0,
                "tidal_all": 0
            }]
        },
        "eawarn": {
            "status": "OK",
            "results": [{
                "alert_area_id": "064FAG99SElondon",
                "last_alert_date": "2020-02-25",
                "warning_area_id": "064FWF43Becknham",
                "last_warning_date": "2018-04-27",
                "sev_1_count": 1,
                "sev_2_count": 3,
                "sev_3_count": 9
            }]
        },
        "ridist": {
            "status": "OK",
            "results": [{
                "name": "The Beck",
                "distance": 65
            }]
        },
        "rofrse": {
            "status": "OK",
            "results": [{
                "prob_4band": "Low",
                "pub_date": "2018-03-28T00:00:00+00:00",
                "suitability": "County to Town"
            }]
        }
    }
}

Recorded Flood Outlines (eahfld)

Field	Description	Data Type
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

Historical Flood Statistics (eahist)

Field	Description	Data Type
last_flood_date	Last Flood Date	Date
count_all	Total Floods	Numeric
fluvial_all	Total Fluvial Floods	Numeric
tidal_all	Total Tidal Floods	Numeric
coastal_all	Total Coastal Floods	Numeric
count_10yr	Total Floods (Last 10 Years)	Numeric
fluvial_10yr	Total Fluvial Floods (Last 10 Years)	Numeric
tidal_10yr	Total Tidal Floods (Last 10 Years)	Numeric
coastal_10yr	Total Coastal Floods (Last 10 Years)	Numeric

Historical Flood Warnings/Alerts (eawarn)

Field	Description	Data Type
alert_area_id	Alert Area ID	Text
last_alert_date	Last Alert Date	Date
warning_area_id	Alert Area ID	Text
last_warning_date	Last Warning Date	Date
sev_1_count	Severity 1 Count (Warning: Severe Flooding)	Number
sev_2_count	Severity 2 Count (Warning: Flooding Expected)	Number
sev_3_count	Severity 3 Count (Alert: Flooding Possible)	Number

Distance to River (ridist)

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

Risk of Flood from Rivers & Sea (rofrse)

Field	Description	Data Type
prob_4band	Risk likelihood (4 categories: Very Low to High)	Text
pub_date	Date of publication	Date
suitability	The scale at which it is suitable to use the likelihood information	Text

Addresscloud Open Land (acland)

A sample result:

{
    "acland": {
        "consrv": {
            "status": "OK",
            "results": [{
                "exists": true,
                "uid": 995,
                "name": "Tyler Hill",
                "date_designated": "28/02/1995",
                "date_updated": "none",
                "scale": "Land-Line/MasterMap",
                "lpa": "Canterbury"
            }]
        },
        "eahlfl": {
            "status": "OK",
            "results": [{
                "exists": true,
                "hld_ref": "EAHLD16446",
                "site_name": "Land at Fairy Lane",
                "site_add": "Cheetham Hill, Manchester, Greater Manchester"
            }]
        },
        "hs2dis": {
            "status": "OK",
            "results": [{
                "phase": "phase1",
                "tunnel": true,
                "speed": "400kph",
                "dist": 165
            }]
        },
        "aonben": {
            "status": "OK",
            "results": [{
                "code": "5",
                "name": "Chilterns",
                "desig_date": "Mar-90"
            }]
        },
        "sssien": {
            "status": "OK",
            "results": [{
                "sssi_id": 1000352,
                "name": "West Blean and Thornden Woods"
            }]
        },
        "clclnd": {
            "status": "OK",
            "results": [{
                "clc_id": "EU_588095",
                "code": "311"
            }]
        },
        "coastl": {
            "status": "OK",
            "results": [{
                "dist": 100,
                "dist_band": "J"
            }]
        }
    }
}

Conservation Areas (consrv)

Field	Description	Data Type
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

Historic Landfill (eahlfl)

Field	Description	Data Type
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

Distance to HS2 (hs2dis)

Field	Description	Data Type
phase	Phase	Text
tunnel	Tunnel?	Boolean
speed	Speed Limit	Text
dist	Distance to HS2 (m)	Numeric

Areas of Natural Beauty England (aonben)

Field	Description	Data Type
code	Code	Text
name	Name	Text
desig_date	Date Designated	Text

Sites of Special Scientific Interest England (sssien)

Field	Description	Data Type	Lookup
sssi_id	SSSI ID	Text
name	Name	Text

CORINE Land Cover (clclnd)

Field	Description	Data Type	Lookup
clc_id	CLC ID	Text
code	Code	Text	Land Use

Distance to Coast (coastl)

Field	Description	Data Type	Lookup
dist	Distance to Coast (m within 5km)	Numeric
dist_band	Distance to Coast Band	Text	Distance to Coast

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:

{
    "trersk": {
        "status": "OK",
        "results": [
            {
                "count": 0,
                "max": 3.5,
                "score": 1,
                "class": 2,
                "buil_5m_count_5m": 0,
                "buil_5m_count_10m": 0,
                "buil_5m_count_20m": 0,
                "buil_5m_90pc": 0,
                "buil_5m_max": 0,
                "buil_10m_count_5m": 0,
                "buil_10m_count_10m": 0,
                "buil_10m_count_20m": 0,
                "buil_10m_90pc": 0,
                "buil_10m_max": 0,
                "dist_5m_count_5m": 0,
                "dist_5m_count_10m": 0,
                "dist_5m_count_20m": 0,
                "dist_5m_90pc": 0,
                "dist_5m_max": 0,
                "dist_10m_count_5m": 0,
                "dist_10m_count_10m": 0,
                "dist_10m_count_20m": 0,
                "dist_10m_90pc": 0,
                "dist_10m_max": 0,
                "dist_20m_count_5m": 0,
                "dist_20m_count_10m": 0,
                "dist_20m_count_20m": 0,
                "dist_20m_90pc": 3.5,
                "dist_20m_max": 3.5
            }
        ]
    }
}

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
dist_5m_count_5m	Trees > 5m within 5m of building perimeter	Numeric
dist_5m_count_10m	Trees > 10m within 5m of building perimeter	Numeric
dist_5m_count_20m	Trees > 20m within 5m of building perimeter	Numeric
dist_5m_max	Height of tallest tree within 5m of building perimeter	Numeric
dist_5m_90pc	90th percentile height within 5m of building perimeter	Numeric
dist_10m_count_5m	Trees > 5m within 10m of building perimeter	Numeric
dist_10m_count_10m	Trees > 10m within 10m of building perimeter	Numeric
dist_10m_count_20m	Trees > 20m within 10m of building perimeter	Numeric
dist_10m_max	Height of tallest tree within 10m of building perimeter	Numeric
dist_10m_90pc	90th percentile height within 10m of building perimeter	Numeric
dist_5m_count_5m	Trees > 5m within 5m of building centroid	Numeric
dist_5m_count_10m	Trees > 10m within 5m of building centroid	Numeric
dist_5m_count_20m	Trees > 20m within 5m of building centroid	Numeric
dist_5m_max	Height of tallest tree within 5m of building centroid	Numeric
dist_5m_90pc	90th percentile height within 5m of building centroid	Numeric
dist_10m_count_5m	Trees > 5m within 10m of building centroid	Numeric
dist_10m_count_10m	Trees > 10m within 10m of building centroid	Numeric
dist_10m_count_20m	Trees > 20m within 10m of building centroid	Numeric
dist_10m_max	Height of tallest tree within 10m of building centroid	Numeric
dist_10m_90pc	90th percentile height within 10m of building centroid	Numeric
dist_20m_count_5m	Trees > 5m within 20m of building centroid	Numeric
dist_20m_count_10m	Trees > 10m within 20m of building centroid	Numeric
dist_20m_count_20m	Trees > 20m within 20m of building centroid	Numeric
dist_20m_max	Height of tallest tree within 20m of building centroid	Numeric
dist_20m_90pc	90th percentile height within 20m of building centroid	Numeric

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

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,
                    "mainheat": "MG",
                    "construction_age_band": "G",
                    "tenure": "P",
                    "rating": "C",
                    "ptl_rating": "B",
                    "lmk_key": "148549899802010092919574753002318",
                    "insp_date": "2010-09-29"
                }]
            },
            "nondom": {
                "status": "OK",
                "results": [{
                    "aircon": false,
                    "asset_rating": 68,
                    "asset_rating_band": "C",
                    "floor_area": 77,
                    "insp_date": "2011-04-28",
                    "lmk_key": "49681030062011050109325759240831",
                    "main_heating_fuel": "Grid Supplied Electricity",
                    "property_type": "A1/A2 Retail and Financial/Professional services"
                }]
            }
        }
    }
}

EPC Domestic 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
mainheat	Main Heat Source	Text	EPC Heat
construction_age	Construction Age Band	Text	EPC Age
tenure	Tenure	Text	EPC Tenure
rating	Current Energy Rating	Text
ptl_rating	Potential Energy Rating	Text
lmk_key	Individual lodgement identifier	Text
insp_date	Inspection Date	Date

EPC Non-Domestic Survey (nondom)

Field	Description	Data Type
lmk_key	Individual lodgement identifier	Text
asset_rating	Asset Rating	Numeric
asset_rating_band	Asset Rating Band	Text
property_type	Property Type	Text
main_heating_fuel	Main Heating Fuel	Text
floor_area	Floor Area	Numeric
aircon	Aircon?	Boolean
insp_date	Inspection Date	Date

Aon IF European windstorm (ifeuws)

A sample result:

{
    "intel_status": "OK",
    "found": 1,
    "results": {
        "ifeuws": {
            "ifeuws": {
                "status": "OK",
                "results": [
                    {
                        "rp20": 35,
                        "rp20_kph": 126,
                        "rp50": 38,
                        "rp50_kph": 137,
                        "rp100": 39,
                        "rp100_kph": 140,
                        "rp200": 39,
                        "rp200_kph": 140,
                        "rp500": 40,
                        "rp500_kph": 144,
                        "rp1000": 41,
                        "rp1000_kph": 148
                    }
                ]
            }
        }
    }
}

Aon IF European windstorm (ifeuws)

Field	Description	Data Type
rp20	Peak Gust m/s (1 in 20 Year Storm)	Numeric
rp20_kph	Peak Gust kph (1 in 20 Year Storm)	Numeric
rp50	Peak Gust m/s (1 in 50 Year Storm)	Numeric
rp50_kph	Peak Gust kph (1 in 50 Year Storm)	Numeric
rp100	Peak Gust m/s (1 in 100 Year Storm)	Numeric
rp100_kph	Peak Gust kph (1 in 100 Year Storm)	Numeric
rp200	Peak Gust m/s (1 in 200 Year Storm)	Numeric
rp200_kph	Peak Gust kph (1 in 200 Year Storm)	Numeric
rp500	Peak Gust m/s (1 in 500 Year Storm)	Numeric
rp500_kph	Peak Gust kph (1 in 500 Year Storm)	Numeric
rp1000	Peak Gust m/s (1 in 1000 Year Storm)	Numeric
rp1000_kph	Peak Gust kph (1 in 1000 Year Storm)	Numeric

FloodRe Eligibility (flodre)

A sample result:

{
    "intel_status": "OK",
    "found": 1,
    "results": {
        "flodre": {
            "eligib": {
                "status": "OK",
                "results": [{
                    "FRid": "47a314cc-aad3-42ae-a6d5-4cf37eac00f6",
                    "eligibility_category": "D",
                    "eligibility_criteria": "1",
                    "eligibility_effective_date": "2015-08-14",
                    "source": "1",
                    "strike_claim_count": 0
                }]
            }
        }
    }
}

FloodRe Eligibility (eligib)

Field	Description	Data Type
FRid	Flood Re Unique Reference	Text
source	Agency File Source	FloodRe Source
delete_effective_date	Date record was deleted in agency file to indicate this FRid has a limited remaining life span	Date
strike_claim_count	Strike Claim Count (for future use)	Numeric
resilience_indicator	Resilience Indicator (for future use)	String
exclusion_indicator	Exclusion Indicator (for future use)	String
eligibility_category	Eligibility Category	Text
eligibility_criteria	Eligibility Criteria	FloodRe Eligible
eligibility_effective_date	Eligibility Effective Date	Date

JBA UK Flood Maps (jbafgb)

A sample result:

{
    "jbafgb": {
        "flddef": {
            "status": "OK",
            "results": [{
                "canal_failure": false,
                "cdef1000matrix": 0,
                "cdef100matrix": 0,
                "cdef200matrix": 0,
                "cdef75matrix": 0,
                "cdefmax100": 0,
                "cdefmax1000": 0,
                "cdefmax200": 0,
                "cdefmax75": 0,
                "coastal_floodscore_def": 0,
                "dam_break": false,
                "floodability": "No Colour",
                "floodscore_def": 0,
                "groundwater_chalk": 0,
                "groundwaterchalk_floodscore": 0,
                "r1000matrix": 0,
                "r1000matrix_def": 0,
                "r100matrix": 0,
                "r100matrix_def": 0,
                "r200matrix": 0,
                "r200matrix_def": 0,
                "r20matrix": 0,
                "r20matrix_def": 0,
                "r75matrix": 0,
                "r75matrix_def": 0,
                "river_floodscore_def": 0,
                "rmax100": 0,
                "rmax1000": 0,
                "rmax20": 0,
                "rmax200": 0,
                "rmax75": 0,
                "sop_ri": 50,
                "sop_sw": 0,
                "surfacewater_floodscore_def": 0,
                "sw1000matrix": 0,
                "sw1000matrix_def": 0,
                "sw200matrix": 0,
                "sw200matrix_def": 0,
                "sw75matrix": 0,
                "sw75matrix_def": 0,
                "swmax1000": 0,
                "swmax200": 0,
                "swmax75": 0
            }]
        },
        "fldudf": {
            "status": "OK",
            "results": [{
                "canal_failure": false,
                "coastal_floodscore_ud": 0,
                "cud1000matrix": 0,
                "cud100matrix": 0,
                "cud200matrix": 0,
                "cud75matrix": 0,
                "cudmax100": 0,
                "cudmax1000": 0,
                "cudmax200": 0,
                "cudmax75": 0,
                "dam_break": false,
                "floodability": "No Colour",
                "floodscore_ud": 0,
                "groundwater_chalk": 0,
                "groundwaterchalk_floodscore": 0,
                "r1000matrix": 0,
                "r100matrix": 0,
                "r200matrix": 0,
                "r20matrix": 0,
                "r75matrix": 0,
                "river_floodscore_ud": 0,
                "rmax100": 0,
                "rmax1000": 0,
                "rmax20": 0,
                "rmax200": 0,
                "rmax75": 0,
                "surfacewater_floodscore_ud": 0,
                "sw1000matrix": 0,
                "sw200matrix": 0,
                "sw75matrix": 0,
                "swmax1000": 0,
                "swmax200": 0,
                "swmax75": 0
            }]
        },
        "unflod": {
            "status": "OK",
            "results": [{
                "heightband": "x <= 0.5m",
                "value": 1
            }]
        },
        "acflod": {
            "status": "OK",
            "results": [{
                "floodscore_def_adr_90pc": 0,
                "floodscore_def_adr_max": 0,
                "floodscore_def_bld_90pc": 0,
                "floodscore_def_bld_max": 0,
                "floodscore_def_bld_sit_max": 0,
                "floodscore_def_pco_max": 25,
                "floodscore_def_sit_90pc": 0,
                "floodscore_def_sit_max": 0,
                "surfacewater_floodscore_def_pco_max": 3
            }]
        }
    }
}

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	boolean
dam_break	Dam Break Risk	boolean
idb	Internal Drainage Board	boolean
groundwater_chalk	Groundwater Chalk Return Period	Numeric
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
floodability	Floodability	Text

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	boolean
dam_break	Dam Break Risk	boolean
idb	Internal Drainage Board	boolean
groundwater_chalk	Groundwater Chalk Return Period	Numeric
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
floodability	Floodability	Text

Unflood (unflod)

Field	Description	Data Type	Lookup
value	Unflood Score (1-3)	Numeric
heightband	Height Band	Text

Addresscloud (acflod)

Field	Description	Data Type
floodscore_def_adr_90pc	Defended Flood Score at Address level (90th percentile in 10m buffer)	Numeric
floodscore_def_adr_max	Defended Flood Score at Address level (max in 10m buffer)	Numeric
floodscore_def_bld_90pc	Defended Flood Score at OS OML Building level (90th percentile)	Numeric
floodscore_def_bld_max	Defended Flood Score at OS OML Building level (max)	Numeric
floodscore_def_bld_sit_max	Worst Defended Flood Score at OS OML Building level within an INSPIRE land parcel (max)	Numeric
floodscore_def_pco_max	Defended Flood Score at Postcode level (max)	Numeric
floodscore_def_sit_90pc	Defended Flood Score at INSPIRE land parcel (90th percentile)	Numeric
floodscore_def_sit_max	Defended Flood Score at INSPIRE land parcel (max)	Numeric
surfacewater_floodscore_def_pco_max	Defended Surface Water Flood Score at Postcode level (max)	Numeric

JBA Irish Flood Maps (jbafie)

A sample result:

{
    "jbafie": {
        "flddef": {
            "status": "OK",
            "results": [{
                "coastal_floodscore_ud": 0,
                "cud1000matrix": 0,
                "cud100matrix": 0,
                "cud200matrix": 0,
                "cud75matrix": 0,
                "cudmax100": 0,
                "cudmax1000": 0,
                "cudmax200": 0,
                "cudmax75": 0,
                "floodability": "No Colour",
                "floodscore_def": 0,
                "r1000matrix": 0,
                "r1000matrix_def": 0,
                "r100matrix": 0,
                "r100matrix_def": 0,
                "r200matrix": 0,
                "r200matrix_def": 0,
                "r20matrix": 0,
                "r20matrix_def": 0,
                "r75matrix": 0,
                "r75matrix_def": 0,
                "river_floodscore_def": 0,
                "rmax100": 0,
                "rmax1000": 0,
                "rmax20": 0,
                "rmax200": 0,
                "rmax75": 0,
                "sop_ri": 0,
                "surfacewater_floodscore_ud": 0,
                "sw1000matrix": 0,
                "sw200matrix": 0,
                "sw75matrix": 0,
                "swmax1000": 0,
                "swmax200": 0,
                "swmax75": 0
            }]
        },
        "fldudf": {
            "status": "OK",
            "results": [{
                "coastal_floodscore_ud": 0,
                "cud1000matrix": 0,
                "cud100matrix": 0,
                "cud200matrix": 0,
                "cud75matrix": 0,
                "cudmax100": 0,
                "cudmax1000": 0,
                "cudmax200": 0,
                "cudmax75": 0,
                "floodability": "No Colour",
                "floodscore_ud": 0,
                "r1000matrix": 0,
                "r100matrix": 0,
                "r200matrix": 0,
                "r20matrix": 0,
                "r75matrix": 0,
                "river_floodscore_ud": 0,
                "rmax100": 0,
                "rmax1000": 0,
                "rmax20": 0,
                "rmax200": 0,
                "rmax75": 0,
                "surfacewater_floodscore_ud": 0,
                "sw1000matrix": 0,
                "sw200matrix": 0,
                "sw75matrix": 0,
                "swmax1000": 0,
                "swmax200": 0,
                "swmax75": 0
            }]
        },
        "unflod": {
            "status": "OK",
            "results": [{
                "heightband": "0.5m < x <= 10.0m",
                "value": 2
            }]
        },
        "acflod": {
            "status": "OK",
            "results": [{
                "floodscore_def_adr_90pc": 0,
                "floodscore_def_adr_max": 0
            }]
        }
    }
}

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
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
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
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 (Def)	Numeric
floodscore_def	Overall Flood Score (Def)	Numeric
floodability	Floodability	Text

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
floodability	Floodability	Text

Unflood (unflod)

Field	Description	Data Type	Lookup
value	Unflood Score (1-3)	Numeric
heightband	Height Band	Text

Addresscloud (acflod)

Field	Description	Data Type	Lookup
floodscore_def_adr_90pc	Defended Flood Score at Address level (90th percentile in 10m buffer)	Numeric
floodscore_def_adr_max	Defended Flood Score at Address level (max in 10m buffer)	Numeric

JBA Northern Ireland Flood Maps (jbafni)

A sample result:

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

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
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
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
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 (Def)	Numeric
floodscore_def	Overall Flood Score (Def)	Numeric
floodability	Floodability	Text

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
floodability	Floodability	Text

Unflood (unflod)

Field	Description	Data Type	Lookup
value	Unflood Score (1-3)	Numeric
heightband	Height Band	Text

Addresscloud (acflod)

Field	Description	Data Type
floodscore_def_adr_90pc	Defended Flood Score at Address level (90th percentile in 10m buffer)	Numeric
floodscore_def_adr_max	Defended Flood Score at Address level (max in 10m buffer)	Numeric
floodscore_def_pco_max	Defended Flood Score at Postcode level (max)	Numeric
surfacewater_floodscore_def_pco_max	Defended Surface Water Flood Score at Postcode level (max)	Numeric

JBA UK Climate Data (jbacgb)

A sample result:

{
    "jbacgb": {
        "frcp26": {
            "status": "OK",
            "results": [{
                "floodscore_base": 14,
                "floodscore_2021_2025": 14,
                "floodscore_2026_2030": 14,
                "floodscore_2031_2035": 14,
                "floodscore_2036_2040": 14,
                "floodscore_2041_2045": 14,
                "floodscore_2046_2050": 14,
                "floodscore_2051_2055": 14,
                "floodscore_2056_2060": 14,
                "floodscore_2061_2065": 14,
                "floodscore_2066_2070": 14,
                "floodscore_2071_2075": 14,
                "floodscore_2076_2080": 14,
                "floodscore_2081_2085": 14,
                "floodscore_2086_2090": 14,
                "floodscore_2091_2095": 14,
                "floodscore_2096_2100": 14
            }]
        },
        "frcp45": {
            "status": "OK",
            "results": [{
                "floodscore_base": 14,
                "floodscore_2021_2025": 14,
                "floodscore_2026_2030": 14,
                "floodscore_2031_2035": 14,
                "floodscore_2036_2040": 14,
                "floodscore_2041_2045": 14,
                "floodscore_2046_2050": 14,
                "floodscore_2051_2055": 14,
                "floodscore_2056_2060": 17,
                "floodscore_2061_2065": 17,
                "floodscore_2066_2070": 17,
                "floodscore_2071_2075": 17,
                "floodscore_2076_2080": 17,
                "floodscore_2081_2085": 17,
                "floodscore_2086_2090": 17,
                "floodscore_2091_2095": 17,
                "floodscore_2096_2100": 17
            }]
        },
        "frcp60": {
            "status": "OK",
            "results": [{
                "floodscore_base": 14,
                "floodscore_2021_2025": 14,
                "floodscore_2026_2030": 14,
                "floodscore_2031_2035": 14,
                "floodscore_2036_2040": 14,
                "floodscore_2041_2045": 14,
                "floodscore_2046_2050": 14,
                "floodscore_2051_2055": 14,
                "floodscore_2056_2060": 17,
                "floodscore_2061_2065": 17,
                "floodscore_2066_2070": 17,
                "floodscore_2071_2075": 17,
                "floodscore_2076_2080": 17,
                "floodscore_2081_2085": 17,
                "floodscore_2086_2090": 17,
                "floodscore_2091_2095": 17,
                "floodscore_2096_2100": 17
            }]
        },
        "frcp85": {
            "status": "OK",
            "results": [{
                "floodscore_base": 14,
                "floodscore_2021_2025": 14,
                "floodscore_2026_2030": 14,
                "floodscore_2031_2035": 14,
                "floodscore_2036_2040": 14,
                "floodscore_2041_2045": 17,
                "floodscore_2046_2050": 17,
                "floodscore_2051_2055": 17,
                "floodscore_2056_2060": 17,
                "floodscore_2061_2065": 17,
                "floodscore_2066_2070": 17,
                "floodscore_2071_2075": 17,
                "floodscore_2076_2080": 17,
                "floodscore_2081_2085": 17,
                "floodscore_2086_2090": 17,
                "floodscore_2091_2095": 17,
                "floodscore_2096_2100": 19
            }]
        }
    }
}

RCP 2.6 Scenario (frcp26)

Field	Description	Data Type
floodscore_base	Flood Score Base (Current)	Numeric
floodscore_2021_2025	Flood Score 2021 to 2025	Numeric
floodscore_2026_2030	Flood Score 2026 to 2030	Numeric
floodscore_2031_2035	Flood Score 2031 to 2035	Numeric
floodscore_2036_2040	Flood Score 2036 to 2040	Numeric
floodscore_2041_2045	Flood Score 2041 to 2045	Numeric
floodscore_2046_2050	Flood Score 2046 to 2050	Numeric
floodscore_2051_2055	Flood Score 2051 to 2055	Numeric
floodscore_2056_2060	Flood Score 2056 to 2060	Numeric
floodscore_2061_2065	Flood Score 2061 to 2065	Numeric
floodscore_2066_2070	Flood Score 2066 to 2070	Numeric
floodscore_2071_2075	Flood Score 2071 to 2075	Numeric
floodscore_2076_2080	Flood Score 2076 to 2080	Numeric
floodscore_2081_2085	Flood Score 2081 to 2085	Numeric
floodscore_2086_2090	Flood Score 2086 to 2090	Numeric
floodscore_2091_2095	Flood Score 2091 to 2095	Numeric
floodscore_2096_2100	Flood Score 2096 to 2100	Numeric

RCP 4.5 Scenario (frcp45)

Field	Description	Data Type
floodscore_base	Flood Score Base (Current)	Numeric
floodscore_2021_2025	Flood Score 2021 to 2025	Numeric
floodscore_2026_2030	Flood Score 2026 to 2030	Numeric
floodscore_2031_2035	Flood Score 2031 to 2035	Numeric
floodscore_2036_2040	Flood Score 2036 to 2040	Numeric
floodscore_2041_2045	Flood Score 2041 to 2045	Numeric
floodscore_2046_2050	Flood Score 2046 to 2050	Numeric
floodscore_2051_2055	Flood Score 2051 to 2055	Numeric
floodscore_2056_2060	Flood Score 2056 to 2060	Numeric
floodscore_2061_2065	Flood Score 2061 to 2065	Numeric
floodscore_2066_2070	Flood Score 2066 to 2070	Numeric
floodscore_2071_2075	Flood Score 2071 to 2075	Numeric
floodscore_2076_2080	Flood Score 2076 to 2080	Numeric
floodscore_2081_2085	Flood Score 2081 to 2085	Numeric
floodscore_2086_2090	Flood Score 2086 to 2090	Numeric
floodscore_2091_2095	Flood Score 2091 to 2095	Numeric
floodscore_2096_2100	Flood Score 2096 to 2100	Numeric

RCP 6.0 Scenario (frcp60)

Field	Description	Data Type
floodscore_base	Flood Score Base (Current)	Numeric
floodscore_2021_2025	Flood Score 2021 to 2025	Numeric
floodscore_2026_2030	Flood Score 2026 to 2030	Numeric
floodscore_2031_2035	Flood Score 2031 to 2035	Numeric
floodscore_2036_2040	Flood Score 2036 to 2040	Numeric
floodscore_2041_2045	Flood Score 2041 to 2045	Numeric
floodscore_2046_2050	Flood Score 2046 to 2050	Numeric
floodscore_2051_2055	Flood Score 2051 to 2055	Numeric
floodscore_2056_2060	Flood Score 2056 to 2060	Numeric
floodscore_2061_2065	Flood Score 2061 to 2065	Numeric
floodscore_2066_2070	Flood Score 2066 to 2070	Numeric
floodscore_2071_2075	Flood Score 2071 to 2075	Numeric
floodscore_2076_2080	Flood Score 2076 to 2080	Numeric
floodscore_2081_2085	Flood Score 2081 to 2085	Numeric
floodscore_2086_2090	Flood Score 2086 to 2090	Numeric
floodscore_2091_2095	Flood Score 2091 to 2095	Numeric
floodscore_2096_2100	Flood Score 2096 to 2100	Numeric

RCP 8.5 Scenario (frcp85)

Field	Description	Data Type
floodscore_base	Flood Score Base (Current)	Numeric
floodscore_2021_2025	Flood Score 2021 to 2025	Numeric
floodscore_2026_2030	Flood Score 2026 to 2030	Numeric
floodscore_2031_2035	Flood Score 2031 to 2035	Numeric
floodscore_2036_2040	Flood Score 2036 to 2040	Numeric
floodscore_2041_2045	Flood Score 2041 to 2045	Numeric
floodscore_2046_2050	Flood Score 2046 to 2050	Numeric
floodscore_2051_2055	Flood Score 2051 to 2055	Numeric
floodscore_2056_2060	Flood Score 2056 to 2060	Numeric
floodscore_2061_2065	Flood Score 2061 to 2065	Numeric
floodscore_2066_2070	Flood Score 2066 to 2070	Numeric
floodscore_2071_2075	Flood Score 2071 to 2075	Numeric
floodscore_2076_2080	Flood Score 2076 to 2080	Numeric
floodscore_2081_2085	Flood Score 2081 to 2085	Numeric
floodscore_2086_2090	Flood Score 2086 to 2090	Numeric
floodscore_2091_2095	Flood Score 2091 to 2095	Numeric
floodscore_2096_2100	Flood Score 2096 to 2100	Numeric

MapleSky Subsidence Model (mplsky)

A sample result:

{
    "mplsky": {
        "mplsky": {
            "status": "OK",
            "results": [
                {
                    "clay_baseline": 21,
                    "score_5": 3,
                    "score_10": 5,
                    "coal": false,
                    "brine": false,
                    "non_coal_mining": 3,
                    "collapse": 1,
                    "compressible": 1,
                    "landslide": 1,
                    "sand": 1,
                    "soluble": 3,
                    "rivers_20m": false
                }
            ]
        }
    }
}

MapleSky Subsidence Model (mplsky)

Field	Description	Data Type	Lookup
clay_baseline	The subsidence hazard (0-100) for baseline climate conditions (1991-2020)	Numeric
score_5	Addresscloud suggested score out of 5	Numeric
score_10	Addresscloud suggested score out of 10	Numeric
coal	Is this address in a hexagon which includes a coal mining area?	Booelan
brine	Is this address in a hexagon affected by Cheshire Brine extraction?	Booelan
non_coal_mining	Is this address in a hexagon where non-coal related mining has occurred?	Numeric	MapleSky Hazard Level
collapse	Is this address in a hexagon where collapsible soils are common?	Numeric	MapleSky Hazard Level
compressible	Is this address in a hexagon where compressible soils are common?	Numeric	MapleSky Hazard Level
landslide	Is this address in a hexagon in where landslides have been known to occur?	Numeric	MapleSky Hazard Level
sand	Is this address in a hexagon where running sand conditions are common?	Numeric	MapleSky Hazard Level
soluble	Is this address in a hexagon where subsidence due to subterranean cavities is more common?	Numeric	MapleSky Hazard Level
rivers_20m	Is there a mapped river within 20 m of this cell?	Booelan

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
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"
                }
            ]
        }
    }
}

Property Sales (psales)

Field	Description	Data Type
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

Terrafirma NGRM (tfngrm)

A sample result:

{
    "tfngrm": {
        "tfngrm": {
            "status": "OK",
            "results": [{
                "highest_bl": 50,
                "highest20_rcp26": 50,
                "highest20_rcp45": 50,
                "highest20_rcp60": 50,
                "highest20_rcp85": 50,
                "highest50_rcp26": 50,
                "highest50_rcp45": 50,
                "highest50_rcp60": 50,
                "highest50_rcp85": 50,
                "highest80_rcp26": 50,
                "highest80_rcp45": 60,
                "highest80_rcp60": 60,
                "highest80_rcp85": 60,
                "mining_bl": 20,
                "miningn_bl": 20,
                "miningc_bl": 0,
                "miningb_bl": 0,
                "dissol_bl": 0,
                "snkhol_bl": 0,
                "misc_bl": 0,
                "ssubs_bl": 50,
                "ssubs_20_rcp26": 50,
                "ssubs_20_rcp45": 50,
                "ssubs_20_rcp60": 50,
                "ssubs_20_rcp85": 50,
                "ssubs_50_rcp26": 50,
                "ssubs_50_rcp45": 50,
                "ssubs_50_rcp60": 50,
                "ssubs_50_rcp85": 50,
                "ssubs_80_rcp26": 50,
                "ssubs_80_rcp45": 60,
                "ssubs_80_rcp60": 60,
                "ssubs_80_rcp85": 60,
                "lslip_bl": 0,
                "coast_bl": 0,
                "coast_20_rcp26": 0,
                "coast_20_rcp45": 0,
                "coast_20_rcp60": 0,
                "coast_20_rcp85": 0,
                "coast_50_rcp26": 0,
                "coast_50_rcp45": 0,
                "coast_50_rcp60": 0,
                "coast_50_rcp85": 0,
                "coast_80_rcp26": 0,
                "coast_80_rcp45": 0,
                "coast_80_rcp60": 0,
                "coast_80_rcp85": 0,
                "subs_base": 5,
                "sbs26y20": 5,
                "sbs26y50": 5,
                "sbs26y80": 5,
                "sbs45y20": 5,
                "sbs45y50": 5,
                "sbs45y80": 6,
                "sbs60y20": 5,
                "sbs60y50": 5,
                "sbs60y80": 6,
                "sbs85y20": 5,
                "sbs85y50": 5,
                "sbs85y80": 6
            }]
        }
    }
}

Terrafirma NGRM (tfngrm)

Field	Description	Data Type
subs_base	Soil hazard score (baseline)	Numeric
highest_bl	Highest baseline risk score across all hazards	Numeric
highest20_rcp26	Highest future risk score (2020s, RCP 2.6 (low) emissions) across all hazards	Numeric
highest20_rcp45	Highest future risk score (2020s, RCP 4.5 (med) emissions) across all hazards	Numeric
highest20_rcp60	Highest future risk score (2020s, RCP 6.0 (med) emissions) across all hazards	Numeric
highest20_rcp85	Highest future risk score (2020s, RCP 8.5 (high) emissions) across all hazards	Numeric
highest50_rcp26	Highest future risk score (2050s, RCP 2.6 (low) emissions) across all hazards	Numeric
highest50_rcp45	Highest future risk score (2050s, RCP 4.5 (med) emissions) across all hazards	Numeric
highest50_rcp60	Highest future risk score (2050s, RCP 6.0 (med) emissions) across all hazards	Numeric
highest50_rcp85	Highest future risk score (2050s, RCP 8.5 (high) emissions) across all hazards	Numeric
highest80_rcp26	Highest future risk score (2050s, RCP 2.6 (low) emissions) across all hazards	Numeric
highest80_rcp45	Highest future risk score (2080s, RCP 4.5 (med) emissions) across all hazards	Numeric
highest80_rcp60	Highest future risk score (2080s, RCP 6.0 (med) emissions) across all hazards	Numeric
highest80_rcp85	Highest future risk score (2080s, RCP 8.5 (high) emissions) across all hazards	Numeric
mining_bl	Mining (highest non-coal/coal/brine) baseline risk score	Numeric
miningn_bl	Mining (non-coal) baseline risk score	Numeric
miningc_bl	Mining (coal) baseline risk score	Numeric
miningb_bl	Mining (Cheshire brine) baseline risk score	Numeric
dissol_bl	Dissolution baseline risk score	Numeric
snkhol_bl	Sinkhole baseline risk score	Numeric
misc_bl	Scoring from miscellaneous datasets (ie. historical landfill sites)	Numeric
ssubs_bl	Soil related subsidence baseline risk score	Numeric
ssubs_20_rcp26	Soil related subsidence (2020s, RCP 2.6 (low) emissions)	Numeric
ssubs_20_rcp45	Soil related subsidence (2020s, RCP 4.5 (med) emissions)	Numeric
ssubs_20_rcp60	Soil related subsidence (2020s, RCP 6.0 (med) emissions)	Numeric
ssubs_20_rcp85	Soil related subsidence (2020s, RCP 8.5 (high) emissions)	Numeric
ssubs_50_rcp26	Soil related subsidence (2050s, RCP 2.6 (low) emissions)	Numeric
ssubs_50_rcp45	Soil related subsidence (2050s, RCP 4.5 (med) emissions)	Numeric
ssubs_50_rcp60	Soil related subsidence (2050s, RCP 6.0 (med) emissions)	Numeric
ssubs_50_rcp85	Soil related subsidence (2050s, RCP 8.5 (high) emissions)	Numeric
ssubs_80_rcp26	Soil related subsidence (2080s, RCP 2.6 (low) emissions)	Numeric
ssubs_80_rcp45	Soil related subsidence (2080s, RCP 4.5 (med) emissions)	Numeric
ssubs_80_rcp60	Soil related subsidence (2080s, RCP 6.0 (med) emissions)	Numeric
ssubs_80_rcp85	Soil related subsidence (2080s, RCP 8.5 (high) emissions)	Numeric
lslip_bl	Landslip baseline risk score	Numeric
coast_bl	Coastal risk baseline risk score	Numeric
coast_20_rcp26	Coastal risk score (2020s, RCP 2.6 (low) emissions)	Numeric
coast_20_rcp45	Coastal risk score (2020s, RCP 4.5 (med) emissions)	Numeric
coast_20_rcp60	Coastal risk score (2020s, RCP 6.0 (med) emissions)	Numeric
coast_20_rcp85	Coastal risk score (2020s, RCP 8.5 (high) emissions)	Numeric
coast_50_rcp26	Coastal risk score (2050s, RCP 2.6 (low) emissions)	Numeric
coast_50_rcp45	Coastal risk score (2050s, RCP 4.5 (med) emissions)	Numeric
coast_50_rcp60	Coastal risk score (2050s, RCP 6.0 (med) emissions)	Numeric
coast_50_rcp85	Coastal risk score (2050s, RCP 8.5 (high) emissions)	Numeric
coast_80_rcp26	Coastal risk score (2080s, RCP 2.6 (low) emissions)	Numeric
coast_80_rcp45	Coastal risk score (2080s, RCP 4.5 (med) emissions)	Numeric
coast_80_rcp60	Coastal risk score (2080s, RCP 6.0 (med) emissions)	Numeric
coast_80_rcp85	Coastal risk score (2080s, RCP 8.5 (high) emissions)	Numeric
subs_base	Soil hazard score (baseline)	Numeric
sbs26y20	Soil hazard score (2020s, RCP 2.6 (low) emissions)	Numeric
sbs26y50	Soil hazard score (2050s, RCP 2.6 (low) emissions)	Numeric
sbs26y80	Soil hazard score (2080s, RCP 2.6 (low) emissions)	Numeric
sbs45y20	Soil hazard score (2020s, RCP 4.5 (med) emissions)	Numeric
sbs45y50	Soil hazard score (2050s, RCP 4.5 (med) emissions)	Numeric
sbs45y80	Soil hazard score (2080s, RCP 4.5 (med) emissions)	Numeric
sbs60y20	Soil hazard score (2020s, RCP 6.0 (med) emissions)	Numeric
sbs60y50	Soil hazard score (2050s, RCP 6.0 (med) emissions)	Numeric
sbs60y80	Soil hazard score (2080s, RCP 6.0 (med) emissions)	Numeric
sbs85y20	Soil hazard score (2020s, RCP 8.5 (high) emissions)	Numeric
sbs85y50	Soil hazard score (2050s, RCP 8.5 (high) emissions)	Numeric
sbs85y80	Soil hazard score (2080s, RCP 8.5 (high) emissions)	Numeric

Business Rating (voarat)

A sample result:

{
    "voarat": {
        "results": [{
            "uarn": 382409065,
            "primary_code": "CS",
            "scat_code": "249",
            "assessment_reference": 16333847000
        }]
    }
}

Business Rating (voarat)

Field	Description	Data Type
uarn	Unique Address Reference Number	Numeric
primary_code	Primary Code	Text
scat_code	SCAT Code	Text
assessment_reference	Unique reference for last assessment	Numeric

Data Dictionary (Europe)

Addresscloud supports a range of datasets, these are listed below together with the update frequency:

Dataset Code	Provider	Dataset	Update Frequency
frabat	Addresscloud⁽¹⁾	Addresscloud Buildings (France)	Adhoc
jbafeu	JBA Risk	European Flood Maps	Annual
skyblu	Skyblu	Skyblu Perils	Annual

⁽¹⁾ Licensed under French goverment open licence

Addresscloud Buildings (frabat)

A sample result:

{
    "frabat": {
        "frabat": {
            "status": "OK",
            "results": [{
                "altitude": 163,
                "altitude_accuracy": "D",
                "annexes": 0,
                "building_count": 9,
                "clay": "H",
                "clay_accuracy": "A",
                "footprint": 131,
                "footprint_accuracy": "D",
                "height": 8,
                "height_accuracy": "D",
                "listed_building": false,
                "listed_building_accuracy": "D",
                "mixed_use": false,
                "mixed_use_accuracy": "A",
                "multi_occ": 1,
                "multi_occ_accuracy": "C",
                "radon": "H",
                "radon_accuracy": "A",
                "roof": "TI",
                "roof_accuracy": "A",
                "type": "H",
                "type_accuracy": "A",
                "use": "U",
                "use_accuracy": "C",
                "walls": "AG",
                "walls_accuracy": "C",
                "year_built": 1991,
                "year_built_accuracy": "D"
            }]
        }
    }
}

Addresscloud Buildings (frabat)

Field	Description	Data Type	Lookup
building_count	Building Count	Text
use	Use	Text	Addresscloud Use
use_accuracy	Use Accuracy	Text	Addresscloud Accuracy
mixed_use	Mixed Use	Boolean
mixed_use_accuracy	Mixed Use Accuracy	Text	Addresscloud Accuracy
height	Numeric	Text
height_accuracy	Height Accuracy	Text
footprint	Footprint	Text
footprint_accuracy	Footprint Accuracy	Text	Addresscloud Accuracy
floor_area	Floor Area	Numeric
floor_area_accuracy	Floor Area Accuracy	Text	Addresscloud Accuracy
altitude	Altitude	Numeric
altitude_accuracy	Altitude Accuracy	Text	Addresscloud Accuracy
type	Type	Text	Addresscloud Type
type_accuracy	Type Accuracy	Text	Addresscloud Accuracy
year_built	Year Built	Numeric
year_built_accuracy	Year Built Accuracy	Text	Addresscloud Accuracy
walls	Walls	Text	Addresscloud Wall Type
walls_accuracy	Walls Accuracy	Text	Addresscloud Accuracy
roof	Roof	Text	Addresscloud Roof Material
roof_accuracy	Roof Accuracy	Text	Addresscloud Accuracy
multi_occ	Multi Occ	Numeric
multi_occ_accuracy	Multi Occ Accuracy	Text	Addresscloud Accuracy
listed_building	Listed Building	Boolean
listed_building_accuracy	Listed Building Accuracy	Text	Addresscloud Accuracy
clay	Clay	Text	Addresscloud HML
clay_accuracy	Clay Accuracy	Text	Addresscloud Accuracy
radon	Radon	Text	Addresscloud HML
radon_accuracy	Radon Accuracy	Text	Addresscloud Accuracy
annexes	Count of Known Annexes	Numeric
site_area	Site Area	Numeric

JBA European Flood Maps (jbafeu)

A sample result:

{
    "jbafgb": {
        "flddef": {
            "status": "OK",
            "results": [{
                "floodscore_def": 15,
                "floodscore_ud": 15,
                "rmax20": 2,
                "rmax50": 2,
                "rmax100": 3,
                "rmax200": 3,
                "rmax500": 3,
                "rmax1500": 4,
                "river_floodscore_def": 15,
                "river_floodscore_ud": 15,
                "sop_ri": 0,
                "level_ri": "0",
                "swmax20": 0,
                "swmax50": 0,
                "swmax100": 0,
                "swmax200": 0,
                "swmax500": 0,
                "swmax1500": 0,
                "surfacewater_floodscore_ud": 15
            }]
        }
    }
}

Defended Flood Risk (flddef)

Field	Description	Data Type	Lookup
rmax20	River Flood Depth 1 in 20 Yr	Numeric	JBA Flood Depth WW
rmax50	River Flood Depth 1 in 50 Yr	Numeric	JBA Flood Depth WW
rmax100	River Flood Depth 1 in 100 Yr	Numeric	JBA Flood Depth WW
rmax200	River Flood Depth 1 in 200 Yr	Numeric	JBA Flood Depth WW
rmax500	River Flood Depth 1 in 500 Yr	Numeric	JBA Flood Depth WW
rmax1500	River Flood Depth 1 in 1500 Yr	Numeric	JBA Flood Depth WW
river_floodscore_def	River Flood Score (Defended)	Numeric
river_floodscore_ud	River Flood Score (Undefended)	Numeric
sop_ri	River Defences Standard of Protection	Numeric
level_ri	River Defences Level	Text
swmax20	Surface Water Flood Depth 1 in 20 Yr	Numeric	JBA Flood Depth WW
swmax50	Surface Water Flood Depth 1 in 50 Yr	Numeric	JBA Flood Depth WW
swmax100	Surface Water Flood Depth 1 in 100 Yr	Numeric	JBA Flood Depth WW
swmax200	Surface Water Flood Depth 1 in 200 Yr	Numeric	JBA Flood Depth WW
swmax500	Surface Water Flood Depth 1 in 500 Yr	Numeric	JBA Flood Depth WW
swmax1500	Surface Water Flood Depth 1 in 1500 Yr	Numeric	JBA Flood Depth WW
surfacewater_floodscore_ud	Surface Water Flood Score (Undefended)	Numeric
floodscore_def	Overall Flood Score (Defended)	Numeric
floodscore_def	Overall Flood Score (Undefended)	Numeric

Skyblu Perils (skyblu)

A sample result:

{
    "skyblu": {
        "floods": {
            "status": "OK",
            "results": [{
                "score": 0
            }]
        },
        "hailsc": {
            "status": "OK",
            "results": [{
                "score": 0
            }]
        },
        "landsl": {
            "status": "OK",
            "results": [{
                "score": 0
            }]
        },
        "rain40": {
            "status": "OK",
            "results": [{
                "score": 0
            }]
        },
        "subsid": {
            "status": "OK",
            "results": [{
                "score": 0
            }]
        },
        "wildfi": {
            "status": "OK",
            "results": [{
                "score": 0
            }]
        },
        "windgu": {
            "status": "OK",
            "results": [{
                "score": 0
            }]
        }
    }
}

Skyblu Flood (floods)

Field	Description	Data Type	Lookup
score	Flood Score	Numeric

Skyblu Hail (hailsc)

Field	Description	Data Type	Lookup
score	Hail Score	Numeric

Skyblu Landslide (landsl)

Field	Description	Data Type	Lookup
score	Landslide Score	Numeric

Skyblu Rain 40 (rain40)

Field	Description	Data Type	Lookup
score	Rain 40 Score	Numeric

Skyblu Subsidence (subsid)

Field	Description	Data Type	Lookup
score	Subsidence Score	Numeric

Skyblu Wildfire (wildfi)

Field	Description	Data Type	Lookup
score	Wildfire Score	Numeric

Skyblu Wind Gust (windgu)

Field	Description	Data Type	Lookup
score	Wind Gust Score	Numeric

Data Dictionary (North America)

Addresscloud supports a range of datasets, these are listed below together with the update frequency:

Dataset Code	Provider	Dataset	Update Frequency
fenfhl	FEMA	National Flood Hazard Layer	Adhoc
noaslo	NOAA	Sea, Lake, and Overland Surges from Hurricanes (SLOSH)	Adhoc
noharm	Anchor Point NoHARM	US Wildfire	Adhoc

FEMA National Flood Hazard Layer (fenfhl)

A sample result: json { "fenfhl": { "fldhaz": { "results": [ { "dfirm_id": "12073C", "version_id": "1.1.1.0", "fld_ar_id": "12073C", "study_typ": "NP", "fld_zone": "X", "zone_subty": "AREA OF MINIMAL FLOOD HAZARD", "sfha_tf": "F", "static_bfe": -9999, "depth": -9999 } ], "status": "OK" }, "frmpan": { "results": [ { "dfirm_id": "12073C", "version_id": "1.1.1.0", "firm_id": "12073C_3", "st_fips": "12", "pcomm": "073C", "panel": "0289", "suffix": "F", "firm_pan": "12073C0289F", "panel_typ": "Countywide, Panel Printed", "pre_date": "9999-09-09T00:00:00+00:00", "eff_date": "2009-08-18T00:00:00+00:00", "scale": "6000", "base_typ": "NP", "source_cit": "12073C_STUDY1", "gfid": "10725b4d-08f5-4773-8a8a-be5d4fb690d7" } ], "status": "OK" } } }

Flood Hazard Area (fldhaz)

Field	Description	Data Type
dfirm_id	Study Identifier	Text
version_id	Version Identifier	Numeric
fld_ar_id	Primary key for lookups to other FIRM database tables	String
study_typ	Study Type	String
fld_zone	Flood Zone	String
zone_subty	Flood Zone Subtype	String
sfha_tf	Special Flood Hazard Area	String
static_bfe	Static Base Flood Elevation	Numeric
depth	Depth	Numeric

FIRM Panel Area (frmpan)

Field	Description	Data Type
dfirm_id	Study Identifier	Text
version_id	Version Identifier	String
firm_id	Primary key for lookups to other FIRM database tables	String
st_fips	State FIPS	String
pcomm	Community or County Identification Number	String
panel	Panel Number	String
suffix	Map Suffix	String
firm_pan	FIRM Panel Number	String
panel_typ	Panel Type	String
pre_date	Preliminary Release Date	String
eff_date	Effective Date	String
scale	Map Scale	String
base_typ	Base Map Type	String
source_cit	Source Citation	String
gfid	Identifier	String

NOAA SLOSH (noaslo)

A sample result: json { "noaslo": { "momhi1": { "results": [ { "country": "us", "cat": 1, "class": 3 } ], "status": "OK" }, "momhi2": { "results": [ { "country": "us", "cat": 2, "class": 8 } ], "status": "OK" }, "momhi3": { "results": [ { "country": "us", "cat": 3, "class": 12 } ], "status": "OK" }, "momhi4": { "results": [ { "country": "us", "cat": 4, "class": 15 } ], "status": "OK" } } }

NOAA SLOSH Storm Surge Maximum of the Maximum Category 1 (noaslo)

Field	Description	Data Type
country	Country code	Text
cat	Hurricane Catagory	Numeric
class	Maximum Storm Surge Height (feet)	Numeric

NOAA SLOSH Storm Surge Maximum of the Maximum Category 2 (noaslo)

Field	Description	Data Type
country	Country code	Text
cat	Hurricane Catagory	Numeric
class	Maximum Storm Surge Height (feet)	Numeric

NOAA SLOSH Storm Surge Maximum of the Maximum Category 3 (noaslo)

Field	Description	Data Type
country	Country code	Text
cat	Hurricane Catagory	Numeric
class	Maximum Storm Surge Height (feet)	Numeric

NOAA SLOSH Storm Surge Maximum of the Maximum Category 4 (noaslo)

Field	Description	Data Type
country	Country code	Text
cat	Hurricane Catagory	Numeric
class	Maximum Storm Surge Height (feet)	Numeric

NOAA SLOSH Storm Surge Maximum of the Maximum Category 5 (noaslo)

Field	Description	Data Type
country	Country code	Text
cat	Hurricane Catagory	Numeric
class	Maximum Storm Surge Height (feet)	Numeric

Anchor Point NoHARM (noharm)

A sample result:

{
    "intel_status": "OK",
    "found": 1,
    "results": {
        "noharm": {
            "noharm": {
                "results": [{
                        "acc_egress": 9,
                        "burn_prob": 12,
                        "burnable": 37,
                        "community": 24,
                        "crown_fire": 7,
                        "damage": 1,
                        "ember_cast": 22,
                        "frequency": 19,
                        "fstatprox": 10,
                        "hist_loss": 1,
                        "i_and_d": 1,
                        "intensity": 10,
                        "line_dist": 29,
                        "mitigation": 20,
                        "noharm_id": "CX1714438170",
                        "noharmcls": "X",
                        "pastfires": 23,
                        "prob_ignit": 12,
                        "risk50": 27,
                        "riskdesc": "Intermix High",
                        "risktype": "intermix",
                        "severity": 16,
                        "state": "CA",
                        "structure": 19,
                        "topo_pos": 18,
                        "veg_cover": 44,
                        "w_align_rd": 0,
                        "water_dist": 5,
                        "wind_spd": 17
                    }
                ],
                "status": "OK",
                "stats": {
                    "riskdesc": {
                        "split": {
                            "Mle Minimal": 0.43,
                            "Wildland Moderate": 0.2,
                            "Wildland High": 0.16,
                            "Intermix High": 0.13,
                            "Intermix Very High": 0.08
                        }
                    }
                }
            }
        }
    }
}

NoHARM Wildfire Risk (noharm)

Field	Description	Data Type
risktype	Risk Type	Text
riskdesc	Wildfire Risk	Text
risk50	Overall Risk Rating (0-50)	Numeric
severity	Severity Rating (1-50)	Numeric
frequency	Frequency Rating (1-50)	Numeric
community	Community Rating (1-50)	Numeric
damage	Damage Rating (1-50)	Numeric
mitigation	Mitigation Rating (1-50)	Numeric
fstatprox	Proximity to Nearest Fire Station (0-50)	Numeric
pastfires	No of Historic Fire Perimiters (0-50)	Numeric
intensity	Predicted Fireline Intensity (0-50)	Numeric
crown_fire	% Area within 1/2m of Fire Shed (0-50)	Numeric
wind_spd	Relative Wind Speed (0-50)	Numeric
ember_cast	Relative Ember Cast (0-50)	Numeric
burn_prob	FSim Burn Probability (0-50)	Numeric
prob_ignit	Probability of Ignition (0-50)	Numeric
line_dist	Nearest Electrical Transmission Line (0-50)	Numeric
structure	Structural Density (0-50)	Numeric
w_align_rd	No of Wind Aligned Roads (0-50)	Numeric
acc_egress	Access Points : Road Distance (0-50)	Numeric
veg_cover	Vegetation Cover (0-50)	Numeric
hist_loss	No of Fires with Home Losses (0-50)	Numeric
i_and_d	Insect/Disease Damaged Vegetation (0-50)	Numeric
water_dist	Distance to Water (0-50)	Numeric
topo_pos	Topographic Situation (0-50)	Numeric
burnable	Percent of Burnable Land	Numeric

Data Dictionary (Asia Pacific)

Addresscloud supports a range of datasets, these are listed below together with the update frequency:

Dataset Code	Provider	Dataset	Update Frequency
arpczo	Australian Reinsurance Pool Corporation⁽¹⁾	ARPC Zones (Australia)	Adhoc

⁽¹⁾ Licensed by Australian Bureau of National Statistics under a CC BY 4.0 licence

ARPC Zones (arpczo)

A sample result:

{
    "arpczo": {
        "arpczo": {
            "status": "OK",
            "results": [{
                "postcode": "2026",
                "state": "NSW",
                "tier": "B"
            }]
        }
    }
}

ARPC Zones (arpczo)

Field	Description	Data Type
postcode	Postcode	Text
state	State Code	Text
tier	ARPC Tier	Text

Data Dictionary (Global)

Addresscloud supports a range of datasets, these are listed below together with the update frequency:

Dataset Code	Provider	Dataset	Update Frequency
acadmn	Addresscloud⁽⁶⁾	Addresscloud Open Admin	Adhoc
cresta	Perils.org / GfK	CRESTA Zones	Annual
fibkww	Addresscloud	Addresscloud Fire Blocks	Adhoc
jbahaz	JBA	Hydrological Accumulation Zones (HAZ)	Annual

Addresscloud Open Admin (acadmn)

A sample result:

{
    "acadmn": {
        "level0": {
            "status": "OK",
            "results": [
                {
                    "country": "GB",
                    "code": "085eea613fffffff01a8a15aa3da4c44",
                    "name": "United Kingdom"
                }
            ]
        },
        "level1": {
            "status": "OK",
            "results": [
                {
                    "country": "GB",
                    "code": "085255dd7fffffff011aba243af254bd",
                    "name": "England"
                }
            ]
        },
        "level2": {
            "status": "OK",
            "results": []
        },
        "level3": {
            "status": "OK",
            "results": [
                {
                    "country": "GBR",
                    "code": "999999999",
                    "name": "Greater London Authority"
                }
            ]
        },
        "level4": {
            "status": "OK",
            "results": [
                {
                    "country": "GBR",
                    "code": "E09000006",
                    "name": "Bromley London Boro"
                }
            ]
        }
    }
}

Admin Level 0 (level0)

Field	Description	Data Type
code	Code	Text
name	Name	Text
country	ISO 3166 alpha3 Country Code	Text

Admin Level 1 (level1)

Field	Description	Data Type
code	Code	Text
name	Name	Text
country	ISO 3166 alpha3 Country Code	Text

Admin Level 2 (level2)

Field	Description	Data Type
code	Code	Text
name	Name	Text
country	ISO 3166 alpha3 Country Code	Text

Admin Level 3 (level3)

Field	Description	Data Type
code	Code	Text
name	Name	Text
country	ISO 3166 alpha3 Country Code	Text

Admin Level 4 (level4)

Field	Description	Data Type
code	Code	Text
name	Name	Text
country	ISO 3166 alpha3 Country Code	Text

CRESTA Zones (cresta)

A sample result:

{
    "cresta": {
        "higres": {
            "status": "OK",
            "results": [{
                "cresta_id": "GBR_BR3 4",
                "low_res_id": "GBR_BR",
                "iso3": "GBR"
            }]
        },
        "lowres": {
            "status": "OK",
            "results": [{
                "cresta_id": "GBR_BR",
                "iso3": "GBR"
            }]
        },
        "states": {
            "status": "OK",
            "results": [{
                "iso3": "GBR"
            }]
        }
    }
}

CRESTA High-Res Zones (higres)

Field	Description	Data Type
cresta_id	CRESTA ID (High Res)	Text
low_res_id	CRESTA Low Res ID	Text
iso3	ISO 3 Char Country Code	Text

CRESTA Low-Res Zones (lowres)

Field	Description	Data Type	Lookup
cresta_id	CRESTA ID (Low Res)	Text
iso3	ISO 3 Char Country Code	Text

World States (states)

Field	Description	Data Type	Lookup
iso3	ISO 3 Char Country Code	Text

Addresscloud Fire Blocks (fibkww)

A sample result:

{
    "fibkww": {
        "fibk05": {
            "status": "OK",
            "results": [{
                "fire_block_id": "9223371714989431071"
            }]
        }
    }
}

Addresscloud 5m Fire Blocks (fibk05)

Field	Description	Data Type	Lookup
fire_block_id	Fire Block ID	Text

JBA HAZ Zones (jbahaz)

A sample result:

{
    "jbahaz": {
        "t5zone": {
            "status": "OK",
            "results": [{
                "t5_id": "5_1_1293"
            }]
        },
        "t500zo": {
            "status": "OK",
            "results": [{
                "t500_id": "500_12_9"
            }]
        }
    }
}

JBA HAZ T5 Zones (t5zone)

Field	Description	Data Type	Lookup
t5_id	JBA T5 ID	Text

JBA HAZ T500 Zones (t500zo)

Field	Description	Data Type	Lookup
t500_id	JBA T500 ID	Text

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 Classification

Code	Value
C001	AA/RAC
C003	Advertising
C004	Agricultural Building
C005	Airport
C006	Air Strip
C007	Airport
C008	Airport
C009	Aluminium Smelting Works
C010	Ambulance Stations
C011	Amusement Arcade
C012	Amusement Park
C013	Animal Boarding
C014	Arenas
C015	MOD
C016	Artificial Fibre Works
C017	Asphalt Plant
C018	ATMs
C019	Auction Room
C020	Baling Plants
C021	Financial Offices
C022	Beach Huts
C023	Beet Sugar Factory
C024	Betting Office
C025	Bingo Hall
C026	Bird Sanctuary
C027	Boat Yard
C028	Bowling Alleys
C029	Bowling Centre
C030	Bowling Green
C031	Breweries
C032	Brickworks
C033	Cement Storage Depot
C034	Bullion/Money Store
C036	Bus Station
C037	Cable Head End Building
C038	Car Auction
C039	Car Park (Multi-Storey)
C040	Car Park (Open)
C041	Car Park (Open)
C042	Car Showroom
C043	Car Spaces
C044	Car Supermarket
C045	Car Wash
C046	Car/Caravan Sales/Display/Hiring Sites
C047	Caravan Park
C048	Caravan Park
C049	Casinos & Gambling Clubs
C050	Cattle Breeding Centre
C051	Cement Works
C052	Cement Works
C053	Cemeteries
C054	Chalet Park
C055	Chemical Works
C056	Cinema
C057	Civic & Public Building
C058	Civic Amenity Site
C059	Airport
C060	Clubhouse
C061	Clubs & Institution
C062	Coaching Inn
C063	Coking & Carbonising Plants
C065	Colleges of Further Education
C066	Communication Station
C067	Community Day Centre
C068	Computer Centre (Non-Purpose Built)
C069	Computer Centre
C070	Concert Hall
C071	Concrete Batching Plants
C072	Concrete Block Works
C073	Concrete Product Works
C074	Conference & Exhibition Centre
C075	Conference Centres in Country House
C076	Contractors Huts & Compounds
C077	Country House Hotel
C079	Creamery
C080	Crematorium
C081	Cricket Centre
C082	Cricket Ground
C083	Cricket Grounds/Pitches
C084	Dance School
C085	Day Nursery/Play School
C086	Department Store or Shopping Centre
C087	Distilleries
C088	Heating Utility
C089	Docks & Harbours
C090	Domestic Fuel Installations
C091	Drive-In Restaurants
C092	Drive-Thru Restaurants
C093	Effluent Minewater Treatment Plant & Premises
C094	Electricity Utility
C095	Exhaust & Tyre Centre
C096	Factories, Workshops & Warehouses (Incl Bakeries & Dairies)
C097	Factory Shop
C098	Farm Shop
C099	Field Study, Activity & Adventure Centre
C100	Film & TV Studio
C101	Fire Station
C102	Fish Farm
C103	Flour Mill
C104	Food Court
C105	Food Processing Centre
C106	Food Store
C107	Football Ground
C108	Football Pitches
C109	Football Stadia
C110	Foundry
C111	Funeral Parlour/Chapel Of Rest
C112	Game Farm
C113	Transport or Commercial Garage
C114	Garden Centre
C115	Gas Processing Plant
C116	Go Kart Rink
C117	Golf Course
C118	Golf Driving Range
C119	Grain Silos
C120	Granary Store
C121	Greyhound Racetrack
C122	Guest or Boarding House
C123	Gypsy Camp Site
C124	Hatchery or Poultry Farm
C125	Health Farm
C126	Heliport
C127	Minerals processing
C128	Heritage Railway
C129	High Tech Warehouse
C130	Holiday Centre
C131	Holiday Home
C132	Horse Racecourse
C133	Hospital Let Out
C134	NHS Hospital or Clinic
C135	Private Hospital or Clinic
C136	Hostel
C137	Hotel
C138	Hotel (4 Star & Above)
C139	Hypermarket/Superstore (over 2,500m2)
C140	Ice Rink
C141	Telephone Kiosk
C142	Iron and/or Steel Works
C143	Kennel or Cattery
C144	Laboratory
C145	Lakes With Water Sport Facilities
C146	Land Used For Advertising
C147	Land Used For Car Boot Sales
C148	Land Used For Storage
C149	Landfill Gas Generator Sites
C150	Land used for Waste Composting
C151	Large Distribution Warehouses
C152	Large Food Store (750 - 2500m2)
C153	Large Industrial Building (Over 20,000m2)
C154	Large Shop (750 - 1850m2)
C155	Large Shop (Over 1850m2)
C156	Library
C157	Liquid Bulk Storage (Incl Petrol & Oil)
C158	Livestock Market
C159	School
C160	Lodge
C161	Lorry Park
C162	Maltings - Non Trad
C163	Maltings - Trad
C164	Marina
C165	Non Livestock Market
C166	Mineral Depot & Premises
C167	Mineral Producing Building - Blockstone
C168	Mineral Producing Building - Brine
C169	Mineral Producing Building - Chalk
C170	Mineral Producing Building - China Clay
C171	Mineral Producing Building - Clay
C172	Mineral Producing Building - Coal
C173	Mineral Producing Building - Fluorspar
C174	Mineral Producing Building - Gas
C175	Mineral Producing Building - Hardrock
C176	Mineral Producing Building - Inert
C177	Mineral Producing Building - Oil
C178	Mineral Producing Building - Other Mineral Category
C179	Mineral Producing Building - Putrescible
C180	Mineral Producing Building - Sand & Gravel
C181	Mineral Producing Building - Sand
C182	Mineral Producing Building - Shale Unburnt
C183	Mineral Producing Building - Slate
C184	Mineral Producing Building With Batching Plant
C185	Mineral Producing Building With Coating Plant
C186	Mineral Producing Building With Tunnel Kiln
C187	MOD
C188	Model Village
C189	Moorings
C190	Mortuaries
C191	Motor Racetrack
C192	Motor Vehicle Works
C193	Motorway Service Area Let Outs
C194	Motorway & Major Road Service Areas
C195	Museum or Art Gallery
C196	Museum or Art Gallery
C197	MOD
C198	Newspaper Printing Works
C199	Night Club
C200	Nuclear Facility
C201	Nursing Home or Old Peoples Home
C202	Observatory
C203	Office (Inc Computer Centres)
C204	Headquarters/Institutional Office
C205	Oil Refinery
C206	University and buildings
C207	Paper Mill
C208	Pavilion
C209	Petrol Station
C210	Pharmacy
C211	Photographic Booth
C212	Pipelines
C213	Pleasure Pier
C214	Point to Point & Eventing Course
C215	Police Station
C216	Polo Ground
C217	Post Office Sorting Centre
C218	Potteries
C219	Power Generators
C220	Prison Service Building
C221	Aggregate Processing
C222	Provender Mill
C223	Public & Independent School
C224	Public Convenience
C225	Public Hall
C226	Public House/ Pub Restaurant
C227	Public House/ Pub Restaurant
C228	Public Telephone Kiosk
C229	Equestrian Stables
C230	MOD
C231	Railways & Tramways (Non Leisure)
C232	Recording Studio
C233	Refuse Destructor Plants/Disposal Site
C234	Restaurant
C235	Retail Warehouses & Foodstore
C236	Equestrian Schools & Stables
C237	Rifle & Weapons Range
C238	Roadside Restaurant
C239	Roller Skating Rink
C240	Royal Palace
C241	Rugby League Ground
C242	Rugby Union Ground
C243	Sales Kiosk
C244	Scrap Metal/Breakers Yard
C245	Sea Dredged Aggregate Processing Plants & Depot
C246	Sewage Works
C247	Ship Building Yard
C248	Ship Repair Yard
C249	Shop
C250	Showhouse
C251	Showroom
C252	Ski Centre
C253	Snooker Halls/Club
C254	Speedway Racetrack
C255	Spoil Heap Working
C256	Sporting Right
C257	Sports & Leisure Centre (LA) (Dry Only)
C258	Sports & Leisure Centre (LA) (Wet & Dry)
C259	Sports & Leisure Centre (Private)(Dry Only)
C260	Sports & Leisure Centre (Private)(Wet & Dry)
C261	Sports Ground
C262	Sports Stadia
C263	Squash Courts
C264	Equestrian Stables & Loose Boxes
C265	Stately Home or Historic House
C266	Station Let Outs
C267	Storage Depot
C268	Store
C269	Stud Farm
C270	Studio
C272	Swimming Pool (Local Authority)
C273	Swimming Pool (Private)
C274	Tannery
C275	Telecommunications
C276	Telecommunications Switching Centres
C277	Tennis Centre
C278	Tennis Courts/Club
C279	Theatre
C280	Theme Park
C281	Timeshare Complexes
C282	Tolls (Ferries, Roads & Bridges)
C283	Totalisators On Horse Racecourses
C284	Tourist Attraction/Park Rides
C285	Training Centre (Non Residential)
C286	Training Centre (Residential)
C287	Truck Stop
C288	University and buildings
C289	Vehicle Repair Workshop or Garage
C290	Vehicle Testing Centre
C291	Vehicle Testing Centre
C292	Veterinary Clinic / Animal Clinic
C293	Village Hall or Scout Hut or Cadet Hut
C294	Vineyard/Winery
C295	Wafer Fabrications
C296	War Games Courses/Misc Ag. Use
C297	Waste Incinerator Plant
C298	Waste Recycling Plant
C299	Waste Transfer Station
C300	Water Utility
C301	Wholesale Warehouse
C302	Windmill
C303	Wine Bar
C304	Zoos & Safari Park
C400	Abattoirs & Slaughter House
C401	Abattoirs & Slaughter House
C402	Agricultural Research Centre
C403	Aquaria
C404	Archives
C405	Boathouse
C406	Bus Garage
C407	Bus Garage
C408	Business Units
C409	Cafe
C410	Changing Rooms
C411	Coastguard Station
C412	Cold Store
C413	Cold Store
C414	Law Court
C415	Law Court
C416	Gym or Fitness facility
C417	Hairdressing/Beauty Salon
C418	Information/Visitor Centre
C419	Land Used for Display
C420	Lifeboat Station
C421	Miniature Railway
C422	Pack House
C423	Peat Fields
C424	Pet Grooming Parlour
C425	Pharmacies associated with Surgery or Health Centre
C426	Pitch & Putt
C427	Pitches for Stalls, Sales or Promotions
C428	Police Training College
C429	Post Office
C430	Pumping Mine
C431	Residential Religious Retreat or Study Centre
C432	Office
C433	Docks & Harbours
C434	Docks & Harbours
C435	Docks & Harbours
C436	Surgeries, Clinics, Health Centre
C437	Surgeries, Clinics, Health Centre
C438	Telescope Site
C439	University - Ancillary Land or Buildings
C440	University facility Within a Hospital
C441	Weighbridge
C442	Takeaway Food Outlet
C500	Cafes/Restaurants Within Another Property
C501	Car Parking Within Another Property
C502	Garages Within Another Property
C503	Gym/Fitness Facility Within Another Property
C504	Kiosk Within Another Property
C505	Nursery/Creche Within Another Property
C506	Offices Within Another Property
C507	Salons/Clinics Within Another Property
C508	Shops Within Another Property
C509	Sports & Leisure Centres Another Property
C510	Stores Within Another Property
C511	Warehouses Within Another Property
C512	Workshops Within Another Property
C513	Miscellaneous Another Property
C600	Dwelling
C601	Embassy, High Commission
C602	Consulate, General
C603	Consulate, Honorary
C604	Health Miscellaneous
C605	Food Miscellaneous
C710	Shopping Centre
C712	Rail Freight Depots
C714	Rail Maintenance Depots
C715	Football Training Grounds
C721	Self Storage Facilities
C722	Serviced Apartments
C725	Park and Ride Car Parks
C726	Telecommunications Large Broadcast Sites
C729	Renewable Power Generators - Mixed Technologies
C730	Biomass Biologicals (Crop and Slurry Based Anaerobic Digesters, Including Gas to Grid)
C733	Battery Storage Sites
C737	Ferry Terminals
C738	Building Merchants
C739	Soccer Centres
C741	Independent Gas Transporters
C742	Independent Distribution Network Operators
C743	Renewable Power Generators - Photovoltaic
C744	Renewable Power Generators - Wind
C745	Renewable Power Generators - Other
C746	Renewable Power Generators - Hydro
C747	Fossil Fuel Power Stations
C748	Nuclear Power Stations
C757	Plant Nurseries
C990	Transport Miscellaneous
C991	Religious Miscellaneous
C992	Commercial Miscellaneous
C993	Leisure Miscellaneous
C994	Industrial Miscellaneous
C995	Educational Miscellaneous
C996	Formula Assessed Miscellaneous
C997	Minerals Miscellaneous
C998	Crown Miscellaneous
C999	Commercial Unknown

Lookup: Addresscloud Form

Code	Value
DT	Detached
FC	Converted Flat
FP	Purpose Built Flat
FL	Flat
RM	Room
SD	Semi-Detached
TE	End-Terrace
TM	Mid-Terrace
TR	Terraced

Lookup: Addresscloud Heat Source

Code	Value
MG	Mains Gas
EL	Electric
OI	Oil
CO	Coal
BG	Bottled Gas
LP	LPG

Lookup: Addresscloud HML

Code	Value
H	High
M	Medium
L	Low

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: Addresscloud Roof Type

Code	Value
PI	Pitched
FL	Flat
TH	Thatched

Lookup: Addresscloud Roof Material

Code	Value
CN	Concrete
SL	Slate
TI	Tiles
ZA	Zinc

Lookup: Addresscloud Site Classification

Code	Value
220	Type 220
230	Type 230
240	Type 240
250	Type 250
320	Type 320
330	Type 330
340	Type 340
350	Type 350
420	Type 420
430	Type 430
440	Type 440
450	Type 450

Lookup: Addresscloud Style

Code	Value
CM	Caravan / mobile
DT	Detached
FL	Flat
HB	House Boat
RM	Room
SA	Sheltered Accommodation
SD	Semi-detached
TR	Terraced

Lookup: Addresscloud Tenure

Code	Value
FH	Freehold
LH	Leasehold
FE	Feudal
SH	Shared

Lookup: Addresscloud Type

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

Lookup: Addresscloud Use

Code	Value
R	Residential
N	Non-Residential
P	Parent Address
O	Other

Lookup: Addresscloud Wall Type

Code	Value
AG	Agglomerate
BR	Brick
CB	Cob
CN	Concrete
GR	Grit Stone
NT	Non Traditional
PH	Park Home
ST	Stone
TF	Timber Frame
WO	Wood
OT	Other
UN	Unknown

Lookup: Classification

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

Lookup: Land Use

Code	Label 1	Label 2	Label 3	Addresscloud
111	Artificial surfaces	Urban fabric	Continuous urban fabric	Dense Urban
112	Artificial surfaces	Urban fabric	Discontinuous urban fabric	Suburban
121	Artificial surfaces	Industrial, commercial and transport units	Industrial or commercial units	Industry or Commercial
122	Artificial surfaces	Industrial, commercial and transport units	Road and rail networks and associated land	Road and Rail
123	Artificial surfaces	Industrial, commercial and transport units	Port areas	Ports and Harbours
124	Artificial surfaces	Industrial, commercial and transport units	Airports	Aiports
131	Artificial surfaces	Mine, dump and construction sites	Mineral extraction sites	Mineral Extraction
132	Artificial surfaces	Mine, dump and construction sites	Dump sites	Land Fill and Dumps
133	Artificial surfaces	Mine, dump and construction sites	Construction sites	Construction and development
141	Artificial surfaces	Artificial, non-agricultural vegetated areas	Green urban areas	Green Urban
142	Artificial surfaces	Artificial, non-agricultural vegetated areas	Sport and leisure facilities	Leisure land
211	Agricultural areas	Arable land	Non-irrigated arable land	Arable land
212	Agricultural areas	Arable land	Permanently irrigated land	Arable land
213	Agricultural areas	Arable land	Rice fields	Arable land
221	Agricultural areas	Permanent crops	Vineyards	Agricultural land
222	Agricultural areas	Permanent crops	Fruit trees and berry plantations	Agricultural land
223	Agricultural areas	Permanent crops	Olive groves	Agricultural land
231	Agricultural areas	Pastures	Pastures	Agricultural land
241	Agricultural areas	Heterogeneous agricultural areas	Annual crops associated with permanent crops	Agricultural land
242	Agricultural areas	Heterogeneous agricultural areas	Complex cultivation patterns	Agricultural land
243	Agricultural areas	Heterogeneous agricultural areas	Land principally occupied by agriculture, with significant areas of natural vegetation	Agricultural land
244	Agricultural areas	Heterogeneous agricultural areas	Agro-forestry areas	Agricultural land
311	Forest and semi natural areas	Forests	Broad-leaved forest	Forests
312	Forest and semi natural areas	Forests	Coniferous forest	Forests
313	Forest and semi natural areas	Forests	Mixed forest	Forests
321	Forest and semi natural areas	Scrub and/or herbaceous vegetation associations	Natural grasslands	Forest and semi natural areas
322	Forest and semi natural areas	Scrub and/or herbaceous vegetation associations	Moors and heathland	Forest and semi natural areas
323	Forest and semi natural areas	Scrub and/or herbaceous vegetation associations	Sclerophyllous vegetation	Forest and semi natural areas
324	Forest and semi natural areas	Scrub and/or herbaceous vegetation associations	Transitional woodland-shrub	Forest and semi natural areas
331	Forest and semi natural areas	Open spaces with little or no vegetation	Beaches, dunes, sands	Natural Open
332	Forest and semi natural areas	Open spaces with little or no vegetation	Bare rocks	Natural Open
333	Forest and semi natural areas	Open spaces with little or no vegetation	Sparsely vegetated areas	Natural Open
334	Forest and semi natural areas	Open spaces with little or no vegetation	Burnt areas	Natural Open
335	Forest and semi natural areas	Open spaces with little or no vegetation	Glaciers and perpetual snow	Natural Open
411	Wetlands	Inland wetlands	Inland marshes	Wetlands
412	Wetlands	Inland wetlands	Peat bogs	Wetlands
421	Wetlands	Maritime wetlands	Salt marshes	Wetlands
422	Wetlands	Maritime wetlands	Salines	Wetlands
423	Wetlands	Maritime wetlands	Intertidal flats	Wetlands
511	Water bodies	Inland waters	Water courses	Water bodies
512	Water bodies	Inland waters	Water bodies	Water bodies
521	Water bodies	Marine waters	Coastal lagoons	Water bodies
522	Water bodies	Marine waters	Estuaries	Water bodies
523	Water bodies	Marine waters	Sea and ocean	Water bodies

Lookup: Distance to Coast

Code	Value
A	4500m to 5000m
B	4000m to 4500m
C	3500m to 4000m
D	3000m to 3500m
E	2500m to 3000m
F	2000m to 2500m
G	1500m to 2000m
H	1000m to 1500m
I	500m to 1000m
J	< 500m

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 Heat Source

Code	Value
MG	Mains Gas
EL	Electric
OI	Oil
CO	Coal
BG	Bottled Gas
LP	LPG

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 Wall Type

Code	Value
BR	Brick
ST	Stone
NT	Non Traditional
TF	Timber Frame
CB	Cob
PH	Park Home

Lookup: EPC Roof Type

Code	Value
PI	Pitched
FL	Flat
TH	Thatched

Lookup: EPC Age

Code	Value
A	Before 1900
B	1900-1929
C	1930-1949
D	1950-1966
E	1967-1975
F	1976-1982
G	1983-1990
H	1991-1995
I	1996-2002
J	2003-2006
K	2007 Onwards

Lookup: EPC Tenure

Code	Value
O	Owner Occupied
P	Private Rental
S	Social Rental
U	Unknown

Lookup: FloodRe Eligible

Code	Value
0	No
1	Yes
9	Unknown

Lookup: FloodRe Source

Code	Value
1	England Data File
2	Wales Data File
3	Northern Ireland Data File
4	Scottish Data File

Lookup: EPC Floor Type

Code	Value
SL	Solid
SU	Suspended

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: JBA Flood Depth (Surface)

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

Lookup: JBA Flood Depth (WW)

Code	Value
0	Negligible Hazard
1	0.01m < x <= 0.3m
2	0.3m < x <= 1m
3	1m < x <= 3m
4	3m < x <= 6m
5	6m < x <= 9m
6	> 9m

Lookup: MapleSky Hazard Level

Code	Value
0	N/A
1	Low
2	Moderate
3	Signifcant

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: 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.

You must replace YOUR_API_KEY and YOUR_CLIENT_ID with your supplied credentials.

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:

Adding properties to JSON objects
Adding new parameters
Changing the number of items returned in a single listing request
The structure or length of identifiers generated by the API
Changing error messages

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

Removing properties from JSON objects
Changing an API's URL structure

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

Attribution

Addresscloud Services include third-party services and data. A list of the related attribution can be found here