Skip to main content

AddressBase Core

Essential Elements

ID

Global unique internally generated identifier for an address

Example

paf_8387729

Property Name

id

Type

string


Dataset

Indicates the provenance of an address

Property Name

dataset

Type

string

Possible Values

  • "ab"

Language

Property Name

language


Address Line 1

First Address Line. Often contains premise and thoroughfare information. In the case of a commercial premise, the first line is always the full name of the registered organisation. Never empty.

Example

Prime Minister & First Lord of Treasury

Property Name

line_1

Type

string


Address Line 2

Second Address Line. Often contains thoroughfare and locality information. May be empty

Example

10 Downing Street

Property Name

line_2

Type

string


Address Line 3

Third address line. May be empty.

Property Name

line_3

Type

string


Premise

A pre-computed string which sensibly combines building_number, building_name and sub_building_name. building_number, building_name and sub_building_name represent raw data from Royal Mail's and can be difficult to parse if you are unaware of how the Postcode Address File premise fields work together. For this reason, we also provide a pre-computed premise field which intelligently gathers these points into a single, simple premise string. This field is ideal if you want to pull premise information and thoroughfare information separately instead of using our address lines data.

Example

10

Property Name

premise

Type

string


UPRN

Unique Property Reference Number (UPRN) assigned by the LLPG Custodian or Ordnance Survey.

Property Name

uprn

Type

string


UDPRN

Royal Mail's Unique Delivery Point Reference Number (UDPRN).

Property Name

udprn

Type

number


PARENT_UPRN

UPRN of the parent Record if a parent-child relationship exists.

Property Name

parent_uprn

Type

string


USRN

Unique Street Reference Number assigned by the Street Name and Numbering Custodian OR Ordnance Survey depending on the address record.

Property Name

usrn

Type

number


TOID

The Topographic Identifier taken from OS MasterMap Topography Layer. This TOID is assigned to the UPRN by performing a spatial intersection between the two identifiers. It consists of the letters 'osgb' and is followed by up to sixteen digits.

Property Name

toid

Type

string


Classification Code

A code that describes the classification of the address record to a maximum of a secondary level.

Property Name

classification_code

Type

string


Easting

A value in metres defining the x location in accordance with the British National Grid.

Property Name

eastings

Type

number


Northing

A value in metres defining the y location in accordance with the British National Grid.

Property Name

northings

Type

number


Latitude

A value in metres defining the y location in accordance with the British National Grid.

Property Name

latitude

Type

number


Longitude

A value defining the Longitude location in accordance with the ETRS89 coordinate reference system.

Property Name

longitude

Type

number


Single Line Address

A single attribute containing text concatenation of the address elements separated by a comma.

Property Name

single_address_line

Type

string


Street Name

Street / Road name for the address record.

Property Name

street_name

Type

string


Locality

A locality defines an area or geographical identifier within a town, village, or hamlet. Locality represents the lower level geographical area. The locality field should be used in conjunction with the town name and street description fields to uniquely identify geographic area where there may be more than one within an administrative area.

Property Name

locality

Type

string


Town Name

Geographical town name assigned by the Local Authority. Please note this can be different from the Post Town value assigned by Royal Mail.

Property Name

town_name

Type

string


Delivery Point Suffix

A two-character code uniquely identifying an individual delivery point within a postcode, assigned by Royal Mail.

Property Name

delivery_point_suffix

Type

string


Post Town

The town or city in which the Royal Mail sorting office is located which services this address record.

Condition: POST_TOWN is not populated if this is the same as TOWN_NAME.

Property Name

post_town

Type

string


Governmental Statistical Service

The Office for National Statistics Governmental Statistical Service (GSS) code representing the contributing Local Authority.

Property Name

gss_code

Type

string


Representative Point Code

Representative Point Code describes the accuracy of the coordinate that has been allocated to the UPRN as indicated by the Local Authority and enhanced using large scale OS data.

Property Name

rpc

Type

number


Last Update Date

The latest date on which any of the attributes on this record were last changed.

Property Name

last_update_date

Type

string


Island

Third level of geographic area name to record island names where appropriate.

Property Name

island

Type

string


Change Code

This enumeration is used in association with the attribute “CHANGE_CODE”. This enumeration identifies the type of change that has been made to a feature. The change type must be set when a feature is inserted, updated, or deleted. Please see section 3 for more information. Example I = Insert, U = Update, D = Delete

Property Name

change_code

Type

string

Possible Values

  • "I"
  • "U"
  • "D"

Building Name

The building name is a description applied to a single address or a group of addresses.

Property Name

building_name

Type

string


Building Number

The building number is a number or range of numbers given to a single address or a group of addresses.

Property Name

building_number

Type

string


Sub-building"

The sub-building name and/or number for the address record.

Property Name

sub_building

Type

string


Postcode

A postcode assigned by Royal Mail for the address record.

Property Name

postcode

Type

string


PO Box

Text concatenation of 'PO BOX' and the Post Office Box (PO Box) number or 'BFPO' and the British Forces Post Office number.

Property Name

po_box

Type

string


Organisation

The organisation name is the business name given, when appropriate, to an address record.

Property Name

organisation

Type

string


Country

Full country names (ISO 3166)

Example

England

Property Name

country

Type

string


Country ISO

3 letter country code (ISO 3166-1)

Property Name

country_iso

Type

string


County

Since postal, administrative or traditional counties may not apply to some addresses, the county field is designed to return whatever county data is available. Normally, the postal county is returned. If this is not present, the county field will fall back to the administrative county. If the administrative county is also not present, the county field will fall back to the traditional county. May be empty in cases where no administrative, postal or traditional county present.

Example

London

Property Name

county

Type

string


District

A distict is a type of administrative division that is managed by the local authorities.

Property Name

district

Type

string


Ward

The current administrative/electoral area to which the postcode has been assigned. May be empty for a small number of addresses.

Example

St. James'

Property Name

ward

Type

string


Traditional County

Traditional counties are provided by the Association of British Counties. It is historical data, and can date from the 1800s. May be empty.

Example

Greater London

Property Name

traditional_county

Type

string


Postal County

Postal counties were used for the distribution of mail before the Postcode system was introduced in the 1970s. The Former Postal County was the Administrative County at the time. This data rarely changes. May be empty.

Example

London

Property Name

postal_county

Type

string