--- title: "Resolve Address" method: GET path: "/autocomplete/addresses/{address}/gbr" tags: ["Address Search"] --- # Resolve Address `GET /autocomplete/addresses/{address}/gbr` Resolves an address autocompletion by its address ID. Resolved addresses (including global addresses) are returned in a UK format (up to 3 address lines) using UK nomenclature (like postcode and county). ## Path parameters - `address` string, required ## Query parameters - `api_key` string - `tags` string ## Response `200` Success - GbrResolveAddressResponse - `code` 2000, required - `message` 'Success', required - `result` union, required - PafAddress — Standard UK Address. Also known as a Postcode Address File (PAF) address is defined by Royal Mail and updated on a daily cadence. A PAF Address represents a deliverable endpoint. - `id` string, required — Global unique internally generated identifier for an address - `dataset` 'paf', required — Indicates the provenance of an address - `country_iso` 'GBR' | 'IMN' | 'JEY' | 'GGY', required — 3 letter country code (ISO 3166-1) - `country_iso_2` 'GB' | 'IM' | 'JE' | 'GG', required — 2 letter country code (ISO 3166-1) - `country` 'England' | 'Scotland' | 'Wales' | 'Northern Ireland' | 'Jersey' | 'Guernsey' | 'Isle of Man', required — Full country names (ISO 3166) - `language` 'en', required — Language represented by 2 letter ISO Code (639-1) - `line_1` string, required — First Address Line. Often contains premise and thoroughfare information. In the case of a commercial premise, the first line is always the full name of the registered organisation. Never empty. - `line_2` string, required — Second Address Line. Often contains thoroughfare and locality information. May be empty - `line_3` string, required — Third address line. May be empty. - `post_town` string, required — **Filter by Town or City" A Post Town is mandatory for delivery of mail to a Delivery Point. This is not necessarily the nearest town geographically, but a routing instruction to the Royal Mail delivery office sorting mail for that Delivery Point. A Post Town will always be present in every address, and for some Localities the Post Town will be the only locality element present. - `postcode` string, required — Correctly formatted postcode. Capitalised and spaced. - `county` string, required — Since postal, administrative or traditional counties may not apply to some addresses, the county field is designed to return whatever county data is available. Normally, the postal county is returned. If this is not present, the county field will fall back to the administrative county. If the administrative county is also not present, the county field will fall back to the traditional county. May be empty in cases where no administrative, postal or traditional county present. - `county_code` string, required — Short code representing the county or province. May be empty (`""`) - `uprn` string, required — UPRN 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. 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_INTEGER` in 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. - `udprn` integer, required — UDPRN 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. - `umprn` union, required — A 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 — If premise is not multiple occupancy, this will be an empty string - number — If premise is multiple occupancy, this will be an integer - `postcode_outward` string, required — The 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’. - `postcode_inward` string, required — The 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. - `dependant_locality` string, required — When the same thoroughfare name reoccurs in a Post town, it may not be possible to make it dependant on a dependant thoroughfare. In this case the thoroughfare is dependant on a locality. For example if we want to find 1 Back Lane in Huddersfield we see that there are three. - `double_dependant_locality` string, required — Used to supplement Dependant Locality. A Double Dependant Locality supplied along with a Dependant Locality if the Dependant Locality exists twice in the same locality. - `thoroughfare` string, required — Also known as the street or road name. In general each Thoroughfare Name will have a separate Postcode. Longer Thoroughfares with high number ranges often have multiple Postcodes covering the entire length of the road, with breaks at suitable points e.g. junctions or natural breaks in the road. - `dependant_thoroughfare` string, required — Used to supplement thoroughfare. When a thoroughfare name is used twice in the same Post Town, the dependant thoroughfare is added to uniquely indentify a delivery point. - `building_number` string, required — Number to identify premise on a thoroughfare or dependant thoroughfare. - `building_name` string, required — Name of residential or commercial premise. Examples: - The Manor - 1-2 - A - 12A - K - Victoria House - `sub_building_name` string, required — When a premise is split into individual units such as flats, apartments or business units. Cannot be present without either building_name or building_number. E.g. Flat 1, A, 10B - `po_box` string, required — When the PO Box Number field is populated it will contain PO BOX nnnnnn where n represents the PO Box number. Note that the PO Box details can occasionally consist of a combination of numbers and letters. PO Box Numbers are only allocated to Large Users. - `department_name` string, required — Used to supplment Organisation Name to identify a deparment within the organisation. - `organisation_name` string, required — Used to supplment Organisation Name to identify a deparment within the organisation - `postcode_type` 'S' | 'L' | '', required — This indicates the type of user. It can only take the values 'S' or 'L' indicating small or large respectively. Large User Postcodes. These are assigned to one single address either due to the large volume of mail received at that address, or because a PO Box or Selectapost service has been set up. Small User Postcodes. These identify a group of Delivery Points. On average there are 19 Delivery Points per Postcode. However this can vary between 1 and, in some cases, 100. There will never be more than 100 Delivery Points on a Postcode. - `su_organisation_indicator` string, required — Small User Organisation Indicator can have the values 'Y' or space. A value of 'Y' indicates that a Small User Organisation is present at this address. - `delivery_point_suffix` string, required — A unique Royal Mail 2-character code (the first numeric & the second alphabetical), which, when added to the Postcode, enables each live Delivery Point to be uniquely identified. Once the Delivery Point is deleted from PAF the DPS may be reused (although they aren’t reused until all remaining Delivery Points in the range have been allocated). The DPS for a Large User is always '1A' as each Large User has its own Postcode. - `premise` string, required — A pre-computed string which sensibly combines building_number, building_name and sub_building_name. building_number, building_name and sub_building_name represent raw data from Royal Mail's and can be difficult to parse if you are unaware of how the Postcode Address File premise fields work together. For this reason, we also provide a pre-computed premise field which intelligently gathers these points into a single, simple premise string. This field is ideal if you want to pull premise information and thoroughfare information separately instead of using our address lines data. - `administrative_county` string, required — The 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. Data source: ONS - `postal_county` string, required — Postal counties were used for the distribution of mail before the Postcode system was introduced in the 1970s. The Former Postal County was the Administrative County at the time. This data rarely changes. May be empty. - `traditional_county` string, required — Traditional counties are provided by the Association of British Counties. It is historical data, and can date from the 1800s. May be empty. - `district` string, required — The current district/unitary authority to which the postcode has been assigned. - `ward` string, required — The current administrative/electoral area to which the postcode has been assigned. May be empty for a small number of addresses. - `longitude` union, required — The longitude of the postcode (WGS84/ETRS89). Can be a positive or negative decimal. E.g. -0.1283983 Returns an empty string if no location data is available. - string — Empty string `""` if not available - number — Represents longitude - `latitude` union, required — The latitude of the postcode (WGS84/ETRS89). Can be a positive or negative decimal. E.g. `51.5083983`. Returns an empty string if no location data is available. - string — Empty string `""` if not available - number — Represents latitude - `eastings` union, required — Eastings reference using the [Ordnance Survey National Grid reference system](https://en.wikipedia.org/wiki/Ordnance_Survey_National_Grid). Northern Ireland Eastings uses the [Irish Grid Reference System](https://en.wikipedia.org/wiki/Irish_grid_reference_system). Metres from origin. E.g. `550458` Returns an empty string if no location data is available. Otherwise a number is returned. - string — Empty string `""` if not available - number — Metres offset east from origin - `northings` union, required — Northings reference using the [Ordnance Survey National Grid reference system](https://en.wikipedia.org/wiki/Ordnance_Survey_National_Grid) Northern Ireland Northings uses the [Irish Grid Reference System](https://en.wikipedia.org/wiki/Irish_grid_reference_system) Metres from origin. E.g. `180458` Returns an empty string if no location data is available. Otherwise a number is returned - string — Empty string `""` if not available - number — Metres offset north from origin - MrAddress — Subdivision of a Postcode Address File address. Also known as a Multiple Residence or Multiple Occupancy address. A Multiple Residence address does not have its own deliverable endpoint. Instead it relies on the deliverable endpoint of a parent address, where the parent address can be found on the main Postcode Address File. - `id` string, required — Global unique internally generated identifier for an address - `dataset` 'mr', required — Indicates the provenance of an address - `country_iso` 'GBR' | 'IMN' | 'JEY' | 'GGY', required — 3 letter country code (ISO 3166-1) - `country_iso_2` 'GB' | 'IM' | 'JE' | 'GG', required — 2 letter country code (ISO 3166-1) - `country` 'England' | 'Scotland' | 'Wales' | 'Northern Ireland' | 'Jersey' | 'Guernsey' | 'Isle of Man', required — Full country names (ISO 3166) - `language` 'en', required — Language represented by 2 letter ISO Code (639-1) - `line_1` string, required — First Address Line. Often contains premise and thoroughfare information. In the case of a commercial premise, the first line is always the full name of the registered organisation. Never empty. - `line_2` string, required — Second Address Line. Often contains thoroughfare and locality information. May be empty - `line_3` string, required — Third address line. May be empty. - `post_town` string, required — **Filter by Town or City" A Post Town is mandatory for delivery of mail to a Delivery Point. This is not necessarily the nearest town geographically, but a routing instruction to the Royal Mail delivery office sorting mail for that Delivery Point. A Post Town will always be present in every address, and for some Localities the Post Town will be the only locality element present. - `postcode` string, required — Correctly formatted postcode. Capitalised and spaced. - `county` string, required — Since postal, administrative or traditional counties may not apply to some addresses, the county field is designed to return whatever county data is available. Normally, the postal county is returned. If this is not present, the county field will fall back to the administrative county. If the administrative county is also not present, the county field will fall back to the traditional county. May be empty in cases where no administrative, postal or traditional county present. - `county_code` string, required — Short code representing the county or province. May be empty (`""`) - `uprn` string, required — UPRN 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. 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_INTEGER` in 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. - `udprn` integer, required — UDPRN 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. - `umprn` union, required — A 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 — If premise is not multiple occupancy, this will be an empty string - number — If premise is multiple occupancy, this will be an integer - `postcode_outward` string, required — The 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’. - `postcode_inward` string, required — The 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. - `dependant_locality` string, required — When the same thoroughfare name reoccurs in a Post town, it may not be possible to make it dependant on a dependant thoroughfare. In this case the thoroughfare is dependant on a locality. For example if we want to find 1 Back Lane in Huddersfield we see that there are three. - `double_dependant_locality` string, required — Used to supplement Dependant Locality. A Double Dependant Locality supplied along with a Dependant Locality if the Dependant Locality exists twice in the same locality. - `thoroughfare` string, required — Also known as the street or road name. In general each Thoroughfare Name will have a separate Postcode. Longer Thoroughfares with high number ranges often have multiple Postcodes covering the entire length of the road, with breaks at suitable points e.g. junctions or natural breaks in the road. - `dependant_thoroughfare` string, required — Used to supplement thoroughfare. When a thoroughfare name is used twice in the same Post Town, the dependant thoroughfare is added to uniquely indentify a delivery point. - `building_number` string, required — Number to identify premise on a thoroughfare or dependant thoroughfare. - `building_name` string, required — Name of residential or commercial premise. Examples: - The Manor - 1-2 - A - 12A - K - Victoria House - `sub_building_name` string, required — When a premise is split into individual units such as flats, apartments or business units. Cannot be present without either building_name or building_number. E.g. Flat 1, A, 10B - `po_box` string, required — When the PO Box Number field is populated it will contain PO BOX nnnnnn where n represents the PO Box number. Note that the PO Box details can occasionally consist of a combination of numbers and letters. PO Box Numbers are only allocated to Large Users. - `department_name` string, required — Used to supplment Organisation Name to identify a deparment within the organisation. - `organisation_name` string, required — Used to supplment Organisation Name to identify a deparment within the organisation - `postcode_type` 'S' | 'L' | '', required — This indicates the type of user. It can only take the values 'S' or 'L' indicating small or large respectively. Large User Postcodes. These are assigned to one single address either due to the large volume of mail received at that address, or because a PO Box or Selectapost service has been set up. Small User Postcodes. These identify a group of Delivery Points. On average there are 19 Delivery Points per Postcode. However this can vary between 1 and, in some cases, 100. There will never be more than 100 Delivery Points on a Postcode. - `su_organisation_indicator` string, required — Small User Organisation Indicator can have the values 'Y' or space. A value of 'Y' indicates that a Small User Organisation is present at this address. - `delivery_point_suffix` string, required — A unique Royal Mail 2-character code (the first numeric & the second alphabetical), which, when added to the Postcode, enables each live Delivery Point to be uniquely identified. Once the Delivery Point is deleted from PAF the DPS may be reused (although they aren’t reused until all remaining Delivery Points in the range have been allocated). The DPS for a Large User is always '1A' as each Large User has its own Postcode. - `premise` string, required — A pre-computed string which sensibly combines building_number, building_name and sub_building_name. building_number, building_name and sub_building_name represent raw data from Royal Mail's and can be difficult to parse if you are unaware of how the Postcode Address File premise fields work together. For this reason, we also provide a pre-computed premise field which intelligently gathers these points into a single, simple premise string. This field is ideal if you want to pull premise information and thoroughfare information separately instead of using our address lines data. - `administrative_county` string, required — The 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. Data source: ONS - `postal_county` string, required — Postal counties were used for the distribution of mail before the Postcode system was introduced in the 1970s. The Former Postal County was the Administrative County at the time. This data rarely changes. May be empty. - `traditional_county` string, required — Traditional counties are provided by the Association of British Counties. It is historical data, and can date from the 1800s. May be empty. - `district` string, required — The current district/unitary authority to which the postcode has been assigned. - `ward` string, required — The current administrative/electoral area to which the postcode has been assigned. May be empty for a small number of addresses. - `longitude` union, required — The longitude of the postcode (WGS84/ETRS89). Can be a positive or negative decimal. E.g. -0.1283983 Returns an empty string if no location data is available. - string — Empty string `""` if not available - number — Represents longitude - `latitude` union, required — The latitude of the postcode (WGS84/ETRS89). Can be a positive or negative decimal. E.g. `51.5083983`. Returns an empty string if no location data is available. - string — Empty string `""` if not available - number — Represents latitude - `eastings` union, required — Eastings reference using the [Ordnance Survey National Grid reference system](https://en.wikipedia.org/wiki/Ordnance_Survey_National_Grid). Northern Ireland Eastings uses the [Irish Grid Reference System](https://en.wikipedia.org/wiki/Irish_grid_reference_system). Metres from origin. E.g. `550458` Returns an empty string if no location data is available. Otherwise a number is returned. - string — Empty string `""` if not available - number — Metres offset east from origin - `northings` union, required — Northings reference using the [Ordnance Survey National Grid reference system](https://en.wikipedia.org/wiki/Ordnance_Survey_National_Grid) Northern Ireland Northings uses the [Irish Grid Reference System](https://en.wikipedia.org/wiki/Irish_grid_reference_system) Metres from origin. E.g. `180458` Returns an empty string if no location data is available. Otherwise a number is returned - string — Empty string `""` if not available - number — Metres offset north from origin - WelshPafAddress — Welsh language alternative for a PAF Address - `id` string, required — Global unique internally generated identifier for an address - `dataset` 'pafw', required — Indicates the provenance of an address - `country_iso` 'GBR', required — 3 letter country code (ISO 3166-1) - `country_iso_2` 'GB', required — 2 letter country code (ISO 3166-1) - `country` 'Wales', required — Full country names (ISO 3166) - `language` 'cy', required — Language represented by 2 letter ISO Code (639-1) - `line_1` string, required — First Address Line. Often contains premise and thoroughfare information. In the case of a commercial premise, the first line is always the full name of the registered organisation. Never empty. - `line_2` string, required — Second Address Line. Often contains thoroughfare and locality information. May be empty - `line_3` string, required — Third address line. May be empty. - `post_town` string, required — **Filter by Town or City" A Post Town is mandatory for delivery of mail to a Delivery Point. This is not necessarily the nearest town geographically, but a routing instruction to the Royal Mail delivery office sorting mail for that Delivery Point. A Post Town will always be present in every address, and for some Localities the Post Town will be the only locality element present. - `postcode` string, required — Correctly formatted postcode. Capitalised and spaced. - `county` string, required — Since postal, administrative or traditional counties may not apply to some addresses, the county field is designed to return whatever county data is available. Normally, the postal county is returned. If this is not present, the county field will fall back to the administrative county. If the administrative county is also not present, the county field will fall back to the traditional county. May be empty in cases where no administrative, postal or traditional county present. - `county_code` string, required — Short code representing the county or province. May be empty (`""`) - `uprn` string, required — UPRN 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. 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_INTEGER` in 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. - `udprn` integer, required — UDPRN 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. - `umprn` union, required — A 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 — If premise is not multiple occupancy, this will be an empty string - number — If premise is multiple occupancy, this will be an integer - `postcode_outward` string, required — The 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’. - `postcode_inward` string, required — The 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. - `dependant_locality` string, required — When the same thoroughfare name reoccurs in a Post town, it may not be possible to make it dependant on a dependant thoroughfare. In this case the thoroughfare is dependant on a locality. For example if we want to find 1 Back Lane in Huddersfield we see that there are three. - `double_dependant_locality` string, required — Used to supplement Dependant Locality. A Double Dependant Locality supplied along with a Dependant Locality if the Dependant Locality exists twice in the same locality. - `thoroughfare` string, required — Also known as the street or road name. In general each Thoroughfare Name will have a separate Postcode. Longer Thoroughfares with high number ranges often have multiple Postcodes covering the entire length of the road, with breaks at suitable points e.g. junctions or natural breaks in the road. - `dependant_thoroughfare` string, required — Used to supplement thoroughfare. When a thoroughfare name is used twice in the same Post Town, the dependant thoroughfare is added to uniquely indentify a delivery point. - `building_number` string, required — Number to identify premise on a thoroughfare or dependant thoroughfare. - `building_name` string, required — Name of residential or commercial premise. Examples: - The Manor - 1-2 - A - 12A - K - Victoria House - `sub_building_name` string, required — When a premise is split into individual units such as flats, apartments or business units. Cannot be present without either building_name or building_number. E.g. Flat 1, A, 10B - `po_box` string, required — When the PO Box Number field is populated it will contain PO BOX nnnnnn where n represents the PO Box number. Note that the PO Box details can occasionally consist of a combination of numbers and letters. PO Box Numbers are only allocated to Large Users. - `department_name` string, required — Used to supplment Organisation Name to identify a deparment within the organisation. - `organisation_name` string, required — Used to supplment Organisation Name to identify a deparment within the organisation - `postcode_type` 'S' | 'L' | '', required — This indicates the type of user. It can only take the values 'S' or 'L' indicating small or large respectively. Large User Postcodes. These are assigned to one single address either due to the large volume of mail received at that address, or because a PO Box or Selectapost service has been set up. Small User Postcodes. These identify a group of Delivery Points. On average there are 19 Delivery Points per Postcode. However this can vary between 1 and, in some cases, 100. There will never be more than 100 Delivery Points on a Postcode. - `su_organisation_indicator` string, required — Small User Organisation Indicator can have the values 'Y' or space. A value of 'Y' indicates that a Small User Organisation is present at this address. - `delivery_point_suffix` string, required — A unique Royal Mail 2-character code (the first numeric & the second alphabetical), which, when added to the Postcode, enables each live Delivery Point to be uniquely identified. Once the Delivery Point is deleted from PAF the DPS may be reused (although they aren’t reused until all remaining Delivery Points in the range have been allocated). The DPS for a Large User is always '1A' as each Large User has its own Postcode. - `premise` string, required — A pre-computed string which sensibly combines building_number, building_name and sub_building_name. building_number, building_name and sub_building_name represent raw data from Royal Mail's and can be difficult to parse if you are unaware of how the Postcode Address File premise fields work together. For this reason, we also provide a pre-computed premise field which intelligently gathers these points into a single, simple premise string. This field is ideal if you want to pull premise information and thoroughfare information separately instead of using our address lines data. - `administrative_county` string, required — The 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. Data source: ONS - `postal_county` string, required — Postal counties were used for the distribution of mail before the Postcode system was introduced in the 1970s. The Former Postal County was the Administrative County at the time. This data rarely changes. May be empty. - `traditional_county` string, required — Traditional counties are provided by the Association of British Counties. It is historical data, and can date from the 1800s. May be empty. - `district` string, required — The current district/unitary authority to which the postcode has been assigned. - `ward` string, required — The current administrative/electoral area to which the postcode has been assigned. May be empty for a small number of addresses. - `longitude` union, required — The longitude of the postcode (WGS84/ETRS89). Can be a positive or negative decimal. E.g. -0.1283983 Returns an empty string if no location data is available. - string — Empty string `""` if not available - number — Represents longitude - `latitude` union, required — The latitude of the postcode (WGS84/ETRS89). Can be a positive or negative decimal. E.g. `51.5083983`. Returns an empty string if no location data is available. - string — Empty string `""` if not available - number — Represents latitude - `eastings` union, required — Eastings reference using the [Ordnance Survey National Grid reference system](https://en.wikipedia.org/wiki/Ordnance_Survey_National_Grid). Northern Ireland Eastings uses the [Irish Grid Reference System](https://en.wikipedia.org/wiki/Irish_grid_reference_system). Metres from origin. E.g. `550458` Returns an empty string if no location data is available. Otherwise a number is returned. - string — Empty string `""` if not available - number — Metres offset east from origin - `northings` union, required — Northings reference using the [Ordnance Survey National Grid reference system](https://en.wikipedia.org/wiki/Ordnance_Survey_National_Grid) Northern Ireland Northings uses the [Irish Grid Reference System](https://en.wikipedia.org/wiki/Irish_grid_reference_system) Metres from origin. E.g. `180458` Returns an empty string if no location data is available. Otherwise a number is returned - string — Empty string `""` if not available - number — Metres offset north from origin - PafAliasAddress — PAF Aliases addresses are alternate ways to present an address already found on PAF. Alias data is information the public chooses to use when addressing mail, but which isn’t actually required for delivery purposes. The Alias data contains records of alternative address details that are included in the address but not necessarily needed for delivery purposes. - `id` string, required — Global unique internally generated identifier for an address - `dataset` 'pafa', required — Indicates the provenance of an address - `country_iso` 'GBR' | 'IMN' | 'JEY' | 'GGY', required — 3 letter country code (ISO 3166-1) - `country_iso_2` 'GB' | 'IM' | 'JE' | 'GG', required — 2 letter country code (ISO 3166-1) - `country` 'England' | 'Scotland' | 'Wales' | 'Northern Ireland' | 'Jersey' | 'Guernsey' | 'Isle of Man', required — Full country names (ISO 3166) - `language` 'en', required — Language represented by 2 letter ISO Code (639-1) - `line_1` string, required — First Address Line. Often contains premise and thoroughfare information. In the case of a commercial premise, the first line is always the full name of the registered organisation. Never empty. - `line_2` string, required — Second Address Line. Often contains thoroughfare and locality information. May be empty - `line_3` string, required — Third address line. May be empty. - `post_town` string, required — **Filter by Town or City" A Post Town is mandatory for delivery of mail to a Delivery Point. This is not necessarily the nearest town geographically, but a routing instruction to the Royal Mail delivery office sorting mail for that Delivery Point. A Post Town will always be present in every address, and for some Localities the Post Town will be the only locality element present. - `postcode` string, required — Correctly formatted postcode. Capitalised and spaced. - `county` string, required — Since postal, administrative or traditional counties may not apply to some addresses, the county field is designed to return whatever county data is available. Normally, the postal county is returned. If this is not present, the county field will fall back to the administrative county. If the administrative county is also not present, the county field will fall back to the traditional county. May be empty in cases where no administrative, postal or traditional county present. - `county_code` string, required — Short code representing the county or province. May be empty (`""`) - `uprn` string, required — UPRN 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. 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_INTEGER` in 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. - `udprn` integer, required — UDPRN 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. - `umprn` union, required — A 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 — If premise is not multiple occupancy, this will be an empty string - number — If premise is multiple occupancy, this will be an integer - `postcode_outward` string, required — The 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’. - `postcode_inward` string, required — The 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. - `dependant_locality` string, required — When the same thoroughfare name reoccurs in a Post town, it may not be possible to make it dependant on a dependant thoroughfare. In this case the thoroughfare is dependant on a locality. For example if we want to find 1 Back Lane in Huddersfield we see that there are three. - `double_dependant_locality` string, required — Used to supplement Dependant Locality. A Double Dependant Locality supplied along with a Dependant Locality if the Dependant Locality exists twice in the same locality. - `thoroughfare` string, required — Also known as the street or road name. In general each Thoroughfare Name will have a separate Postcode. Longer Thoroughfares with high number ranges often have multiple Postcodes covering the entire length of the road, with breaks at suitable points e.g. junctions or natural breaks in the road. - `dependant_thoroughfare` string, required — Used to supplement thoroughfare. When a thoroughfare name is used twice in the same Post Town, the dependant thoroughfare is added to uniquely indentify a delivery point. - `building_number` string, required — Number to identify premise on a thoroughfare or dependant thoroughfare. - `building_name` string, required — Name of residential or commercial premise. Examples: - The Manor - 1-2 - A - 12A - K - Victoria House - `sub_building_name` string, required — When a premise is split into individual units such as flats, apartments or business units. Cannot be present without either building_name or building_number. E.g. Flat 1, A, 10B - `po_box` string, required — When the PO Box Number field is populated it will contain PO BOX nnnnnn where n represents the PO Box number. Note that the PO Box details can occasionally consist of a combination of numbers and letters. PO Box Numbers are only allocated to Large Users. - `department_name` string, required — Used to supplment Organisation Name to identify a deparment within the organisation. - `organisation_name` string, required — Used to supplment Organisation Name to identify a deparment within the organisation - `postcode_type` 'S' | 'L' | '', required — This indicates the type of user. It can only take the values 'S' or 'L' indicating small or large respectively. Large User Postcodes. These are assigned to one single address either due to the large volume of mail received at that address, or because a PO Box or Selectapost service has been set up. Small User Postcodes. These identify a group of Delivery Points. On average there are 19 Delivery Points per Postcode. However this can vary between 1 and, in some cases, 100. There will never be more than 100 Delivery Points on a Postcode. - `su_organisation_indicator` string, required — Small User Organisation Indicator can have the values 'Y' or space. A value of 'Y' indicates that a Small User Organisation is present at this address. - `delivery_point_suffix` string, required — A unique Royal Mail 2-character code (the first numeric & the second alphabetical), which, when added to the Postcode, enables each live Delivery Point to be uniquely identified. Once the Delivery Point is deleted from PAF the DPS may be reused (although they aren’t reused until all remaining Delivery Points in the range have been allocated). The DPS for a Large User is always '1A' as each Large User has its own Postcode. - `premise` string, required — A pre-computed string which sensibly combines building_number, building_name and sub_building_name. building_number, building_name and sub_building_name represent raw data from Royal Mail's and can be difficult to parse if you are unaware of how the Postcode Address File premise fields work together. For this reason, we also provide a pre-computed premise field which intelligently gathers these points into a single, simple premise string. This field is ideal if you want to pull premise information and thoroughfare information separately instead of using our address lines data. - `administrative_county` string, required — The 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. Data source: ONS - `postal_county` string, required — Postal counties were used for the distribution of mail before the Postcode system was introduced in the 1970s. The Former Postal County was the Administrative County at the time. This data rarely changes. May be empty. - `traditional_county` string, required — Traditional counties are provided by the Association of British Counties. It is historical data, and can date from the 1800s. May be empty. - `district` string, required — The current district/unitary authority to which the postcode has been assigned. - `ward` string, required — The current administrative/electoral area to which the postcode has been assigned. May be empty for a small number of addresses. - `longitude` union, required — The longitude of the postcode (WGS84/ETRS89). Can be a positive or negative decimal. E.g. -0.1283983 Returns an empty string if no location data is available. - string — Empty string `""` if not available - number — Represents longitude - `latitude` union, required — The latitude of the postcode (WGS84/ETRS89). Can be a positive or negative decimal. E.g. `51.5083983`. Returns an empty string if no location data is available. - string — Empty string `""` if not available - number — Represents latitude - `eastings` union, required — Eastings reference using the [Ordnance Survey National Grid reference system](https://en.wikipedia.org/wiki/Ordnance_Survey_National_Grid). Northern Ireland Eastings uses the [Irish Grid Reference System](https://en.wikipedia.org/wiki/Irish_grid_reference_system). Metres from origin. E.g. `550458` Returns an empty string if no location data is available. Otherwise a number is returned. - string — Empty string `""` if not available - number — Metres offset east from origin - `northings` union, required — Northings reference using the [Ordnance Survey National Grid reference system](https://en.wikipedia.org/wiki/Ordnance_Survey_National_Grid) Northern Ireland Northings uses the [Irish Grid Reference System](https://en.wikipedia.org/wiki/Irish_grid_reference_system) Metres from origin. E.g. `180458` Returns an empty string if no location data is available. Otherwise a number is returned - string — Empty string `""` if not available - number — Metres offset north from origin - NybAddress — A UK premise under construction and currently not occupied. This dataset is updated by Royal Mail on a monthly cadence. - `id` string, required — Global unique internally generated identifier for an address - `dataset` 'nyb', required — Indicates the provenance of an address - `country_iso` 'GBR' | 'IMN' | 'JEY' | 'GGY', required — 3 letter country code (ISO 3166-1) - `country_iso_2` 'GB' | 'IM' | 'JE' | 'GG', required — 2 letter country code (ISO 3166-1) - `country` 'England' | 'Scotland' | 'Wales' | 'Northern Ireland' | 'Jersey' | 'Guernsey' | 'Isle of Man', required — Full country names (ISO 3166) - `language` 'en', required — Language represented by 2 letter ISO Code (639-1) - `line_1` string, required — First Address Line. Often contains premise and thoroughfare information. In the case of a commercial premise, the first line is always the full name of the registered organisation. Never empty. - `line_2` string, required — Second Address Line. Often contains thoroughfare and locality information. May be empty - `line_3` string, required — Third address line. May be empty. - `post_town` string, required — **Filter by Town or City" A Post Town is mandatory for delivery of mail to a Delivery Point. This is not necessarily the nearest town geographically, but a routing instruction to the Royal Mail delivery office sorting mail for that Delivery Point. A Post Town will always be present in every address, and for some Localities the Post Town will be the only locality element present. - `postcode` string, required — Correctly formatted postcode. Capitalised and spaced. - `county` string, required — Since postal, administrative or traditional counties may not apply to some addresses, the county field is designed to return whatever county data is available. Normally, the postal county is returned. If this is not present, the county field will fall back to the administrative county. If the administrative county is also not present, the county field will fall back to the traditional county. May be empty in cases where no administrative, postal or traditional county present. - `county_code` string, required — Short code representing the county or province. May be empty (`""`) - `uprn` string, required — UPRN 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. 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_INTEGER` in 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. - `udprn` integer, required — UDPRN 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. - `umprn` union, required — A 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 — If premise is not multiple occupancy, this will be an empty string - number — If premise is multiple occupancy, this will be an integer - `postcode_outward` string, required — The 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’. - `postcode_inward` string, required — The 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. - `dependant_locality` string, required — When the same thoroughfare name reoccurs in a Post town, it may not be possible to make it dependant on a dependant thoroughfare. In this case the thoroughfare is dependant on a locality. For example if we want to find 1 Back Lane in Huddersfield we see that there are three. - `double_dependant_locality` string, required — Used to supplement Dependant Locality. A Double Dependant Locality supplied along with a Dependant Locality if the Dependant Locality exists twice in the same locality. - `thoroughfare` string, required — Also known as the street or road name. In general each Thoroughfare Name will have a separate Postcode. Longer Thoroughfares with high number ranges often have multiple Postcodes covering the entire length of the road, with breaks at suitable points e.g. junctions or natural breaks in the road. - `dependant_thoroughfare` string, required — Used to supplement thoroughfare. When a thoroughfare name is used twice in the same Post Town, the dependant thoroughfare is added to uniquely indentify a delivery point. - `building_number` string, required — Number to identify premise on a thoroughfare or dependant thoroughfare. - `building_name` string, required — Name of residential or commercial premise. Examples: - The Manor - 1-2 - A - 12A - K - Victoria House - `sub_building_name` string, required — When a premise is split into individual units such as flats, apartments or business units. Cannot be present without either building_name or building_number. E.g. Flat 1, A, 10B - `po_box` string, required — When the PO Box Number field is populated it will contain PO BOX nnnnnn where n represents the PO Box number. Note that the PO Box details can occasionally consist of a combination of numbers and letters. PO Box Numbers are only allocated to Large Users. - `department_name` string, required — Used to supplment Organisation Name to identify a deparment within the organisation. - `organisation_name` string, required — Used to supplment Organisation Name to identify a deparment within the organisation - `postcode_type` 'S' | 'L' | '', required — This indicates the type of user. It can only take the values 'S' or 'L' indicating small or large respectively. Large User Postcodes. These are assigned to one single address either due to the large volume of mail received at that address, or because a PO Box or Selectapost service has been set up. Small User Postcodes. These identify a group of Delivery Points. On average there are 19 Delivery Points per Postcode. However this can vary between 1 and, in some cases, 100. There will never be more than 100 Delivery Points on a Postcode. - `su_organisation_indicator` string, required — Small User Organisation Indicator can have the values 'Y' or space. A value of 'Y' indicates that a Small User Organisation is present at this address. - `delivery_point_suffix` string, required — A unique Royal Mail 2-character code (the first numeric & the second alphabetical), which, when added to the Postcode, enables each live Delivery Point to be uniquely identified. Once the Delivery Point is deleted from PAF the DPS may be reused (although they aren’t reused until all remaining Delivery Points in the range have been allocated). The DPS for a Large User is always '1A' as each Large User has its own Postcode. - `premise` string, required — A pre-computed string which sensibly combines building_number, building_name and sub_building_name. building_number, building_name and sub_building_name represent raw data from Royal Mail's and can be difficult to parse if you are unaware of how the Postcode Address File premise fields work together. For this reason, we also provide a pre-computed premise field which intelligently gathers these points into a single, simple premise string. This field is ideal if you want to pull premise information and thoroughfare information separately instead of using our address lines data. - `administrative_county` string, required — The 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. Data source: ONS - `postal_county` string, required — Postal counties were used for the distribution of mail before the Postcode system was introduced in the 1970s. The Former Postal County was the Administrative County at the time. This data rarely changes. May be empty. - `traditional_county` string, required — Traditional counties are provided by the Association of British Counties. It is historical data, and can date from the 1800s. May be empty. - `district` string, required — The current district/unitary authority to which the postcode has been assigned. - `ward` string, required — The current administrative/electoral area to which the postcode has been assigned. May be empty for a small number of addresses. - `longitude` union, required — The longitude of the postcode (WGS84/ETRS89). Can be a positive or negative decimal. E.g. -0.1283983 Returns an empty string if no location data is available. - string — Empty string `""` if not available - number — Represents longitude - `latitude` union, required — The latitude of the postcode (WGS84/ETRS89). Can be a positive or negative decimal. E.g. `51.5083983`. Returns an empty string if no location data is available. - string — Empty string `""` if not available - number — Represents latitude - `eastings` union, required — Eastings reference using the [Ordnance Survey National Grid reference system](https://en.wikipedia.org/wiki/Ordnance_Survey_National_Grid). Northern Ireland Eastings uses the [Irish Grid Reference System](https://en.wikipedia.org/wiki/Irish_grid_reference_system). Metres from origin. E.g. `550458` Returns an empty string if no location data is available. Otherwise a number is returned. - string — Empty string `""` if not available - number — Metres offset east from origin - `northings` union, required — Northings reference using the [Ordnance Survey National Grid reference system](https://en.wikipedia.org/wiki/Ordnance_Survey_National_Grid) Northern Ireland Northings uses the [Irish Grid Reference System](https://en.wikipedia.org/wiki/Irish_grid_reference_system) Metres from origin. E.g. `180458` Returns an empty string if no location data is available. Otherwise a number is returned - string — Empty string `""` if not available - number — Metres offset north from origin - AbAddress — Address from Ordnance Survey AddressBase Core dataset. Please contact us to have this enabled on your account. All AddressBase Core address have a UPRN and a rooftop geolocation available however they may not have a UDPRN. - `id` string, required — Global unique internally generated identifier for an address - `dataset` 'ab', required — Indicates the provenance of an address - `country_iso` 'GBR', required — 3 letter country code (ISO 3166-1) - `country_iso_2` 'GB', required — 2 letter country code (ISO 3166-1) - `country` 'England' | 'Scotland' | 'Wales', required — Full country names (ISO 3166) - `language` 'en', required — Language represented by 2 letter ISO Code (639-1) - `line_1` string, required — First Address Line. Often contains premise and thoroughfare information. In the case of a commercial premise, the first line is always the full name of the registered organisation. Never empty. - `line_2` string, required — Second Address Line. Often contains thoroughfare and locality information. May be empty - `line_3` string, required — Third address line. May be empty. - `post_town` string, required — **Filter by Town or City" A Post Town is mandatory for delivery of mail to a Delivery Point. This is not necessarily the nearest town geographically, but a routing instruction to the Royal Mail delivery office sorting mail for that Delivery Point. A Post Town will always be present in every address, and for some Localities the Post Town will be the only locality element present. - `postcode` string, required — Correctly formatted postcode. Capitalised and spaced. - `county` string, required — Since postal, administrative or traditional counties may not apply to some addresses, the county field is designed to return whatever county data is available. Normally, the postal county is returned. If this is not present, the county field will fall back to the administrative county. If the administrative county is also not present, the county field will fall back to the traditional county. May be empty in cases where no administrative, postal or traditional county present. - `county_code` string, required — Short code representing the county or province. May be empty (`""`) - `uprn` string, required — UPRN 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. 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_INTEGER` in 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. - `udprn` integer, required — UDPRN 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. - `umprn` union, required — A 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 — If premise is not multiple occupancy, this will be an empty string - number — If premise is multiple occupancy, this will be an integer - `postcode_outward` string, required — The 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’. - `postcode_inward` string, required — The 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. - `dependant_locality` string, required — When the same thoroughfare name reoccurs in a Post town, it may not be possible to make it dependant on a dependant thoroughfare. In this case the thoroughfare is dependant on a locality. For example if we want to find 1 Back Lane in Huddersfield we see that there are three. - `double_dependant_locality` string, required — Used to supplement Dependant Locality. A Double Dependant Locality supplied along with a Dependant Locality if the Dependant Locality exists twice in the same locality. - `thoroughfare` string, required — Also known as the street or road name. In general each Thoroughfare Name will have a separate Postcode. Longer Thoroughfares with high number ranges often have multiple Postcodes covering the entire length of the road, with breaks at suitable points e.g. junctions or natural breaks in the road. - `dependant_thoroughfare` string, required — Used to supplement thoroughfare. When a thoroughfare name is used twice in the same Post Town, the dependant thoroughfare is added to uniquely indentify a delivery point. - `building_number` string, required — Number to identify premise on a thoroughfare or dependant thoroughfare. - `building_name` string, required — Name of residential or commercial premise. Examples: - The Manor - 1-2 - A - 12A - K - Victoria House - `sub_building_name` string, required — When a premise is split into individual units such as flats, apartments or business units. Cannot be present without either building_name or building_number. E.g. Flat 1, A, 10B - `po_box` string, required — When the PO Box Number field is populated it will contain PO BOX nnnnnn where n represents the PO Box number. Note that the PO Box details can occasionally consist of a combination of numbers and letters. PO Box Numbers are only allocated to Large Users. - `department_name` string, required — Used to supplment Organisation Name to identify a deparment within the organisation. - `organisation_name` string, required — Used to supplment Organisation Name to identify a deparment within the organisation - `postcode_type` '', required — This indicates the type of user. It can only take the values 'S' or 'L' indicating small or large respectively. Large User Postcodes. These are assigned to one single address either due to the large volume of mail received at that address, or because a PO Box or Selectapost service has been set up. Small User Postcodes. These identify a group of Delivery Points. On average there are 19 Delivery Points per Postcode. However this can vary between 1 and, in some cases, 100. There will never be more than 100 Delivery Points on a Postcode. - `su_organisation_indicator` string, required — Small User Organisation Indicator can have the values 'Y' or space. A value of 'Y' indicates that a Small User Organisation is present at this address. - `delivery_point_suffix` string, required — A unique Royal Mail 2-character code (the first numeric & the second alphabetical), which, when added to the Postcode, enables each live Delivery Point to be uniquely identified. Once the Delivery Point is deleted from PAF the DPS may be reused (although they aren’t reused until all remaining Delivery Points in the range have been allocated). The DPS for a Large User is always '1A' as each Large User has its own Postcode. - `premise` string, required — A pre-computed string which sensibly combines building_number, building_name and sub_building_name. building_number, building_name and sub_building_name represent raw data from Royal Mail's and can be difficult to parse if you are unaware of how the Postcode Address File premise fields work together. For this reason, we also provide a pre-computed premise field which intelligently gathers these points into a single, simple premise string. This field is ideal if you want to pull premise information and thoroughfare information separately instead of using our address lines data. - `administrative_county` string, required — The 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. Data source: ONS - `postal_county` string, required — Postal counties were used for the distribution of mail before the Postcode system was introduced in the 1970s. The Former Postal County was the Administrative County at the time. This data rarely changes. May be empty. - `traditional_county` string, required — Traditional counties are provided by the Association of British Counties. It is historical data, and can date from the 1800s. May be empty. - `district` string, required — The current district/unitary authority to which the postcode has been assigned. - `ward` string, required — The current administrative/electoral area to which the postcode has been assigned. May be empty for a small number of addresses. - `longitude` union, required — The longitude of the postcode (WGS84/ETRS89). Can be a positive or negative decimal. E.g. -0.1283983 Returns an empty string if no location data is available. - string — Empty string `""` if not available - number — Represents longitude - `latitude` union, required — The latitude of the postcode (WGS84/ETRS89). Can be a positive or negative decimal. E.g. `51.5083983`. Returns an empty string if no location data is available. - string — Empty string `""` if not available - number — Represents latitude - `eastings` union, required — Eastings reference using the [Ordnance Survey National Grid reference system](https://en.wikipedia.org/wiki/Ordnance_Survey_National_Grid). Northern Ireland Eastings uses the [Irish Grid Reference System](https://en.wikipedia.org/wiki/Irish_grid_reference_system). Metres from origin. E.g. `550458` Returns an empty string if no location data is available. Otherwise a number is returned. - string — Empty string `""` if not available - number — Metres offset east from origin - `northings` union, required — Northings reference using the [Ordnance Survey National Grid reference system](https://en.wikipedia.org/wiki/Ordnance_Survey_National_Grid) Northern Ireland Northings uses the [Irish Grid Reference System](https://en.wikipedia.org/wiki/Irish_grid_reference_system) Metres from origin. E.g. `180458` Returns an empty string if no location data is available. Otherwise a number is returned - string — Empty string `""` if not available - number — Metres offset north from origin - `native` AddressBaseCore, required — Represents a GB address in Ordnance Survey's AddressBase Core dataset - `id` string, required — Global unique internally generated identifier for an address - `dataset` 'ab', required — Indicates the provenance of an address - `language` 'en' | 'ar' | 'as' | 'az' | 'be' | 'bg' | 'bn' | 'bs' | 'ca' | 'cs' | 'cy' | 'da' | 'de' | 'el' | 'es' | 'et' | 'eu' | 'fi' | 'fo' | 'fr' | 'ga' | 'gl' | 'gn' | 'he' | 'hi' | 'hr' | 'hu' | 'hy' | 'id' | 'is' | 'it' | 'ja' | 'ka' | 'kk' | 'km' | 'kn' | 'ko' | 'lt' | 'lv' | 'mk' | 'mn' | 'ms' | 'mt' | 'my' | 'nl' | 'no' | 'pl' | 'pt' | 'ro' | 'ru' | 'sk' | 'sl' | 'sq' | 'sr' | 'sv' | 'ta' | 'th' | 'tr' | 'uk' | 'uz' | 'vi' | 'wa' | 'zh', required — Language represented by 2 letter ISO Code (639-1) - `line_1` string, required — First Address Line. Often contains premise and thoroughfare information. In the case of a commercial premise, the first line is always the full name of the registered organisation. Never empty. - `line_2` string, required — Second Address Line. Often contains thoroughfare and locality information. May be empty - `line_3` string, required — Third address line. May be empty. - `premise` string, required — A pre-computed string which sensibly combines building_number, building_name and sub_building_name. building_number, building_name and sub_building_name represent raw data from Royal Mail's and can be difficult to parse if you are unaware of how the Postcode Address File premise fields work together. For this reason, we also provide a pre-computed premise field which intelligently gathers these points into a single, simple premise string. This field is ideal if you want to pull premise information and thoroughfare information separately instead of using our address lines data. - `uprn` string, required — Unique Property Reference Number (UPRN) assigned by the LLPG Custodian or Ordnance Survey. - `udprn` number, required — Royal Mail's Unique Delivery Point Reference Number (UDPRN). - `parent_uprn` string, required — UPRN of the parent Record if a parent-child relationship exists. - `usrn` number, required — Unique Street Reference Number assigned by the Street Name and Numbering Custodian OR Ordnance Survey depending on the address record. - `toid` string, required — The Topographic Identifier taken from OS MasterMap Topography Layer. This TOID is assigned to the UPRN by performing a spatial intersection between the two identifiers. It consists of the letters 'osgb' and is followed by up to sixteen digits. - `classification_code` string, required — A code that describes the classification of the address record to a maximum of a secondary level. - `eastings` number, required — A value in metres defining the x location in accordance with the British National Grid. - `northings` number, required — A value in metres defining the y location in accordance with the British National Grid. - `latitude` number, required — A value in metres defining the y location in accordance with the British National Grid. - `longitude` number, required — A value defining the Longitude location in accordance with the ETRS89 coordinate reference system. - `single_address_line` string, required — A single attribute containing text concatenation of the address elements separated by a comma. - `street_name` string, required — Street / Road name for the address record. - `locality` string, required — A locality defines an area or geographical identifier within a town, village or hamlet. Locality represents the lower level geographical area. The locality field should be used in conjunction with the town name and street description fields to uniquely identify geographic area where there may be more than one within an administrative area. - `town_name` string, required — Geographical town name assigned by the Local Authority. Please note this can be different from the Post Town value assigned by Royal Mail. - `delivery_point_suffix` string, required — A two-character code uniquely identifying an individual delivery point within a postcode, assigned by Royal Mail. - `post_town` string, required — The town or city in which the Royal Mail sorting office is located which services this address record. Condition: POST_TOWN is not populated if this is the same as TOWN_NAME. - `gss_code` string, required — The Office for National Statistics Governmental Statistical Service (GSS) code representing the contributing Local Authority. - `rpc` number, required — Representative Point Code describes the accuracy of the coordinate that has been allocated to the UPRN as indicated by the Local Authority and enhanced using large scale OS data. - `last_update_date` string, date, required — The latest date on which any of the attributes on this record were last changed. - `island` string, required — Third level of geographic area name to record island names where appropriate. - `change_code` 'I' | 'U' | 'D', required — This enumeration is used in association with the attribute “CHANGE_CODE”. This enumeration identifies the type of change that has been made to a feature. The change type must be set when a feature is inserted, updated or deleted. Please see section 3 for more information. Example I = Insert, U = Update, D = Delete - `building_name` string, required — The building name is a description applied to a single address or a group of addresses. - `building_number` string, required — The building number is a number or range of numbers given to a single address or a group of addresses. - `sub_building` string, required — The sub-building name and/or number for the address record. - `postcode` string, required — A postcode assigned by Royal Mail for the address record. - `po_box` string, required — Text concatenation of 'PO BOX' and the Post Office Box (PO Box) number or 'BFPO' and the British Forces Post Office number. - `organisation` string, required — The organisation name is the business name given, when appropriate, to an address record. - `country` string, required — Full country names (ISO 3166) - `country_iso` string, required — 3 letter country code (ISO 3166-1) - `county` string, required — Since postal, administrative or traditional counties may not apply to some addresses, the county field is designed to return whatever county data is available. Normally, the postal county is returned. If this is not present, the county field will fall back to the administrative county. If the administrative county is also not present, the county field will fall back to the traditional county. May be empty in cases where no administrative, postal or traditional county present. - `district` string, required — The current district/unitary authority to which the postcode has been assigned. - `ward` string, required — The current administrative/electoral area to which the postcode has been assigned. May be empty for a small number of addresses. - `traditional_county` string, required — Traditional counties are provided by the Association of British Counties. It is historical data, and can date from the 1800s. May be empty. - `administrative_county` string, required — The 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. Data source: ONS - `postal_county` string, required — Postal counties were used for the distribution of mail before the Postcode system was introduced in the 1970s. The Former Postal County was the Administrative County at the time. This data rarely changes. May be empty. - GbrGlobalAddress — Global (non-UK) address in the UK address format - `id` string, required — Global unique internally generated identifier for an address - `dataset` 'paf' | 'pafw' | 'pafa' | 'mr' | 'nyb' | 'usps' | 'ecaf' | 'ecad' | 'ab' | 'herewe' | 'heret' | 'heresa' | 'hereo' | 'herena' | 'heremeas' | 'heremea' | 'herem' | 'herei' | 'herehk' | 'hereee' | 'hereap' | 'gnaf' | 'kadaster' | 'kartverket' | 'sdfi' | 'cannar' | 'fodbosa' | 'mois' | 'upujp' | 'bev', required — Indicates the provenance of an address. - `paf` (GBR) Postcode Address File - `usps` (USA) USPS Zip+4 - `mr` (GBR) Multiple Residence File - `nyb` (GBR) Not Yet Built File - `pafa` (GBR) Alias File - `pafw` (GBR) Welsh File - `ab` (GBR) AddressBase Core - `ecaf` (IRL) Eircode ECAF - `ecad` (IRL) Eircode ECAD - `herewe` (Western Europe) Western Europe Dataset - `heret` (Taiwan) Taiwan Dataset - `heresa` (South America) South America Dataset - `hereo` (Oceania) Oceania Dataset - `herena` (North America) North America Dataset - `herei` (India) India Dataset - `heremea` (Middle East and Africa) Middle East and Africa Dataset - `herem` (Macau) Macau Dataset - `herehk` (Hong Kong) Hong Kong Dataset - `hereee` (Eastern Europe) Eastern Europe Dataset - `hereap` (Asia Pacific) Asia Pacific Dataset - `gnaf` (AUS) Geoscape Geocoded National Address File - `kadaster` (NLD) Kadaster BAG 2.0 Address File - `kartverket` (NOR) Norway Dataset - `sdfi` (DNK) Denmark Dataset - `cannar` (CAN) Canada National Address Register Dataset - `fodbosa` (BEL) Belgium Dataset - `mois` (KOR) South Korea Dataset - `upujp` (JPN) Japan UPU Address File - `bev` (AUT) Austria Dataset - `country_iso` 'GBR' | 'IMN' | 'JEY' | 'GGY' | 'USA' | 'PRI' | 'GUM' | 'IRL' | 'VAT' | 'FRA' | 'GRL' | 'NLD' | 'LUX' | 'AUT' | 'GIB' | 'LIE' | 'FIN' | 'UNI' | 'ISL' | 'CHE' | 'PRT' | 'BEL' | 'MCO' | 'ITA' | 'FRO' | 'NOR' | 'DNK' | 'SMR' | 'MLT' | 'AND' | 'SWE' | 'DEU' | 'ESP' | 'SJM' | 'BRN' | 'IDN' | 'KHM' | 'MMR' | 'MYS' | 'PHL' | 'SGP' | 'THA' | 'TLS' | 'VNM' | 'ALB' | 'ARM' | 'AZE' | 'BGR' | 'BIH' | 'BLR' | 'CYP' | 'CZE' | 'EST' | 'GEO' | 'GRC' | 'HRV' | 'HUN' | 'KAZ' | 'KGZ' | 'LTU' | 'LVA' | 'MDA' | 'MKD' | 'MNE' | 'POL' | 'ROU' | 'RUS' | 'SRB' | 'SVK' | 'SVN' | 'TUR' | 'UKR' | 'UZB' | 'XKX' | 'HKG' | 'BGD' | 'IND' | 'LKA' | 'MAC' | 'AGO' | 'ARE' | 'BFA' | 'BHR' | 'BWA' | 'CMR' | 'EGY' | 'GHA' | 'ISR' | 'JOR' | 'KEN' | 'KWT' | 'LBN' | 'LSO' | 'MAR' | 'MOZ' | 'MUS' | 'MYT' | 'NAM' | 'NGA' | 'OMN' | 'QAT' | 'REU' | 'SAU' | 'SEN' | 'SWZ' | 'TUN' | 'ZAF' | 'ZMB' | 'ZWE' | 'BHS' | 'BLZ' | 'BMU' | 'CAN' | 'CRI' | 'CYM' | 'DOM' | 'GTM' | 'HND' | 'HTI' | 'JAM' | 'MEX' | 'NIC' | 'PAN' | 'SLV' | 'VGB' | 'AUS' | 'CCK' | 'CXR' | 'FJI' | 'NCL' | 'NFK' | 'NZL' | 'PYF' | 'TON' | 'VUT' | 'ABW' | 'ARG' | 'BLM' | 'BOL' | 'BRA' | 'BRB' | 'CHL' | 'COL' | 'CUW' | 'DMA' | 'ECU' | 'GLP' | 'GUF' | 'GUY' | 'MAF' | 'MTQ' | 'PER' | 'PRY' | 'SUR' | 'TTO' | 'URY' | 'VEN' | 'TWN' | 'CHN' | 'JPN' | 'KOR' | 'LAO' | 'MNG' | 'PNG' | 'PRK' | 'SLB' | 'TJK' | 'TKM' | 'BTN' | 'IOT' | 'LKA' | 'MDV' | 'NPL' | 'PAK' | 'AFG' | 'BDI' | 'BEN' | 'CAF' | 'CIV' | 'COD' | 'COG' | 'COM' | 'CPV' | 'DJI' | 'DZA' | 'ERI' | 'ESH' | 'ETH' | 'GAB' | 'GIN' | 'GMB' | 'GNB' | 'GNQ' | 'IRN' | 'IRQ' | 'LBR' | 'LBY' | 'MDG' | 'MLI' | 'MRT' | 'MWI' | 'NER' | 'RWA' | 'SHN' | 'SLE' | 'SOM' | 'SSD' | 'STP' | 'SYC' | 'TCD' | 'TGO' | 'TZA' | 'UGA' | 'SDN' | 'SYR' | 'YEM' | 'CUB' | 'SPM' | 'TCA' | 'COK' | 'KIR' | 'NIU' | 'NRU' | 'PCN' | 'TKL' | 'TUV' | 'WLF' | 'WSM' | 'AIA' | 'ATG' | 'BES' | 'FLK' | 'GRD' | 'KNA' | 'LCA' | 'MSR' | 'SGS' | 'SXM' | 'VCT' | 'ASM' | 'FSM' | 'MHL' | 'MNP' | 'PLW' | 'VIR', required — 3 letter country code (ISO 3166-1) - `country_iso_2` 'GB' | 'IM' | 'JE' | 'GG' | 'US' | 'PR' | 'GU' | 'IE' | 'VA' | 'FR' | 'GL' | 'NL' | 'LU' | 'AT' | 'GI' | 'LI' | 'FI' | 'GB' | 'IS' | 'CH' | 'PT' | 'BE' | 'MC' | 'IT' | 'FO' | 'NO' | 'DK' | 'SM' | 'MT' | 'AD' | 'SE' | 'DE' | 'ES' | 'SJ' | 'BS' | 'BZ' | 'BM' | 'CA' | 'CR' | 'KY' | 'DO' | 'GT' | 'HN' | 'HT' | 'JM' | 'MX' | 'NI' | 'PA' | 'SV' | 'VG' | 'AU' | 'CC' | 'CX' | 'FJ' | 'NC' | 'NF' | 'NZ' | 'PF' | 'TO' | 'VU' | 'AW' | 'AR' | 'BL' | 'BO' | 'BR' | 'BB' | 'CL' | 'CO' | 'CW' | 'DM' | 'EC' | 'GP' | 'GD' | 'GF' | 'GY' | 'MF' | 'MQ' | 'PE' | 'PY' | 'SR' | 'TT' | 'UY' | 'VE' | 'TW' | 'BN' | 'ID' | 'KH' | 'MM' | 'MY' | 'PH' | 'SG' | 'TH' | 'TL' | 'VN' | 'AL' | 'AM' | 'AZ' | 'BG' | 'BA' | 'BY' | 'CY' | 'CZ' | 'EE' | 'GE' | 'GR' | 'HR' | 'HU' | 'KZ' | 'KG' | 'XK' | 'LT' | 'LV' | 'MD' | 'MK' | 'ME' | 'PL' | 'RO' | 'RU' | 'RS' | 'SK' | 'SI' | 'TR' | 'UA' | 'UZ' | 'HK' | 'BD' | 'IN' | 'LK' | 'MO' | 'AO' | 'AE' | 'BF' | 'BH' | 'BW' | 'CM' | 'EG' | 'GH' | 'IL' | 'JO' | 'KE' | 'KW' | 'LB' | 'LS' | 'MA' | 'MZ' | 'MU' | 'YT' | 'NA' | 'NG' | 'OM' | 'QA' | 'RE' | 'SA' | 'SN' | 'SZ' | 'TN' | 'ZA' | 'ZM' | 'ZW' | 'CN' | 'JP' | 'KR' | 'LA' | 'MN' | 'PG' | 'KP' | 'SB' | 'TJ' | 'TM' | 'BT' | 'IO' | 'LK' | 'MV' | 'NP' | 'PK' | 'AF' | 'BI' | 'BJ' | 'CF' | 'CI' | 'CD' | 'CG' | 'KM' | 'CV' | 'DJ' | 'DZ' | 'ER' | 'EH' | 'ET' | 'GA' | 'GN' | 'GM' | 'GW' | 'GQ' | 'IR' | 'IQ' | 'LR' | 'LY' | 'MG' | 'ML' | 'MR' | 'MW' | 'NE' | 'RW' | 'SH' | 'SL' | 'SO' | 'SS' | 'ST' | 'SC' | 'TD' | 'TG' | 'TZ' | 'UG' | 'SD' | 'SY' | 'YE' | 'CU' | 'PM' | 'TC' | 'CK' | 'KI' | 'NU' | 'NR' | 'PN' | 'TK' | 'TV' | 'WF' | 'WS' | 'AI' | 'AG' | 'BQ' | 'FK' | 'KN' | 'LC' | 'MS' | 'GS' | 'SX' | 'VC' | 'AS' | 'FM' | 'MH' | 'MP' | 'PW' | 'VI', required — 2 letter country code (ISO 3166-1) - `language` 'en' | 'ar' | 'as' | 'az' | 'be' | 'bg' | 'bn' | 'bs' | 'ca' | 'cs' | 'cy' | 'da' | 'de' | 'el' | 'es' | 'et' | 'eu' | 'fi' | 'fo' | 'fr' | 'ga' | 'gl' | 'gn' | 'he' | 'hi' | 'hr' | 'hu' | 'hy' | 'id' | 'is' | 'it' | 'ja' | 'ka' | 'kk' | 'km' | 'kn' | 'ko' | 'lt' | 'lv' | 'mk' | 'mn' | 'ms' | 'mt' | 'my' | 'nl' | 'no' | 'pl' | 'pt' | 'ro' | 'ru' | 'sk' | 'sl' | 'sq' | 'sr' | 'sv' | 'ta' | 'th' | 'tr' | 'uk' | 'uz' | 'vi' | 'wa' | 'zh', required — Language represented by 2 letter ISO Code (639-1) - `line_1` string, required — First line of the address. Typically the building number and street name - `line_2` string, required — Second line of the address. Can be blank - `line_3` string, required — Third line of the address. Can also be blank - `postcode` string, required — Represents the postal or zip code - `post_town` string, required — The city, town or other primary locality - `county` string, required — State or county name - `county_code` string, required — Code abbreviation for state or county used in some countries. - `longitude` union, required — The longitude of the postcode (WGS84/ETRS89). Can be a positive or negative decimal. E.g. -0.1283983 Returns an empty string if no location data is available. - string — Empty string `""` if not available - number — Represents longitude - `latitude` union, required — The latitude of the postcode (WGS84/ETRS89). Can be a positive or negative decimal. E.g. `51.5083983`. Returns an empty string if no location data is available. - string — Empty string `""` if not available - number — Represents latitude - `country` 'United Kingdom' | 'England' | 'Scotland' | 'Wales' | 'Northern Ireland' | 'Isle of Man' | 'Jersey' | 'Guernsey' | 'Guam' | 'United States' | 'Puerto Rico' | 'Ireland' | 'Vatican City' | 'France' | 'Greenland' | 'Netherlands' | 'Luxembourg' | 'Austria' | 'Gibraltar' | 'Liechtenstein' | 'Finland' | 'United Kingdom' | 'Iceland' | 'Switzerland' | 'Portugal' | 'Belgium' | 'Monaco' | 'Italy' | 'Faroe Islands' | 'Norway' | 'Denmark' | 'San Marino' | 'Malta' | 'Andorra' | 'Sweden' | 'Germany' | 'Spain' | 'Svalbard and Jan Mayen' | 'Bahamas' | 'Belize' | 'Bermuda' | 'Canada' | 'Costa Rica' | 'Cayman Islands' | 'Dominican Republic' | 'Guatemala' | 'Honduras' | 'Haiti' | 'Jamaica' | 'Mexico' | 'Nicaragua' | 'Panama' | 'El Salvador' | 'British Virgin Islands' | 'Australia' | 'Cocos (Keeling) Islands' | 'Christmas Island' | 'Fiji' | 'New Caledonia' | 'Norfolk Island' | 'New Zealand' | 'French Polynesia' | 'Tonga' | 'Vanuatu' | 'Aruba' | 'Argentina' | 'Saint Barthélemy' | 'Bolivia' | 'Brazil' | 'Barbados' | 'Chile' | 'Colombia' | 'Curaçao' | 'Dominica' | 'Ecuador' | 'Guadeloupe' | 'Grenada' | 'French Guiana' | 'Guyana' | 'Saint Martin (French part)' | 'Martinique' | 'Peru' | 'Paraguay' | 'Suriname' | 'Trinidad and Tobago' | 'Uruguay' | 'Venezuela' | 'Taiwan' | 'Brunei Darussalam' | 'Indonesia' | 'Cambodia' | 'Myanmar' | 'Malaysia' | 'Philippines' | 'Singapore' | 'Thailand' | 'Timor-Leste' | 'Vietnam' | 'Albania' | 'Armenia' | 'Azerbaijan' | 'Bulgaria' | 'Bosnia and Herzegovina' | 'Belarus' | 'Cyprus' | 'Czech Republic' | 'Estonia' | 'Georgia' | 'Greece' | 'Croatia' | 'Hungary' | 'Kazakhstan' | 'Kyrgyzstan' | 'Kosovo' | 'Lithuania' | 'Latvia' | 'Moldova' | 'North Macedonia' | 'Montenegro' | 'Poland' | 'Romania' | 'Russia' | 'Serbia' | 'Slovakia' | 'Slovenia' | 'Turkey' | 'Ukraine' | 'Uzbekistan' | 'Hong Kong' | 'Bangladesh' | 'India' | 'Sri Lanka' | 'Macau' | 'Angola' | 'United Arab Emirates' | 'Burkina Faso' | 'Bahrain' | 'Botswana' | 'Cameroon' | 'Egypt' | 'Ghana' | 'Israel' | 'Jordan' | 'Kenya' | 'Kuwait' | 'Lebanon' | 'Lesotho' | 'Morocco' | 'Mozambique' | 'Mauritius' | 'Mayotte' | 'Namibia' | 'Nigeria' | 'Oman' | 'Qatar' | 'Réunion' | 'Saudi Arabia' | 'Senegal' | 'Eswatini' | 'Tunisia' | 'South Africa' | 'Zambia' | 'Zimbabwe' | 'China' | 'Japan' | 'South Korea' | 'Laos' | 'Mongolia' | 'Papua New Guinea' | 'North Korea' | 'Solomon Islands' | 'Tajikistan' | 'Turkmenistan' | 'Bhutan' | 'British Indian Ocean Territory' | 'Sri Lanka' | 'Maldives' | 'Nepal' | 'Pakistan' | 'Afghanistan' | 'Burundi' | 'Benin' | 'Central African Republic' | 'Côte d'Ivoire' | 'Democratic Republic of the Congo' | 'Republic of the Congo' | 'Comoros' | 'Cape Verde' | 'Djibouti' | 'Algeria' | 'Eritrea' | 'Western Sahara' | 'Ethiopia' | 'Gabon' | 'Guinea' | 'Gambia' | 'Guinea-Bissau' | 'Equatorial Guinea' | 'Iran' | 'Iraq' | 'Liberia' | 'Libya' | 'Madagascar' | 'Mali' | 'Mauritania' | 'Malawi' | 'Niger' | 'Rwanda' | 'Saint Helena' | 'Sierra Leone' | 'Somalia' | 'South Sudan' | 'São Tomé and Príncipe' | 'Seychelles' | 'Chad' | 'Togo' | 'Tanzania' | 'Uganda' | 'Sudan' | 'Syria' | 'Yemen' | 'Cuba' | 'Saint Pierre and Miquelon' | 'Turks and Caicos Islands' | 'Cook Islands' | 'Kiribati' | 'Niue' | 'Nauru' | 'Pitcairn Islands' | 'Tokelau' | 'Tuvalu' | 'Vanuatu' | 'Wallis and Futuna' | 'Samoa' | 'Anguilla' | 'Antigua and Barbuda' | 'Bonaire, Sint Eustatius and Saba' | 'Falkland Islands (Malvinas)' | 'Saint Kitts and Nevis' | 'Saint Lucia' | 'Montserrat' | 'South Georgia and the South Sandwich Islands' | 'Sint Maarten (Dutch part)' | 'Saint Vincent and the Grenadines' | 'American Samoa' | 'Federated States of Micronesia' | 'Marshall Islands' | 'Northern Mariana Islands' | 'Palau' | 'United States Virgin Islands', required — Full country names (ISO 3166) - `native` union, required — The native representation of a non-UK address - EcadAddress — The ECAD contains additional data for each ECAF address. - `id` string, required — Global unique internally generated identifier for an address - `dataset` 'ecad', required — Source of address - `country_iso` 'IRL', required — 3 letter country code (ISO 3166-1) - `country_iso_2` 'IE', required — 2 letter country code (ISO 3166-1) - `country` 'Ireland', required — Full country names (ISO 3166) - `language` 'en' | 'ga', required — Language represented by 2 letter ISO Code (639-1) - `line_1` string, required — Address Line 1 - `line_2` string, required — Address Line 2 - `line_3` string, required — Address Line 3 - `line_4` string, required — Address Line 4 - `line_5` string, required — Address Line 5 - `line_6` string, required — Address Line 6 - `line_7` string, required — Address Line 7 - `line_8` string, required — Address Line 8 - `line_9` string, required — Address Line 9 - `department` string, required — The department or division within an organisation. If the department element exists, then the organisation must also exist. - `organisation` string, required — Organisation name - `sub_building_name` string, required — The sub-building refers to an apartment, flat or unit within a building. - `building_name` string, required — The name given to the building. 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_number` string, required — A 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 and `2_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_group` string, required — A building group is a collection of buildings with a collective name, located on or near the same thoroughfare. - `primary_thoroughfare` string, required — The name of the thoroughfare on which premises are located. 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_thoroughfare` string, required — It 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_locality` string, required — First 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_locality` string, required — Never 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_locality` string, required — Also 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 Phoist4, 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_county` string, required — One 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. - `eircode` string, required — The 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_reference` string, required — The address reference is the An Post GeoDirectory address reference identifier used by the Universal Service Provider. - `longitude` union, required — The longitude of the postcode (WGS84/ETRS89). Can be a positive or negative decimal. E.g. -0.1283983 Returns an empty string if no location data is available. - string — Empty string `""` if not available - number — Represents longitude - `latitude` union, required — The latitude of the postcode (WGS84/ETRS89). Can be a positive or negative decimal. E.g. `51.5083983`. Returns an empty string if no location data is available. - string — Empty string `""` if not available - number — Represents latitude - `ecad_id` string — Unique 10 digit ECAD ID - `organisation_id` string, required — Organisation ID - `address_point_id` string, required — Address Point ID - `building_id` string, required — Building ID - `building_group_id` string, required — Building Group ID - `primary_thoroughfare_id` string, required — Primary Thoroughfare ID - `secondary_thoroughfare_id` string, required — Secondary Thoroughfare ID - `primary_locality_id` string, required — Primary Locality ID - `secondary_locality_id` string, required — Secondary Locality ID - `post_town` string, required — 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 Phoist1, 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_id` string, required — Post Town ID - `post_county_id` string, nullable, required — Post County ID - `nua` boolean, required — NUA means "non-unique address". The NUA field contains `true` when the address is a non-unique address, and `false` when 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. - `gaeltacht` boolean, required — Gaeltact refers to a district where the Irish government recognises that the Irish language is the predominant language. Returns `true` if address is in a Gaeltacht area and `false` if not. - `address_type` string, required — Addresses 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_type` string, required — The 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_type` string, required — The 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_type` string, required — The 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_type` string, required — The 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_type` string, required — Describes the type of building, e.g. detached, semi-detached, bungalow. - `holiday_home` 'N' | 'Y' | '', required — A Yes/No field, indicating whether or not the building is a holiday home. - `under_construction` 'N' | 'Y' | '', required — A Yes/No field, indicating whether or not the building is under construction. - `building_use` 'R' | 'C' | 'B' | 'U', required — Can be one of: - `R` Residential - `C` Commercial - `B` Both - `U` Unknown - `vacant` 'Y' | 'N' | '', required — A Yes/No field, indicating whether the building is vacant. - `org_vacant` 'Y' | 'N' | '', required — A Yes/No field, indicating whether the organisation is vacant. - `nace_code` string, required — The NACE Code for the Category. - `nace_category` string, required — Name of the NACE Category - `local_authority` string, required — Name of local authority - `ded_id` string, required — Unique Identifier for Electoral Divisions 2017 data. 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 his change. - `small_area_id` string, required — Unique Identifier for the Small Area 2017 data. 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 his change. - `townland_id` string, required — Unique Identifier for townland 2017 data. 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 his change. - `gaeltacht_id` string, required — Unique Identifier for the 7 Gaeltacht areas 2017 data. 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 his change. - `postaim_presort_61` string, required — An Post sorting information. - `postaim_presort_152` string, required — An Post sorting information. - `publicity_post_zone` string, required — An Post publicity post zone information. - EcafAddress — ECAF is the Eircode Address File which contains one record for each Postal Address. English language and Irish language versions are available. It is distributed as a flat file, details of data provision and updates are provided in section 2. - `id` string, required — Global unique internally generated identifier for an address - `dataset` 'ecaf', required — Source of address - `country_iso` 'IRL', required — 3 letter country code (ISO 3166-1) - `country_iso_2` 'IE', required — 2 letter country code (ISO 3166-1) - `country` 'Ireland', required — Full country names (ISO 3166) - `language` 'en' | 'ga', required — Language represented by 2 letter ISO Code (639-1) - `line_1` string, required — Address Line 1 - `line_2` string, required — Address Line 2 - `line_3` string, required — Address Line 3 - `line_4` string, required — Address Line 4 - `line_5` string, required — Address Line 5 - `line_6` string, required — Address Line 6 - `line_7` string, required — Address Line 7 - `line_8` string, required — Address Line 8 - `line_9` string, required — Address Line 9 - `department` string, required — The department or division within an organisation. If the department element exists, then the organisation must also exist. - `organisation` string, required — Organisation name - `sub_building_name` string, required — The sub-building refers to an apartment, flat or unit within a building. - `building_name` string, required — The name given to the building. 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_number` string, required — A 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 and `2_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_group` string, required — A building group is a collection of buildings with a collective name, located on or near the same thoroughfare. - `primary_thoroughfare` string, required — The name of the thoroughfare on which premises are located. 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_thoroughfare` string, required — It 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_locality` string, required — First 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_locality` string, required — Never 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_locality` string, required — Also 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 Phoist4, 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_county` string, required — One 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. - `eircode` string, required — The 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_reference` string, required — The address reference is the An Post GeoDirectory address reference identifier used by the Universal Service Provider. - `longitude` union, required — The longitude of the postcode (WGS84/ETRS89). Can be a positive or negative decimal. E.g. -0.1283983 Returns an empty string if no location data is available. - string — Empty string `""` if not available - number — Represents longitude - `latitude` union, required — The latitude of the postcode (WGS84/ETRS89). Can be a positive or negative decimal. E.g. `51.5083983`. Returns an empty string if no location data is available. - string — Empty string `""` if not available - number — Represents latitude - `ecaf_id` string, required — The 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. - UspsAddress — Standard USA Address - `id` string, required — Global unique internally generated identifier for an address - `dataset` 'usps', required — Identifies the address as sourced from USPS - `country` 'American Samoa' | 'Federated States of Micronesia' | 'Guam' | 'Marshall Islands' | 'Northern Mariana Islands' | 'Palau' | 'Puerto Rico' | 'United States' | 'United States Virgin Islands', required — Full country names (ISO 3166) - `country_iso` 'ASM' | 'FSM' | 'GUM' | 'MHL' | 'MNP' | 'PLW' | 'PRI' | 'USA' | 'VIR', required — 3 letter country code (ISO 3166-1) - `country_iso_2` 'AS' | 'FM' | 'GU' | 'MH' | 'MP' | 'PR' | 'PW' | 'US' | 'VI', required — 2 letter country code (ISO 3166-1) - `language` 'en', required — Language represented by 2 letter ISO Code (639-1) - `primary_number` string, required — A 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_number` string, required — Number of the sub unit, apartment, suite etc - `plus_4_code` string, required — 4 digit ZIP add-on code. - `line_1` string, required — The primary delivery line (usually the street address) of the address. - `line_2` string, required — Secondary delivery line of the address. Typically populated if the first line is the firm or building name. - `last_line` string, required — Last line of the address comprising of city, state, zip code and zip+4 - `zip_code` string, required — A 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_code` string, required — Nine-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_number` string, required — Field 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_code` 'G' | 'H' | 'F' | 'S' | 'P' | 'R' | 'M' | '', required — An 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_id` string, required — A 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_abbreviation` string, required — A geographic direction that precedes the street name. - `street_name` string, required — The 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_abbreviation` string, required — Code that is the standard USPS abbreviation for the trailing designator in a street address. - `street_post_directional_abbreviation` string, required — A geographic direction that follows the street name. - `building_or_firm_name` string, required — The 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_abbreviation` string, required — A 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_code` 'A' | 'B' | '', required — Code 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_indicator` '' | 'L', required — The 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_indicator` '' | 'A' | 'B' | 'C' | 'D' | 'E' | 'F' | 'G', required — An 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_abbreviation` string, required — A 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.” - `state` string, required — Full name of a state, U.S. territory, or armed forces ZIP Code designation. - `municipality_city_state_key` string, required — Municipality City State Key. Currently blank. - `urbanization_city_state_key` string, required — An index to the City State file that provides the urbanization name for this delivery range. - `preferred_last_line_city_state_key` string, required — In 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. - `county` string, required — The 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. - `city` string, required — A valid city name for mailing purposes; appears in the last line of an address on a mail piece. - `city_abbreviation` string, required — A 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_city` string, required — Field that contains the default preferred or alternate preferred last-line name for a ZIP Code. - `city_state_name_facility_code` 'B' | 'C' | 'N' | 'P' | 'S' | 'U' | 'Y' | '', required — The 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_code` '' | 'M' | 'P' | 'U', required — A 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_indicator` string, required — Specifies 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_sortation` string, required — Identifies 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_number` union, required — A code assigned to Postal Service facilities (primarily Post Offices) to collect cost and statistical data and compile revenue and expense data. - string — Empty string `""` if not available - number — Finance Number - `congressional_district_number` union, required — A 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 — Empty string `""` if not available - number — Congressional district number - `county_number` union, required — The 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 — Empty string `""` if not available - number — FIPS code - HereAddress — Address from the global HERE dataset - `id` string, required — Global unique internally generated identifier for an address - `country_iso` string, required — Three character country code based on ISO Standard 3166. Can be empty string `""` if not present. - `dataset` 'herewe' | 'heret' | 'heresa' | 'hereo' | 'herena' | 'heremeas' | 'heremea' | 'herem' | 'herei' | 'herehk' | 'hereee' | 'hereap', required - `language` string, required — Language Code of Address and Building Name for the Point Address. - `line_1` string, required — First address line. Can be empty string `""` if not present. - `line_2` string, required — Second address line. Can be empty string `""` if not present. - `line_3` string, required — Third address line. Can be empty string `""` if not present. - `line_4` string, required — Fourth address line. Can be empty string `""` if not present. - `line_5` string, required — Fifth address line. Can be empty string `""` if not present. - `address` string, required — Address / House Number uniquely identifying the address along the specified road link. Can be empty string `""` if not present. - `address_type` string — Address Type defines the type of address represented by the Point Address (e.g., Base, Commercial). Can be empty string `""` if not present. - `delivery_latitude` union, required - string — Empty string `""` if not available - number — Latitude defining the arrival position of the Point Address. - `delivery_longitude` union, required - string — Empty string `""` if not available - number — Longitude defining the arrival position of the Point Address. - `building_name` string, required — Name of the Building to which the Point Address is associated. Can be empty string `""` if not present. - `latitude` union, required - string — Empty string `""` if not available - number — Latitude of the display position for the Point Address. - `longitude` union, required - string — Empty string `""` if not available - number — Longitude of the display position for the Point Address. - `street_name` string, required — The full spelling of the street name, including Prefix, Base Name, Suffix, Street Type, and Direction on Sign. - `postal_code` string, required — Full postal code; could be numeric or alphanumeric postal code. Can be empty string `""` if not present. - `order1_name` string, required — Identifies the highest administrative level in which a country can be subdivided. - `order2_name` string, required — Identifies 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. - `order8_name` string, required — Identifies the lowest level of the country's administrative hierarchy that is present country- wide. (No gaps exist in the coverage.) - `builtup_name` string, required — Identifies 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. - `poi_name` string, required — Name of the point of interest associated with the address. - `building_unit_name` string, required — Name of the Building associated with a Micro Point Address. - `level_name` string, required — Name of floor or level within a building associated with a Micro Point Address. - `unit_name` string, required — Name of the unit (suite, etc) associated with a Micro Point Address. - `suppl_address_info` string, required — Additional address or building information. - `building_grp_name` string, required — Name of the group of buildings with which the address is associated. - GnafAddress - `id` string, required — Global unique internally generated identifier for an address - `dataset` 'gnaf', required - `country_iso` 'AUS' | 'CCK' | 'CXR' | 'NFK', required — 3 letter country code (ISO 3166-1) - `country_iso_2` 'AU' | 'CC' | 'CX' | 'NF', required — 2 letter country code (ISO 3166-1) - `country` 'Australia' | 'Cocos (Keeling) Islands' | 'Christmas Island' | 'Norfolk Island', required — Full country names (ISO 3166) - `line_1` string, required — First address line. Can be empty string `""` if not present. - `line_2` string, required — Second address line. Can be empty string `""` if not present. - `language` 'en', required — Language represented by 2 letter ISO Code (639-1) - `address` string, required — Address / House Number uniquely identifying the address along the specified street. Can be empty string `""` if not present. - `longitude` union, required — The longitude of the postcode (WGS84/ETRS89). Can be a positive or negative decimal. E.g. -0.1283983 Returns an empty string if no location data is available. - string — Empty string `""` if not available - number — Represents longitude - `latitude` union, required — The latitude of the postcode (WGS84/ETRS89). Can be a positive or negative decimal. E.g. `51.5083983`. Returns an empty string if no location data is available. - string — Empty string `""` if not available - number — Represents latitude - `address_detail_pid` string, required — The Persistent Identifier is unique to the real world feature this record represents. - `date_created` string, date, required — Date this record was created. - `date_last_modified` string, date, required — Date this record was last modified (not retired/recreated in line with ICSM standard). - `date_retired` string, date, required — Date this record was retired. - `building_name` string, required — Combines both building/property name fields. Field length: up to 200 alphanumeric characters (AS4590:2006 5.7). - `lot_number_prefix` string, required — Lot number prefix. Field length: up to two alphanumeric characters (AS4590:2006 5.8.1). - `lot_number` string, required — Lot number. Field length: up to five alphanumeric characters (AS4590:2006 5.8.1). - `lot_number_suffix` string, required — Lot number suffix. Field length: up to two alphanumeric characters (AS4590:2006 5.8.1). - `flat_type_code` string, required — Specification 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_prefix` string, required — Level number prefix. Field length: up to two alphanumeric characters (AS4590:2006 5.5.2.2). - `flat_number` union, required - string — Empty string `""` if not available - number — Flat/unit number. Field length: up to five numeric characters (AS4590:2006 5.5.1.2). - `flat_number_suffix` string, required — Flat/unit number suffix Field length: up to two alphanumeric characters (AS4590:2006 5.5.1.2). - `level_type_code` string, required — Level type. Field length: up to four alphanumeric characters (AS4590:2006 5.5.2.1). - `level_number_prefix` string, required — Level number prefix. Field length: up to two alphanumeric characters (AS4590:2006 5.5.2.2). - `level_number` union, required - string — Empty string `""` if not available - number — Level number. Field length: up to three numeric characters (AS4590:2006 5.5.2.2). - `level_number_suffix` string, required — Level number suffix. Field length: up to two alphanumeric characters (AS4590:2006 5.5.2.2). - `number_first_prefix` string, required — Prefix for the first (or only) number in range. Field length: up to three uppercase alphanumeric characters (AS4590:2006 5.5.3.1). - `number_first` union, required - string — Empty string `""` if not available - number — Identifies first (or only) street number in range. Field length: up to six numeric characters (AS4590:2006 5.5.3.1). - `number_first_suffix` string, required — Suffix for the first (or only) number in range. Field length: up to two uppercase alphanumeric characters (AS4590:2006 5.5.3.1). - `number_last_prefix` string, required — Prefix for the last number in range. Field length: up to three uppercase alphanumeric characters (AS4590:2006 5.5.3.2). - `number_last` union, required - string — Empty string `""` if not available - number — Identifies last number in range. Field length: up to six numeric characters (AS4590:2006 5.5.3.2). - `number_last_suffix` string, required — Suffix for the last number in range. Field length: up to two uppercase alphanumeric characters (AS4590:2006 5.5.3.2). - `street_locality_pid` string, required — Street/Locality of this address - not mandatory N as some records in G-F may not require street (e.g. remote rural property). - `alias_principal` string, required — A = Alias record, P = Principal record. - `postcode` string, required — Postcodes are optional as prescribed by AS4819 and AS4590:2006 5.13. - `private_street` string, required — Private 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_id` string, required — Generic parcel id field derived from the Geoscape Australia’s Cadastre parcel where available. - `confidence` union, required - string — Empty string `""` if not available - number — Reflects how many contributor databases this address appears in (0 = 1 database, 1 = 2 database etc.). - `level_geocoded_code` number, required — Binary 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_secondary` string, required — Indicator that identifies if the address is P (Primary) or S (secondary). - `alias_type_code` string, required — Alias type (e.g. "Synonym"). - `geocode_type_code` string, required — Unique abbreviation for the geocode type. - `default_latitude` union, required - string — Empty string `""` if not available - number — Latitude - `default_longitude` union, required - string — Empty string `""` if not available - number — Longitude - `address_change_type_code` string, required — The code indicating the type of change, for example, LOC-STN for locality name and street name change. - `mb_2016_match_code` string, required — Code for mesh block match e.g. 1. - `mb_2021_match_code` string, required — Code for mesh block match e.g. 1. - `address_type` string, required — Address type (e.g. "Postal", Physical"). - `address_site_name` string, required — Address site name. Field length: 200 alphanumeric characters. - `geocode_site_name` string, required — An identifier that relates to this specific geocoded site (e.g. "Transformer 75658"). - `site_geocode_type_code` string, required — Unique abbreviation for geocode feature. (e.g. "PRCL") (SAWG 7.4.1). - `reliability_code` string, required — Spatial precision of the geocode expressed N as number in the range, 1 (unique identification of feature) to 6 (feature associated to region i.e. postcode). - `site_boundary_extent` string, required — Measurement (metres) of a geocode from other geocodes associated with the same address persistent identifier. - `site_planimetric_accuracy` string, required — Planimetric accuracy. - `elevation` string, required — Elevation. This field is not currently populated. - `site_longitude` string, required — Site longitude - `site_latitude` string, required — Site latitude - `geocode_type_priority_order` union, required - string — Empty string `""` if not available - number — The priority order enables a default geocode to be assigned to each address which represents the geocode of the highest precision currently assigned to an address. - `site_geocode_priority_order` union, required - string — Empty string `""` if not available - number — The priority order enables a default geocode to be assigned to each address which represents the geocode of the highest precision currently assigned to an address. - `locality_name` string, required — The name of the locality or suburb. - `primary_postcode` string, required — Required to differentiate localities of the same name within a state. - `locality_class_code` string, required — Describes the class of locality (e.g. Gazetted, topographic feature etc.). Lookup to locality class. - `locality_gnaf_reliability_code` union, required - string — Empty string `""` if not available - number — = 5 if suburb locality, else = 6. Spatial precision of the geocode expressed as number in the range, 1 (unique identification of feature) to 6 (feature associated to region i.e. postcode). - `locality_alias_name` string, required — The alias name for the locality or suburb. - `locality_alias_postcode` string, required — Postcode. - `locality_alias_type_code` string, required — Alias type code for the locality. - `locality_planimetric_accuracy` union, required - string — Empty string `""` if not available - number — Planimetric accuracy of geocode (if known). - `locality_latitude` union, required - string — Empty string `""` if not available - number — Locality latitude - `locality_longitude` union, required - string — Empty string `""` if not available - number — Locality longitude - `mb_2016_code` string, required — The 2016 mesh block code. - `mb_2021_code` string, required — The 2021 mesh block code. - `ps_join_type_code` string, required — Code of 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_name` string, required — The state or territory name. All in uppercase. E.g. TASMANIA. - `state_abbreviation` string, required — The state or territory abbreviation. - `street_class_code` string, required — Defines whether this street represents a confirmed or unconfirmed street. - `street_name` string, required — Street name. e.g. "POPLAR". - `street_type_code` string, required — The street type code. e.g. "PLACE". - `street_suffix_code` string, required — The street suffix code. e.g. "WEST". - `gnaf_street_confidence` union, required - string — Empty string `""` if not available - number — The street confidence level. - `street_locality_gnaf_reliability_code` union, required - string — Empty string `""` if not available - number — Always = 4. Spatial precision of the geocode expressed as number in the range, 1 (unique identification of feature) to 6 (feature associated to region i.e. postcode). - `street_locality_alias_street_name` string, required — The street alias name. e.g. "POPLAR". - `street_locality_alias_street_type_code` string, required — The street type code. e.g. "PLACE". - `street_locality_alias_street_suffix_code` string, required — The street suffix code. e.g. "WEST". - `street_locality_alias_type_code` string, required — The alias type code. - `street_locality_boundary_extent` union, required - string — Empty string `""` if not available - number — Measurement (metres) of a geocode from other geocodes associated with the same address persistent identifier. - `street_locality_planimetric_accuracy` union, required - string — Empty string `""` if not available - number — Planimetric accuracy of geocode (if known). - `street_locality_latitude` union, required - string — Empty string `""` if not available - number — Street locality latitude - `street_locality_longitude` union, required - string — Empty string `""` if not available - number — Street locality longitude - `street_type_name` string, required — Abbreviation of street type - `street_locality_alias_street_type_name` string, required — Abbreviation of street type - KadasterAddress - `id` string, required — Global unique internally generated identifier for an address - `dataset` 'kadaster', required - `country_iso` 'NLD', required — 3 letter country code (ISO 3166-1) - `country_iso_2` 'NL', required — 2 letter country code (ISO 3166-1) - `country` 'Netherlands', required — Full country names (ISO 3166) - `line_1` string, required — First address line. Can be empty string `""` if not present. - `language` 'nl', required — Language represented by 2 letter ISO Code (639-1) - `address` string, required — Address / House Number uniquely identifying the address along the specified street. Can be empty string `""` if not present. - `longitude` union, required — The longitude of the postcode (WGS84/ETRS89). Can be a positive or negative decimal. E.g. -0.1283983 Returns an empty string if no location data is available. - string — Empty string `""` if not available - number — Represents longitude - `latitude` union, required — The latitude of the postcode (WGS84/ETRS89). Can be a positive or negative decimal. E.g. `51.5083983`. Returns an empty string if no location data is available. - string — Empty string `""` if not available - number — Represents latitude - `identificatie` string, required — The unique identifier of a BAG verblijfsobject. - `gebruiksdoel` string, required — The purpose of use of the verblijfsobject. - `oppervlakte` number, required — The area of the verblijfsobject in square metres. - `status` string, required — Verblijfsobject status. - `geconstateerd` boolean, required — Indicates 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. - `documentdatum` string, date, required — Date on which the verblijfsobject source document was created. - `documentnummer` string, required — The unique identifier of the verblijfsobject source document. - `voorkomenidentificatie` union, required - string — Empty string `""` if not available - number — The identifier of this instance of the verblijfsobject history. - `begin_geldigheid` string, date, required — The time at which a version of a verblijfsobject is valid in reality in accordance with the effective date in the source document. - `eind_geldigheid` string, date, required — The time at which a version of a verblijfsobject is no longer valid in reality. Empty string `""` if not applicable. - `tijdstip_registratie` string, date, required — The time at which a version of a verblijfsobject is registered by the bronhouder. - `eind_registratie` string, date, required — The time at which a version of a verblijfsobject is no longer valid according to the bronhouder. Empty string `""` if not applicable. - `tijdstip_registratie_lv` string, date, required — The time at which a version of a verblijfsobject is registered in the Landelijke Voorziening BAG. - `tijdstip_eind_registratie_lv` string, date, required — The time at which a version of a verblijfsobject is no longer valid in the Landelijke Voorziening BAG. Empty string `""` if not applicable. - `nummeraanduidingen_identificatie` string, required — The unique identifier of a BAG nummeraanduiding object. - `nummeraanduidingen_huisnummer` string, required — The house number assigned to a nummeraanduiding object by or on behalf of the municipal council. - `nummeraanduidingen_huisnummertoevoeging` string, required — A further addition to a house number or a combination of house number and house letter granted by or on behalf of the municipal council with regard to a nummeraanduiding object. - `nummeraanduidingen_huisletter` string, required — An 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. - `nummeraanduidingen_postcode` string, required — A code determined by PostNL associated with a specific combination of a street name and a house number. - `nummeraanduidingen_type_adresseerbaar_object` string, required — The nature of the nummeraanduiding object. - `nummeraanduidingen_status` string, required — The status of the nummeraanduiding object. - `nummeraanduidingen_geconstateerd` boolean, required — Indicates 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_documentdatum` string, date, required — Date on which the nummeraanduidingen object source document was created. - `nummeraanduidingen_documentnummer` string, required — The unique identifier of the nummeraanduidingen object source document. - `nummeraanduidingen_voorkomenidentificatie` union, required - string — Empty string `""` if not available - number — The identifier of this instance of the nummeraanduidingen object history. - `nummeraanduidingen_begin_geldigheid` string, date, required — The time at which a version of a nummeraanduidingen object is valid in reality in accordance with the effective date in the source document. - `nummeraanduidingen_eind_geldigheid` string, date, required — The time at which a version of a nummeraanduidingen object is no longer valid in reality. Empty string `""` if not applicable. - `nummeraanduidingen_tijdstip_registratie` string, date, required — The time at which a version of a nummeraanduidingen object is registered by the bronhouder. - `nummeraanduidingen_eind_registratie` string, date, required — The time at which a version of a nummeraanduidingen object is no longer valid according to the bronhouder. Empty string `""` if not applicable. - `nummeraanduidingen_tijdstip_registratie_lv` string, date, required — The time at which a version of a nummeraanduidingen object is registered in the Landelijke Voorziening BAG. - `nummeraanduidingen_tijdstip_eind_registratie_lv` string, date, required — The time at which a version of a nummeraanduidingen object is no longer valid in the Landelijke Voorziening BAG. Empty string `""` if not applicable. - `pand_identificatie` string, required — The unique identifier of a BAG pand object. - `pand_oorspronkelijk_bouwjaar` union, required - string — Empty string `""` if not available - number — The year in which a building was or will be originally completed. - `pand_status` string, required — The status of the pand object. - `pand_geconstateerd` boolean, required — Indicates 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_documentdatum` string, date, required — Date on which the pand object source document was created. - `pand_documentnummer` string, required — The unique identifier of the pand object source document. - `pand_voorkomenidentificatie` union, required - string — Empty string `""` if not available - number — The identifier of this instance of the pand object history. - `pand_begin_geldigheid` string, date, required — The time at which a version of a pand object is valid in reality in accordance with the effective date in the source document. - `pand_eind_geldigheid` string, date, required — The time at which a version of a pand object is no longer valid in reality. Empty string `""` if not applicable. - `pand_tijdstip_registratie` string, date, required — The time at which a version of a pand object is registered by the bronhouder. - `pand_eind_registratie` string, date, required — The time at which a version of a pand object is no longer valid according to the bronhouder. Empty string `""` if not applicable. - `pand_tijdstip_registratie_lv` string, date, required — The time at which a version of a pand object is registered in the Landelijke Voorziening BAG. - `pand_tijdstip_eind_registratie_lv` string, date, required — The time at which a version of a pand object is no longer valid in the Landelijke Voorziening BAG. Empty string `""` if not applicable. - `openbare_ruimte_identificatie` string, required — The unique identifier of a BAG openbare ruimte object. - `openbare_ruimte_naam` string, required — The name assigned to an openbare ruimte object by or on behalf of the municipal council. - `openbare_ruimte_type` string, required — The nature of the openbare ruimte object. - `openbare_ruimte_status` string, required — The status of the openbare ruimte object. - `openbare_ruimte_geconstateerd` boolean, required — Indicates 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_documentdatum` string, date, required — Date on which the openbare ruimte object source document was created. - `openbare_ruimte_documentnummer` string, required — The unique identifier of the openbare ruimte object source document. - `openbare_ruimte_voorkomenidentificatie` union, required - string — Empty string `""` if not available - number — The identifier of this instance of the openbare ruimte object history. - `openbare_ruimte_begin_geldigheid` string, date, required — The time at which a version of an openbare ruimte object is valid in reality in accordance with the effective date in the source document. - `openbare_ruimte_eind_geldigheid` string, date, required — The time at which a version of an openbare ruimte object is no longer valid in reality. Empty string `""` if not applicable. - `openbare_ruimte_tijdstip_registratie` string, date, required — The time at which a version of an openbare ruimte object is registered by the bronhouder. - `openbare_ruimte_eind_registratie` string, date, required — The time at which a version of an openbare ruimte object is no longer valid according to the bronhouder. Empty string `""` if not applicable. - `openbare_ruimte_tijdstip_registratie_lv` string, date, required — The time at which a version of an openbare ruimte object is registered in the Landelijke Voorziening BAG. - `openbare_ruimte_tijdstip_eind_registratie_lv` string, date, required — The time at which a version of an openbare ruimte object is no longer valid in the Landelijke Voorziening BAG. Empty string `""` if not applicable. - `openbare_ruimte_verkorte_naam` string, required — An abbreviated name assigned to an openbare ruimte object if its name is longer than 24 characters. - `woonplaats_identificatie` string, required — The unique identifier of a BAG woonplaats object. - `woonplaats_naam` string, required — The name assigned to a woonplaats object by or on behalf of the municipal council. - `woonplaats_status` string, required — The status of the woonplaats object. - `woonplaats_geconstateerd` boolean, required — Indicates 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_documentdatum` string, date, required — Date on which the woonplaats object source document was created. - `woonplaats_documentnummer` string, required — The unique identifier of the woonplaats object source document. - `woonplaats_voorkomenidentificatie` union, required - string — Empty string `""` if not available - number — The identifier of this instance of the woonplaats object history. - `woonplaats_begin_geldigheid` string, date, required — The time at which a version of a woonplaats object is valid in reality in accordance with the effective date in the source document. - `woonplaats_eind_geldigheid` string, date, required — The time at which a version of a woonplaats object is no longer valid in reality. Empty string `""` if not applicable. - `woonplaats_tijdstip_registratie` string, date, required — The time at which a version of a woonplaats object is registered by the bronhouder. - `woonplaats_eind_registratie` string, date, required — The time at which a version of a woonplaats object is no longer valid according to the bronhouder. Empty string `""` if not applicable. - `woonplaats_tijdstip_registratie_lv` string, date, required — The time at which a version of a woonplaats object is registered in the Landelijke Voorziening BAG. - `woonplaats_tijdstip_eind_registratie_lv` string, date, required — The time at which a version of a woonplaats object is no longer valid in the Landelijke Voorziening BAG. Empty string `""` if not applicable. - `provincie` string, required — The province name. - KartverketAddress - `id` string, required — Global unique internally generated identifier for an address - `dataset` 'kartverket', required - `country_iso` 'NOR' | 'SJM', required — 3 letter country code (ISO 3166-1) - `country_iso_2` 'NO' | 'SJ', required — 2 letter country code (ISO 3166-1) - `country` 'Norway' | 'Svalbard and Jan Mayen', required — Full country names (ISO 3166) - `line_1` string, required — First address line. Can be empty string `""` if not present. - `line_2` string, required — Second address line. Can be empty string `""` if not present. - `language` 'no', required — Language represented by 2 letter ISO Code (639-1) - `address` string, required — Address / House Number uniquely identifying the address along the specified street. Can be empty string `""` if not present. - `longitude` union, required — The longitude of the postcode (WGS84/ETRS89). Can be a positive or negative decimal. E.g. -0.1283983 Returns an empty string if no location data is available. - string — Empty string `""` if not available - number — Represents longitude - `latitude` union, required — The latitude of the postcode (WGS84/ETRS89). Can be a positive or negative decimal. E.g. `51.5083983`. Returns an empty string if no location data is available. - string — Empty string `""` if not available - number — Represents latitude - `lokal_id` string, required — Local identifier assigned by the data supplier. Can be empty string `""` if not present. - `kommunenummer` string, required — Kommune (municipality) number. - `kommunenavn` string, required — Kommune (municipality) name. - `adressetype` string, required — `vegadresse` = street address, `matrikkeladresse` = land registry address - `adressetilleggsnavn` string, required — A local place name used in a road address. Can be empty string `""` if not present. - `adressetilleggsnavn_kilde` string, required — Code for adressetilleggsnavn origin. Can be empty string `""` if not present. - `adressekode` union, required - string — Empty string `""` if not available - number — A number that uniquely identifies addressable streets, roads, paths, places and areas that are entered in the land register. - `adressenavn` string, required — Name of street, road, path, place or area entered in the land register. Can be empty string `""` if not present. - `nummer` union, required - string — Empty string `""` if not available - number — A number that uniquely identifies properties, facilities, buildings or entrances to buildings within an addressable street, road, path, place or area. - `bokstav` string, required — A subsequent letter that may be used in addition to a number. Can be empty string `""` if not present. - `gardsnummer` number, required — The number of a farm unit in the land register, unique within each municipality. - `bruksnummer` number, required — A unique identification number automatically assigned to each individual unit within a farm. - `festenummer` union, required - string — Empty string `""` if not available - number — The number of a fixture within a gardsnummer/bruksnummer. - `seksjonsnummer` union, required - string — Empty string `""` if not available - number — The number of a section within a gardsnummer/bruksnummer and possibly a festenummer. - `undernummer` union, required - string — Empty string `""` if not available - number — A sub-number within a gardsnummer, bruksnummer and festenummer. - `adresse_tekst` string, required — Official address text without bruksenhetsnummer, unique within a kommune. Can be empty string `""` if not present. - `adresse_tekst_uten_adressetilleggsnavn` string, required — Official address text without bruksenhetsnummer and adressetilleggsnavn, unique within a kommune. Can be empty string `""` if not present. - `bruksenhet_id` string, required — Local identifier for a unit within a building. Can be empty string `""` if not present. - `bruksenhetsnummer_tekst` string, required — Unit number, e.g. an apartment in a multi-dwelling building. Can be empty string `""` if not present. - `offisiell_adresse_tekst` string, required — Official address text with bruksenhetsnummer, unique within a kommune. Can be empty string `""` if not present. - `offisiell_adresse_tekst_uten_adressetilleggsnavn` string, required — Official address text with bruksenhetsnummer and without adressetilleggsnavn, unique within a kommune. Can be empty string `""` if not present. - `epsg_kode` number, required — EPSG code = `25833`. - `nord` string, required — Northward coordinate of address. - `oest` string, required — Eastward coordinate of address. - `postnummer` string, required — Postal code. - `poststed` string, required — Name of postal town according to Posten. - `grunnkretsnummer` string, required — Identifier 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. - `grunnkretsnavn` string, required — Official grunnkrets name from Statistics Norway (SSB). Can be empty string `""` if not present. - `soknenummer` string, required — Unique 8 digit identifier of a parish. Can be empty string `""` if not present. - `soknenavn` string, required — Parish name. Can be empty string `""` if not present. - `organisasjonsnummer` string, required — Unique identifier of organisation in the Brønnøysund Register. Can be empty string `""` if not present. - `tettstednummer` string, required — 4 digit code for tettsted (urban settlement). Can be empty string `""` if not present. - `tettstednavn` string, required — Name of tettsted (urban settlement). Can be empty string `""` if not present. - `valgkretsnummer` union, required - string — Empty string `""` if not available - number — Constituency code within a kommune. - `valgkretsnavn` string, required — Name of constituency. Can be empty string `""` if not present. - `oppdateringsdato` string, required — Date of last change to the object data. - `datauttaksdato` string, required — Date of extraction from database. - `adresse_id` string, required — Address local identifier assigned by the data supplier. - `uuid_adresse` string, required — Address identifier realized as UUID managed by the cadastral system. - `uuid_bruksenhet` string, required — Unit of usage identifier realized as UUID managed by the cadastral system. Can be empty string `""` if not present. - `atkomst_id` string, required — Local identifier for means of access to a property. Can be empty string `""` if not present. - `uuid_atkomst` string, required — Identifier of the means of access to a property realized as UUID in the cadastral system. Can be empty string `""` if not present. - `atkomst_nord` string, required — Northward coordinate of the means of access to a property. Can be empty string `""` if not present. - `atkomst_oest` string, required — Eastward coordinate of the means of access to a property. Can be empty string `""` if not present. - `sommeratkomst_id` string, required — Local identifier for means of access to a property in summer. Can be empty string `""` if not present. - `uuid_sommeratkomst` string, required — Identifier of the means of access to a property in summer realized as UUID in the cadastral system. Can be empty string `""` if not present. - `sommeratkomst_nord` string, required — Northward coordinate of the means of access to a property in summer. Can be empty string `""` if not present. - `sommeratkomst_oest` string, required — Eastward coordinate of the means of access to a property in summer. Can be empty string `""` if not present. - `vinteratkomst_id` string, required — Local identifier for means of access to a property in winter. Can be empty string `""` if not present. - `uuid_vinteratkomst` string, required — Identifier of the means of access to a property in winter realized as UUID in the cadastral system. Can be empty string `""` if not present. - `vinteratkomst_nord` string, required — Northward coordinate of the means of access to a property in winter. Can be empty string `""` if not present. - `vinteratkomst_oest` string, required — Eastward coordinate of the means of access to a property in winter. Can be empty string `""` if not present. - `fylke` string, required — Name of county. - `landsdel` string, required — Name of region. - SdfiAddress - `id` string, required — Global unique internally generated identifier for an address - `dataset` 'sdfi', required - `country_iso` 'DNK', required — 3 letter country code (ISO 3166-1) - `country_iso_2` 'DK', required — 2 letter country code (ISO 3166-1) - `country` 'Denmark', required — Full country names (ISO 3166) - `line_1` string, required — First address line. Can be empty string `""` if not present. - `line_2` string, required — Second address line. Can be empty string `""` if not present. - `language` 'da', required — Language represented by 2 letter ISO Code (639-1) - `address` string, required — Address / House Number uniquely identifying the address along the specified street. Can be empty string `""` if not present. - `longitude` union, required — The longitude of the postcode (WGS84/ETRS89). Can be a positive or negative decimal. E.g. -0.1283983 Returns an empty string if no location data is available. - string — Empty string `""` if not available - number — Represents longitude - `latitude` union, required — The latitude of the postcode (WGS84/ETRS89). Can be a positive or negative decimal. E.g. `51.5083983`. Returns an empty string if no location data is available. - string — Empty string `""` if not available - number — Represents latitude - `adresse_id` string, required — Unique address identifier assigned by the data supplier. - `kvhx` string, required — Unique composite key for the address, containing codes for the municipality, road section, house number, floor and door. Can be empty string `""` if not present. - `kvh` string, required — Composite key for the address, containing codes for the municipality, road section and house number. Can be empty string `""` if not present. - `adgangsadresse` boolean, required — Indicates whether the address is an access address. - `status` string, required — `1` = final address, `3` = provisional address. - `darstatus` string, required — Status of the address indicated by the status code in Danmarks Adresseregister (DAR): `2` = provisional, `3` = valid, `4` = retired, `5` = suspended. - `oprettet` string, required — Date and time of address creation in Danmarks Adresseregister (DAR). Can be empty string `""` if not present. - `ændret` string, required — Date and time of the last change to the address in Danmarks Adresseregister (DAR). Can be empty string `""` if not present. - `ikrafttrædelse` string, required — Date and time at which the address became valid. Can be empty string `""` if not present. - `nedlagt` string, required — Date and time from which the address is retired or suspended (may be in the future). Can be empty string `""` if not present. - `vejkode` string, required — Four digit street identifier. - `vejnavn` string, required — Street name. - `adresseringsvejnavn` string, required — A possibly shortened version of the street name of no more than 20 characters, used where there is no space for the full street name. - `husnr` string, required — House number. - `etage` string, required — Floor designation. Can be empty string `""` if not present. - `dør` string, required — Door designation. Can be empty string `""` if not present. - `supplerendebynavn_dagi_id` string, required — Unique identifier in Danmarks Administrative Geografiske Inddeling (DAGI) of the supplementary town or city name. Can be empty string `""` if not present. - `supplerendebynavn` string, required — Supplementary city name. Can be empty string `""` if not present. - `postnr` string, required — Postal code. - `postnrnavn` string, required — The city or district name associated with the postal code. - `stormodtagerpostnr` string, required — Bulk recipient postal code (company postal code) which is associated with the address. Can be empty string `""` if not present. - `stormodtagerpostnrnavn` string, required — The city or district name associated with the bulk recipient postal code. Can be empty string `""` if not present. - `betegnelse` string, required — Full text of postal address. - `adressepunktændringsdato` string, required — Date and time of the last change to the address point. Can be empty string `""` if not present. - `etrs89koordinat_øst` string, required — Easting coordinate for the address in the ETRS89 system. - `etrs89koordinat_nord` string, required — Northing coordinate for the address in the ETRS89 system. - `wgs84koordinat_bredde` union, required — Latitude of the address in the WGS84 system. Can be empty string `""` if not present. - string - number - `wgs84koordinat_længde` union, required — Longitude of the address in the WGS84 system. Can be empty string `""` if not present. - string - number - `højde` string, required — Height 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øjagtighed` string, required — Code indicating the accuracy of the address point. `A` = accurate to within 2 metres, `B` = accurate to within 100 metres, `U` = no address point. - `kilde` string, required — Code indicating the source of the address point. Can be empty string `""` if not present. - `tekniskstandard` string, required — Technical classification code for the location of an address point. - `tekstretning` string, required — Orientation for an address in gons, where a full circle is divided into 400 gons. - `ddkn_m100` string, required — Identifier of the 100m cell in which the address is located in Det Danske Kvadratnet (DDKN). - `ddkn_km1` string, required — Identifier of the 1km cell in which the address is located in Det Danske Kvadratnet (DDKN). - `ddkn_km10` string, required — Identifier of the 10km cell in which the address is located in Det Danske Kvadratnet (DDKN). - `kommunekode` string, required — Four digit identifier of the municipality in which the address is located. - `kommunenavn` string, required — Name of the municipality in which the address is located. - `landsdelsnuts3` string, required — NUTS 3 code of the province in which the address is located. - `landsdelsnavn` string, required — Name of the province in which the address is located. - `regionskode` string, required — Four digit identifier of the region in which the address is located. - `regionsnavn` string, required — Name of the region in which the address is located. - `afstemningsområdenummer` string, required — Identifier of the polling district in which the address is located. - `afstemningsområdenavn` string, required — Unique name of the polling district in which the address is located. - `menighedsrådsafstemningsområdenummer` string, required — Identifier of the parish council polling district in which the address is located. Can be empty string `""` if not present. - `menighedsrådsafstemningsområdenavn` string, required — Name of the parish council polling district in which the address is located. Can be empty string `""` if not present. - `opstillingskredskode` string, required — Identifier of the local electoral district in which the address is located. - `opstillingskredsnavn` string, required — Name of the local electoral district in which the address is located. - `storkredsnummer` string, required — Identifier of the regional electoral district in which the address is located. - `storkredsnavn` string, required — Name of the regional electoral district in which the address is located. - `valglandsdelsbogstav` string, required — Letter identifier of the national electoral district in which the address is located: `A`, `B` or `C`. - `valglandsdelsnavn` string, required — Name of the national electoral district in which the address is located. - `sognekode` string, required — Identifier of the parish in which the address is located. - `sognenavn` string, required — Name of the parish in which the address is located. - `politikredskode` string, required — Identifier of the police district in which the address is located. - `politikredsnavn` string, required — Name of the police district in which the address is located. - `retskredskode` string, required — Four digit identifier of the judicial district in which the address is located. - `retskredsnavn` string, required — Name of the judicial district in which the address is located. - `jordstykke_ejerlavkode` string, required — Identifier of a cadastral unit with a single owner. Can be empty string `""` if not present. - `jordstykke_ejerlavnavn` string, required — Name of a cadastral unit with a single owner. Can be empty string `""` if not present. - `jordstykke_matrikelnr` string, required — Cadastre 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_esrejendomsnr` string, required — Identifier 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. - `ejerlavkode` string, required — Identifier of a cadastral unit with a single owner (deprecated). Can be empty string `""` if not present. - `ejerlavnavn` string, required — Name of a cadastral unit with a single owner (deprecated). Can be empty string `""` if not present. - `matrikelnr` string, required — Cadastre 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. - `esrejendomsnr` string, required — Identifier 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. - `zone` string, required — Status of the address zone: `Byzone`, `Sommerhusområde` or `Landzone`. - `brofast` boolean, required — Indicates whether the address is connected by a bridge. - `adgangsadresseid` string, required — Identifier of the access address associated with the address. Can be empty string `""` if not present. - `adgangspunktid` string, required — Identifier of the access point for the address. - `navngivenvej_id` string, required — Identifier of the named road on which the access address is located. - `adgangsadresse_status` string, required — Status of the access address associated with the address: `1` = final address, `3` = provisional address. - `adgangsadresse_darstatus` string, required — Status 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_oprettet` string, required — Date and time of the creation of the access address associated with the address. Can be empty string `""` if not present. - `adgangsadresse_ændret` string, required — Date and time of the last change to the access address associated with the address. Can be empty string `""` if not present. - `adgangsadresse_ikrafttrædelse` string, required — Date and time at which the access address became valid. Can be empty string `""` if not present. - `adgangsadresse_nedlagt` string, required — Date and time from which the access address is retired or suspended (may be in the future). Can be empty string `""` if not present. - `vejpunkt_id` string, required — Unique 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_ændret` string, required — Date 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_kilde` string, required — Source 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øjagtighed` string, required — Accuracy 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_tekniskstandard` string, required — Technical 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_x` string, required — Longitude 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_y` string, required — Latitude 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. - CannarAddress - `id` string, required — Global unique internally generated identifier for an address - `dataset` 'cannar', required - `country_iso` 'CAN', required — 3 letter country code (ISO 3166-1) - `country_iso_2` 'CA', required — 2 letter country code (ISO 3166-1) - `country` 'Canada', required — Full country names (ISO 3166) - `line_1` string, required — First address line. Can be empty string `""` if not present. - `line_2` string, required — Second address line. Can be empty string `""` if not present. - `language` 'en' | 'fr', required — Language represented by 2 letter ISO Code (639-1) - `address` string, required — Address / House Number uniquely identifying the address along the specified street. Can be empty string `""` if not present. - `longitude` union, required — The longitude of the postcode (WGS84/ETRS89). Can be a positive or negative decimal. E.g. -0.1283983 Returns an empty string if no location data is available. - string — Empty string `""` if not available - number — Represents longitude - `latitude` union, required — The latitude of the postcode (WGS84/ETRS89). Can be a positive or negative decimal. E.g. `51.5083983`. Returns an empty string if no location data is available. - string — Empty string `""` if not available - number — Represents latitude - `loc_guid` string, required — Globally unique identifier for location. - `addr_guid` string, required — Globally unique identifier for address. - `apt_no_label` string, required — Apartment or suite number. Can be empty string `""` if not present. - `civic_no` string, required — The building number assigned to the address. Can be empty string `""` if not present. - `civic_no_suffix` string, required — A suffix attached to the civic number. Can be empty string `""` if not present. - `official_street_name` string, required — Official street name. Can be empty string `""` if not present. - `official_street_type` string, required — Official street designator. Can be empty string `""` if not present. - `official_street_dir` string, required — Official street direction. Can be empty string `""` if not present. - `prov_code` string, required — Province code. - `csd_eng_name` string, required — Census subdivision English name. Can be empty string `""` if not present. - `csd_fre_name` string, required — Census subdivision French name. Can be empty string `""` if not present. - `csd_type_eng_code` string, required — English code indicating the type of Census Subdivision. Can be empty string `""` if not present. - `csd_type_fre_code` string, required — French code indicating the type of Census Subdivision. Can be empty string `""` if not present. - `mail_street_name` string, required — Name of the street used in the mailing address. Can be empty string `""` if not present. - `mail_street_type` string, required — Designator of the street used in the mailing address. Can be empty string `""` if not present. - `mail_street_dir` string, required — Direction of the street used in the mailing address. Can be empty string `""` if not present. - `mail_mun_name` string, required — Municipality name used in the mailing address. Can be empty string `""` if not present. - `mail_prov_abvn` string, required — Province abbreviation used in the mailing address. Can be empty string `""` if not present. - `mail_postal_code` string, required — Postal code used in the mailing address. Can be empty string `""` if not present. - `bg_dls_lsd` string, required — Legal Subdivision number within the Dominion Land Survey system for the address location. Can be empty string `""` if not present. - `bg_dls_qtr` string, required — Quarter section within a section of the Dominion Land Survey system for the address location. Can be empty string `""` if not present. - `bg_dls_sctn` string, required — Section number within a township of the Dominion Land Survey system for the address location. Can be empty string `""` if not present. - `bg_dls_twnshp` string, required — Township number within the Dominion Land Survey system for the address location. Can be empty string `""` if not present. - `bg_dls_rng` string, required — Range number within a meridian of the Dominion Land Survey system for the address location. Can be empty string `""` if not present. - `bg_dls_mrd` string, required — Meridian number within the Dominion Land Survey system for the address location. Can be empty string `""` if not present. - `bg_x` string, required — Spatial X coordinate (GPS) of building. (ESPG 3347) Can be empty string `""` if not present. - `bg_y` string, required — Spatial Y coordinate (GPS) of building. (ESPG 3347) Can be empty string `""` if not present. - `bu_n_civic_add` string, required — Additional delivery information for mailing address. Can be empty string `""` if not present. - `bu_use` string, required — Building usage codes. Can be empty string `""` if not present. - `csd_code` string, required — Unique identifier code for a Census Subdivision (CSD). Can be empty string `""` if not present. - `fed_code` string, required — Unique identifier code for a federal electoral district. Can be empty string `""` if not present. - `fed_eng_name` string, required — Name of the federal electoral district in English. Can be empty string `""` if not present. - `fed_fre_name` string, required — Name of the federal electoral district in French. Can be empty string `""` if not present. - `er_code` string, required — Unique identifier code for an economic region. Can be empty string `""` if not present. - `er_eng_name` string, required — Name of the economic region in English. Can be empty string `""` if not present. - `er_fre_name` string, required — Name of the economic region in French. Can be empty string `""` if not present. - `reppoint_latitude` union, required — The latitude of the postcode (WGS84/ETRS89). Can be a positive or negative decimal. E.g. `51.5083983`. Returns an empty string if no location data is available. - string — Empty string `""` if not available - number — Represents latitude - `reppoint_longitude` union, required — The longitude of the postcode (WGS84/ETRS89). Can be a positive or negative decimal. E.g. -0.1283983 Returns an empty string if no location data is available. - string — Empty string `""` if not available - number — Represents longitude - FodbosaAddress - `id` string, required — Global unique internally generated identifier for an address - `dataset` 'fodbosa', required - `country_iso` 'BEL', required — 3 letter country code (ISO 3166-1) - `country_iso_2` 'BE', required — 2 letter country code (ISO 3166-1) - `country` 'Belgium', required — Full country names (ISO 3166) - `line_1` string, required — First address line. Can be empty string `""` if not present. - `language` 'de' | 'fr' | 'nl', required — Language represented by 2 letter ISO Code (639-1) - `address` string, required — Address / House Number uniquely identifying the address along the specified street. Can be empty string `""` if not present. - `longitude` union, required — The longitude of the postcode (WGS84/ETRS89). Can be a positive or negative decimal. E.g. -0.1283983 Returns an empty string if no location data is available. - string — Empty string `""` if not available - number — Represents longitude - `latitude` union, required — The latitude of the postcode (WGS84/ETRS89). Can be a positive or negative decimal. E.g. `51.5083983`. Returns an empty string if no location data is available. - string — Empty string `""` if not available - number — Represents latitude - `epsg_31370_x` string, required — X coordinate of the address in the BD72 / Belgian Lambert 72 (EPSG:31370) coordinate system. - `epsg_31370_y` string, required — Y coordinate of the address in the BD72 / Belgian Lambert 72 (EPSG:31370) coordinate system. - `epsg_4326_lat` string, required — Latitude of the address in the WGS84 (EPSG:4326) coordinate system. - `epsg_4326_lon` string, required — Longitude of the address in the WGS84 (EPSG:4326) coordinate system. - `address_id` string, required — Address local identifier assigned by the data supplier. - `box_number` string, required — PO Box number. Can be empty string `""` if not present. - `house_number` string, required — House number. Can be empty string `""` if not present. - `municipality_id` string, required — Municipality local identifier assigned by the data supplier. - `municipality_name_de` string, required — Municipality name in German. Can be empty string `""` if not present. - `municipality_name_fr` string, required — Municipality name in French. Can be empty string `""` if not present. - `municipality_name_nl` string, required — Municipality name in Dutch. Can be empty string `""` if not present. - `postcode` string, required — Postal code. - `postname_fr` string, required — Name of postal area in French. Can be empty string `""` if not present. - `postname_nl` string, required — Name of postal area in Dutch. Can be empty string `""` if not present. - `street_id` string, required — Street local identifier assigned by the data supplier. - `streetname_de` string, required — Street name in German. Can be empty string `""` if not present. - `streetname_fr` string, required — Street name in French. Can be empty string `""` if not present. - `streetname_nl` string, required — Street name in Dutch. Can be empty string `""` if not present. - `region_code` string, required — ISO 3166-2 code of the region in which the address is located. - `status` string, required — Status of the address: `current`, `proposed` or `retired`. - MoisAddress - `id` string, required — Global unique internally generated identifier for an address - `dataset` 'mois', required - `country` 'South Korea', required — Full country names (ISO 3166) - `country_iso` 'KOR', required — 3 letter country code (ISO 3166-1) - `country_iso_2` 'KR', required — 2 letter country code (ISO 3166-1) - `language` 'ko', required — Language represented by 2 letter ISO Code (639-1) - `address` string, required — Address / House Number identifying the address along the specified street. Can be empty string `""` if not present. - `line_1` string, required — First address line. Can be empty string `""` if not present. - `line_2` string, required — Second address line. Can be empty string `""` if not present. - `city` string, required — Preferred city name. Can be empty string `""` if not present. - `province` string, required — Preferred province name. Can be empty string `""` if not present. - `법정읍면동명` string, required — Legal town name. Can be empty string `""` if not present. - `법정동코드` string, required — Legal district code. - `법정리명` string, required — Legal name. Can be empty string `""` if not present. - `비고1` string, required — Note 1. Can be empty string `""` if not present. - `비고2` string, required — Note 2. Can be empty string `""` if not present. - `변동전도로명주소` string, required — Changed street name address. Can be empty string `""` if not present. - `변경이력정보` string, required — Change history information. Can be empty string `""` if not present. - `변경이력사유` string, required — Change history reason. Can be empty string `""` if not present. - `변경전_도로명주소` string, required — Previous road name address. Can be empty string `""` if not present. - `변경사유` string, required — Change reason. Can be empty string `""` if not present. - `변경사유코드` string, required — Change reason code. Can be empty string `""` if not present. - `층일련번호` string, required — Floor serial number. Can be empty string `""` if not present. - `층명칭` string, required — Floor name. Can be empty string `""` if not present. - `대표지번여부` string, required — Is representative address. Can be empty string `""` if not present. - `대표여부` string, required — Is representative. Can be empty string `""` if not present. - `다량배달처명` string, required — Bulk delivery location name. Can be empty string `""` if not present. - `동일련번호` string, required — Building serial number. Can be empty string `""` if not present. - `동명칭` string, required — Building name. Can be empty string `""` if not present. - `도로명` string, required — Road name. Can be empty string `""` if not present. - `도로명_로마자` string, required — Romanized road name. Can be empty string `""` if not present. - `도로명번호` string, required — Road name number. Can be empty string `""` if not present. - `도로명코드` string, required — Road name code. - `도로명코드_고시일자` string, required — Road name code creation date. Can be empty string `""` if not present. - `도로명코드_말소일자` string, required — Road name code deletion date. Can be empty string `""` if not present. - `읍면동구분` string, required — Town classification. Can be empty string `""` if not present. - `읍면동일련번호` string, required — Town serial number. Can be empty string `""` if not present. - `읍면동코드` string, required — Town code. Can be empty string `""` if not present. - `읍면동명` string, required — Town name. Can be empty string `""` if not present. - `읍면동명_로마자` string, required — Romanized town name. Can be empty string `""` if not present. - `건축물대장_건물명` string, required — Building name in building register. Can be empty string `""` if not present. - `건물본번` string, required — Building number. - `건물부번` string, required — Building sub-number. Can be empty string `""` if not present. - `건물관리번호` string, required — Building management number. Can be empty string `""` if not present. - `기초구역번호` string, required — Basic area number. Can be empty string `""` if not present. - `공동주택여부` string, required — Is apartment. Can be empty string `""` if not present. - `고시일자` string, required — Creation date. Can be empty string `""` if not present. - `관리번호` string, required — Management number. Can be empty string `""` if not present. - `행정동코드` string, required — Administrative district code. Can be empty string `""` if not present. - `행정동명` string, required — Administrative district name. Can be empty string `""` if not present. - `호일련번호` string, required — Unit serial number. Can be empty string `""` if not present. - `호명칭` string, required — Unit name. Can be empty string `""` if not present. - `호접미사일련번호` string, required — Unit suffix serial number. Can be empty string `""` if not present. - `호접미사명칭` string, required — Unit suffix name. Can be empty string `""` if not present. - `이동사유코드` string, required — Movement reason code. Can be empty string `""` if not present. - `일련번호` string, required — Serial number. Can be empty string `""` if not present. - `지번일련번호` string, required — Address serial number. Can be empty string `""` if not present. - `지번본번_번지` string, required — Address building number. Can be empty string `""` if not present. - `지번부번_호` string, required — Address unit number. Can be empty string `""` if not present. - `지하구분` string, required — Is basement. Can be empty string `""` if not present. - `지하여부` string, required — Level (ground level, underground, aerial). - `산여부` string, required — Is mountain. Can be empty string `""` if not present. - `상위도로명` string, required — Upper road name. Can be empty string `""` if not present. - `상위도로명번호` string, required — Upper road name number. Can be empty string `""` if not present. - `상세건물명` string, required — Detailed building name. Can be empty string `""` if not present. - `상세주소_부여여부` string, required — Whether detailed address assigned. Can be empty string `""` if not present. - `상세주소여부` string, required — Whether detailed address exists. Can be empty string `""` if not present. - `사용여부` string, required — In use. Can be empty string `""` if not present. - `시도명` string, required — City name. - `시도명_로마자` string, required — Romanized city name. Can be empty string `""` if not present. - `시군구_건물명` string, required — District building name. Can be empty string `""` if not present. - `시군구코드` string, required — District code. Can be empty string `""` if not present. - `시군구명` string, required — District name. Can be empty string `""` if not present. - `시군구명_로마자` string, required — Romanized district name. Can be empty string `""` if not present. - `시군구용_건물명` string, required — District building name. Can be empty string `""` if not present. - `우편일련번호` string, required — Postal sequence number. Can be empty string `""` if not present. - `우편번호` string, required — Postal code. Can be empty string `""` if not present. - `우편번호_일련번호` string, required — Postal code serial number. Can be empty string `""` if not present. - `영문_법정리명` string, required — English legal name. Can be empty string `""` if not present. - `영문읍면동명` string, required — English town name. Can be empty string `""` if not present. - `영문_법정읍면동명` string, required — English legal town name. Can be empty string `""` if not present. - `영문도로명` string, required — English road name. Can be empty string `""` if not present. - `영문시도명` string, required — English city name. Can be empty string `""` if not present. - `영문시군구명` string, required — English district name. Can be empty string `""` if not present. - UpujpAddress - `id` string, required — Global unique internally generated identifier for an address - `dataset` 'upujp', required - `country` 'Japan', required — Full country names (ISO 3166) - `country_iso` 'JPN', required — 3 letter country code (ISO 3166-1) - `country_iso_2` 'JP', required — 2 letter country code (ISO 3166-1) - `language` 'ja' | 'en', required — Language represented by 2 letter ISO Code (639-1) - `line_1` string, required — First address line. Can be empty string `""` if not present. - `address` string, required — Address / House Number uniquely identifying the address along the specified street. Can be empty string `""` if not present. - `building_name` string, required — Preferred building name. Can be empty string `""` if not present. - `neighbourhood` string, required — Preferred neighbourhood name. Can be empty string `""` if not present. - `district` string, required — Preferred district name. Can be empty string `""` if not present. - `city` string, required — Preferred city name. Can be empty string `""` if not present. - `prefecture` string, required — Preferred prefecture name. Can be empty string `""` if not present. - `postcode` string, required — Preferred postal code. Can be empty string `""` if not present. - `longitude` union, required — The longitude of the postcode (WGS84/ETRS89). Can be a positive or negative decimal. E.g. -0.1283983 Returns an empty string if no location data is available. - string — Empty string `""` if not available - number — Represents longitude - `latitude` union, required — The latitude of the postcode (WGS84/ETRS89). Can be a positive or negative decimal. E.g. `51.5083983`. Returns an empty string if no location data is available. - string — Empty string `""` if not available - number — Represents latitude - `org_id` string, required — The unique identifier of an organisation. Can be empty string `""` if not present. - `org_type_ind` union, required — Indicates the type of organisation. Can be empty string `""` if not present. - string - number - `org_sub_type_ind` union, required — Indicates the sub-type of the organisation. Can be empty string `""` if not present. - string - number - `org_loc_id` string, required — Locality identifier for the organisation. Can be empty string `""` if not present. - `org_dis_id` string, required — District identifier for the organisation. Can be empty string `""` if not present. - `org_nei_id` string, required — Neighbourhood identifier for the organisation. Can be empty string `""` if not present. - `org_org_id` string, required — Associated organisation identifier for the organisation. Can be empty string `""` if not present. - `org_name` string, required — Name of the organisation. Can be empty string `""` if not present. - `org_name_trans` string, required — Translated name of the organisation in Latin script. Can be empty string `""` if not present. - `org_loc_sfx` string, required — Suffix of the locality for the organisation. Can be empty string `""` if not present. - `org_loc_sfx_trans` string, required — Translated suffix of the locality for the organisation in Latin script. Can be empty string `""` if not present. - `org_adr` string, required — Address of the organisation. Can be empty string `""` if not present. - `org_adr_trans` string, required — Translated address of the organisation in Latin script. Can be empty string `""` if not present. - `org_po_ind` union, required — Indicates whether the organisation has a post office box. Can be empty string `""` if not present. - string - number - `org_po_start` string, required — Post office box number or start of the post office box range associated with the organisation. Can be empty string `""` if not present. - `org_po_end` string, required — End of the post office box range associated with the organisation. Can be empty string `""` if not present. - `org_dsc` string, required — Additional information about the organisation. Can be empty string `""` if not present. - `org_dsc_trans` string, required — Translated additional information about the organisation in Latin script. Can be empty string `""` if not present. - `org_pcode` string, required — Postal code for the organisation. Can be empty string `""` if not present. - `org_pcode_fin` string, required — Final postal code for the organisation. Can be empty string `""` if not present. - `org_script` string, required — Script used for the organisation name. `Hani` = Kanji, `Hira` = Hiragana, `Latn` = Latin. Can be empty string `""` if not present. - `org_language` string, required — Language used for the organisation name. Can be empty string `""` if not present. - `str_id` string, required — Identifier of the street (not unique). Can be empty string `""` if not present. - `str_key` string, required — Permanent identifier of the street. Can be empty string `""` if not present. - `str_loc_id` string, required — Locality identifier for the street. Can be empty string `""` if not present. - `str_dis_id` string, required — District identifier for the street. Can be empty string `""` if not present. - `str_nei_id` string, required — Neighbourhood identifier for the street. Can be empty string `""` if not present. - `str_org_id` string, required — Associated organisation identifier for the street. Can be empty string `""` if not present. - `str_pfx` string, required — Prefix of the street name. Can be empty string `""` if not present. - `str_pfx_trans` string, required — Translated prefix of the street name in Latin script. Can be empty string `""` if not present. - `str_qlf_pre` string, required — Preceding qualifier of the street name. Can be empty string `""` if not present. - `str_qlf_pre_trans` string, required — Translated preceding qualifier of the street name in Latin script. Can be empty string `""` if not present. - `str_qlf_suc` string, required — Succeeding qualifier of the street name. Can be empty string `""` if not present. - `str_qlf_suc_trans` string, required — Translated succeeding qualifier of the street name in Latin script. Can be empty string `""` if not present. - `str_name` string, required — Name of the street. Can be empty string `""` if not present. - `str_name_trans` string, required — Translated name of the street in Latin script. Can be empty string `""` if not present. - `str_loc_sfx` string, required — Suffix of the locality for the street. Can be empty string `""` if not present. - `str_loc_sfx_trans` string, required — Translated suffix of the locality for the street in Latin script. Can be empty string `""` if not present. - `str_type` string, required — Type of the street. Can be empty string `""` if not present. - `str_type_trans` string, required — Translated type of the street in Latin script. Can be empty string `""` if not present. - `str_type_abv` string, required — Abbreviation of the street type. Can be empty string `""` if not present. - `str_type_abv_trans` string, required — Translated abbreviation of the street type in Latin script. Can be empty string `""` if not present. - `str_adr_num_key` string, required — Permanent identifier of the address. Can be empty string `""` if not present. - `str_from_num` union, required — Lowest address number on the street. Can be empty string `""` if not present. - string - number - `str_from_unit` string, required — Lowest unit number on the street. Can be empty string `""` if not present. - `str_from_alph` string, required — Extension of the lowest address number on the street. Can be empty string `""` if not present. - `str_to_num` union, required — Highest address number on the street. Can be empty string `""` if not present. - string - number - `str_to_unit` string, required — Highest unit number on the street. Can be empty string `""` if not present. - `str_to_alph` string, required — Extension of the highest address number on the street. Can be empty string `""` if not present. - `str_evenodd` union, required — Indicates whether the address range for this street contains even numbers, odd numbers, or both. Can be empty string `""` if not present. - string - number - `str_dsc` string, required — Additional information about the street. Can be empty string `""` if not present. - `str_dsc_trans` string, required — Translated additional information about the street in Latin script. Can be empty string `""` if not present. - `str_blg_id` string, required — Identifier of the building for the street. Can be empty string `""` if not present. - `str_blg_name` string, required — Name of the building for the street. Can be empty string `""` if not present. - `str_blg_name_trans` string, required — Translated name of the building for the street in Latin script. Can be empty string `""` if not present. - `str_blg_type` string, required — Type of the building for the street. Can be empty string `""` if not present. - `str_blg_type_trans` string, required — Translated type of the building for the street in Latin script. Can be empty string `""` if not present. - `str_blg_dsc` string, required — Additional information about the building for the street. Can be empty string `""` if not present. - `str_blg_dsc_trans` string, required — Translated additional information about the building for the street in Latin script. Can be empty string `""` if not present. - `str_ref_str_id` string, required — Identifier of the associated street. Can be empty string `""` if not present. - `str_pcode` string, required — Postal code for the street. Can be empty string `""` if not present. - `str_script` string, required — Script used for the street name. `Hani` = Kanji, `Hira` = Hiragana, `Latn` = Latin. Can be empty string `""` if not present. - `str_language` string, required — Language used for the street name. Can be empty string `""` if not present. - `sub_dis_id` string, required — Unique identifier of the district. Can be empty string `""` if not present. - `sub_dis_key` string, required — Permanent identifier of the district. Can be empty string `""` if not present. - `sub_loc_id` string, required — Locality identifier for the subdivision. Can be empty string `""` if not present. - `sub_loc_sfx` string, required — Suffix of the locality for the subdivision. Can be empty string `""` if not present. - `sub_loc_sfx_trans` string, required — Translated suffix of the locality for the subdivision in Latin script. Can be empty string `""` if not present. - `sub_dis_name` string, required — Name of the district. Can be empty string `""` if not present. - `sub_dis_name_trans` string, required — Translated name of the district in Latin script. Can be empty string `""` if not present. - `sub_dis_sfx` string, required — Suffix of the district. Can be empty string `""` if not present. - `sub_dis_sfx_trans` string, required — Translated suffix of the district in Latin script. Can be empty string `""` if not present. - `sub_dis_dsc` string, required — Additional information about the district. Can be empty string `""` if not present. - `sub_dis_dsc_trans` string, required — Translated additional information about the district in Latin script. Can be empty string `""` if not present. - `sub_dis_pcode` string, required — Postal code for the district. Can be empty string `""` if not present. - `sub_dis_pcode_fin` string, required — Final postal code for the district. Can be empty string `""` if not present. - `sub_nei_id` string, required — Identifier of the neighbourhood. Can be empty string `""` if not present. - `sub_nei_key` string, required — Permanent identifier of the neighbourhood. Can be empty string `""` if not present. - `sub_nei_name` string, required — Name of the neighbourhood. Can be empty string `""` if not present. - `sub_nei_name_trans` string, required — Translated name of the neighbourhood in Latin script. Can be empty string `""` if not present. - `sub_nei_sfx` string, required — Suffix of the neighbourhood. Can be empty string `""` if not present. - `sub_nei_sfx_trans` string, required — Translated suffix of the neighbourhood in Latin script. Can be empty string `""` if not present. - `sub_nei_zone_from` string, required — Start of the range of zone numbers to which the neighbourhood postal code corresponds. Can be empty string `""` if not present. - `sub_nei_zone_to` string, required — End of the range of zone numbers to which the neighbourhood postal code corresponds. Can be empty string `""` if not present. - `sub_nei_dsc` string, required — Additional information about the neighbourhood. Can be empty string `""` if not present. - `sub_nei_dsc_trans` string, required — Translated additional information about the neighbourhood in Latin script. Can be empty string `""` if not present. - `sub_nei_pcode` string, required — Postal code for the neighbourhood. Can be empty string `""` if not present. - `sub_script` string, required — Script used for the subdivision names. `Hani` = Kanji, `Hira` = Hiragana, `Latn` = Latin. Can be empty string `""` if not present. - `sub_language` string, required — Language used for the subdivision names. Can be empty string `""` if not present. - `loc_id` string, required — Unique identifier of the locality. Can be empty string `""` if not present. - `loc_key` string, required — Permanent identifier of the locality. Can be empty string `""` if not present. - `loc_adm1_id` string, required — Identifier of administrative division 1. Can be empty string `""` if not present. - `loc_adm1_key` string, required — Permanent identifier of administrative division 1. Can be empty string `""` if not present. - `loc_adm1_name` string, required — Name of administrative division 1. Can be empty string `""` if not present. - `loc_adm1_name_trans` string, required — Translated name of administrative division 1 in Latin script. Can be empty string `""` if not present. - `loc_adm1_sfx` string, required — Suffix of administrative division 1. Can be empty string `""` if not present. - `loc_adm1_sfx_trans` string, required — Translated suffix of administrative division 1 in Latin script. Can be empty string `""` if not present. - `loc_adm1_abv` string, required — Abbreviation of administrative division 1. Can be empty string `""` if not present. - `loc_adm1_abv_trans` string, required — Translated abbreviation of administrative division 1 in Latin script. Can be empty string `""` if not present. - `loc_adm2_id` string, required — Identifier of administrative division 2. Can be empty string `""` if not present. - `loc_adm2_key` string, required — Permanent identifier of administrative division 2. Can be empty string `""` if not present. - `loc_adm2_name` string, required — Name of administrative division 2. Can be empty string `""` if not present. - `loc_adm2_name_trans` string, required — Translated name of administrative division 2 in Latin script. Can be empty string `""` if not present. - `loc_adm2_sfx` string, required — Suffix of administrative division 2. Can be empty string `""` if not present. - `loc_adm2_sfx_trans` string, required — Translated suffix of administrative division 2 in Latin script. Can be empty string `""` if not present. - `loc_adm2_abv` string, required — Abbreviation of administrative division 2. Can be empty string `""` if not present. - `loc_adm2_abv_trans` string, required — Translated abbreviation of administrative division 2 in Latin script. Can be empty string `""` if not present. - `loc_adm3_id` string, required — Identifier of administrative division 3. Can be empty string `""` if not present. - `loc_adm3_key` string, required — Permanent identifier of administrative division 3. Can be empty string `""` if not present. - `loc_adm3_name` string, required — Name of administrative division 3. Can be empty string `""` if not present. - `loc_adm3_name_trans` string, required — Translated name of administrative division 3 in Latin script. Can be empty string `""` if not present. - `loc_adm3_sfx` string, required — Suffix of administrative division 3. Can be empty string `""` if not present. - `loc_adm3_sfx_trans` string, required — Translated suffix of administrative division 3 in Latin script. Can be empty string `""` if not present. - `loc_adm3_abv` string, required — Abbreviation of administrative division 3. Can be empty string `""` if not present. - `loc_adm3_abv_trans` string, required — Translated abbreviation of administrative division 3 in Latin script. Can be empty string `""` if not present. - `loc_name` string, required — Name of the locality. Can be empty string `""` if not present. - `loc_name_trans` string, required — Translated name of the locality in Latin script. Can be empty string `""` if not present. - `loc_sfx` string, required — Suffix of the locality. Can be empty string `""` if not present. - `loc_sfx_trans` string, required — Translated suffix of the locality in Latin script. Can be empty string `""` if not present. - `loc_pcode` string, required — Postal code of the locality. Can be empty string `""` if not present. - `loc_pcode_fin` string, required — Final postal code of the locality. Can be empty string `""` if not present. - `loc_dsc` string, required — Additional information about the locality. Can be empty string `""` if not present. - `loc_dsc_trans` string, required — Translated additional information about the locality in Latin script. Can be empty string `""` if not present. - `loc_script` string, required — Script used for the locality names. `Hani` = Kanji, `Hira` = Hiragana, `Latn` = Latin. Can be empty string `""` if not present. - `loc_language` string, required — Language used for the locality names. Can be empty string `""` if not present. - BevAddress - `id` string, required — Global unique internally generated identifier for an address - `dataset` 'bev', required - `country_iso` 'AUT', required — 3 letter country code (ISO 3166-1) - `country_iso_2` 'AT', required — 2 letter country code (ISO 3166-1) - `country` 'Austria', required — Full country names (ISO 3166) - `language` 'de', required — Language represented by 2 letter ISO Code (639-1) - `address` string, required — Combination of hnr_adr_zusammen and hnr_geb_zusammen - the full house number and building designation. Can be empty string `""` if not present. - `line_1` string, required — First address line. Can be empty string `""` if not present. - `line_2` string, required — Second address line. Can be empty string `""` if not present. - `longitude` union, required — The longitude of the postcode (WGS84/ETRS89). Can be a positive or negative decimal. E.g. -0.1283983 Returns an empty string if no location data is available. - string — Empty string `""` if not available - number — Represents longitude - `latitude` union, required — The latitude of the postcode (WGS84/ETRS89). Can be a positive or negative decimal. E.g. `51.5083983`. Returns an empty string if no location data is available. - string — Empty string `""` if not available - number — Represents latitude - `adrcd` string, required — Unique identifier of the address - `kgnr` string, required — Cadastral number of the municipality of the land parcel associated with the address - `gkz` string, required — Municipality unique identifier - `okz` string, required — Locality unique identifier - `plz` string, required — Postal code - `skz` string, required — Street unique identifier - `zaehlsprengel` string, required — Census district unique identifier - `hausnrtext` string, required — Text before house number - `hausnrzahl1` union, required - string — Empty string `""` if not available - number — House number part 1 - `hausnrbuchstabe1` string, required — House letter part 1 - `hausnrverbindung1` string, required — House number connector 1 - `hausnrzahl2` union, required - string — Empty string `""` if not available - number — House number part 2 - `hausnrbuchstabe2` string, required — House letter part 2 - `hausnrbereich` string, required — House number range scheme (even, odd, all or not specified) - `hnr_adr_zusammen` string, required — Complete house number (combination of house number parts and letters) - `gnradresse` number, required — Parcel number used as an address when no house number is present - `hofname` string, required — Name of building or building complex (e.g. farmstead) - `rw` string, required — Easting / X coordinate - `hw` string, required — Northing / Y coordinate - `epsg` number, required — Coordinate reference system identifier - `quelladresse` string, required — Coordinate accuracy level (building level, parcel level, etc.) - `bestimmungsart` string, required — Coordinate determination method (DKM, surveying office, municipality, etc.) - `subcd` string, required — Subcode to distinguish multiple buildings at the same address - `objektnummer` string, required — Object number of the building - `objfunktkennziffer` string, required — All building function codes related to the address Can be empty string `""` if not present. - `hauptadresse` union, required - string — Empty string `""` if not available - number — Indicates whether this address is the primary address for the associated building. - `hausnrverbindung2` string, required — House number connector 2 - `hausnrzahl3` union, required - string — Empty string `""` if not available - number — House number part 3 - `hausnrbuchstabe3` string, required — House letter part 3 - `hausnrverbindung3` string, required — House number connector 3 - `hausnrzahl4` union, required - string — Empty string `""` if not available - number — House number part 4 - `hausnrbuchstabe4` string, required — House letter part 4 - `hausnrgebaeudebez` string, required — Building description - `hnr_geb_zusammen` string, required — Combination of house number and building designation - `eigenschaft` string, required — Code indicating the primary use or function of the building associated with the address - `gemeindename` string, required — Name of the municipality - `ortsname` string, required — Name of the locality - `strassenname` string, required — Name of the street - `strassennamenzusatz` string, required — Street type (e.g., "Allee", "Strasse", etc.) - `szusadrbest` number, required — Indicates whether the street type is included in the street name - `zustellort` string, required — Postal town name - `zustellort_id` string, required — Postal town identifier - `zaehlsprengelname` string, required — Name of the census district - `postcode_outward` '', required — Not available for non-UK addresses - `postcode_inward` '', required — Not available for non-UK addresses - `dependant_locality` '', required — Not available for non-UK addresses - `double_dependant_locality` '', required — Not available for non-UK addresses - `thoroughfare` string, required — Street name - `dependant_thoroughfare` '', required — Not available for non-UK addresses - `building_number` string, required — Address or house number - `building_name` string, required — Name of the building associated with the address - `sub_building_name` string, required — Name of the sub-building associated with the address - `premise` '', required — Not available for non-UK addresses - `po_box` string, required — PO Box number - `department_name` '', required — Not available for non-UK addresses - `organisation_name` string, required — Name of the company or organisation associated with the address - `udprn` string, required — Not available for non-UK addresses. See `id` for address identifier - `umprn` '', required — Not available for non-UK addresses. See `id` for address identifier - `postcode_type` '', required — Not available for non-UK addresses - `su_organisation_indicator` '', required — Not available for non-UK addresses - `delivery_point_suffix` '', required — Not available for non-UK addresses - `administrative_county` '', required — Not available for non-UK addresses - `postal_county` '', required — Not available for non-UK addresses - `traditional_county` '', required — Not available for non-UK addresses - `district` '', required — Not available for non-UK addresses - `ward` '', required — Not available for non-UK addresses - `eastings` '', required — Not available for non-UK addresses - `northings` '', required — Not available for non-UK addresses - `uprn` '', required — Not available for non-UK addresses. See `id` for address identifier ## Other responses - `404` — Resource not found --- [API](https://skmtc.net/ideal-postcodes/apis/api-reference.md) · [All operations](https://skmtc.net/ideal-postcodes/apis/api-reference/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/ideal-postcodes/api-reference/revisions/295dd3238f22/schema)