Cleanse Address
/v1/cleanse/addressesReturns the closest matching address for a freeform address input, with Match Level indicators describing how closely each element of the suggested address matches the input. The more impaired the input address, the harder it is to cleanse.
A cleanse that returns a match costs a lookup. A no-match response is free.
Confidence Score
Each incorrect, missing or misspelled element subtracts from the overall confidence score.
Deciding on an Acceptable Confidence Score Threshold
Inputs differ widely between address cleanse projects. Within a project, though, they tend to repeat the same errors. Some datasets are keyed in by hand and prone to typos. Others have a persistently missing datapoint such as organisation name or postcode. There is no absolute Confidence Score threshold. Set the acceptable score project by project, based on the systematic errors in the data and your business goals.
To set a threshold, load a subset of the dataset into a spreadsheet application like Excel and sort on the score. Scrolling from top to bottom shows matches from best to worst. As you reach the lower quality searches you can judge roughly:
- Which confidence scores indicate ambiguous matches (i.e. up to building level only)
- Which confidence scores indicate a poor or no match (i.e. the nearest matching address is too far from the input address)
Depending on your business goals, you can also use the Match Levels to determine an acceptable match. You may need to match only up to the thoroughfare or building name, or accurate organisation names may matter.
Query parameters
api_keystring optionalAPI Key
Your unique identifier that allows access to our APIs.
Begins
ak_. Available from your dashboard.tagsstring optionalTags
A comma separated list of tags to query over.
Useful if you want to specify the circumstances in which the request was made.
If you specify multiple tags, the response comprises only requests that satisfy all of them. Searching
"foo,bar"queries only requests tagged both"foo"and"bar".contextstring optionalIdentify the country of the address to cleanse. Defaults to UK (GBR)
Request body
A JSON object holding the address to cleanse. Only query is required.
bodyobjectquerystring requiredFreeform address input to cleanse
postcodestring optionalOptionally specify the postal code for the address.
post_townstring optionalOptionally specify the city or town of the address.
This should be the "post town" of the address.
countystring optionalOptionally specify the county of the address.
We recommend omitting this field as county data is unreliable.
Response
result is one of two shapes: an address match, whose match is a flat
Address record carrying its raw native dataset record, or a no-match
object. Both carry a confidence score and per-component match indicators.
Follow a dataset link for that record's complete field list. The response sits
inside the standard { result, code, message } envelope; see the
API reference for the wrapper format.
resultone ofAddress Match
querystringOriginally submitted query
matchobjectNearest matching address
idstringGlobal unique internally generated identifier for an address
datasetstringIndicates the provenance of an address.
country_isostring3 letter country code (ISO 3166-1)
country_iso_2string2 letter country code (ISO 3166-1)
countrystringFull country names (ISO 3166)
languagestringLanguage represented by 2 letter ISO Code (639-1)
line_1stringFirst address line. Often contains premise and thoroughfare information. For a commercial premise the first line is the full name of the registered organisation. Never empty.
line_2stringSecond address line. Often contains thoroughfare and locality information. May be empty.
line_3stringThird address line. Takes the address elements left after
line_1andline_2are filled; where the address needs more than three lines the remaining elements are joined intoline_3, comma separated. May be empty.post_townstringThe town or city used to route mail to the address. For UK addresses this is the Royal Mail post town, which is a routing instruction rather than the nearest town geographically. Present on every address.
postcodestringCorrectly formatted postcode. Capitalised and spaced. Empty (
"") where the address has no postcode.countystringWhatever county data is available for the address. Normally the postal county. If that is not present it falls back to the administrative county, then to the traditional county. May be empty where none of the three is present.
county_codestringShort code representing the county or province. May be empty (
"")uprnstringUPRN stands for Unique Property Reference Number and is maintained by the Ordnance Survey (OS). Local governments in the UK have allocated a unique number for each land or property.
Up to 12 digits in length.
Multiple Residence premises currently share the same UPRN as the parent premise.
May not be available for a small number of Great Britain addresses due to longer update cycles for Ordnance Survey's AddressBase datasets. Returns empty string "" in these instances, as it does for addresses outside the UK.
Although UPRN takes an integer format, we encode and transmit this data as strings. As a 12 digit number, the UPRN can exceed the maximum safe integer
Number.MAX_SAFE_INTEGERin most browsers causing this datapoint to be corrupted.Take special care when storing UPRN. As a 12 digit identifier, you will need 64 bits to encode every possible UPRN value. This means applications like Excel will corrupt cells containing UPRN values.
udprnone ofUDPRN stands for 'Unique Delivery Point Reference Number'. Royal Mail assigns a unique UDPRN code for each premise on PAF. Simple, unique reference number for each Delivery Point. Unlikely to be reused when an address expires.
Up to 8-digit numeric code. A new UDPRN is automatically assigned to each new Delivery Point added to PAF.
Returns
0on a UK dataset that carries no UDPRN for the address, and an empty string""on a non-UK address. Useidfor an identifier present on every address.- integer
- string
umprnone ofA small minority of individual premises (as identified by a UDPRN) may have multiple occupants behind the same letterbox. These are known as Multiple Residence occupants and can be queried via the Multiple Residence dataset. Simple, unique reference number for each Multiple Residence occupant.
Note: this will be an empty string
""when not used.- string
- number
postcode_outwardstringThe first part of a postcode is known as the outward code. e.g. The outward code of ID1 1QD is ID1. Enables mail to be sorted to the correct local area for delivery. This part of the code contains the area and the district to which the mail is to be delivered, e.g. 'PO1', 'SW1A' or 'B23'.
Empty (
"") where the address has no UK postcode.postcode_inwardstringThe second part of a postcode is known as the inward code. e.g. The inward code of ID1 1QD is 1QD.
The number identifies the sector in the postal district. The number is followed by 2 letters. The letters then define one or more properties in that sector.
Empty (
"") where the address has no UK postcode.dependant_localitystringA locality that qualifies the thoroughfare. Used where the same thoroughfare name occurs more than once in a post town and no dependant thoroughfare distinguishes them. May be empty.
double_dependant_localitystringSupplements dependant locality. Supplied where the dependant locality itself occurs twice in the same locality. May be empty.
thoroughfarestringAlso known as the street or road name. May be empty.
dependant_thoroughfarestringSupplements thoroughfare. Used where a thoroughfare name occurs twice in the same post town, to identify the address uniquely. May be empty.
building_numberstringNumber identifying the premise on a thoroughfare or dependant thoroughfare. May be empty.
building_namestringName of a residential or commercial premise. May be empty.
Examples:
- The Manor
- 1-2
- A
- 12A
- K
- Victoria House
sub_building_namestringIdentifies a unit where a premise is split into flats, apartments or business units. Cannot be present without either building_name or building_number. E.g. Flat 1, A, 10B. May be empty.
po_boxstringPO Box number for the address, occasionally a combination of numbers and letters. Allocated to Large User postcodes only. May be empty.
department_namestringSupplements organisation name to identify a department within the organisation. May be empty.
organisation_namestringName of the business or organisation at this address. May be empty.
postcode_typestringRoyal Mail postcode user type. UK addresses only.
Ssmall user. The postcode identifies a group of delivery points. There are on average 19 delivery points per postcode, and never more than 100Llarge user. The postcode is assigned to a single address, either because of the volume of mail it receives or because a PO Box or Selectapost service is set up
Empty (
"") where not applicable.su_organisation_indicatorstringYwhere an organisation is present at a small user postcode. Empty ("") otherwise. UK addresses only.delivery_point_suffixstringTwo-character code (the first numeric, the second alphabetical) which, added to the postcode, uniquely identifies a delivery point. May be reused once a delivery point is deleted, though not until every remaining code in the range has been allocated. Always
1Afor a large user postcode, since each large user has its own postcode. Empty ("") where not available.premisestringA pre-computed string which sensibly combines building_number, building_name and sub_building_name. Those three fields hold raw dataset values and can be difficult to parse if you are unaware of how they work together, so we also provide this single, simple premise string. Ideal if you want to pull premise information and thoroughfare information separately instead of using our address lines data.
administrative_countystringThe current administrative county to which the postcode has been assigned.
A Unitary Authority name, where one is present. If there is no Unitary Authority, the County name is used. This information is not static, because County boundaries may change due to administrative changes.
Source: ONS. May be empty.
postal_countystringPostal 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.
traditional_countystringTraditional counties are provided by the Association of British Counties. It is historical data, and can date from the 1800s. May be empty.
districtstringThe current district/unitary authority to which the postcode has been assigned. May be empty.
wardstringThe current administrative/electoral area to which the postcode has been assigned. May be empty for a small number of addresses.
longitudeLongitudeThe longitude of the address or postcode (WGS84).
Can be a positive or negative decimal. E.g. -0.1283983
Returns an empty string if no location data is available.
- string
- number
latitudeLatitudeThe latitude of the address or postcode (WGS84).
Can be a positive or negative decimal. E.g.
51.5083983.Returns an empty string if no location data is available.
- string
- number
eastingsEastingsEastings reference using the Ordnance Survey National Grid reference system.
Northern Ireland Eastings uses the Irish Grid Reference System.
Metres from origin. E.g.
550458Returns an empty string if no location data is available. Otherwise a number is returned.
- string
- number
northingsNorthingsNorthings reference using the Ordnance Survey National Grid reference system
Northern Ireland Northings uses the Irish Grid Reference System
Metres from origin. E.g.
180458Returns an empty string if no location data is available. Otherwise a number is returned
- string
- number
nativeNativeRecordThe raw dataset record backing an address, exactly as the dataset supplies it. One schema per dataset;
dataseton the record says which.Royal Mail Postcode Address File Address Full guide
Raw Royal Mail Postcode Address File record backing a
pafaddress.datasetstringpostcodestringPostcode, space separated
post_townstringRoyal Mail post town, title cased
dependant_localitystringDependant locality. Empty string when not present
double_dependant_localitystringDouble dependant locality. Empty string when not present
thoroughfarestringStreet name
dependant_thoroughfarestringDependant street name. Empty string when not present
building_numberstringBuilding number. Empty string when not present, or when PAF merges it into the building name
building_namestringBuilding name. Empty string when not present
sub_building_namestringSub building name. Empty string when not present
department_namestringDepartment name within an organisation. Empty string when not present
organisation_namestringOrganisation name. Empty string when not present
udprnintegerUnique Delivery Point Reference Number
postcode_typestringPostcode type.
SSmall userLLarge user""where Royal Mail supplies none
su_organisation_indicatorstringSmall user organisation indicator.
Ywhere the small user postcode is held by an organisationdelivery_point_suffixstringRoyal Mail delivery point suffix
po_boxstringPO Box number. Empty string when not present
Multiple Residence Address Full guide
Raw Royal Mail Multiple Residence record backing an
mraddress.Multiple Residence holds sub-premises (flats, rooms) that share a parent PAF delivery point.
umprnkeys the residence,udprnthe parent delivery point. The record has nopo_box.datasetstringpostcodestringPostcode, space separated
post_townstringRoyal Mail post town, title cased
dependant_localitystringDependant locality. Empty string when not present
double_dependant_localitystringDouble dependant locality. Empty string when not present
thoroughfarestringStreet name
dependant_thoroughfarestringDependant street name. Empty string when not present
building_numberstringBuilding number. Empty string when not present, or when PAF merges it into the building name
building_namestringBuilding name. Empty string when not present
sub_building_namestringSub building name. Empty string when not present
department_namestringDepartment name within an organisation. Empty string when not present
organisation_namestringOrganisation name. Empty string when not present
udprnintegerUnique Delivery Point Reference Number
postcode_typestringPostcode type.
SSmall userLLarge user""where Royal Mail supplies none
su_organisation_indicatorstringSmall user organisation indicator.
Ywhere the small user postcode is held by an organisationdelivery_point_suffixstringRoyal Mail delivery point suffix
umprnintegerUnique Multiple Residence Reference Number
Not Yet Built Address Full guide
Raw Royal Mail Not Yet Built record backing an
nybaddress.Delivery points Royal Mail has allocated for addresses under construction, ahead of them appearing in PAF. Same shape as a PAF record.
datasetstringpostcodestringPostcode, space separated
post_townstringRoyal Mail post town, title cased
dependant_localitystringDependant locality. Empty string when not present
double_dependant_localitystringDouble dependant locality. Empty string when not present
thoroughfarestringStreet name
dependant_thoroughfarestringDependant street name. Empty string when not present
building_numberstringBuilding number. Empty string when not present, or when PAF merges it into the building name
building_namestringBuilding name. Empty string when not present
sub_building_namestringSub building name. Empty string when not present
department_namestringDepartment name within an organisation. Empty string when not present
organisation_namestringOrganisation name. Empty string when not present
udprnintegerUnique Delivery Point Reference Number
postcode_typestringPostcode type.
SSmall userLLarge user""where Royal Mail supplies none
su_organisation_indicatorstringSmall user organisation indicator.
Ywhere the small user postcode is held by an organisationdelivery_point_suffixstringRoyal Mail delivery point suffix
po_boxstringPO Box number. Empty string when not present
PAF Alias Address Full guide
The Royal Mail PAF record backing a
pafaaddress, with the alias applied. Alias data holds alternative address details the public uses when addressing mail, which are not required for delivery.This is the parent delivery point, not the alias row: the alias text replaces the building name, organisation name or department name, so those three fields carry the alias and the rest is the parent PAF record. The alias row's own columns (
alias_text,category,currency) are not yet returned.idis the parent UDPRN plus a hash of the alias text, since a delivery point can carry several aliases.datasetstringpostcodestringPostcode, space separated
post_townstringRoyal Mail post town, title cased
dependant_localitystringDependant locality. Empty string when not present
double_dependant_localitystringDouble dependant locality. Empty string when not present
thoroughfarestringStreet name
dependant_thoroughfarestringDependant street name. Empty string when not present
building_numberstringBuilding number. Empty string when not present, or when PAF merges it into the building name
building_namestringBuilding name. Empty string when not present
sub_building_namestringSub building name. Empty string when not present
department_namestringDepartment name within an organisation. Empty string when not present
organisation_namestringOrganisation name. Empty string when not present
udprnintegerUnique Delivery Point Reference Number
postcode_typestringPostcode type.
SSmall userLLarge user""where Royal Mail supplies none
su_organisation_indicatorstringSmall user organisation indicator.
Ywhere the small user postcode is held by an organisationdelivery_point_suffixstringRoyal Mail delivery point suffix
po_boxstringPO Box number. Empty string when not present
Welsh PAF Address Full guide
Raw Royal Mail Welsh language record backing a
pafwaddress.Welsh alternatives for addresses in the sectors Royal Mail defines as part of the Welsh principality. Same shape as a PAF record, keyed on the same UDPRN.
datasetstringpostcodestringPostcode, space separated
post_townstringRoyal Mail post town, title cased
dependant_localitystringDependant locality. Empty string when not present
double_dependant_localitystringDouble dependant locality. Empty string when not present
thoroughfarestringStreet name
dependant_thoroughfarestringDependant street name. Empty string when not present
building_numberstringBuilding number. Empty string when not present, or when PAF merges it into the building name
building_namestringBuilding name. Empty string when not present
sub_building_namestringSub building name. Empty string when not present
department_namestringDepartment name within an organisation. Empty string when not present
organisation_namestringOrganisation name. Empty string when not present
udprnintegerUnique Delivery Point Reference Number
postcode_typestringPostcode type.
SSmall userLLarge user""where Royal Mail supplies none
su_organisation_indicatorstringSmall user organisation indicator.
Ywhere the small user postcode is held by an organisationdelivery_point_suffixstringRoyal Mail delivery point suffix
po_boxstringPO Box number. Empty string when not present
AddressBase Core Address Full guide
An address from Ordnance Survey's AddressBase Core, a flat cut of the approved addresses in Great Britain. Each record is one UPRN drawn from the local authority gazetteers: the National Land and Property Gazetteer for England and Wales, the One Scotland Address Gazetteer for Scotland. It carries the Royal Mail delivery point where one has been matched, property level coordinates, a classification (
classification_code), the key identifiers (uprn,parent_uprn,udprn,usrn,toid), the contributing authority (gss_code), coordinate quality (rpc) and the change the latest supply applied (change_code). Ordnance Survey publishes around 35 million records and refreshes them weekly.How it differs from the neighbouring datasets:
- AddressBase Premium (
abp) is the full gazetteer: around 40 million UPRNs including historic and provisional records, the local authority address breakdown (pao_*,sao_*), lifecycle (logical_status,blpu_state), Welsh alternatives, the street record and cross references to the Valuation Office Agency and ONS, refreshed every six weeks. AddressBase Core carries none of these. Use it when one approved address per UPRN, with coordinates and a classification, is enough. - Royal Mail PAF (
paf) lists delivery points only, keyed by UDPRN. AddressBase Core keys on UPRN and also holds non-postal objects (substations, car parks, land parcels, parent shells) with no delivery point. On those recordsudprnis0anddelivery_point_suffixis empty. Where a record matches PAF,abrenders the sameline_1toline_3aspaffor that UDPRN, bar a handful of records with a trailing range in the building name, which AddressBase Core keeps whole. - The Ordnance Survey end of life notice for autumn 2027 covers AddressBase and AddressBase Plus, not AddressBase Core.
idstringGlobal unique internally generated identifier for an address
country_isostring3 letter country code (ISO 3166-1)
datasetstringIndicates the provenance of an address
languagestringLanguage represented by 2 letter ISO Code (639-1)
line_1stringFirst 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.
line_2stringSecond Address Line. Often contains thoroughfare and locality information. May be empty
line_3stringThird address line. Takes the address elements left after
line_1andline_2are filled; where the address needs more than three lines the remaining elements are joined intoline_3, comma separated. May be empty.premisestringA pre-computed string which sensibly combines the building name, sub-building and building number fields into a single, simple premise string. Ideal if you want to pull premise information and thoroughfare information separately instead of using the address lines.
uprnstringUnique Property Reference Number (UPRN) assigned by the LLPG Custodian or Ordnance Survey.
udprnintegerRoyal Mail's Unique Delivery Point Reference Number (UDPRN).
0where the record has no matching PAF delivery point.parent_uprnstringUPRN of the parent record where a parent-child relationship exists. Empty where the record has no parent.
usrnintegerUnique Street Reference Number assigned by the Street Name and Numbering Custodian or by Ordnance Survey, depending on the address record.
toidstringThe 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' followed by up to sixteen digits. May be empty.
classification_codestringA code that describes the classification of the address record to a maximum of a secondary level. The first letter is the primary class (e.g.
Rresidential,Ccommercial,Lland), the second the secondary class (e.g.RDdwelling).eastingsnumberA value in metres defining the x location in accordance with the British National Grid.
northingsnumberA value in metres defining the y location in accordance with the British National Grid.
latitudenumberA value defining the Latitude location in accordance with the ETRS89 coordinate reference system.
longitudenumberA value defining the Longitude location in accordance with the ETRS89 coordinate reference system.
single_address_linestringA single attribute containing text concatenation of the address elements separated by a comma.
street_namestringStreet / Road name for the address record.
localitystringA 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.
town_namestringGeographical town name assigned by the Local Authority. Note this can differ from the post town assigned by Royal Mail.
delivery_point_suffixstringA two-character code uniquely identifying an individual delivery point within a postcode, assigned by Royal Mail. May be empty.
post_townstringThe town or city in which the Royal Mail sorting office servicing this address record is located.
AddressBase populates
POST_TOWNonly where it differs fromTOWN_NAME, so this field falls back to the town name when the raw value is empty.gss_codestringThe Office for National Statistics Governmental Statistical Service (GSS) code representing the contributing Local Authority.
rpcintegerRepresentative 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.
last_update_datestringThe latest date on which any of the attributes on this record were last changed.
islandstringThird level of geographic area name to record island names where appropriate. May be empty.
change_codestringThe type of change last applied to the record.
Iinsert,Uupdate,Ddelete.building_namestringThe building name is a description applied to a single address or a group of addresses. May be empty.
building_numberstringThe building number is a number or range of numbers given to a single address or a group of addresses. May be empty.
sub_buildingstringThe sub-building name and/or number for the address record. May be empty.
postcodestringA postcode assigned by Royal Mail for the address record.
po_boxstringText concatenation of 'PO BOX' and the Post Office Box (PO Box) number or 'BFPO' and the British Forces Post Office number. May be empty.
organisationstringThe organisation name is the business name given, when appropriate, to an address record. May be empty.
countrystringFull country names (ISO 3166)
countystringSince 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.
districtstringThe current district/unitary authority to which the postcode has been assigned.
wardstringThe current administrative/electoral area to which the postcode has been assigned. May be empty for a small number of addresses.
traditional_countystringTraditional counties are provided by the Association of British Counties. It is historical data, and can date from the 1800s. May be empty.
administrative_countystringThe current administrative county to which the postcode has been assigned.
A Unitary Authority name, where one is present. If there is no Unitary Authority, the County name is used. This information is not static, because County boundaries may change due to administrative changes.
Source: ONS. May be empty.
postal_countystringPostal 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.
- AddressBase Premium (
AddressBase Premium Address Full guide
A property record from Ordnance Survey's AddressBase Premium, Ordnance Survey's most detailed address dataset for Great Britain. Each record is a Basic Land and Property Unit (BLPU) keyed by its UPRN. Alongside the Royal Mail delivery point it carries the local authority address (
pao_*,sao_*,usrn), classification (classification_code), lifecycle (logical_status,blpu_state), coordinates, Welsh alternatives (welsh_*), the street record (street_*) and cross references to OS MasterMap (toid), the Valuation Office Agency (council_tax_ref,ndr_ref) and ONS (ons_ward_code,ons_parish_code). Ordnance Survey publishes around 40 million records and refreshes them every six weeks.How it differs from the neighbouring datasets:
- AddressBase Core (
ab) is a weekly, flat cut of the current approved records: one row per UPRN with coordinates, a two-character classification and the key identifiers. It carries no history, no provisional records, no Welsh alternatives, no local authority address breakdown and no street, VOA or ONS cross references. - Royal Mail PAF (
paf) lists delivery points, keyed by UDPRN. The vast majority of PAF addresses are matched to a UPRN, but there will always be a small number (~1%) with no corresponding record on AddressBase Premium. PAF holds around 30 million GB delivery points against AddressBase Premium's 40 million UPRNs; the difference is non-postal objects (substations, car parks, sites under construction), provisional and historic records. Every GB PAF delivery point appears here as thedpa_*record. - OS NGD Address carries the same content restructured into feature types with daily currency. AddressBase Premium is not being retired. The Ordnance Survey end of life notice for autumn 2027 covers AddressBase and AddressBase Plus only.
uprnstringUnique Property Reference Number - a persistent identifier for a Basic Land and Property Unit (BLPU). Up to 12 digits. Primary key for the BLPU spine. Carried as a string to preserve precision (12-digit values can exceed Number.MAX_SAFE_INTEGER).
parent_uprnstring optionalUPRN of the parent record where a parent-child relationship exists (flats sharing a building entrance, sub-units of a parent property).
logical_statusintegerLogical lifecycle status of the BLPU.
1Approved,6Provisional,8Historical. BLPU records do not take value3(alternative).blpu_statestring optionalPhysical state of the BLPU.
1Under construction,2In use,3Unoccupied / vacant / derelict,4No longer existing,6Planning permission granted.blpu_state_datestring optionalDate the BLPU achieved its current state.
countrystringCountry containing the BLPU, determined by intersection with OS Boundary-Line.
EEngland,WWales,SScotland,NNorthern Ireland,LChannel Islands,MIsle of Man,Jnot assigned to a country.latitudenumberLatitude coordinate in the ETRS89 coordinate reference system.
longitudenumberLongitude coordinate in the ETRS89 coordinate reference system.
x_coordinatenumberX location in metres on the OSGB36 British National Grid (precision 8, scale 2).
y_coordinatenumberY location in metres on the OSGB36 British National Grid (precision 9, scale 2).
rpcinteger optionalRepresentative Point Code - reliability of the BLPU's coordinate, as assessed by the local authority custodian.
1Central internal,2General internal,3Transitional,4Street location,5Postcode unit,9Low accuracy.local_custodian_codeinteger4-digit identifier of the Local Authority responsible for maintaining the record.
addressbase_postalstringWhether the address can receive mail per AddressBase rules.
Dlinked to PAF,Nnot a postal address,Cpostal with a PAF-linked parent,Lpostal based on Local Authority information.postcode_locatorstringRoyal Mail PAF postcode, locally assigned by the custodian, or spatially derived where no PAF match exists. Up to 8 characters.
multi_occ_countintegerCount of child UPRNs for this record where parent-child relationships exist.
blpu_start_datestring optionalDate the address record was inserted into the database.
blpu_end_datestring optionalDate the address record was closed in the database.
blpu_last_update_datestring optionalDate of the most recent attribute change on the BLPU record.
blpu_entry_datestring optionalDate the record was inserted into the Local Authority database.
udprnstring optionalRoyal Mail's Unique Delivery Point Reference Number - primary key for the Delivery Point Address (DPA) record. Up to 8 digits. NULL for non-postal UPRNs.
organisation_namestring optionalRoyal Mail-recognised organisation name from DPA, falling back to the AddressBase Organisation record's
organisationwhen DPA is absent. Title-cased.legal_namestring optionalRegistered legal name from the AddressBase Organisation record.
department_namestring optionalSubdivision of an organisation that receives mail at a distinct delivery point. Requires
organisation_nameto be present. Title-cased.sub_building_namestring optionalProperty subdivision identifier (e.g. flat number). Requires
building_nameorbuilding_number. Title-cased. Falls back to the LPI'ssao_textwhen there is no delivery point.building_namestring optionalDescriptive name applied to a single building or small group of buildings. Title-cased. Falls back to the LPI's SAO number/range plus
pao_textwhen there is no delivery point.building_numberinteger optionalNumeric identifier for a single building or small group of buildings. Complex number formats (e.g. "12A") go in
building_nameorsub_building_name. Falls back to the LPI'spao_start_numberwhen there is no delivery point and that number is a bare integer - a suffixed or ranged PAO number is folded ontothoroughfareinstead.dependent_thoroughfarestring optionalNamed thoroughfare within another named thoroughfare. Requires
thoroughfareto be present. Title-cased.thoroughfarestring optionalRoad, track or named access route with Royal Mail delivery points. Title-cased. Falls back to the LPI street's
street_description(with a suffixed or ranged PAO number prefixed) when there is no delivery point.double_dependent_localitystring optionalEstate or area name used to distinguish similar thoroughfares within a dependent locality. Requires
dependent_locality. Title-cased.dependent_localitystring optionalSubdivision of a post town to differentiate same-name thoroughfares. Title-cased. Falls back to the LPI street's
street_localitywhen there is no delivery point.post_townstring optionalTown or city of the Royal Mail sorting office serving this record. Capitalised. Falls back to the LPI street's
street_townwhen there is no delivery point; NULL when neither is present.postcodestringRoyal Mail postcode from DPA, falling back to BLPU's
postcode_locatorwhen no Royal Mail delivery point exists. Uppercased, with single space between outward and inward portions.postcode_typestring optionalRoyal Mail postal-user category.
SSmall user (e.g. a residential property),LLarge user (e.g. a large commercial company).delivery_point_suffixstring optionalTwo-character code uniquely identifying an individual delivery point within a postcode (Royal Mail DPS).
po_box_numberstring optionalPost Office Box number.
welsh_dependent_thoroughfarestring optionalWelsh translation of
dependent_thoroughfare. Requireswelsh_thoroughfare.welsh_thoroughfarestring optionalWelsh translation of
thoroughfare.welsh_double_dependent_localitystring optionalWelsh translation of
double_dependent_locality. Requireswelsh_dependent_locality.welsh_dependent_localitystring optionalWelsh translation of
dependent_locality.welsh_post_townstring optionalWelsh translation of
post_town.dpa_process_datestring optionalDate the PAF record was processed into the database.
dpa_start_datestring optionalDate the address record was matched to the Delivery Point Address.
dpa_end_datestring optionalDate the PAF record no longer existed in the database.
dpa_last_update_datestring optionalDate any attribute on the DPA record was last changed.
dpa_entry_datestring optionalDate the PAF record was first loaded by GeoPlace.
classification_codestring optionalCurrent AddressBase classification code (e.g.
RDresidential,CRcommercial retail). Top-level categories:RResidential,CCommercial,LLand,MMilitary,OOther,PParent shell,UUnclassified,XDual use,ZObject of interest. NULL when no current classification row exists for the UPRN.class_schemestring optionalName of the classification scheme applied to this record.
scheme_versionnumber optionalVersion number of the classification scheme in use (e.g.
1.0).classification_start_datestring optionalDate the classification record was first loaded into the database.
classification_end_datestring optionalDate the classification record ceased to exist.
classification_last_update_datestring optionalDate of the most recent attribute change on the classification record.
classification_entry_datestring optionalDate the associated address record was inserted into the Local Authority database.
organisation_start_datestring optionalDate the organisation record was initially loaded into the database.
organisation_end_datestring optionalDate the organisation record ceased to exist.
organisation_last_update_datestring optionalDate of the most recent attribute change on the organisation record.
organisation_entry_datestring optionalDate the UPRN was entered into the Local Authority database.
lpi_keystring optionalUnique identifier and primary key for the LPI record.
lpi_languagestring optionalLanguage used for this LPI record.
ENGEnglish,CYMWelsh,GAEGaelic (Scottish),BILBilingual.lpi_logical_statusinteger optionalLogical status of the LPI record.
1Approved,3Alternative,6Provisional,8Historical.lpi_start_datestring optionalDate the LPI was first loaded into the database.
lpi_end_datestring optionalDate the LPI record ceased to exist.
lpi_last_update_datestring optionalDate of the most recent attribute change on the LPI record.
lpi_entry_datestring optionalDate the LPI record was inserted into the Local Authority database.
sao_start_numberinteger optionalNumber of the Secondary Addressable Object, or range start. Requires
pao_start_numberorpao_textto be present.sao_start_suffixstring optionalSuffix appended to
sao_start_number. Requiressao_start_number.sao_end_numberinteger optionalEnd number of the SAO range. Requires
sao_start_number.sao_end_suffixstring optionalSuffix appended to
sao_end_number. Requiressao_end_number.sao_textstring optionalBuilding name or description for the Secondary Addressable Object (e.g. "FLAT 1", "UNIT B"). Requires
pao_start_numberorpao_text.pao_start_numberinteger optionalNumber of the Primary Addressable Object, or range start. Mandatory if
pao_textis absent.pao_start_suffixstring optionalSuffix appended to
pao_start_number. Requirespao_start_number.pao_end_numberinteger optionalEnd number of the PAO range. Requires
pao_start_number.pao_end_suffixstring optionalSuffix appended to
pao_end_number. Requirespao_end_number.pao_textstring optionalBuilding name or description for the Primary Addressable Object. Mandatory if
pao_start_numberis absent.usrnstring optionalUnique Street Reference Number linking this LPI to its Street record. Up to 8 digits.
usrn_match_indicatorstring optionalConfidence of the LPI to Street linkage.
1Matched manually to the nearest accessible Street,2Matched spatially to the nearest USRN.area_namestring optionalThird-level geographic area name such as island or property group.
levelstring optionalVertical position of the property (e.g. "GROUND FLOOR").
official_flagstring optionalWhether the LPI corresponds to an entry in the official Street Name and Numbering register.
YOfficial address,NUnofficial address.street_record_typeinteger optionalDescription of the street record type.
1Official designated Street Name,2Street Description,3Numbered Street,4Unofficial Street Description,9Description used for LLPG Access.swa_org_ref_naminginteger optionalCode identifying the Street Naming and Numbering Authority or Local Highway Authority (DfT-allocated).
street_statestring optionalCurrent state of the street.
1Under construction,2Open,4Permanently closed.street_state_datestring optionalDate when the street achieved its current state.
street_surfacestring optionalSurface finish of the street.
1Metalled,2Unmetalled,3Mixed.street_classificationstring optionalPrimary classification of the street record.
4Pedestrian way or footpath,6Cycletrack or cycleway,8All vehicles,9Restricted byway,10Bridleway.street_start_datestring optionalDate this street record or version was inserted into the database.
street_last_update_datestring optionalDate when any attribute of the street record was last changed.
street_record_entry_datestring optionalDate the street record was entered into the Local Authority database.
street_start_xnumber optionalX coordinate (BNG) for the street start point.
street_start_ynumber optionalY coordinate (BNG) for the street start point.
street_start_latnumber optionalLatitude (ETRS89) for the street start point.
street_start_longnumber optionalLongitude (ETRS89) for the street start point.
street_end_xnumber optionalX coordinate (BNG) for the street end point.
street_end_ynumber optionalY coordinate (BNG) for the street end point.
street_end_latnumber optionalLatitude (ETRS89) for the street end point.
street_end_longnumber optionalLongitude (ETRS89) for the street end point.
street_toleranceinteger optionalAccuracy of street-coordinate data capture, in metres.
street_descriptionstring optionalStreet name, description or street number.
street_localitystring optionalGeographical area within a town.
street_townstring optionalName of the town. Required for Street Record Types
1and2; optional for types3,4and9.adminstrative_areastring optionalLocal Highway Authority name (administrative area / county / unitary authority). Field name spelling preserved verbatim from OS (
ADMINSTRATIVE_AREA).sd_languagestring optionalLanguage of the street descriptor.
ENGEnglish,CYMWelsh,GAEGaelic (Scottish),BILBilingual.sd_start_datestring optionalDate the street descriptor record was first created in the database.
sd_end_datestring optionalDate the street descriptor record ceased to exist.
sd_last_update_datestring optionalDate of the most recent attribute change on the street descriptor record.
sd_entry_datestring optionalDate the street descriptor record was entered into the Local Authority database.
toidstring optionalOS MasterMap Topography Layer TOID (cross-reference source
7666MT) linked to the UPRN.toid_addressstring optionalOS MasterMap Address Layer 2 TOID (cross-reference source
7666MA) linked to the UPRN.toid_highwaysstring optionalOS MasterMap Highways TOID (cross-reference source
7666MI) linked to the UPRN.council_tax_refstring optionalCentrally created Valuation Office Agency council tax reference (cross-reference source
7666VC) linked to the UPRN.ndr_refstring optionalCentrally created Valuation Office Agency non-domestic rates reference (cross-reference source
7666VN) linked to the UPRN.ons_ward_codestring optionalOffice for National Statistics ward code (cross-reference source
7666OW) linked to the UPRN.ons_parish_codestring optionalOffice for National Statistics parish code (cross-reference source
7666OP) linked to the UPRN.idstringStable identifier for the record,
abp_prefixed to the UPRN. Accepted by the resolve endpoints.datasetstringDataset this record belongs to.
country_isostringISO 3166-1 alpha-3 code for the country covered by the dataset. Always
GBR- usecountryfor the England / Wales / Scotland split.suggestion_linestringSingle-line address used for autocomplete suggestions: the address line components, then the post town, then the outward half of the postcode, comma separated. Repeated components are collapsed.
- AddressBase Core (
USPS Address Full guide
The USPS ZIP + 4 record backing a
uspsaddress. Carries the complete USPS field set for the delivery point, including elements the standard address format does not expose.idstringGlobal unique internally generated identifier for an address
datasetstringIdentifies the address as sourced from USPS
countrystringFull country names (ISO 3166)
country_isostring3 letter country code (ISO 3166-1)
country_iso_2string2 letter country code (ISO 3166-1)
languagestringLanguage represented by 2 letter ISO Code (639-1)
primary_numberstringA house, rural route, contract box, or Post Office Box number. The numeric or alphanumeric component of an address preceding the street name. Often referred to as house number.
secondary_numberstringNumber of the sub unit, apartment, suite etc
plus_4_codestring4 digit ZIP add-on code.
line_1stringThe primary delivery line (usually the street address) of the address.
line_2stringSecondary delivery line of the address. Typically populated if the first line is the firm or building name.
last_linestringLast line of the address comprising of city, state, zip code and zip+4
zip_codestringA 5-digit code that identifies a specific geographic delivery area. ZIP Codes can represent an area within a state, or a single building or company that has a very high mail volume.
zip_plus_4_codestringNine-digit code that identifies a small geographic delivery area that is serviceable by a single carrier; appears in the last line of the address on a mail piece.
update_key_numberstringField that contains a number that uniquely identifies a record; used to identify the base record to which an add or delete transaction is being directed. The Update Key Number field is used only when applying transactions to the base file; it is not used in address matching and remains fixed for the life of the record. The field is alphanumeric and consists of the database segment code (V1, V2, W1, W2, X1, X2, Y1, Y2, Z1, or Z2) and eight characters containing an alphanumeric value ranging from 00000001 to AAAAAAAA.
record_type_codestringAn alphabetic value that identifies the type of data in the record. - G = General delivery (5-Digit ZIP, ZIP + 4, and Carrier Route products) - H = High-rise (ZIP + 4 only) - F = Firm (ZIP + 4 only) - S = Street (5-Digit ZIP, ZIP + 4, and Carrier Route products) - P = PO Box (5-Digit ZIP, ZIP + 4, and Carrier Route products) - R = Rural route/contract (5-Digit ZIP, ZIP + 4, and Carrier Route products) - M = Multi-carrier (Carrier Route product only)
carrier_route_idstringA 4 character ID identifying the postal route for the address. The first character indicates the route type. Specifically:
- "B" indicates PO Box
- "H" indicates highway
- "C" indicates city
- "G" indicates general
- "R" indicates rural
street_pre_directional_abbreviationstringA geographic direction that precedes the street name.
street_namestringThe official name of a street as assigned by a local governing authority. The Street Name field contains only the street name and does not include directionals (EAST, WEST, etc.) or suffixes (ST, DR, BLVD, etc.). This element may also contain literals, such as PO BOX, GENERAL DELIVERY, USS, PSC, or UNIT.
street_suffix_abbreviationstringCode that is the standard USPS abbreviation for the trailing designator in a street address.
street_post_directional_abbreviationstringA geographic direction that follows the street name.
building_or_firm_namestringThe name of a company, building, apartment complex, shopping center, or other distinguishing secondary address information. This field is normally used with firm and highrise records but may also contain literals such as “Postmaster” or “United States Postal Service.”
address_secondary_abbreviationstringA descriptive code used to identify the type of address secondary range information in the Address Secondary Range field. This code may be useful in address matching, e.g., the secondary address numbers may indicate apartment, suite, or trailer numbers.
base_alternate_codestringCode that specifies whether a record is a base (preferred) or alternate record. Base records (represented as "B") can represent a range of addresses or an individual address, such as a firm record, while alternate records (represented as "A") are individual delivery points. Base records are generally preferred over alternate records. Government deliveries will only be listed on alternate records with the appropriate government building indicator (federal, state, or city) set.
lacs_status_indicatorstringThe Locatable Address Conversion Service (LACS) indicator describes records that have been converted to the LACS system (a product/system in a different USPS® product line that allows mailers to identify and convert a rural route address to a city-style address). Rural route and some city addresses are being modified to city-style addresses so that emergency services (e.g., ambulances, police) can find these addresses more efficiently.
- L = LACS address: The old (usually rural-route) address that has been converted for the LACS system.
- Blank = Not applicable
government_building_indicatorstringAn alphabetic value that identifies the type of government agency at the delivery point and/or whether a firm is the only delivery at an address. For this purpose, "address" is defined as the complete delivery line (e.g., complete street address and, if included as part of the firm record, the secondary abbreviation and/or address secondary number).
- A = City government building - alternates only
- B = Federal government building - alternates only
- C = State government building - alternates only
- D = Firm only - base and alternates
- E = City government building and firm only - alternates only
- F = Federal government building and firm only - alternates only
- G = State government building and firm only - alternates only
state_abbreviationstringA 2-character abbreviation for the name of a state, U.S. territory, or armed forces ZIP Code designation. If APO/FPO/DPO, then the state abbreviation will be “AA,” “AE,” or “AP.”
statestringFull name of a state, U.S. territory, or armed forces ZIP Code designation.
municipality_city_state_keystringMunicipality City State Key. Currently blank.
urbanization_city_state_keystringAn index to the City State file that provides the urbanization name for this delivery range.
preferred_last_line_city_state_keystringIn the Carrier Route, Five-Digit ZIP Code, Delivery Statistics, and ZIP + 4 products, an index to the City State product record that provides the preferred last-line name for this address range. In the City State product, the preferred last line city/state key contains the key value of a City State product record that has the default preferred or alternate preferred last-line key for a given ZIP Code.
countystringThe name of the county or parish in which the 5-digit ZIP Code resides. If APO/FPO/DPO, then the county name will be blank.
citystringA valid city name for mailing purposes; appears in the last line of an address on a mail piece.
city_abbreviationstringA standard 13-character abbreviation for a city/state name. This field is only used for names that are greater than 13 characters in length and have a city/state mailing name indicator of "Y." If the field is longer than 13 characters and the city/state mailing name indicator is "N," the field will be blank.
preferred_citystringField that contains the default preferred or alternate preferred last-line name for a ZIP Code.
city_state_name_facility_codestringThe type of locale identified in the city/state name. The facility may be a USPS facility, such as a post office, station, or branch, or it may be a non-postal place name. City/state name facility codes include the following:
- B = Branch
- C = Community post office (CPO)
- N = Non-postal community name, former USPS facility, or place name
- P = Post Office
- S = Station
- U = Urbanization
zip_classification_codestringA field that describes the type of ZIP area that a 5-digit ZIP Code serves, e.g., a single educational institution, post office boxes only, or a single address that has unusually high mail volume or many different addresses. - M = Military ZIP Code - P = ZIP Code having only Post Office Boxes - U = Unique ZIP Code (ZIP assigned to a single organization) - Blank = Standard ZIP with many addresses assigned to it
city_state_mailing_name_indicatorstringSpecifies whether or not the city state name can be used as a last line of address on a mail piece.
- "Y = City/state name is a USPS-approved mailing name."
- "N = City/state name is not approved for mailing purposes."
carrier_route_rate_sortationstringIdentifies where automation Carrier Route rates are available and where the commingling of automation and non-automation mail, including Enhanced Carrier Routes and 5-digit presort, on the same pallet or in the same container is allowed.
finance_numberone ofA code assigned to Postal Service facilities (primarily Post Offices) to collect cost and statistical data and compile revenue and expense data.
- string
- number
congressional_district_numberone ofA standard value identifying a geographic area within the United States served by a member of the U.S. House of Representatives. If Army/Air Force (APO), Fleet Post Office (FPO), or Diplomatic/Defense Post Office (DPO), this field will be blank. If there is only one member of Congress within a state, the code will be "AL" (at large).
- string
- number
county_numberone ofThe Federal Information Processing Standard (FIPS) code assigned to a given county or parish within a state. In Alaska, it identifies a region within the state. If APO/FPO/DPO, and the record type is “S,” “H,” or “F,” the county number will be blank.
- string
- number
Ireland ECAD Address Full guide
ECAD is the Eircode Address Database. It carries every ECAF postal address element plus GeoDirectory identifiers, building and organisation attributes, administrative area references and An Post sorting information. English and Irish language versions of each address are indexed separately and distinguished by
language.Unavailable elements are returned as an empty string, never
null.idstringGlobal unique internally generated identifier for an address
datasetstringcountry_isostring3 letter country code (ISO 3166-1)
country_iso_2string2 letter country code (ISO 3166-1)
countrystringFull country names (ISO 3166)
languagestringLanguage represented by 2 letter ISO Code (639-1)
line_1stringAddress Line 1
line_2stringAddress Line 2
line_3stringAddress Line 3
line_4stringAddress Line 4
line_5stringAddress Line 5
line_6stringAddress Line 6
line_7stringAddress Line 7
line_8stringAddress Line 8
line_9stringAddress Line 9
departmentstringThe department or division within an organisation, e.g.
Accounts Department. If the department element exists, then the organisation must also exist.organisationstringOrganisation name, e.g.
Oak Tree Limited.sub_building_namestringThe sub-building refers to an apartment, flat or unit within a building, e.g.
Flat 1.building_namestringThe name given to the building, e.g.
Rose Cottage. Prepended by sub building, if any, when the sub building does not appear on a line to itself. The building name is omitted if it is the same as either the Organisation or Building Group.building_numberstringA number associated with the whole building. The building number may have a numeric and an alphanumeric component, which are concatenated e.g. 2A, or alternatively will have a simple building number or a complex building number. The building number always relates to the whole building and not a sub-unit within it. A complex building number may be one of the following:
- Dual. Two number separated by '/' e.g. 63/64 = 63, 64
- Sequence. An odd or even sequence of numbers with lower and upper bound separated by an underscore '_' e.g.
1_5= 1,3,5 and2_6= 2,4,6 - Range. A range of consecutive numbers with lower and upper bound separated by a dash '-' e.g.
63-66= 63, 64, 56, 66 The building number never appears on a line by itself and can prepend Building Group, Primary Thoroughfare or Primary Locality.
building_groupstringA building group is a collection of buildings with a collective name, located on or near the same thoroughfare, e.g.
Marrian Terrace.primary_thoroughfarestringThe name of the thoroughfare on which premises are located, e.g.
Griffith Road. It may appear on a line by itself or be appended to either a sub building or building number.Addresses with thoroughfares can sometimes have the thoroughfare excluded where a Building Group exists, such as a Retail Centre or Business Park, and the thoroughfare is not part of the Postal Address.
secondary_thoroughfarestringIt is never present without a primary thoroughfare. The primary thoroughfare is dependent on the secondary thoroughfare and appears before the secondary thoroughfare in any address.
Secondary thoroughfare are generally used to assist locating a primary thoroughfare.
primary_localitystringFirst locality elements which can refer to areas, districts, industrial estates, towns, etc.
The primary locality refers to the specific place the address is.
In urban areas, the primary locality can be required to distinguish between two thoroughfares of the same name in the same district or town. Industrial estates with named thoroughfares are also held as localities. In rural areas the primary locality is generally a townland name.
secondary_localitystringNever present without a primary locality. The secondary locality has a wider geographic scope than the primary locality.
It is the secondary locality therefore which differentiates addresses with the same primary locality name within the same county.
Secondary localities are more likely to be required for rural addresses.
Second locality elements which can refer to areas, districts, industrial estates, towns, etc
The secondary locality helps identify where the primary locality is located.
tertiary_localitystringAlso known as the Post Town.
The name of the post town associated with the premises for postal delivery purposes. This includes Dublin Postal Districts "Dublin 1" to "Dublin 24".
The post town is a significant element of the Postal Address, however it is not always populated in an address. The official post office guide, Eolaí an Phoist, describes post towns in the following manner:
"A provincial postal address may include the name of a town or village several miles distant, with which the addressee has little or no connection, and, in some places, especially if this residence happens to be near a county boundary, the name of the neighbouring county instead of the county in which he actually resides. The explanation is that the main mail despatches have to be sent for more detailed sub division to certain centres known as POST TOWNS, chosen because of their accessibility and convenience."
post_countystringOne of the 26 Counties in the Republic of Ireland. These counties are sub-national divisions used for the purposes of administrative, geographical and political demarcation. Post County is the County associated with the Post Town, not the geographic county in which the building is located. The Post County is normally used as part of the Postal Address with some exceptions e.g. Dublin Postal Districts where the Post County is not used and some Post Towns (e.g. Tipperary, Kildare, etc.) that have the same name as the Post County.
eircodestringThe seven character Eircode has an A65 F4E2 format. The Eircode is a mandatory address element. The last line of a Postal Address will contain the Eircode, displayed with a space. e.g.
A65 F4E2.The Eircode is always the last line of a Postal Address generated within the state, e.g. if an address has four lines then the Eircode will be on its own on Address Line 5. For inbound international mail the country name IRELAND should be appended as the last line of the Postal Address.
address_referencestringThe address reference is the An Post GeoDirectory address reference identifier used by the Universal Service Provider.
longitudeLongitudeThe longitude of the address or postcode (WGS84).
Can be a positive or negative decimal. E.g. -0.1283983
Returns an empty string if no location data is available.
- string
- number
latitudeLatitudeThe latitude of the address or postcode (WGS84).
Can be a positive or negative decimal. E.g.
51.5083983.Returns an empty string if no location data is available.
- string
- number
ecad_idstring optionalUnique ECAD identifier for the postal address. Up to 10 digits.
organisation_idstring optionalGeoDirectory identifier for the organisation. Empty string if the address has no organisation.
address_point_idstring optionalGeoDirectory identifier for the address point.
building_idstring optionalGeoDirectory identifier for the building.
building_group_idstring optionalGeoDirectory identifier for the building group. Empty string if the address has no building group.
primary_thoroughfare_idstring optionalGeoDirectory identifier for the primary thoroughfare.
secondary_thoroughfare_idstring optionalGeoDirectory identifier for the secondary thoroughfare. Empty string if the address has no secondary thoroughfare.
primary_locality_idstring optionalGeoDirectory identifier for the primary locality. Empty string if the address has no primary locality.
secondary_locality_idstring optionalGeoDirectory identifier for the secondary locality. Empty string if the address has no secondary locality.
post_townstring optionalThe name of the post town associated with the premises for postal delivery purposes. Returned in the language given by
language, and mirrorstertiary_localityfor this dataset.The post town is a significant element of the Postal Address, however it is not always populated in an address. The official post office guide, Eolaí an Phoist, describes post towns in the following manner:
"A provincial postal address may include the name of a town or village several miles distant, with which the addressee has little or no connection, and, in some places, especially if this residence happens to be near a county boundary, the name of the neighbouring county instead of the county in which he actually resides. The explanation is that the main mail despatches have to be sent for more detailed sub division to certain centres known as post towns, chosen because of their accessibility and convenience."
post_town_idstring optionalGeoDirectory identifier for the post town.
post_county_idstring optionalGeoDirectory identifier for the post county. Empty string if the address has no post county.
nuaboolean optionalNUA means "non-unique address".
The NUA field contains
truewhen the address is a non-unique address, andfalsewhen it is a unique address.Ireland has a very high level of non-unique addresses (NUA), i.e. the address does not contain a unique building number or name. Approximately 35% of all Irish addresses are non-unique which equates to 600,000 addresses.
The typical example of NUA addressing is where every address in a townland is the same. The way that post is delivered is by local knowledge of postal delivery personnel of which addressee lives in which house.
N.B. For a NUA address, it is impossible to match to a unique record in the ECAD and assign an Eircode.
gaeltachtboolean optionalGaeltacht refers to a district where the Irish government recognises that the Irish language is the predominant language.
Returns
trueif address is in a Gaeltacht area andfalseif not.address_typestring optionalAddresses points can assume one of the following values:
- Residential Address Point. This type of address point has one residential addresses associated with it.
- Non-Residential Address Point. This type of address point has one or more non-residential address (business, club or other organisation) associated with it.
- Mixed Address Point. This is a special case where the residential and non residential addresses in the building are essentially the same address. The typical example is a farm house on an active farm. It is important to note that this is a special case. In general a building with both residential and non-residential addresses (e.g. an apartment over a shop) will receive two address points, one commercial and one residential, and hence two Eircodes.
Buildings can contain multiple address points of type Residential and/or Non-Residential.
building_address_typestring optionalThe building type can assume one of the following values:
- Single Occupancy Residential Building. This type of building contains one residential address.
- Multi Occupancy Residential Building. This type of building contains multiple residential addresses.
- Single Occupancy Non-Residential Building. This type of building contains one non-residential address (business, club or other organisation).
- Multi Occupancy Non-Residential Building. This type of building contains multiple non-residential addresses (business, club or other organisation).
- Multi Occupancy Mixed Use Building. This type of building contains multiple residential and non- residential addresses.
Buildings can also have a more specific address types such as a Hospital, School, Shopping Centre, etc.
building_group_address_typestring optionalThe building group type can be:
- Residential Building Group. This type of building group contains buildings with residential addresses only.
- Non-Residential Building Group This type of building group contains buildings with non-residential addresses (business, club or other organisation) only.
- Mixed Building Group. This type of building group contains buildings with residential and non-residential addresses. Can also have a more specific address type such as a Hospital, School, Shopping Centre, etc.
Building groups can also have a more specific address type such as a Hospital, School, Shopping Centre, etc.
primary_locality_address_typestring optionalThe locality type can be:
- Rural Locality. This is generally a townland.
- Industrial Estate. Industrial Estate, Industrial Park, Business Campus, etc.
- Shopping District. Shopping Centre.
- Housing Estate. Residential Housing Estate.
- Village. Based on Census 2011 population < 1,500.
- Town. Based on Census 2011 population > 1,500.
- Urban Area. Wholly within a village/town/city e.g. Rathmines.
- Suburban Locality. This is an area that is both rural and urban, as it is both a townland, and also an area name applied to houses in a town, as the town has extended partially into the townland.
Where the locality is also the post town, the type can be:
- Village. Based on Census 2011 population < 1,500
- Town. Based on Census 2011 population > 1,500
- Postal District. Dublin 1 to 24
- City. Dublin, Cork, Limerick, Galway or Waterford
secondary_locality_address_typestring optionalThe locality type can be:
- Rural Locality. This is generally a townland.
- Industrial Estate. Industrial Estate, Industrial Park, Business Campus, etc.
- Shopping District. Shopping Centre.
- Housing Estate. Residential Housing Estate.
- Village. Based on Census 2011 population < 1,500.
- Town. Based on Census 2011 population > 1,500.
- Urban Area. Wholly within a village/town/city e.g. Rathmines.
- Suburban Locality. This is an area that is both rural and urban, as it is both a townland, and also an area name applied to houses in a town, as the town has extended partially into the townland.
Where the locality is also the post town, the type can be:
- Village. Based on Census 2011 population < 1,500
- Town. Based on Census 2011 population > 1,500
- Postal District. Dublin 1 to 24
- City. Dublin, Cork, Limerick, Galway or Waterford
building_typestring optionalDescribes the type of building, e.g. detached, semi-detached, bungalow.
holiday_homestring optionalA Yes/No field, indicating whether or not the building is a holiday home. Empty string if unknown.
under_constructionstring optionalA Yes/No field, indicating whether or not the building is under construction. Empty string if unknown.
building_usestring optionalCan be one of:
RResidentialCCommercialBBothUUnknown
Empty string if the building carries no use information.
vacantstring optionalA Yes/No field, indicating whether the building is vacant. Empty string if unknown.
org_vacantstring optionalA Yes/No field, indicating whether the organisation is vacant. Empty string if unknown or the address has no organisation.
nace_codestring optionalThe NACE Code for the Category.
nace_categorystring optionalName of the NACE Category
ded_idstring optionalUnique Identifier for the Electoral Division, from the 2017 data.
Electoral Divisions are legally defined administrative areas in Ireland. There are 3,441 Electoral Divisions, each a sub-division of a County.
Note that this field is subject to breaking changes if a new generation of government data IDs is released. Currently this uses 2017 IDs. Contact us to be notified ahead of this change.
small_area_idstring optionalUnique Identifier for the Small Area, from the 2017 data.
Small Area boundaries are sub-divisions of Electoral Divisions. A normal Small Area comprises approximately 80-120 dwellings, created by the National Institute of Regional and Spatial Analysis (NIRSA) on behalf of Ordnance Survey Ireland (OSi) in consultation with the Central Statistics Office (CSO).
Note that this field is subject to breaking changes if a new generation of government data IDs is released. Currently this uses 2017 IDs. Contact us to be notified ahead of this change.
townland_idstring optionalUnique Identifier for the townland, from the 2017 data.
A townland is a small geographical division of land commonly used in Ireland, and the building block for higher-level Electoral Divisions. Townland names may not be unique within a County.
Note that this field is subject to breaking changes if a new generation of government data IDs is released. Currently this uses 2017 IDs. Contact us to be notified ahead of this change.
gaeltacht_idstring optionalUnique Identifier for the Gaeltacht area, from the 2017 data. There are 7 Gaeltacht areas. Empty string if the address is not in a Gaeltacht.
Note that this field is subject to breaking changes if a new generation of government data IDs is released. Currently this uses 2017 IDs. Contact us to be notified ahead of this change.
postaim_presort_61string optionalAn Post sorting information.
postaim_presort_152string optionalAn Post sorting information.
publicity_post_zonestring optionalAn Post publicity post zone information.
Ireland ECAF Address Full guide
ECAF is the Eircode Address File, which holds one record per Irish postal address. English and Irish language versions of each address are indexed separately and distinguished by
language.Unavailable elements are returned as an empty string, never
null. ECAF carries no coordinates, solongitudeandlatitudeare always empty strings - useEcadAddressfor geolocated Irish addresses.idstringGlobal unique internally generated identifier for an address
datasetstringcountry_isostring3 letter country code (ISO 3166-1)
country_iso_2string2 letter country code (ISO 3166-1)
countrystringFull country names (ISO 3166)
languagestringLanguage represented by 2 letter ISO Code (639-1)
line_1stringAddress Line 1
line_2stringAddress Line 2
line_3stringAddress Line 3
line_4stringAddress Line 4
line_5stringAddress Line 5
line_6stringAddress Line 6
line_7stringAddress Line 7
line_8stringAddress Line 8
line_9stringAddress Line 9
departmentstringThe department or division within an organisation, e.g.
Accounts Department. If the department element exists, then the organisation must also exist.organisationstringOrganisation name, e.g.
Oak Tree Limited.sub_building_namestringThe sub-building refers to an apartment, flat or unit within a building, e.g.
Flat 1.building_namestringThe name given to the building, e.g.
Rose Cottage. Prepended by sub building, if any, when the sub building does not appear on a line to itself. The building name is omitted if it is the same as either the Organisation or Building Group.building_numberstringA number associated with the whole building. The building number may have a numeric and an alphanumeric component, which are concatenated e.g. 2A, or alternatively will have a simple building number or a complex building number. The building number always relates to the whole building and not a sub-unit within it. A complex building number may be one of the following:
- Dual. Two number separated by '/' e.g. 63/64 = 63, 64
- Sequence. An odd or even sequence of numbers with lower and upper bound separated by an underscore '_' e.g.
1_5= 1,3,5 and2_6= 2,4,6 - Range. A range of consecutive numbers with lower and upper bound separated by a dash '-' e.g.
63-66= 63, 64, 56, 66 The building number never appears on a line by itself and can prepend Building Group, Primary Thoroughfare or Primary Locality.
building_groupstringA building group is a collection of buildings with a collective name, located on or near the same thoroughfare, e.g.
Marrian Terrace.primary_thoroughfarestringThe name of the thoroughfare on which premises are located, e.g.
Griffith Road. It may appear on a line by itself or be appended to either a sub building or building number.Addresses with thoroughfares can sometimes have the thoroughfare excluded where a Building Group exists, such as a Retail Centre or Business Park, and the thoroughfare is not part of the Postal Address.
secondary_thoroughfarestringIt is never present without a primary thoroughfare. The primary thoroughfare is dependent on the secondary thoroughfare and appears before the secondary thoroughfare in any address.
Secondary thoroughfare are generally used to assist locating a primary thoroughfare.
primary_localitystringFirst locality elements which can refer to areas, districts, industrial estates, towns, etc.
The primary locality refers to the specific place the address is.
In urban areas, the primary locality can be required to distinguish between two thoroughfares of the same name in the same district or town. Industrial estates with named thoroughfares are also held as localities. In rural areas the primary locality is generally a townland name.
secondary_localitystringNever present without a primary locality. The secondary locality has a wider geographic scope than the primary locality.
It is the secondary locality therefore which differentiates addresses with the same primary locality name within the same county.
Secondary localities are more likely to be required for rural addresses.
Second locality elements which can refer to areas, districts, industrial estates, towns, etc
The secondary locality helps identify where the primary locality is located.
tertiary_localitystringAlso known as the Post Town.
The name of the post town associated with the premises for postal delivery purposes. This includes Dublin Postal Districts "Dublin 1" to "Dublin 24".
The post town is a significant element of the Postal Address, however it is not always populated in an address. The official post office guide, Eolaí an Phoist, describes post towns in the following manner:
"A provincial postal address may include the name of a town or village several miles distant, with which the addressee has little or no connection, and, in some places, especially if this residence happens to be near a county boundary, the name of the neighbouring county instead of the county in which he actually resides. The explanation is that the main mail despatches have to be sent for more detailed sub division to certain centres known as POST TOWNS, chosen because of their accessibility and convenience."
post_countystringOne of the 26 Counties in the Republic of Ireland. These counties are sub-national divisions used for the purposes of administrative, geographical and political demarcation. Post County is the County associated with the Post Town, not the geographic county in which the building is located. The Post County is normally used as part of the Postal Address with some exceptions e.g. Dublin Postal Districts where the Post County is not used and some Post Towns (e.g. Tipperary, Kildare, etc.) that have the same name as the Post County.
eircodestringThe seven character Eircode has an A65 F4E2 format. The Eircode is a mandatory address element. The last line of a Postal Address will contain the Eircode, displayed with a space. e.g.
A65 F4E2.The Eircode is always the last line of a Postal Address generated within the state, e.g. if an address has four lines then the Eircode will be on its own on Address Line 5. For inbound international mail the country name IRELAND should be appended as the last line of the Postal Address.
address_referencestringThe address reference is the An Post GeoDirectory address reference identifier used by the Universal Service Provider.
longitudeLongitudeThe longitude of the address or postcode (WGS84).
Can be a positive or negative decimal. E.g. -0.1283983
Returns an empty string if no location data is available.
- string
- number
latitudeLatitudeThe latitude of the address or postcode (WGS84).
Can be a positive or negative decimal. E.g.
51.5083983.Returns an empty string if no location data is available.
- string
- number
ecaf_idstring optionalThe unique identifier in the ECAF is the
ecaf_id. This unique identifier allows each address in the ECAF to be uniquely identified. It can also be used as index once the data has been imported into a relational database. This is a numeric field that can store values from 0 to 2,147,483,647. It is represented as a number up to 10 digits long. All other fields in ECAF are alphanumeric.
HERE Address Full guide
An address from HERE Technologies' map data, covering 230 countries and territories across twelve regional datasets named in
dataset. Each address carries its address lines, house number (address), street name, HERE's administrative hierarchy (order1_name,order2_name,order8_name,builtup_name), a postal code where the country has one, display and delivery coordinates and, where HERE holds them, the building, unit, level and unit name. Depth varies by country, from building level down to region level only. HERE refreshes the data quarterly.Conventions:
- A record is one of four kinds, named after the dataset in
id:apan address point,aran address range,poia point of interest,loca locality. Postal Addressing records arepapandpar. idis the dataset, the kind, HERE's key and the language code. A range id carries a further segment holding the interpolated house number (herewe_ar|74024700!27769096|8|de).- Text fields are empty strings, never null. Coordinates are empty strings when absent.
- Only
line_1andline_2are ever populated.line_1is the building name line where the record has one, otherwise the street line. Ranges, points of interest and localities produce at most one line. - Casing is as HERE ships it. Only the Postal Addressing fields are title cased.
languageis the ISO 639-1 code for the record. A street named in more than one language yields one record per language, identical but for the language segment ofid.
idstringGlobal unique internally generated identifier for an address
country_isostringThree character country code based on ISO Standard 3166.
datasetstringHERE regional dataset the address was sourced from.
languagestringISO 639-1 language code of the record, mapped down from HERE's three-letter code. Taken from the address point, the road for a range, the point of interest or the administrative place for a locality.
line_1stringFirst address line.
Can be empty string
""if not present.line_2stringSecond address line.
Can be empty string
""if not present.line_3stringThird address line. Always the empty string
""for HERE records, which produce at most two lines.line_4stringFourth address line. Always the empty string
""for HERE records, which produce at most two lines.line_5stringFifth address line. Always the empty string
""for HERE records, which produce at most two lines.addressstringAddress / House Number uniquely identifying the address along the specified road link.
Can be empty string
""if not present.delivery_latitudeone of- string
- number
delivery_longitudeone of- string
- number
building_namestringName of the Building to which the Point Address is associated.
Can be empty string
""if not present.latitudeone of- string
- number
longitudeone of- string
- number
street_namestringThe full spelling of the street name, including Prefix, Base Name, Suffix, Street Type, and Direction on Sign.
Can be empty string
""if not present.postal_codestringFull postal code; could be numeric or alphanumeric postal code.
Can be empty string
""if not present.order1_namestringIdentifies the highest administrative level in which a country can be subdivided.
Can be empty string
""if not present.order2_namestringIdentifies an intermediate administrative level of a country and is a sub-division of an Order-1 area. Only countries with a five (or more) level administrative hierarchy have Order-2 administrative levels defined. This feature can be used for destination selection and map display.
Can be empty string
""if not present.order8_namestringIdentifies the lowest level of the country's administrative hierarchy that is present country-wide. (No gaps exist in the coverage.)
Can be empty string
""if not present.builtup_namestringIdentifies the lowest administrative level for a country. This level does not cover the entire country, (as opposed to the Order-8 Area level which does cover the entire country). This feature should be used in conjunction with Zone and Order-8 Area for destination selection. The Built-up Area polygon, as published in RDF_CARTO, can also be used for map display.
Can be empty string
""if not present.poi_namestringName of the point of interest. Populated for point of interest records only.
Can be empty string
""if not present.building_unit_namestringName of the Building associated with a Micro Point Address.
Can be empty string
""if not present.level_namestringName of floor or level within a building associated with a Micro Point Address.
Can be empty string
""if not present.unit_namestringName of the unit (suite, etc) associated with a Micro Point Address.
Can be empty string
""if not present.suppl_address_infostringAdditional address or building information.
Can be empty string
""if not present.building_grp_namestringName of the group of buildings with which the address is associated.
Can be empty string
""if not present.
- A record is one of four kinds, named after the dataset in
Australia G-NAF Address Full guide
An Australian address from the Geocoded National Address File (G-NAF), published by Geoscape. Covers Australia and the external territories of Cocos (Keeling) Islands, Christmas Island and Norfolk Island.
Every attribute is always present. The API returns fields with no value as an empty string
"".The API returns attributes sourced from a one-to-many table (address aliases, site geocodes, locality aliases, street locality aliases) as a single comma separated string, with one element per related record. Related lists share an ordering, so the nth element of each describes the same record.
idstringGlobal unique internally generated identifier for an address
datasetstringcountrystringFull country names (ISO 3166)
country_isostring3 letter country code (ISO 3166-1)
country_iso_2string2 letter country code (ISO 3166-1)
line_1stringFirst address line. The building name where one is recorded, otherwise the street line.
Can be empty string
""if not present.line_2stringSecond address line. The street line where
line_1carries a building name.Can be empty string
""if not present.languagestringLanguage represented by 2 letter ISO Code (639-1)
addressstringAddress / House Number uniquely identifying the address along the specified street. For a ranged address this is the number matched from the query, not the whole range.
Can be empty string
""if not present.latitudeLatitudeThe latitude of the address or postcode (WGS84).
Can be a positive or negative decimal. E.g.
51.5083983.Returns an empty string if no location data is available.
- string
- number
longitudeLongitudeThe longitude of the address or postcode (WGS84).
Can be a positive or negative decimal. E.g. -0.1283983
Returns an empty string if no location data is available.
- string
- number
address_detail_pidstringThe Persistent Identifier is unique to the real world feature this record represents.
date_createdstringISO 8601 date-time this record was created.
date_last_modifiedstringISO 8601 date-time this record was last modified (not retired/recreated in line with ICSM standard).
Empty string
""if the record has never been modified.date_retiredstringISO 8601 date-time this record was retired.
Empty string
""if the record is current.building_namestringCombines both building/property name fields. Field length: up to 200 alphanumeric characters (AS4590:2006 5.7).
lot_number_prefixstringLot number prefix. Field length: up to two alphanumeric characters (AS4590:2006 5.8.1).
lot_numberstringLot number. Field length: up to five alphanumeric characters (AS4590:2006 5.8.1).
lot_number_suffixstringLot number suffix. Field length: up to two alphanumeric characters (AS4590:2006 5.8.1).
flat_type_codestringSpecification of the type of a separately identifiable portion within a building/complex. Field Length: up to seven upper case alpha characters (AS4590:2006 5.5.1.1).
flat_number_prefixstringFlat/unit number prefix. Field length: up to two alphanumeric characters (AS4590:2006 5.5.1.2).
flat_numberone of- string
- integer
flat_number_suffixstringFlat/unit number suffix. Field length: up to two alphanumeric characters (AS4590:2006 5.5.1.2).
level_type_codestringLevel type. Field length: up to four alphanumeric characters (AS4590:2006 5.5.2.1).
level_number_prefixstringLevel number prefix. Field length: up to two alphanumeric characters (AS4590:2006 5.5.2.2).
level_numberone of- string
- integer
level_number_suffixstringLevel number suffix. Field length: up to two alphanumeric characters (AS4590:2006 5.5.2.2).
number_first_prefixstringPrefix for the first (or only) number in range. Field length: up to three uppercase alphanumeric characters (AS4590:2006 5.5.3.1).
number_firstone of- string
- integer
number_first_suffixstringSuffix for the first (or only) number in range. Field length: up to two uppercase alphanumeric characters (AS4590:2006 5.5.3.1).
number_last_prefixstringPrefix for the last number in range. Field length: up to three uppercase alphanumeric characters (AS4590:2006 5.5.3.2).
number_lastone of- string
- integer
number_last_suffixstringSuffix for the last number in range. Field length: up to two uppercase alphanumeric characters (AS4590:2006 5.5.3.2).
street_locality_pidstringIdentifier of the street locality this address sits on. Not mandatory - some G-NAF records do not require a street (e.g. a remote rural property).
alias_principalstringA = Alias record, P = Principal record.
postcodestringPostcodes are optional as prescribed by AS4819 and AS4590:2006 5.13.
private_streetstringPrivate street information. This is not broken up into name/type/suffix. Field length: up to 75 alphanumeric characters. This is not currently populated.
legal_parcel_idstringGeneric parcel id field derived from the Geoscape Australia's Cadastre parcel where available.
confidenceone of- string
- integer
level_geocoded_codeintegerBinary indicator of the level of geocoding this address has. e.g. 0 = 000 = (No geocode), 1 = 001 = (No Locality geocode, No Street geocode, Address geocode), etc.
primary_secondarystringIndicator that identifies if the address is P (Primary) or S (secondary).
alias_type_codestringComma separated alias types for this address (e.g. "Synonym"), one per alias record.
geocode_type_codestringUnique abbreviation for the geocode type of the default geocode.
default_latitudeone of- string
- number
default_longitudeone of- string
- number
address_change_type_codestringThe code indicating the type of change, for example, LOC-STN for locality name and street name change.
mb_2016_match_codestringCode for the 2016 mesh block match e.g. 1.
mb_2021_match_codestringCode for the 2021 mesh block match e.g. 1.
address_typestringAddress type (e.g. "Postal", "Physical").
address_site_namestringAddress site name. Field length: 200 alphanumeric characters.
geocode_site_namestringComma separated identifiers relating to each geocoded site (e.g. "Transformer 75658"), one per site geocode record.
site_geocode_type_codestringComma separated abbreviations for each site geocode feature (e.g. "PRCL") (SAWG 7.4.1), one per site geocode record.
reliability_codestringComma separated spatial precision of each site geocode, expressed as a number in the range 1 (unique identification of feature) to 6 (feature associated to region i.e. postcode).
site_boundary_extentstringComma separated measurements (metres) of each site geocode from other geocodes associated with the same address persistent identifier.
site_planimetric_accuracystringComma separated planimetric accuracy of each site geocode.
elevationstringComma separated elevation of each site geocode. This field is not currently populated.
site_longitudestringComma separated longitude of each site geocode (GDA2020).
site_latitudestringComma separated latitude of each site geocode (GDA2020).
geocode_type_priority_orderone of- string
- integer
site_geocode_priority_orderstringComma separated priority order of each site geocode type, 1 (most precise) to 29 (least precise), one per site geocode record.
locality_namestringThe name of the locality or suburb.
primary_postcodestringRequired to differentiate localities of the same name within a state.
locality_class_codestringDescribes the class of locality (e.g. Gazetted, topographic feature etc.). Lookup to locality class.
locality_gnaf_reliability_codeone of- string
- integer
locality_alias_namestringComma separated alias names for the locality or suburb.
locality_alias_postcodestringComma separated postcodes, one per locality alias.
locality_alias_type_codestringComma separated alias type codes, one per locality alias.
locality_planimetric_accuracyone of- string
- integer
locality_latitudeone of- string
- number
locality_longitudeone of- string
- number
mb_2016_codestringThe 2016 mesh block code.
mb_2021_codestringThe 2021 mesh block code.
ps_join_type_codestringComma separated join type codes, one per primary/secondary link on this address. Each is 1 OR 2 when the root address:-
Code 1: Automatically generated when the primary and secondary addresses share the same street number, street name (and type) and locality name components.
Code 2: Manually generated where the primary and secondary addresses MAY or MAY NOT share the same street number, street name (and type) and locality name components
state_namestringThe state or territory name, title cased. E.g. Tasmania.
state_abbreviationstringThe state or territory abbreviation.
street_class_codestringDefines whether this street represents a confirmed or unconfirmed street.
street_namestringStreet name. e.g. "Barney".
street_type_codestringThe street type code. e.g. "Street".
street_suffix_codestringThe street suffix code. e.g. "West".
gnaf_street_confidenceone of- string
- integer
street_locality_gnaf_reliability_codeone of- string
- integer
street_locality_alias_street_namestringComma separated street alias names. e.g. "Poplar".
street_locality_alias_street_type_codestringComma separated street type codes, one per street alias. e.g. "Place".
street_locality_alias_street_suffix_codestringComma separated street suffix codes, one per street alias. e.g. "West".
street_locality_alias_type_codestringComma separated alias type codes, one per street alias.
street_locality_boundary_extentone of- string
- integer
street_locality_planimetric_accuracyone of- string
- integer
street_locality_latitudeone of- string
- number
street_locality_longitudeone of- string
- number
street_type_namestringAbbreviation of the street type. e.g. "St".
street_locality_alias_street_type_namestringComma separated abbreviations of the street type, one per street alias. e.g. "St".
Netherlands Kadaster Address Full guide
A Netherlands address as recorded in the Kadaster BAG (Basisregistratie Adressen en Gebouwen), the Dutch national register of addresses and buildings.
Fields are grouped by the BAG object they originate from: the verblijfsobject (unprefixed) and the related
nummeraanduidingen_,pand_,openbare_ruimte_andwoonplaats_objects.idstringGlobal unique internally generated identifier for an address
datasetstringDataset the address originates from.
countrystringFull country names (ISO 3166)
country_isostring3 letter country code (ISO 3166-1)
country_iso_2string2 letter country code (ISO 3166-1)
line_1stringFirst address line: street name followed by house number.
Empty string
""if not available.languagestringLanguage represented by 2 letter ISO Code (639-1)
addressstringHouse number, uniquely identifying the address along the specified street. Combines huisnummer, huisletter and huisnummertoevoeging.
Empty string
""if not available.identificatiestringThe unique identifier of a BAG verblijfsobject.
latitudeLatitudeThe latitude of the address or postcode (WGS84).
Can be a positive or negative decimal. E.g.
51.5083983.Returns an empty string if no location data is available.
- string
- number
longitudeLongitudeThe longitude of the address or postcode (WGS84).
Can be a positive or negative decimal. E.g. -0.1283983
Returns an empty string if no location data is available.
- string
- number
gebruiksdoelstringThe purpose of use of the verblijfsobject. E.g.
woonfunctie(residential),kantoorfunctie(office),winkelfunctie(retail).oppervlakteintegerThe floor area of the verblijfsobject in square metres.
statusstringVerblijfsobject status. E.g.
Verblijfsobject in gebruik(in use).geconstateerdbooleanIndicates that a verblijfsobject has been included in the registry as a result of an observation, without there being a regular source document for this inclusion at the time of registration.
documentdatumstringDate on which the verblijfsobject source document was created.
documentnummerstringThe unique identifier of the verblijfsobject source document.
voorkomenidentificatieone of- string
- integer
begin_geldigheidstringThe time at which a version of a verblijfsobject is valid in reality in accordance with the effective date in the source document. ISO 8601 timestamp.
Empty string
""if not available.eind_geldigheidstringThe time at which a version of a verblijfsobject is no longer valid in reality. ISO 8601 timestamp.
Empty string
""if not available.tijdstip_registratiestringThe time at which a version of a verblijfsobject is registered by the bronhouder. ISO 8601 timestamp.
Empty string
""if not available.eind_registratiestringThe time at which a version of a verblijfsobject is no longer valid according to the bronhouder. ISO 8601 timestamp.
Empty string
""if not available.tijdstip_registratie_lvstringThe time at which a version of a verblijfsobject is registered in the Landelijke Voorziening BAG. ISO 8601 timestamp.
Empty string
""if not available.tijdstip_eind_registratie_lvstringThe time at which a version of a verblijfsobject is no longer valid in the Landelijke Voorziening BAG. ISO 8601 timestamp.
Empty string
""if not available.nummeraanduidingen_identificatiestringThe unique identifier of a BAG nummeraanduidingen object.
Empty string
""if not available.nummeraanduidingen_huisnummerstringThe house number assigned to a nummeraanduiding object by or on behalf of the municipal council.
Empty string
""if not available.nummeraanduidingen_huisnummertoevoegingstringA further addition to a house number, or to a combination of house number and house letter, granted by or on behalf of the municipal council with regard to a nummeraanduiding object.
Empty string
""if not available.nummeraanduidingen_huisletterstringAn addition to a house number in the form of an alphanumeric character assigned by or on behalf of the municipal council with regard to a nummeraanduiding object.
Empty string
""if not available.nummeraanduidingen_postcodestringA code determined by PostNL associated with a specific combination of a street name and a house number. Normalised to
1234 AB.Empty string
""if not available.nummeraanduidingen_type_adresseerbaar_objectstringThe nature of the nummeraanduiding object. Currently always
Verblijfsobject.Empty string
""if not available.nummeraanduidingen_statusstringThe status of the nummeraanduiding object. E.g.
Naamgeving uitgegeven(name issued),Naamgeving ingetrokken(name withdrawn).Empty string
""if not available.nummeraanduidingen_geconstateerdbooleanIndicates that a nummeraanduidingen object has been included in the registry as a result of an observation, without there being a regular source document for this inclusion at the time of registration.
nummeraanduidingen_documentdatumstringDate on which the nummeraanduidingen object source document was created. ISO 8601 timestamp.
Empty string
""if not available.nummeraanduidingen_documentnummerstringThe unique identifier of the nummeraanduidingen object source document.
Empty string
""if not available.nummeraanduidingen_voorkomenidentificatieone of- string
- integer
nummeraanduidingen_begin_geldigheidstringThe time at which a version of a nummeraanduidingen object is valid in reality in accordance with the effective date in the source document. ISO 8601 timestamp.
Empty string
""if not available.nummeraanduidingen_eind_geldigheidstringThe time at which a version of a nummeraanduidingen object is no longer valid in reality. ISO 8601 timestamp.
Empty string
""if not available.nummeraanduidingen_tijdstip_registratiestringThe time at which a version of a nummeraanduidingen object is registered by the bronhouder. ISO 8601 timestamp.
Empty string
""if not available.nummeraanduidingen_eind_registratiestringThe time at which a version of a nummeraanduidingen object is no longer valid according to the bronhouder. ISO 8601 timestamp.
Empty string
""if not available.nummeraanduidingen_tijdstip_registratie_lvstringThe time at which a version of a nummeraanduidingen object is registered in the Landelijke Voorziening BAG. ISO 8601 timestamp.
Empty string
""if not available.nummeraanduidingen_tijdstip_eind_registratie_lvstringThe time at which a version of a nummeraanduidingen object is no longer valid in the Landelijke Voorziening BAG. ISO 8601 timestamp.
Empty string
""if not available.pand_identificatiestringThe unique identifier of a BAG pand object.
Empty string
""if not available.pand_oorspronkelijk_bouwjaarone of- string
- integer
pand_statusstringThe status of the pand object. E.g.
Pand in gebruik(building in use).Empty string
""if not available.pand_geconstateerdbooleanIndicates that a pand object has been included in the registry as a result of an observation, without there being a regular source document for this inclusion at the time of registration.
pand_documentdatumstringDate on which the pand object source document was created. ISO 8601 timestamp.
Empty string
""if not available.pand_documentnummerstringThe unique identifier of the pand object source document.
Empty string
""if not available.pand_voorkomenidentificatieone of- string
- integer
pand_begin_geldigheidstringThe time at which a version of a pand object is valid in reality in accordance with the effective date in the source document. ISO 8601 timestamp.
Empty string
""if not available.pand_eind_geldigheidstringThe time at which a version of a pand object is no longer valid in reality. ISO 8601 timestamp.
Empty string
""if not available.pand_tijdstip_registratiestringThe time at which a version of a pand object is registered by the bronhouder. ISO 8601 timestamp.
Empty string
""if not available.pand_eind_registratiestringThe time at which a version of a pand object is no longer valid according to the bronhouder. ISO 8601 timestamp.
Empty string
""if not available.pand_tijdstip_registratie_lvstringThe time at which a version of a pand object is registered in the Landelijke Voorziening BAG. ISO 8601 timestamp.
Empty string
""if not available.pand_tijdstip_eind_registratie_lvstringThe time at which a version of a pand object is no longer valid in the Landelijke Voorziening BAG. ISO 8601 timestamp.
Empty string
""if not available.openbare_ruimte_identificatiestringThe unique identifier of a BAG openbare ruimte object.
Empty string
""if not available.openbare_ruimte_naamstringThe name assigned to an openbare ruimte object by or on behalf of the municipal council. Usually the street name.
Empty string
""if not available.openbare_ruimte_typestringThe nature of the openbare ruimte object. E.g.
Weg(road),Water,Spoorbaan(railway).Empty string
""if not available.openbare_ruimte_statusstringThe status of the openbare ruimte object. E.g.
Naamgeving uitgegeven(name issued).Empty string
""if not available.openbare_ruimte_geconstateerdbooleanIndicates that an openbare ruimte object has been included in the registry as a result of an observation, without there being a regular source document for this inclusion at the time of registration.
openbare_ruimte_documentdatumstringDate on which the openbare ruimte object source document was created. ISO 8601 timestamp.
Empty string
""if not available.openbare_ruimte_documentnummerstringThe unique identifier of the openbare ruimte object source document.
Empty string
""if not available.openbare_ruimte_voorkomenidentificatieone of- string
- integer
openbare_ruimte_begin_geldigheidstringThe time at which a version of an openbare ruimte object is valid in reality in accordance with the effective date in the source document. ISO 8601 timestamp.
Empty string
""if not available.openbare_ruimte_eind_geldigheidstringThe time at which a version of an openbare ruimte object is no longer valid in reality. ISO 8601 timestamp.
Empty string
""if not available.openbare_ruimte_tijdstip_registratiestringThe time at which a version of an openbare ruimte object is registered by the bronhouder. ISO 8601 timestamp.
Empty string
""if not available.openbare_ruimte_eind_registratiestringThe time at which a version of an openbare ruimte object is no longer valid according to the bronhouder. ISO 8601 timestamp.
Empty string
""if not available.openbare_ruimte_tijdstip_registratie_lvstringThe time at which a version of an openbare ruimte object is registered in the Landelijke Voorziening BAG. ISO 8601 timestamp.
Empty string
""if not available.openbare_ruimte_tijdstip_eind_registratie_lvstringThe time at which a version of an openbare ruimte object is no longer valid in the Landelijke Voorziening BAG. ISO 8601 timestamp.
Empty string
""if not available.openbare_ruimte_verkorte_naamstringAn abbreviated name assigned to an openbare ruimte object if its name is longer than 24 characters.
Empty string
""if not available.woonplaats_identificatiestringThe unique identifier of a BAG woonplaats object.
Empty string
""if not available.woonplaats_naamstringThe name assigned to a woonplaats object by or on behalf of the municipal council. The town or city name.
Empty string
""if not available.woonplaats_statusstringThe status of the woonplaats object. E.g.
Woonplaats aangewezen(place of residence designated).Empty string
""if not available.woonplaats_geconstateerdbooleanIndicates that a woonplaats object has been included in the registry as a result of an observation, without there being a regular source document for this inclusion at the time of registration.
woonplaats_documentdatumstringDate on which the woonplaats object source document was created. ISO 8601 timestamp.
Empty string
""if not available.woonplaats_documentnummerstringThe unique identifier of the woonplaats object source document.
Empty string
""if not available.woonplaats_voorkomenidentificatieone of- string
- integer
woonplaats_begin_geldigheidstringThe time at which a version of a woonplaats object is valid in reality in accordance with the effective date in the source document. ISO 8601 timestamp.
Empty string
""if not available.woonplaats_eind_geldigheidstringThe time at which a version of a woonplaats object is no longer valid in reality. ISO 8601 timestamp.
Empty string
""if not available.woonplaats_tijdstip_registratiestringThe time at which a version of a woonplaats object is registered by the bronhouder. ISO 8601 timestamp.
Empty string
""if not available.woonplaats_eind_registratiestringThe time at which a version of a woonplaats object is no longer valid according to the bronhouder. ISO 8601 timestamp.
Empty string
""if not available.woonplaats_tijdstip_registratie_lvstringThe time at which a version of a woonplaats object is registered in the Landelijke Voorziening BAG. ISO 8601 timestamp.
Empty string
""if not available.woonplaats_tijdstip_eind_registratie_lvstringThe time at which a version of a woonplaats object is no longer valid in the Landelijke Voorziening BAG. ISO 8601 timestamp.
Empty string
""if not available.provinciestringProvince the address falls in, derived from the postcode.
Empty string
""if not available.
Norway Kartverket Address Full guide
An address from Matrikkelen, Norway's official cadastre and address register, published by Kartverket (the Norwegian Mapping Authority).
Covers Norway (
NOR) and Svalbard and Jan Mayen (SJM). Records come from the cadastre address, apartment level and road address files, so the fields available depend on which file the address came from. Any field which is not present is returned as an empty string"".idstringGlobal unique internally generated identifier for an address
datasetstringcountrystringFull country names (ISO 3166)
country_isostring3 letter country code (ISO 3166-1)
country_iso_2string2 letter country code (ISO 3166-1)
line_1stringFirst address line.
adressetilleggsnavnwhere present, otherwise the official address text without it.Can be empty string
""if not present.line_2stringSecond address line. The official address text without
adressetilleggsnavn, where line 1 carries that name.Can be empty string
""if not present.languagestringLanguage represented by 2 letter ISO Code (639-1)
addressstringNumber uniquely identifying the address within its street or farm.
nummerandbokstavfor a vegadresse, otherwise the cadastralgardsnummer/bruksnummer. Anybruksenhetsnummer_tekstis appended after a hyphen.Can be empty string
""if not present.latitudeLatitudeThe latitude of the address or postcode (WGS84).
Can be a positive or negative decimal. E.g.
51.5083983.Returns an empty string if no location data is available.
- string
- number
longitudeLongitudeThe longitude of the address or postcode (WGS84).
Can be a positive or negative decimal. E.g. -0.1283983
Returns an empty string if no location data is available.
- string
- number
lokal_idstringLocal identifier assigned by the data supplier.
Can be empty string
""if not present.kommunenummerstringKommune (municipality) number.
adressetypestringvegadresse= street address,matrikkeladresse= land registry addressadressekodeone of- string
- integer
nummerone of- string
- integer
bokstavstringA subsequent letter that may be used in addition to a number.
Can be empty string
""if not present.gardsnummerintegerThe number of a farm unit in the land register, unique within each municipality.
bruksnummerintegerA unique identification number automatically assigned to each individual unit within a farm.
festenummerone of- string
- integer
seksjonsnummerone of- string
- integer
undernummerone of- string
- integer
adresse_tekststringOfficial address text without bruksenhetsnummer, unique within a kommune.
Can be empty string
""if not present.bruksenhet_idstringLocal identifier for a unit within a building.
Can be empty string
""if not present.bruksenhetsnummer_tekststringUnit number, e.g. an apartment in a multi-dwelling building.
Can be empty string
""if not present.offisiell_adresse_tekststringOfficial address text with bruksenhetsnummer, unique within a kommune.
Can be empty string
""if not present.epsg_kodeintegerEPSG code of the coordinate reference system used by
nordandoest.25833= EUREF89 UTM zone 33.nordstringNorthward (northing) coordinate of address, in the coordinate reference system given by
epsg_kode.oeststringEastward (easting) coordinate of address, in the coordinate reference system given by
epsg_kode.postnummerstringPostal code.
poststedstringName of postal town according to Posten.
grunnkretsnummerstringIdentifier consisting of 8 digits, where the first four are the kommunenummer, the next two are the delområdenummer and the last two indicate the grunnkrets.
Can be empty string
""if not present.soknenummerstringUnique 8 digit identifier of a parish.
Can be empty string
""if not present.organisasjonsnummerstringUnique identifier of organisation in the Brønnøysund Register.
Can be empty string
""if not present.tettstednummerstring4 digit code for tettsted (urban settlement).
Can be empty string
""if not present.valgkretsnummerone of- string
- integer
oppdateringsdatostringDate of last change to the object data.
datauttaksdatostringDate of extraction from database.
adresse_idstringAddress local identifier assigned by the data supplier.
uuid_adressestringAddress identifier realised as UUID managed by the cadastral system.
uuid_bruksenhetstringUnit of usage identifier realised as UUID managed by the cadastral system.
Can be empty string
""if not present.atkomst_idstringLocal identifier for means of access to a property.
Can be empty string
""if not present.uuid_atkomststringIdentifier of the means of access to a property realised as UUID in the cadastral system.
Can be empty string
""if not present.atkomst_nordstringNorthward coordinate of the means of access to a property.
Can be empty string
""if not present.atkomst_oeststringEastward coordinate of the means of access to a property.
Can be empty string
""if not present.sommeratkomst_idstringLocal identifier for means of access to a property in summer.
Can be empty string
""if not present.uuid_sommeratkomststringIdentifier of the means of access to a property in summer realised as UUID in the cadastral system.
Can be empty string
""if not present.sommeratkomst_nordstringNorthward coordinate of the means of access to a property in summer.
Can be empty string
""if not present.sommeratkomst_oeststringEastward coordinate of the means of access to a property in summer.
Can be empty string
""if not present.vinteratkomst_idstringLocal identifier for means of access to a property in winter.
Can be empty string
""if not present.uuid_vinteratkomststringIdentifier of the means of access to a property in winter realised as UUID in the cadastral system.
Can be empty string
""if not present.vinteratkomst_nordstringNorthward coordinate of the means of access to a property in winter.
Can be empty string
""if not present.vinteratkomst_oeststringEastward coordinate of the means of access to a property in winter.
Can be empty string
""if not present.fylkestringName of county. Derived from
kommunenummer.Can be empty string
""if not present.landsdelstringName of region. Derived from
fylke.Can be empty string
""if not present.
Denmark SDFI Address Full guide
An address from Danmarks Adresseregister (DAR), the official Danish address register maintained by the municipalities and distributed by Styrelsen for Dataforsyning og Infrastruktur (SDFI).
Covers both access addresses (
adgangsadresser, a building entrance) and unit addresses (adresser, a flat or office within a building). Access addresses carry no floor, door,kvhoradgangsadresse_*values, which the API returns as empty strings.Field names follow the Danish source. Fields the source spells with ASCII substitutions (
aendret,dor) are returned with their Danish characters (ændret,dør).idstringGlobal unique internally generated identifier for an address
datasetstringcountrystringFull country names (ISO 3166)
country_isostring3 letter country code (ISO 3166-1)
country_iso_2string2 letter country code (ISO 3166-1)
addressstringHouse number uniquely identifying the address along the street. Same value as
husnr.Can be empty string
""if not present.line_1stringFirst address line: street name and house number, followed by floor and door for a unit address.
Can be empty string
""if not present.line_2stringSecond address line: the supplementary city name (
supplerendebynavn) where present.Can be empty string
""if not present.languagestringLanguage represented by 2 letter ISO Code (639-1)
latitudeLatitudeThe latitude of the address or postcode (WGS84).
Can be a positive or negative decimal. E.g.
51.5083983.Returns an empty string if no location data is available.
- string
- number
longitudeLongitudeThe longitude of the address or postcode (WGS84).
Can be a positive or negative decimal. E.g. -0.1283983
Returns an empty string if no location data is available.
- string
- number
adresse_idstringUnique address identifier assigned by the data supplier.
kvhxstringUnique composite key for the address, containing codes for the municipality, road section, house number, floor and door.
kvhstringComposite key for the address, containing codes for the municipality, road section and house number.
Can be empty string
""if not present.adgangsadressebooleanIndicates whether the address is an access address.
statusstring1= final address,3= provisional address.darstatusstringStatus of the address indicated by the status code in Danmarks Adresseregister (DAR):
2= provisional,3= valid,4= retired,5= suspended.oprettetstringDate and time of address creation in Danmarks Adresseregister (DAR).
Can be empty string
""if not present.ændretstringDate and time of the last change to the address in Danmarks Adresseregister (DAR).
Can be empty string
""if not present.ikrafttrædelsestringDate and time at which the address became valid.
Can be empty string
""if not present.nedlagtstringDate and time from which the address is retired or suspended (may be in the future).
Can be empty string
""if not present.vejkodestringFour digit street identifier.
husnrstringHouse number.
etagestringFloor designation.
Can be empty string
""if not present.dørstringDoor designation.
Can be empty string
""if not present.postnrstringPostal code.
stormodtagerpostnrstringBulk recipient postal code (company postal code) which is associated with the address.
Can be empty string
""if not present.betegnelsestringFull text of postal address.
adressepunktændringsdatostringDate and time of the last change to the address point.
Can be empty string
""if not present.etrs89koordinat_øststringEasting coordinate for the address in the ETRS89 system.
etrs89koordinat_nordstringNorthing coordinate for the address in the ETRS89 system.
wgs84koordinat_breddeone ofLatitude of the address in the WGS84 system.
Can be empty string
""if not present.- string
- number
wgs84koordinat_længdeone ofLongitude of the address in the WGS84 system.
Can be empty string
""if not present.- string
- number
højdestringHeight in metres from the mean water level in the seas on Denmark's coasts to ground level at the address, calculated according to the Danish Vertical Reference 1990 (DVR90).
Can be empty string
""if not present.nøjagtighedstringCode indicating the accuracy of the address point.
A= accurate to within 2 metres,B= accurate to within 100 metres,U= no address point.kildestringCode indicating the source of the address point.
Can be empty string
""if not present.tekniskstandardstringTechnical classification code for the location of an address point.
tekstretningstringOrientation for an address in gons, where a full circle is divided into 400 gons.
ddkn_m100stringIdentifier of the 100m cell in which the address is located in Det Danske Kvadratnet (DDKN).
ddkn_km1stringIdentifier of the 1km cell in which the address is located in Det Danske Kvadratnet (DDKN).
ddkn_km10stringIdentifier of the 10km cell in which the address is located in Det Danske Kvadratnet (DDKN).
kommunekodestringFour digit identifier of the municipality in which the address is located.
landsdelsnuts3stringNUTS 3 code of the province in which the address is located.
regionskodestringFour digit identifier of the region in which the address is located.
afstemningsområdenummerstringIdentifier of the polling district in which the address is located.
menighedsrådsafstemningsområdenummerstringIdentifier of the parish council polling district in which the address is located.
Can be empty string
""if not present.opstillingskredskodestringIdentifier of the local electoral district in which the address is located.
storkredsnummerstringIdentifier of the regional electoral district in which the address is located.
valglandsdelsbogstavstringLetter identifier of the national electoral district in which the address is located:
A,BorC.sognekodestringIdentifier of the parish in which the address is located.
politikredskodestringIdentifier of the police district in which the address is located.
retskredskodestringFour digit identifier of the judicial district in which the address is located.
jordstykke_ejerlavkodestringIdentifier of a cadastral unit with a single owner.
Can be empty string
""if not present.jordstykke_matrikelnrstringCadastre identifier for the plot of land on which the address is located, consisting of up to 7 characters.
Can be empty string
""if not present.jordstykke_esrejendomsnrstringIdentifier for the property from the Ejendomsstamregisteret (ESR) property register, corresponding to the plot of land associated with the address, consisting of up to 7 characters.
Can be empty string
""if not present.ejerlavkodestringIdentifier of a cadastral unit with a single owner (deprecated).
Can be empty string
""if not present.matrikelnrstringCadastre identifier for the plot of land on which the address is located, consisting of up to 7 characters.
Can be empty string
""if not present.esrejendomsnrstringIdentifier for the property from the Ejendomsstamregisteret (ESR) property register, corresponding to the plot of land associated with the address, consisting of up to 7 characters.
Can be empty string
""if not present.zonestringStatus of the address zone:
Byzone,SommerhusområdeorLandzone.brofastbooleanIndicates whether the address is connected by a bridge.
adgangsadresseidstringIdentifier of the access address associated with the address.
Can be empty string
""if not present.adgangspunktidstringIdentifier of the access point for the address.
adgangsadresse_statusstringStatus of the access address associated with the address:
1= final address,3= provisional address.Can be empty string
""if not present.adgangsadresse_darstatusstringStatus of the access address indicated by the status code in Danmarks Adresseregister (DAR):
2= provisional,3= valid,4= retired,5= suspended.Can be empty string
""if not present.adgangsadresse_oprettetstringDate and time of the creation of the access address associated with the address.
Can be empty string
""if not present.adgangsadresse_ændretstringDate and time of the last change to the access address associated with the address.
Can be empty string
""if not present.adgangsadresse_ikrafttrædelsestringDate and time at which the access address became valid.
Can be empty string
""if not present.adgangsadresse_nedlagtstringDate and time from which the access address is retired or suspended (may be in the future).
Can be empty string
""if not present.vejpunkt_idstringUnique identifier of the geographic point on the road network that represents the starting point of the access route leading to the access point for the address.
vejpunkt_ændretstringDate and time of the last change in Danmarks Adresseregister (DAR) to the geographic point on the road network that represents the starting point of the access route leading to the access point for the address.
Can be empty string
""if not present.vejpunkt_kildestringSource of the geographic point on the road network that represents the starting point of the access route leading to the access point for the address.
vejpunkt_nøjagtighedstringAccuracy of the geographic point on the road network that represents the starting point of the access route leading to the access point for the address:
A= exact,B= approximate.vejpunkt_tekniskstandardstringTechnical classification code for the geographic point on the road network that represents the starting point of the access route leading to the access point for the address.
vejpunkt_xstringLongitude in the WGS84 system of the geographic point on the road network that represents the starting point of the access route leading to the access point for the address.
vejpunkt_ystringLatitude in the WGS84 system of the geographic point on the road network that represents the starting point of the access route leading to the access point for the address.
Canada NAR Address Full guide
A Canadian civic address from the National Address Register (NAR), published by Statistics Canada under the Statistics Canada Open Licence. Each address carries its civic number, street, municipality, province and postal code, a point coordinate, and its census subdivision, federal electoral district and economic region, in English and French. Statistics Canada publishes around 17.2 million addresses and refreshes them annually. 99.5% carry a full postal code and 95.7% carry a latitude and longitude.
Conventions:
- One record per address.
idiscannar_followed byaddr_guid, a pipe and the language code (cannar_<addr_guid>|en). The suffix selects the English or French form of the record, so preserve it verbatim when resolving an address. languageisenorfr. The API derives it rather than reading it from the file: a French street type givesfr, and the types both languages share (AV,PROM,ROUTE,RTE) givefrin Quebec and New Brunswick andenelsewhere. An address appears under one language only. There is no paired English and French copy of the same record. Thecsd_*,fed_*ander_*name pairs are returned in both languages whatever the record'slanguage.line_1is the number and street. A hyphen joins the apartment or suite number to the civic number (306-1 Finch Bay). A letter civic number suffix joins without a space (5A), a numeric one with a space (1 1/2). The street comes from themail_street_*fields wheremail_street_nameis present and from theofficial_street_*fields otherwise. In English the street type follows the name (Iron Horse Dr), exceptRoute, which precedes it. In French the type is lower cased and precedes the name (rue d'Andermatt).line_2carries the PO Box or Rural Route line frombu_n_civic_add(PO Box 377,RR 4). There is no third line.addressis the number component ofline_1on its own, apartment included (5A,306-1).- The API title cases
mail_street_name,mail_street_type,mail_mun_nameandofficial_street_type. Every other text field is as Statistics Canada ships it, somail_prov_abvn,mail_postal_code,mail_street_dirandofficial_street_dirstay upper case and thecsd_*,fed_*ander_*names keep their supplied case. - No field is null. A value absent upstream is an empty string
"", includinglatitudeandlongitudewhere the location has no coordinate. latitudeandlongituderepeatreppoint_latitudeandreppoint_longitude: the WGS84 representative point of the location record, shared by every address at the sameloc_guid.bg_xandbg_yare the building's coordinates in EPSG:3347, returned as strings.
idstringGlobal unique internally generated identifier for an address
datasetstringcountrystringFull country names (ISO 3166)
country_isostring3 letter country code (ISO 3166-1)
country_iso_2string2 letter country code (ISO 3166-1)
languagestringLanguage represented by 2 letter ISO Code (639-1)
addressstringHouse number, prefixed with the apartment or suite number and a hyphen where one is present. E.g.
1425or10-123 1/2.Can be empty string
""if not present.line_1stringFirst address line. House number and street.
Can be empty string
""if not present.line_2stringSecond address line. Carries the PO Box or Rural Route delivery information where present.
Can be empty string
""if not present.latitudeLatitudeThe latitude of the address or postcode (WGS84).
Can be a positive or negative decimal. E.g.
51.5083983.Returns an empty string if no location data is available.
- string
- number
longitudeLongitudeThe longitude of the address or postcode (WGS84).
Can be a positive or negative decimal. E.g. -0.1283983
Returns an empty string if no location data is available.
- string
- number
loc_guidstringGlobally unique identifier for location.
addr_guidstringGlobally unique identifier for address.
apt_no_labelstringApartment or suite number.
Can be empty string
""if not present.civic_nostringThe building number assigned to the address.
Can be empty string
""if not present.civic_no_suffixstringA suffix attached to the civic number. E.g.
Aor1/2.Can be empty string
""if not present.official_street_namestringOfficial street name.
Can be empty string
""if not present.official_street_typestringOfficial street designator. E.g.
St,Ave.Can be empty string
""if not present.official_street_dirstringOfficial street direction. E.g.
N,SE.Can be empty string
""if not present.prov_codestringProvince code. E.g.
59for British Columbia.csd_eng_namestringCensus subdivision English name.
Can be empty string
""if not present.csd_fre_namestringCensus subdivision French name.
Can be empty string
""if not present.csd_type_eng_codestringEnglish code indicating the type of Census Subdivision.
Can be empty string
""if not present.csd_type_fre_codestringFrench code indicating the type of Census Subdivision.
Can be empty string
""if not present.mail_street_namestringName of the street used in the mailing address.
Can be empty string
""if not present.mail_street_typestringDesignator of the street used in the mailing address.
Can be empty string
""if not present.mail_street_dirstringDirection of the street used in the mailing address.
Can be empty string
""if not present.mail_mun_namestringMunicipality name used in the mailing address.
Can be empty string
""if not present.mail_prov_abvnstringProvince abbreviation used in the mailing address.
Can be empty string
""if not present.mail_postal_codestringPostal code used in the mailing address. Returned as supplied by the provider, without a space between the forward sortation area and local delivery unit.
Can be empty string
""if not present.bg_dls_lsdstringLegal Subdivision number within the Dominion Land Survey system for the address location.
Can be empty string
""if not present.bg_dls_qtrstringQuarter section within a section of the Dominion Land Survey system for the address location.
Can be empty string
""if not present.bg_dls_sctnstringSection number within a township of the Dominion Land Survey system for the address location.
Can be empty string
""if not present.bg_dls_twnshpstringTownship number within the Dominion Land Survey system for the address location.
Can be empty string
""if not present.bg_dls_rngstringRange number within a meridian of the Dominion Land Survey system for the address location.
Can be empty string
""if not present.bg_dls_mrdstringMeridian number within the Dominion Land Survey system for the address location.
Can be empty string
""if not present.bg_xstringX coordinate of the building in the EPSG:3347 projected grid, in metres, returned as a string.
Can be empty string
""if not present.bg_ystringY coordinate of the building in the EPSG:3347 projected grid, in metres, returned as a string.
Can be empty string
""if not present.bu_n_civic_addstringAdditional delivery information for the mailing address, such as a PO Box or Rural Route. Upper cased, with the first
BOXtoken recased toBox(PO Box 377).Can be empty string
""if not present.bu_usestringBuilding usage code.
Can be empty string
""if not present.csd_codestringUnique identifier code for a Census Subdivision (CSD).
Can be empty string
""if not present.fed_codestringUnique identifier code for a federal electoral district.
Can be empty string
""if not present.fed_eng_namestringName of the federal electoral district in English.
Can be empty string
""if not present.fed_fre_namestringName of the federal electoral district in French.
Can be empty string
""if not present.er_codestringUnique identifier code for an economic region.
Can be empty string
""if not present.er_eng_namestringName of the economic region in English.
Can be empty string
""if not present.er_fre_namestringName of the economic region in French.
Can be empty string
""if not present.reppoint_latitudeLatitudeThe latitude of the address or postcode (WGS84).
Can be a positive or negative decimal. E.g.
51.5083983.Returns an empty string if no location data is available.
- string
- number
reppoint_longitudeLongitudeThe longitude of the address or postcode (WGS84).
Can be a positive or negative decimal. E.g. -0.1283983
Returns an empty string if no location data is available.
- string
- number
- One record per address.
Belgium FOD BOSA Address Full guide
A Belgian address from BeSt Address, the open address register published by FOD BOSA (Federal Public Service Policy and Support), covering Flanders, Wallonia and the Brussels Capital Region. Each address carries its street, house number and, where one exists, box number, the municipality (
municipality_idis the NIS code),postcode,region_codeand coordinates in both WGS84 (epsg_4326_*, mirrored as numericlatitudeandlongitude) and Belgian Lambert 72 (epsg_31370_*, in metres). Street, municipality and post town names come in Dutch, French and German. FOD BOSA publishes around 6.6 million current addresses and refreshes them weekly.Conventions:
- One record per address point per language. The API emits an address once for each language in which it has a street name, or, for the few rows with no street name in any language, each language in which it has a municipality name. A bilingual Brussels address therefore exists as both a Dutch and a French record, sharing
address_idbut differing inid,languageandline_1.idisfodbosa_followed byaddress_id,street_id,municipality_idand the language code, pipe separated (fodbosa_1000000|3048|21007|fr). The resolve endpoints read the trailing language code to find the record. - Every property is always present. A value the register does not hold is an empty string
"", never null.latitudeandlongitudeare empty strings when the WGS84 pair does not parse. line_1is the street name andhouse_numberjoined by a space, with the box number appended after-and prefixedbusin Dutch and German orboîtein French:rue Rodenbach 5 - boîte bt08. Absent parts are dropped with their separator. There are no further address lines.streetname_*andmunicipality_name_*keep FOD BOSA's casing.postname_*is title cased because the register supplies it in upper case (GENTbecomesGent). The street name insideline_1is normalised further: double quotes and a trailing parenthetical are removed, and in French the leading street type is lower cased, so astreetname_frofRue Rodenbachappears inline_1asrue Rodenbach.- Only
currentaddresses are indexed. The register'sproposed,retiredandrejectedrecords, around 7% of the file, are not served. - FOD BOSA re-surveys address points between vintages, so a coordinate can move by a metre or so between weekly refreshes.
idstringGlobal unique internally generated identifier for an address
datasetstringDataset the address originates from.
countrystringFull country names (ISO 3166)
country_isostring3 letter country code (ISO 3166-1)
country_iso_2string2 letter country code (ISO 3166-1)
languagestringLanguage represented by 2 letter ISO Code (639-1)
addressstringHouse number, duplicated from
house_numberfor consistency with other datasets. It does not identify the address on its own: boxes on the same number differ only bybox_number.Can be empty string
""if not present.line_1stringFirst address line. Street name, house number and, where present, box number, rendered in the address language.
Can be empty string
""if not present.latitudeLatitudeThe latitude of the address or postcode (WGS84).
Can be a positive or negative decimal. E.g.
51.5083983.Returns an empty string if no location data is available.
- string
- number
longitudeLongitudeThe longitude of the address or postcode (WGS84).
Can be a positive or negative decimal. E.g. -0.1283983
Returns an empty string if no location data is available.
- string
- number
epsg_31370_xstringX coordinate of the address in the BD72 / Belgian Lambert 72 (EPSG:31370) coordinate system.
epsg_31370_ystringY coordinate of the address in the BD72 / Belgian Lambert 72 (EPSG:31370) coordinate system.
epsg_4326_latstringLatitude of the address in the WGS84 (EPSG:4326) coordinate system. String form of
latitude.epsg_4326_lonstringLongitude of the address in the WGS84 (EPSG:4326) coordinate system. String form of
longitude.address_idstringAddress local identifier assigned by the data supplier.
Not unique on its own - the three regional files each number from scratch, so the same identifier can appear once per region. Use
id, or(address_id, street_id, municipality_id), to identify an address.box_numberstringBox or apartment number.
Can be empty string
""if not present.house_numberstringHouse number.
Can be empty string
""if not present.municipality_idstringMunicipality local identifier (NIS code) assigned by the data supplier.
municipality_name_destringMunicipality name in German.
Can be empty string
""if not present.municipality_name_frstringMunicipality name in French.
Can be empty string
""if not present.municipality_name_nlstringMunicipality name in Dutch.
Can be empty string
""if not present.postcodestringPostal code. 4 digits, first digit non-zero.
postname_frstringPost town name in French.
Can be empty string
""if not present. Brussels Capital Region addresses carry no post names - usemunicipality_name_frinstead.postname_nlstringPost town name in Dutch.
Can be empty string
""if not present. Brussels Capital Region addresses carry no post names - usemunicipality_name_nlinstead.street_idstringStreet local identifier assigned by the data supplier.
streetname_destringStreet name in German.
Can be empty string
""if not present.streetname_frstringStreet name in French.
Can be empty string
""if not present.streetname_nlstringStreet name in Dutch.
Can be empty string
""if not present.region_codestringISO 3166-2 code of the region in which the address is located. One of
BE-BRU(Brussels Capital Region),BE-VLG(Flanders) orBE-WAL(Wallonia).statusstringAddress lifecycle status assigned by the data supplier. Only
currentaddresses are indexed and served, so this is alwayscurrent. The supplier's remaining codes (proposed,reserved,retired,rejected) are filtered out.
- One record per address point per language. The API emits an address once for each language in which it has a street name, or, for the few rows with no street name in any language, each language in which it has a municipality name. A bilingual Brussels address therefore exists as both a Dutch and a French record, sharing
South Korea MOIS Address Full guide
A South Korean road name address (도로명주소) as published by the Ministry of the Interior and Safety (MOIS).
Every address is indexed twice, once in Hangul and once in Revised Romanization.
line_1andline_2follow the language of the matched document; the API returns the underlying MOIS fields under their original Hangul names.Korean-named fields are empty strings when the source record does not carry a value.
idstringGlobal unique internally generated identifier for an address
datasetstringDataset the address originates from.
countrystringFull country names (ISO 3166)
country_isostring3 letter country code (ISO 3166-1)
country_iso_2string2 letter country code (ISO 3166-1)
languagestringLanguage represented by 2 letter ISO Code (639-1)
addressstringJibeon (land lot) number:
지번본번_번지and지번부번_호joined by a hyphen.Can be empty string
""if not present.line_1stringFirst address line.
Can be empty string
""if not present.line_2stringSecond address line.
Can be empty string
""if not present.citystringPreferred city name.
Can be empty string
""if not present.provincestringPreferred province name.
Can be empty string
""if not present.법정읍면동명stringLegal town name.
Can be empty string
""if not present.법정동코드stringLegal district code.
Can be empty string
""if not present.법정리명stringLegal name.
Can be empty string
""if not present.비고1stringNote 1.
Can be empty string
""if not present.비고2stringNote 2.
Can be empty string
""if not present.변동전도로명주소stringChanged street name address.
Can be empty string
""if not present.변경이력정보stringChange history information.
Can be empty string
""if not present.변경이력사유stringChange history reason.
Can be empty string
""if not present.변경전_도로명주소stringPrevious road name address.
Can be empty string
""if not present.변경사유stringChange reason.
Can be empty string
""if not present.변경사유코드stringChange reason code.
Can be empty string
""if not present.층일련번호stringFloor serial number.
Can be empty string
""if not present.층명칭stringFloor name.
Can be empty string
""if not present.대표지번여부stringIs representative address.
Can be empty string
""if not present.대표여부stringIs representative.
Can be empty string
""if not present.다량배달처명stringBulk delivery location name.
Can be empty string
""if not present.동일련번호stringBuilding serial number.
Can be empty string
""if not present.동명칭stringBuilding name.
Can be empty string
""if not present.도로명stringRoad name.
Can be empty string
""if not present.도로명_로마자stringRomanised road name.
Can be empty string
""if not present.도로명번호stringRoad name number.
Can be empty string
""if not present.도로명코드stringRoad name code.
Can be empty string
""if not present.도로명코드_고시일자stringRoad name code creation date.
Can be empty string
""if not present.도로명코드_말소일자stringRoad name code deletion date.
Can be empty string
""if not present.읍면동구분stringTown classification.
Can be empty string
""if not present.읍면동일련번호stringTown serial number.
Can be empty string
""if not present.읍면동코드stringTown code.
Can be empty string
""if not present.읍면동명stringTown name.
Can be empty string
""if not present.읍면동명_로마자stringRomanised town name.
Can be empty string
""if not present.건축물대장_건물명stringBuilding name in building register.
Can be empty string
""if not present.건물본번stringBuilding number.
Can be empty string
""if not present.건물부번stringBuilding sub-number.
Can be empty string
""if not present.건물관리번호stringBuilding management number.
Can be empty string
""if not present.기초구역번호stringBasic area number.
Can be empty string
""if not present.공동주택여부stringIs apartment.
Can be empty string
""if not present.고시일자stringCreation date.
Can be empty string
""if not present.관리번호stringManagement number.
Can be empty string
""if not present.행정동코드stringAdministrative district code.
Can be empty string
""if not present.행정동명stringAdministrative district name.
Can be empty string
""if not present.호일련번호stringUnit serial number.
Can be empty string
""if not present.호명칭stringUnit name.
Can be empty string
""if not present.호접미사일련번호stringUnit suffix serial number.
Can be empty string
""if not present.호접미사명칭stringUnit suffix name.
Can be empty string
""if not present.이동사유코드stringMovement reason code.
Can be empty string
""if not present.일련번호stringSerial number.
Can be empty string
""if not present.지번일련번호stringAddress serial number.
Can be empty string
""if not present.지번본번_번지stringJibeon (land lot) main number.
Can be empty string
""if not present.지번부번_호stringJibeon (land lot) sub-number.
Can be empty string
""if not present.지하구분stringIs basement.
Can be empty string
""if not present.지하여부stringLevel (ground level, underground, aerial).
Can be empty string
""if not present.산여부stringIs mountain.
Can be empty string
""if not present.상위도로명stringUpper road name.
Can be empty string
""if not present.상위도로명번호stringUpper road name number.
Can be empty string
""if not present.상세건물명stringDetailed building name.
Can be empty string
""if not present.상세주소_부여여부stringWhether detailed address assigned.
Can be empty string
""if not present.상세주소여부stringWhether detailed address exists.
Can be empty string
""if not present.사용여부stringIn use.
Can be empty string
""if not present.시도명stringCity name.
Can be empty string
""if not present.시도명_로마자stringRomanised city name.
Can be empty string
""if not present.시군구_건물명stringDistrict (sigungu) building name, as recorded in the address DB (주소DB).
Can be empty string
""if not present.시군구코드stringDistrict code.
Can be empty string
""if not present.시군구명stringDistrict name.
Can be empty string
""if not present.시군구명_로마자stringRomanised district name.
Can be empty string
""if not present.시군구용_건물명stringDistrict (sigungu) building name, as recorded in the building and PO box DBs (건물DB, 사서함주소DB).
Can be empty string
""if not present.우편일련번호stringPostal sequence number.
Can be empty string
""if not present.우편번호stringPostal code.
Can be empty string
""if not present.우편번호_일련번호stringPostal code serial number.
Can be empty string
""if not present.영문_법정리명stringEnglish legal name.
Can be empty string
""if not present.영문읍면동명stringEnglish town name.
Can be empty string
""if not present.영문_법정읍면동명stringEnglish legal town name.
Can be empty string
""if not present.영문도로명stringEnglish road name.
Can be empty string
""if not present.영문시도명stringEnglish city name.
Can be empty string
""if not present.영문시군구명stringEnglish district name.
Can be empty string
""if not present.
Japan UPU Address Full guide
A Japanese address from the Universal Postal Union's address file for Japan. Each address carries its postal code, prefecture, city, district and neighbourhood, a block or house number range and, where present, a building and an organisation name, in kanji, hiragana and Hepburn romanisation.
- Records are number ranges, not delivery points. One record covers
str_from_numtostr_to_numunder thestr_evenoddscheme, so a single record can stand for many premises.addressis the one number selected from that range for the query, andidcarries it after a|. - There is no sub-premise detail. The finest elements are the block or house number and a building name. There is no unit, floor or sub-building field.
- The dataset carries no coordinates.
latitudeandlongitudeare always the empty string. - The API indexes every address once per script, so the same address comes back as separate records with separate
ids.scriptisHani(kanji),Hira(hiragana) orLatn(Hepburn romanisation), andlanguageisjaon all three.enis reserved for English building name synonyms and is not expected in practice.
Conventions:
line_1is the block or house number alone and repeatsaddress. There is noline_2orline_3. Build the rest of the address fromprefecture,city,district,neighbourhoodandbuilding_name.- A kanji or hiragana address is written as
〒, the postcode, a space, then prefecture, city, district, neighbourhood, number and building name run together with no separators:〒070-8006 北海道旭川市神楽六条十三丁目12-2. A romanised address is the same elements comma separated after a bare postcode:070-8006, Hokkaido, Asahikawa-shi, Kagura 6jo 13-Chome, 12-2. - On the romanised variant the API title cases the display fields and lower cases the Latin locality suffix before joining it on, giving
Asahikawa-shiandNasu-machi. The raw source fields are as supplied, so every*_transfield stays upper case. - No field is null. A value the source does not carry is the empty string, and every field is present on every record.
idisupujp_followed by a URL-safe base64 MD5 of the address line, suffixed|and the number when the record covers a range and one number has been resolved (upujp_2ry6tOmv4gOAWU2v5CVxBw|12-2).- Alongside the resolved fields the record carries the source columns under their original names:
org_*(organisation),str_*(street, number range and building),sub_*(district and neighbourhood) andloc_*(locality and administrative divisions 1 to 3). Most are empty for a typical residential address.
idstringGlobal unique internally generated identifier for an address
datasetstringIndicates the provenance of an address
countrystringFull country names (ISO 3166)
country_isostring3 letter country code (ISO 3166-1)
country_iso_2string2 letter country code (ISO 3166-1)
languagestringLanguage represented by 2 letter ISO Code (639-1)
scriptstringISO 15924 script of the address elements.
Hani= Kanji,Hira= Hiragana,Latn= Latin.addressstringAddress / House Number uniquely identifying the address along the specified street.
Can be empty string
""if not present.line_1stringThe block or house number alone, identical to
address. There is noline_2orline_3; build the rest of the address fromprefecture,city,district,neighbourhoodandbuilding_name.Can be empty string
""if not present.building_namestringPreferred building name.
Can be empty string
""if not present.neighbourhoodstringPreferred neighbourhood name.
Can be empty string
""if not present.districtstringPreferred district name.
Can be empty string
""if not present.citystringPreferred city name.
Can be empty string
""if not present.prefecturestringPreferred prefecture name.
Can be empty string
""if not present.postcodestringPreferred postal code.
Can be empty string
""if not present.latitudeLatitudeThe latitude of the address or postcode (WGS84).
Can be a positive or negative decimal. E.g.
51.5083983.Returns an empty string if no location data is available.
- string
- number
longitudeLongitudeThe longitude of the address or postcode (WGS84).
Can be a positive or negative decimal. E.g. -0.1283983
Returns an empty string if no location data is available.
- string
- number
org_idstringThe unique identifier of an organisation.
Can be empty string
""if not present.org_type_indone ofIndicates the type of organisation.
Can be empty string
""if not present.- string
- number
org_sub_type_indone ofIndicates the sub-type of the organisation.
Can be empty string
""if not present.- string
- number
org_loc_idstringLocality identifier for the organisation.
Can be empty string
""if not present.org_dis_idstringDistrict identifier for the organisation.
Can be empty string
""if not present.org_nei_idstringNeighbourhood identifier for the organisation.
Can be empty string
""if not present.org_org_idstringAssociated organisation identifier for the organisation.
Can be empty string
""if not present.org_namestringName of the organisation.
Can be empty string
""if not present.org_name_transstringTranslated name of the organisation in Latin script.
Can be empty string
""if not present.org_loc_sfxstringSuffix of the locality for the organisation.
Can be empty string
""if not present.org_loc_sfx_transstringTranslated suffix of the locality for the organisation in Latin script.
Can be empty string
""if not present.org_adrstringAddress of the organisation.
Can be empty string
""if not present.org_adr_transstringTranslated address of the organisation in Latin script.
Can be empty string
""if not present.org_po_indone ofIndicates whether the organisation has a post office box.
Can be empty string
""if not present.- string
- number
org_po_startstringPost office box number or start of the post office box range associated with the organisation.
Can be empty string
""if not present.org_po_endstringEnd of the post office box range associated with the organisation.
Can be empty string
""if not present.org_dscstringAdditional information about the organisation.
Can be empty string
""if not present.org_dsc_transstringTranslated additional information about the organisation in Latin script.
Can be empty string
""if not present.org_pcodestringPostal code for the organisation.
Can be empty string
""if not present.org_pcode_finstringFinal postal code for the organisation.
Can be empty string
""if not present.org_scriptstringScript used for the organisation name.
Hani= Kanji,Hira= Hiragana,Latn= Latin.Can be empty string
""if not present.org_languagestringLanguage used for the organisation name.
Can be empty string
""if not present.str_idstringIdentifier of the street (not unique).
Can be empty string
""if not present.str_keystringPermanent identifier of the street.
Can be empty string
""if not present.str_loc_idstringLocality identifier for the street.
Can be empty string
""if not present.str_dis_idstringDistrict identifier for the street.
Can be empty string
""if not present.str_nei_idstringNeighbourhood identifier for the street.
Can be empty string
""if not present.str_org_idstringAssociated organisation identifier for the street.
Can be empty string
""if not present.str_pfxstringPrefix of the street name.
Can be empty string
""if not present.str_pfx_transstringTranslated prefix of the street name in Latin script.
Can be empty string
""if not present.str_qlf_prestringPreceding qualifier of the street name.
Can be empty string
""if not present.str_qlf_pre_transstringTranslated preceding qualifier of the street name in Latin script.
Can be empty string
""if not present.str_qlf_sucstringSucceeding qualifier of the street name.
Can be empty string
""if not present.str_qlf_suc_transstringTranslated succeeding qualifier of the street name in Latin script.
Can be empty string
""if not present.str_namestringName of the street.
Can be empty string
""if not present.str_name_transstringTranslated name of the street in Latin script.
Can be empty string
""if not present.str_loc_sfxstringSuffix of the locality for the street.
Can be empty string
""if not present.str_loc_sfx_transstringTranslated suffix of the locality for the street in Latin script.
Can be empty string
""if not present.str_typestringType of the street.
Can be empty string
""if not present.str_type_transstringTranslated type of the street in Latin script.
Can be empty string
""if not present.str_type_abvstringAbbreviation of the street type.
Can be empty string
""if not present.str_type_abv_transstringTranslated abbreviation of the street type in Latin script.
Can be empty string
""if not present.str_adr_num_keystringPermanent identifier of the address.
Can be empty string
""if not present.str_from_numone ofLowest address number on the street.
Can be empty string
""if not present.- string
- number
str_from_unitstringLowest unit number on the street.
Can be empty string
""if not present.str_from_alphstringExtension of the lowest address number on the street.
Can be empty string
""if not present.str_to_numone ofHighest address number on the street.
Can be empty string
""if not present.- string
- number
str_to_unitstringHighest unit number on the street.
Can be empty string
""if not present.str_to_alphstringExtension of the highest address number on the street.
Can be empty string
""if not present.str_evenoddone ofIndicates whether the address range for this street contains even numbers, odd numbers, or both.
Can be empty string
""if not present.- string
- number
str_dscstringAdditional information about the street.
Can be empty string
""if not present.str_dsc_transstringTranslated additional information about the street in Latin script.
Can be empty string
""if not present.str_blg_idstringIdentifier of the building for the street.
Can be empty string
""if not present.str_blg_namestringName of the building for the street.
Can be empty string
""if not present.str_blg_name_transstringTranslated name of the building for the street in Latin script.
Can be empty string
""if not present.str_blg_typestringType of the building for the street.
Can be empty string
""if not present.str_blg_type_transstringTranslated type of the building for the street in Latin script.
Can be empty string
""if not present.str_blg_dscstringAdditional information about the building for the street.
Can be empty string
""if not present.str_blg_dsc_transstringTranslated additional information about the building for the street in Latin script.
Can be empty string
""if not present.str_ref_str_idstringIdentifier of the associated street.
Can be empty string
""if not present.str_pcodestringPostal code for the street.
Can be empty string
""if not present.str_scriptstringScript used for the street name.
Hani= Kanji,Hira= Hiragana,Latn= Latin.Can be empty string
""if not present.str_languagestringLanguage used for the street name.
Can be empty string
""if not present.sub_dis_idstringUnique identifier of the district.
Can be empty string
""if not present.sub_dis_keystringPermanent identifier of the district.
Can be empty string
""if not present.sub_loc_idstringLocality identifier for the subdivision.
Can be empty string
""if not present.sub_loc_sfxstringSuffix of the locality for the subdivision.
Can be empty string
""if not present.sub_loc_sfx_transstringTranslated suffix of the locality for the subdivision in Latin script.
Can be empty string
""if not present.sub_dis_namestringName of the district.
Can be empty string
""if not present.sub_dis_name_transstringTranslated name of the district in Latin script.
Can be empty string
""if not present.sub_dis_sfxstringSuffix of the district.
Can be empty string
""if not present.sub_dis_sfx_transstringTranslated suffix of the district in Latin script.
Can be empty string
""if not present.sub_dis_dscstringAdditional information about the district.
Can be empty string
""if not present.sub_dis_dsc_transstringTranslated additional information about the district in Latin script.
Can be empty string
""if not present.sub_dis_pcodestringPostal code for the district.
Can be empty string
""if not present.sub_dis_pcode_finstringFinal postal code for the district.
Can be empty string
""if not present.sub_nei_idstringIdentifier of the neighbourhood.
Can be empty string
""if not present.sub_nei_keystringPermanent identifier of the neighbourhood.
Can be empty string
""if not present.sub_nei_namestringName of the neighbourhood.
Can be empty string
""if not present.sub_nei_name_transstringTranslated name of the neighbourhood in Latin script.
Can be empty string
""if not present.sub_nei_sfxstringSuffix of the neighbourhood.
Can be empty string
""if not present.sub_nei_sfx_transstringTranslated suffix of the neighbourhood in Latin script.
Can be empty string
""if not present.sub_nei_zone_fromstringStart of the range of zone numbers to which the neighbourhood postal code corresponds.
Can be empty string
""if not present.sub_nei_zone_tostringEnd of the range of zone numbers to which the neighbourhood postal code corresponds.
Can be empty string
""if not present.sub_nei_dscstringAdditional information about the neighbourhood.
Can be empty string
""if not present.sub_nei_dsc_transstringTranslated additional information about the neighbourhood in Latin script.
Can be empty string
""if not present.sub_nei_pcodestringPostal code for the neighbourhood.
Can be empty string
""if not present.sub_scriptstringScript used for the subdivision names.
Hani= Kanji,Hira= Hiragana,Latn= Latin.Can be empty string
""if not present.sub_languagestringLanguage used for the subdivision names.
Can be empty string
""if not present.loc_idstringUnique identifier of the locality.
Can be empty string
""if not present.loc_keystringPermanent identifier of the locality.
Can be empty string
""if not present.loc_adm1_idstringIdentifier of administrative division 1.
Can be empty string
""if not present.loc_adm1_keystringPermanent identifier of administrative division 1.
Can be empty string
""if not present.loc_adm1_namestringName of administrative division 1.
Can be empty string
""if not present.loc_adm1_name_transstringTranslated name of administrative division 1 in Latin script.
Can be empty string
""if not present.loc_adm1_sfxstringSuffix of administrative division 1.
Can be empty string
""if not present.loc_adm1_sfx_transstringTranslated suffix of administrative division 1 in Latin script.
Can be empty string
""if not present.loc_adm1_abvstringAbbreviation of administrative division 1.
Can be empty string
""if not present.loc_adm1_abv_transstringTranslated abbreviation of administrative division 1 in Latin script.
Can be empty string
""if not present.loc_adm2_idstringIdentifier of administrative division 2.
Can be empty string
""if not present.loc_adm2_keystringPermanent identifier of administrative division 2.
Can be empty string
""if not present.loc_adm2_namestringName of administrative division 2.
Can be empty string
""if not present.loc_adm2_name_transstringTranslated name of administrative division 2 in Latin script.
Can be empty string
""if not present.loc_adm2_sfxstringSuffix of administrative division 2.
Can be empty string
""if not present.loc_adm2_sfx_transstringTranslated suffix of administrative division 2 in Latin script.
Can be empty string
""if not present.loc_adm2_abvstringAbbreviation of administrative division 2.
Can be empty string
""if not present.loc_adm2_abv_transstringTranslated abbreviation of administrative division 2 in Latin script.
Can be empty string
""if not present.loc_adm3_idstringIdentifier of administrative division 3.
Can be empty string
""if not present.loc_adm3_keystringPermanent identifier of administrative division 3.
Can be empty string
""if not present.loc_adm3_namestringName of administrative division 3.
Can be empty string
""if not present.loc_adm3_name_transstringTranslated name of administrative division 3 in Latin script.
Can be empty string
""if not present.loc_adm3_sfxstringSuffix of administrative division 3.
Can be empty string
""if not present.loc_adm3_sfx_transstringTranslated suffix of administrative division 3 in Latin script.
Can be empty string
""if not present.loc_adm3_abvstringAbbreviation of administrative division 3.
Can be empty string
""if not present.loc_adm3_abv_transstringTranslated abbreviation of administrative division 3 in Latin script.
Can be empty string
""if not present.loc_namestringName of the locality.
Can be empty string
""if not present.loc_name_transstringTranslated name of the locality in Latin script.
Can be empty string
""if not present.loc_sfxstringSuffix of the locality.
Can be empty string
""if not present.loc_sfx_transstringTranslated suffix of the locality in Latin script.
Can be empty string
""if not present.loc_pcodestringPostal code of the locality.
Can be empty string
""if not present.loc_pcode_finstringFinal postal code of the locality.
Can be empty string
""if not present.loc_dscstringAdditional information about the locality.
Can be empty string
""if not present.loc_dsc_transstringTranslated additional information about the locality in Latin script.
Can be empty string
""if not present.loc_scriptstringScript used for the locality names.
Hani= Kanji,Hira= Hiragana,Latn= Latin.Can be empty string
""if not present.loc_languagestringLanguage used for the locality names.
Can be empty string
""if not present.
- Records are number ranges, not delivery points. One record covers
Austria BEV Address Full guide
An address from the Adressregister, Austria's official address register published by the Bundesamt für Eich- und Vermessungswesen (BEV) under Open Government Data Austria.
One record per building at an address: the address (
adrcd) is joined to its building (subcd,objektnummer), municipality, locality, street and census district lookups.Field names follow the German source. House numbers are decomposed into up to four number/letter/connector parts (
hausnrzahl1-hausnrzahl4) and supplied pre-combined (hnr_adr_zusammen,hnr_geb_zusammen,address). Values sourced from list columns (kgnr,objfunktkennziffer) are returned comma-separated.idstringGlobal unique internally generated identifier for an address
datasetstringcountrystringFull country names (ISO 3166)
country_isostring3 letter country code (ISO 3166-1)
country_iso_2string2 letter country code (ISO 3166-1)
languagestringLanguage represented by 2 letter ISO Code (639-1)
addressstringComplete house number:
hnr_adr_zusammencombined withhnr_geb_zusammen.Can be empty string
""if not present.line_1stringFirst address line. The building or farmstead name (
hofname) where one is present, otherwise the street line (street name plusaddress).Can be empty string
""if not present.line_2stringSecond address line. The street line (street name plus
address) whereline_1holds the building name.Empty string
""where the address has no building name.latitudeLatitudeThe latitude of the address or postcode (WGS84).
Can be a positive or negative decimal. E.g.
51.5083983.Returns an empty string if no location data is available.
- string
- number
longitudeLongitudeThe longitude of the address or postcode (WGS84).
Can be a positive or negative decimal. E.g. -0.1283983
Returns an empty string if no location data is available.
- string
- number
adrcdstringUnique identifier of the address
kgnrstringComma-separated cadastral numbers (Katastralgemeindenummer) of the land parcels associated with the address
gkzstringMunicipality unique identifier
okzstringLocality unique identifier
plzstringPostal code
skzstringStreet unique identifier
zaehlsprengelstringCensus district unique identifier
hausnrtextstringText before house number
Can be empty string
""if not present.hausnrzahl1integerHouse number part 1
hausnrbuchstabe1stringHouse letter part 1
Can be empty string
""if not present.hausnrverbindung1stringHouse number connector 1.
-indicateshausnrzahl1tohausnrzahl2is a range.Can be empty string
""if not present.hausnrzahl2one of- string
- integer
hausnrbuchstabe2stringHouse letter part 2
Can be empty string
""if not present.hausnrbereichstringHouse number range scheme (even, odd, all or not specified), as German source text
hnr_adr_zusammenstringComplete house number of the address (combination of house number parts and letters)
Can be empty string
""if not present.gnradresseintegerParcel number used as an address when no house number is present.
0where unused.hofnamestringName of building or building complex (e.g. farmstead), title cased
Can be empty string
""if not present.rwstringEasting / X coordinate in the coordinate reference system given by
epsghwstringNorthing / Y coordinate in the coordinate reference system given by
epsgepsgintegerCoordinate reference system identifier for
rwandhwquelladressestringCoordinate accuracy level (building level, parcel level, etc.)
bestimmungsartstringCoordinate determination method (DKM, surveying office, municipality, etc.)
subcdstringSubcode to distinguish multiple buildings at the same address
objektnummerstringObject number of the building
objfunktkennzifferstringComma-separated building function codes for the building (e.g.
01pharmacy,04fire department,08school,99no function assigned)Can be empty string
""if not present.hauptadresseinteger1where this is the primary address for the associated building,0otherwisehausnrverbindung2stringHouse number connector 2
Can be empty string
""if not present.hausnrzahl3one of- string
- integer
hausnrbuchstabe3stringHouse letter part 3
Can be empty string
""if not present.hausnrverbindung3stringHouse number connector 3
Can be empty string
""if not present.hausnrzahl4one of- string
- integer
hausnrbuchstabe4stringHouse letter part 4
Can be empty string
""if not present.hausnrgebaeudebezstringBuilding description
Can be empty string
""if not present.hnr_geb_zusammenstringComplete building designation (combination of house number and building designation)
Can be empty string
""if not present.eigenschaftstringCode indicating the primary use or function of the building (e.g.
01one apartment,02two or more apartments,05office building)gemeindenamestringName of the municipality
ortsnamestringName of the locality
strassennamestringName of the street
strassennamenzusatzstringStreet type (e.g. "Allee", "Strasse")
Can be empty string
""if not present.szusadrbestintegerIndicates whether the street type is included in the street name
zustellortstringPostal town name
zustellort_idstringPostal town identifier
zaehlsprengelnamestringName of the census district
France BAN Address Full guide
Address from France's Base Adresse Nationale (BAN), the official open national address database published via Etalab.
BAN reaches house-number level only (
numero+ street + commune) - it carries no sub-premise (unit, floor, building) data.idstringGlobal unique internally generated identifier for an address
datasetstringcountrystringFull country names (ISO 3166)
country_isostring3 letter country code (ISO 3166-1)
country_iso_2string2 letter country code (ISO 3166-1)
languagestringLanguage represented by 2 letter ISO Code (639-1)
addressstringThe house number of the address (
numero), without any suffix.Can be empty string
""if not present.line_1stringFirst address line (house number, suffix, and street name).
Can be
nullif not present.line_2stringSecond address line (postcode and municipality name).
Can be
nullif not present.latitudeLatitudeThe latitude of the address or postcode (WGS84).
Can be a positive or negative decimal. E.g.
51.5083983.Returns an empty string if no location data is available.
- string
- number
longitudeLongitudeThe longitude of the address or postcode (WGS84).
Can be a positive or negative decimal. E.g. -0.1283983
Returns an empty string if no location data is available.
- string
- number
id_fantoirstringFANTOIR street identifier
numerointegerHouse number
repstringHouse number suffix / répétition (
bis,ter,quater, etc.)nom_voiestringStreet name
code_postalstring5-digit postal code
code_inseestringINSEE commune code (2-digit département + 3-digit commune)
nom_communestringMunicipality name
code_insee_ancienne_communestringINSEE code of the pre-fusion commune (for merged municipalities)
nom_ancienne_communestringName of the pre-fusion commune (for merged municipalities)
xstringLambert 93 easting coordinate
ystringLambert 93 northing coordinate
lonstringLongitude (WGS84) as returned from source data
latstringLatitude (WGS84) as returned from source data
type_positionstringPositional accuracy type (
entrée,bâtiment,parcelle,délivrance postale, etc.)aliasstringAddress alias
nom_ldstringLieu-dit (named place) label
libelle_acheminementstringPostal routing label
nom_afnorstringAFNOR-normalised street name
source_positionstringSource of position data (
commune,IGN, etc.)source_nom_voiestringSource of street name data
certification_communebooleanWhether the municipality has certified this address
cad_parcellesstringCadastral parcel reference(s)
Switzerland and Liechtenstein Address Full guide
An address in the Swisstopo dataset, which covers Switzerland and Liechtenstein.
Fields are grouped by the upstream Swisstopo product they come from: the building address directory (
gebaeudeadressverzeichnis), the street directory (strassenverzeichnis) and the official directory of towns and cities (amtovz).Records marked as multilingual upstream are split into one address per street name, so
languageidentifies the language of the street name.idstringGlobal unique internally generated identifier for an address
datasetstringcountrystringFull country names (ISO 3166)
country_isostring3 letter country code (ISO 3166-1)
country_iso_2string2 letter country code (ISO 3166-1)
languagestringLanguage represented by 2 letter ISO Code (639-1)
cantonstringCanton name, in the language of the address (e.g.
"Basel-Stadt","Grigioni","Grischun"). For Liechtenstein addresses this is the district.Can be empty string
""if not present.addressstringHouse number. Same value as
adr_number.Can be empty string
""if not present.line_1stringFirst address line. The building name where present, otherwise the street name and house number.
Can be empty string
""if not present.line_2stringSecond address line. The street name and house number where
line_1holds a building name.Can be empty string
""if not present.latitudeLatitudeThe latitude of the address or postcode (WGS84).
Can be a positive or negative decimal. E.g.
51.5083983.Returns an empty string if no location data is available.
- string
- number
longitudeLongitudeThe longitude of the address or postcode (WGS84).
Can be a positive or negative decimal. E.g. -0.1283983
Returns an empty string if no location data is available.
- string
- number
adr_egaidintegerFederal building address identifier (Eidgenössischer Gebäudeadressidentifikator).
str_esidintegerFederal street identifier (Eidgenössischer Strassenidentifikator). Joins the address to the street directory.
bdg_egidintegerFederal building identifier (Eidgenössischer Gebäudeidentifikator).
adr_edidintegerEntrance identifier within the building.
stn_labelstringStreet name label. For French and Italian addresses the leading street type is lowercased (e.g.
"rue de la Gare").adr_numberstringHouse/address number (e.g.
"12","12A").Can be empty string
""if not present.bdg_categorystringBuilding category from the Federal Building and Dwelling Register (GWR), e.g.
"residential","non_residential".bdg_namestringBuilding name.
Can be empty string
""if not present.zip_labelstringPostal code and locality label (e.g.
"8001 Zürich").com_fosnrintegerFederal municipality number assigned by the Federal Statistical Office (FSO/BFS).
com_namestringMunicipality name.
com_cantonstringCanton abbreviation (e.g.
"ZH","BE").Can be empty string
""if not present.adr_statusstringAddress status from the GWR, e.g.
"real","projected".adr_officialbooleanWhether the address is an official address.
adr_modifiedstringDate the address record was last modified, formatted
DD.MM.YYYY.adr_eastingstringEasting coordinate of the address in the Swiss coordinate system CH1903+/LV95 (EPSG:2056), in metres.
adr_northingstringNorthing coordinate of the address in the Swiss coordinate system CH1903+/LV95 (EPSG:2056), in metres.
str_typestringStreet type, e.g.
"Street","Area".str_statusstringStreet status, e.g.
"real","projected".str_officialbooleanWhether the street name is official.
str_modifiedstringDate the street record was last modified, formatted
DD.MM.YYYY.str_eastingstringEasting coordinate of the street centroid in the Swiss coordinate system CH1903+/LV95 (EPSG:2056), in metres.
str_northingstringNorthing coordinate of the street centroid in the Swiss coordinate system CH1903+/LV95 (EPSG:2056), in metres.
ortschaftsnamestringLocality name from the Official Directory of Towns and Cities (Amtliches Ortschaftenverzeichnis).
Can be empty string
""if the address does not match a locality record.plz4string4-digit Swiss postal code, zero padded.
Can be empty string
""if the address does not match a locality record.zusatzzifferstring2-digit supplementary code distinguishing localities that share a 4-digit postal code.
nullif the address does not match a locality record.zip_idintegerUnique identifier for the postal code record.
nullif the address does not match a locality record.gemeindenamestringMunicipality name (Gemeindename) from the locality directory.
nullif the address does not match a locality record.bfs_nrintegerFederal municipality number assigned by the Federal Statistical Office (BFS-Nr).
nullif the address does not match a locality record.kantonskürzelstringCanton abbreviation from the locality directory (e.g.
"ZH","GE").Can be empty string
""if not present.sprachestringLanguage of the address, mirroring
language.validitystringDate the postal code record became valid, formatted
YYYY-MM-DD.
countnumberThe number of addresses we matched to the input. We return the closest match by default.
fitnumberA score represented as number between 1 and 0. Fit compares the address elements present in your query against the matching address elements. It does not incorporate elements you have not presented in the score. A partial address (e.g. 12 Pye Green Road) will have a fit of 1 even though it is missing post town and postcode. Its confidence score will be less than 1 however because it is missing some crucial elements.
confidencenumberA confidence score represented as number between 1 and 0. 1 indicates a full match. 0 indicates no complete matching elements.
organisation_matchstringMatch indicator for the organisation
premise_matchstringMatch indicator for the premise
postcode_matchstringMatch indicator for the postcode
thoroughfare_matchstringMatch indicator for the street
locality_matchstringMatch indicator for the locality
post_town_matchstringMatch indicator for the post_town
No Address Match
querystringOriginally submitted query
matchobjectNearest matching address
countnumberfitnumberconfidencenumberorganisation_matchstringpremise_matchstringpostcode_matchstringthoroughfare_matchstringlocality_matchstringpost_town_matchstring