--- title: "Retrieve Address" method: GET path: "/autocomplete/addresses/{address}/usa" tags: ["Address Search"] --- # Retrieve Address `GET /autocomplete/addresses/{address}/usa` ## Request - Base URL: `https://api.addresszen.com/v1` - URL: `https://api.addresszen.com/v1/autocomplete/addresses/{address}/usa` - Auth: HTTP bearer Returns the full address for an autocomplete suggestion id. This is the charged step of address autocomplete. A successful retrieval decrements your lookup balance. An id which resolves to no address returns `404`. Every address comes back in one US-shaped format, whatever country or dataset it came from: up to two address lines and US field names such as `zip_code`, `state` and `city`. ## Path parameters - `address` string, required ## Query parameters - `api_key` string - `licensee` string - `filter` string - `tags` string ## Response `200` Success - UsaResolveAddressResponse - `code` 2000, required - `message` 'Success', required - `result` Address, required: A single address. Every address is returned in this shape, whatever dataset it came from. US and non-US addresses share the same fields, so an integration reads one format only. - `dataset` identifies where the address came from. Fields a dataset does not carry are returned as an empty string (`""`) - `native` carries the raw dataset record, exactly as the dataset supplies it. Retrieve Address returns it for every dataset except `usps`, whose address already is the USPS record - `id` string, required: Global unique internally generated identifier for an address - `dataset` 'paf' | 'pafw' | 'pafa' | 'mr' | 'nyb' | 'usps' | 'ecaf' | 'ecad' | 'ab' | 'abp' | 'herewe' | 'heret' | 'heresa' | 'hereo' | 'herena' | 'heremeas' | 'heremea' | 'herem' | 'herei' | 'herehk' | 'hereee' | 'hereap' | 'gnaf' | 'kadaster' | 'kartverket' | 'sdfi' | 'cannar' | 'fodbosa' | 'mois' | 'upujp' | 'bev' | 'ban' | 'swt', required: Indicates the provenance of an address. - `country_iso` 'GBR' | 'IMN' | 'JEY' | 'GGY' | 'USA' | 'PRI' | 'GUM' | 'IRL' | 'VAT' | 'FRA' | 'GRL' | 'NLD' | 'LUX' | 'AUT' | 'GIB' | 'LIE' | 'FIN' | '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' | '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' | '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' | '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) - `country` 'United Kingdom' | 'England' | 'Scotland' | 'Wales' | 'Northern Ireland' | 'Isle of Man' | 'Jersey' | 'Guernsey' | 'Channel Islands' | 'Guam' | 'United States' | 'Puerto Rico' | 'Ireland' | 'Vatican City' | 'France' | 'Greenland' | 'Netherlands' | 'Luxembourg' | 'Austria' | 'Gibraltar' | 'Liechtenstein' | 'Finland' | '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' | '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' | '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) - `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' | 'rm' | '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) - `primary_number` string, required: Building, house, rural route, contract box or PO Box number. The numeric or alphanumeric component of an address preceding the street name. - `secondary_number` string, required: Number of the sub unit, apartment, suite etc. - `plus_4_code` string, required: 4 digit ZIP add-on code. USPS addresses only. - `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: Final line of the address, comprising city, state or region and postal code. - `zip_code` string, required: Postal code identifying the delivery area. For US addresses this is the 5 digit ZIP Code. - `zip_plus_4_code` string, required: Nine-digit code that identifies a small geographic delivery area serviceable by a single carrier; appears in the last line of the address on a mail piece. USPS addresses only. - `update_key_number` string, required: Key that uniquely identifies the source dataset record. For USPS this is the Update Key Number: a database segment code (V1, V2, W1, W2, X1, X2, Y1, Y2, Z1 or Z2) followed by eight alphanumeric characters. It is fixed for the life of the record and is not used in address matching. - `record_type_code` 'G' | 'H' | 'F' | 'S' | 'P' | 'R' | 'M' | '', required: An alphabetic value identifying the type of USPS record backing the address. - G = General delivery - H = High-rise - F = Firm - S = Street - P = PO Box - R = Rural route/contract - M = Multi-carrier - `carrier_route_id` string, required: A 4 character ID identifying the USPS postal route for the address. The first character indicates the route type: - "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 the street as assigned by the local governing authority. Contains the street name only, without directionals (EAST, WEST, etc.) or suffixes (ST, DR, BLVD, etc.). May also contain literals such as PO BOX, GENERAL DELIVERY, USS, PSC or UNIT. - `street_suffix_abbreviation` string, required: Standard 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. - `address_secondary_abbreviation` string, required: A descriptive code identifying the type of secondary range held in the secondary number field, e.g. apartment, suite or trailer. - `base_alternate_code` 'A' | 'B' | '', required: Code specifying whether the backing USPS record is a base (preferred) or alternate record. Base records ("B") can represent a range of addresses or an individual address, such as a firm record. Alternate records ("A") are individual delivery points. Base records are generally preferred over alternate records. Government deliveries are only listed on alternate records, with the appropriate government building indicator set. - `lacs_status_indicator` '' | 'L', required: The Locatable Address Conversion Service (LACS) indicator marks USPS records converted to the LACS system, which lets mailers convert a rural route address to a city-style address so emergency services can locate it. - L = LACS address: the old (usually rural-route) address that has been converted - Blank = Not applicable - `government_building_indicator` '' | 'A' | 'B' | 'C' | 'D' | 'E' | 'F' | 'G', required: An alphabetic value identifying the type of government agency at the delivery point and/or whether a firm is the only delivery at an address. - 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: Abbreviated name of the state, province or region. For US addresses this is the 2 character state, territory or armed forces designation ("AA", "AE" or "AP" for APO/FPO/DPO). - `state` string, required: Full name of the state, province or region. - `municipality_city_state_key` string, required: Municipality City State Key. Currently blank. - `urbanization_city_state_key` string, required: An index to the USPS City State file that provides the urbanization name for this delivery range. - `preferred_last_line_city_state_key` string, required: An index to the USPS City State product record that provides the preferred last-line name for this address range. - `county` string, required: Name of the county, parish or equivalent administrative area. Blank for APO/FPO/DPO addresses. - `city` string, required: City or town name used for mailing; appears in the last line of the address. - `city_abbreviation` string, required: A standard 13-character abbreviation for a city/state name. Only used for names longer than 13 characters with a city state mailing name indicator of "Y"; blank otherwise. - `preferred_city` string, required: 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 a non-postal place name. - 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: Describes the type of ZIP area a 5-digit ZIP Code serves, e.g. a single educational institution, post office boxes only or a single address with unusually high mail volume. - 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 the city state name can be used as the last line of an 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 USPS 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. Blank for APO/FPO/DPO addresses. 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. Blank for APO/FPO/DPO addresses whose record type is "S", "H" or "F". - string: Empty string `""` if not available - number: FIPS code - `native` union: The raw dataset record backing an address, exactly as the dataset supplies it. One schema per dataset; `dataset` on the record says which. - PafAddress: Fields shared by every Royal Mail PAF family native record (`paf`, `mr`, `nyb`, `pafa`, `pafw`). The Royal Mail record as held in Postgres, before any derived fields are added. Formatted lines, `premise`, postcode parts, geocodes, UPRN and county fields belong to the address, not to the native record. `dataset` is the one field not taken from Royal Mail. Two values differ from the raw PAF file: `post_town` is title cased (Royal Mail supplies it upper cased), and a `building_number` of `0`, PAF's sentinel for "none", is returned as an empty string. - `dataset` 'paf', required: Dataset the record belongs to. The only field not taken from the Royal Mail record - `postcode` string, required: Postcode, space separated - `post_town` string, required: Royal Mail post town, title cased - `dependant_locality` string, required: Dependant locality. Empty string when not present - `double_dependant_locality` string, required: Double dependant locality. Empty string when not present - `thoroughfare` string, required: Street name - `dependant_thoroughfare` string, required: Dependant street name. Empty string when not present - `building_number` string, required: Building number. Empty string when not present, or when PAF merges it into the building name - `building_name` string, required: Building name. Empty string when not present - `sub_building_name` string, required: Sub building name. Empty string when not present - `department_name` string, required: Department name within an organisation. Empty string when not present - `organisation_name` string, required: Organisation name. Empty string when not present - `udprn` integer, required: Unique Delivery Point Reference Number - `postcode_type` 'S' | 'L' | '', required: Postcode type. - `S` Small user - `L` Large user - `""` where Royal Mail supplies none - `su_organisation_indicator` string, required: Small user organisation indicator. `Y` where the small user postcode is held by an organisation - `delivery_point_suffix` string, required: Royal Mail delivery point suffix - `po_box` string, required: PO Box number. Empty string when not present - MrAddress: Fields shared by every Royal Mail PAF family native record (`paf`, `mr`, `nyb`, `pafa`, `pafw`). The Royal Mail record as held in Postgres, before any derived fields are added. Formatted lines, `premise`, postcode parts, geocodes, UPRN and county fields belong to the address, not to the native record. `dataset` is the one field not taken from Royal Mail. Two values differ from the raw PAF file: `post_town` is title cased (Royal Mail supplies it upper cased), and a `building_number` of `0`, PAF's sentinel for "none", is returned as an empty string. - `dataset` 'mr', required: Dataset the record belongs to. The only field not taken from the Royal Mail record - `postcode` string, required: Postcode, space separated - `post_town` string, required: Royal Mail post town, title cased - `dependant_locality` string, required: Dependant locality. Empty string when not present - `double_dependant_locality` string, required: Double dependant locality. Empty string when not present - `thoroughfare` string, required: Street name - `dependant_thoroughfare` string, required: Dependant street name. Empty string when not present - `building_number` string, required: Building number. Empty string when not present, or when PAF merges it into the building name - `building_name` string, required: Building name. Empty string when not present - `sub_building_name` string, required: Sub building name. Empty string when not present - `department_name` string, required: Department name within an organisation. Empty string when not present - `organisation_name` string, required: Organisation name. Empty string when not present - `udprn` integer, required: Unique Delivery Point Reference Number - `postcode_type` 'S' | 'L' | '', required: Postcode type. - `S` Small user - `L` Large user - `""` where Royal Mail supplies none - `su_organisation_indicator` string, required: Small user organisation indicator. `Y` where the small user postcode is held by an organisation - `delivery_point_suffix` string, required: Royal Mail delivery point suffix - `umprn` integer, required: Unique Multiple Residence Reference Number - NybAddress: Fields shared by every Royal Mail PAF family native record (`paf`, `mr`, `nyb`, `pafa`, `pafw`). The Royal Mail record as held in Postgres, before any derived fields are added. Formatted lines, `premise`, postcode parts, geocodes, UPRN and county fields belong to the address, not to the native record. `dataset` is the one field not taken from Royal Mail. Two values differ from the raw PAF file: `post_town` is title cased (Royal Mail supplies it upper cased), and a `building_number` of `0`, PAF's sentinel for "none", is returned as an empty string. - `dataset` 'nyb', required: Dataset the record belongs to. The only field not taken from the Royal Mail record - `postcode` string, required: Postcode, space separated - `post_town` string, required: Royal Mail post town, title cased - `dependant_locality` string, required: Dependant locality. Empty string when not present - `double_dependant_locality` string, required: Double dependant locality. Empty string when not present - `thoroughfare` string, required: Street name - `dependant_thoroughfare` string, required: Dependant street name. Empty string when not present - `building_number` string, required: Building number. Empty string when not present, or when PAF merges it into the building name - `building_name` string, required: Building name. Empty string when not present - `sub_building_name` string, required: Sub building name. Empty string when not present - `department_name` string, required: Department name within an organisation. Empty string when not present - `organisation_name` string, required: Organisation name. Empty string when not present - `udprn` integer, required: Unique Delivery Point Reference Number - `postcode_type` 'S' | 'L' | '', required: Postcode type. - `S` Small user - `L` Large user - `""` where Royal Mail supplies none - `su_organisation_indicator` string, required: Small user organisation indicator. `Y` where the small user postcode is held by an organisation - `delivery_point_suffix` string, required: Royal Mail delivery point suffix - `po_box` string, required: PO Box number. Empty string when not present - PafaAddress: Fields shared by every Royal Mail PAF family native record (`paf`, `mr`, `nyb`, `pafa`, `pafw`). The Royal Mail record as held in Postgres, before any derived fields are added. Formatted lines, `premise`, postcode parts, geocodes, UPRN and county fields belong to the address, not to the native record. `dataset` is the one field not taken from Royal Mail. Two values differ from the raw PAF file: `post_town` is title cased (Royal Mail supplies it upper cased), and a `building_number` of `0`, PAF's sentinel for "none", is returned as an empty string. - `dataset` 'pafa', required: Dataset the record belongs to. The only field not taken from the Royal Mail record - `postcode` string, required: Postcode, space separated - `post_town` string, required: Royal Mail post town, title cased - `dependant_locality` string, required: Dependant locality. Empty string when not present - `double_dependant_locality` string, required: Double dependant locality. Empty string when not present - `thoroughfare` string, required: Street name - `dependant_thoroughfare` string, required: Dependant street name. Empty string when not present - `building_number` string, required: Building number. Empty string when not present, or when PAF merges it into the building name - `building_name` string, required: Building name. Empty string when not present - `sub_building_name` string, required: Sub building name. Empty string when not present - `department_name` string, required: Department name within an organisation. Empty string when not present - `organisation_name` string, required: Organisation name. Empty string when not present - `udprn` integer, required: Unique Delivery Point Reference Number - `postcode_type` 'S' | 'L' | '', required: Postcode type. - `S` Small user - `L` Large user - `""` where Royal Mail supplies none - `su_organisation_indicator` string, required: Small user organisation indicator. `Y` where the small user postcode is held by an organisation - `delivery_point_suffix` string, required: Royal Mail delivery point suffix - `po_box` string, required: PO Box number. Empty string when not present - PafwAddress: Fields shared by every Royal Mail PAF family native record (`paf`, `mr`, `nyb`, `pafa`, `pafw`). The Royal Mail record as held in Postgres, before any derived fields are added. Formatted lines, `premise`, postcode parts, geocodes, UPRN and county fields belong to the address, not to the native record. `dataset` is the one field not taken from Royal Mail. Two values differ from the raw PAF file: `post_town` is title cased (Royal Mail supplies it upper cased), and a `building_number` of `0`, PAF's sentinel for "none", is returned as an empty string. - `dataset` 'pafw', required: Dataset the record belongs to. The only field not taken from the Royal Mail record - `postcode` string, required: Postcode, space separated - `post_town` string, required: Royal Mail post town, title cased - `dependant_locality` string, required: Dependant locality. Empty string when not present - `double_dependant_locality` string, required: Double dependant locality. Empty string when not present - `thoroughfare` string, required: Street name - `dependant_thoroughfare` string, required: Dependant street name. Empty string when not present - `building_number` string, required: Building number. Empty string when not present, or when PAF merges it into the building name - `building_name` string, required: Building name. Empty string when not present - `sub_building_name` string, required: Sub building name. Empty string when not present - `department_name` string, required: Department name within an organisation. Empty string when not present - `organisation_name` string, required: Organisation name. Empty string when not present - `udprn` integer, required: Unique Delivery Point Reference Number - `postcode_type` 'S' | 'L' | '', required: Postcode type. - `S` Small user - `L` Large user - `""` where Royal Mail supplies none - `su_organisation_indicator` string, required: Small user organisation indicator. `Y` where the small user postcode is held by an organisation - `delivery_point_suffix` string, required: Royal Mail delivery point suffix - `po_box` string, required: PO Box number. Empty string when not present - AbAddress: An address from Ordnance Survey's AddressBase Core, a flat cut of the approved addresses in Great Britain. Each record is one UPRN drawn from the local authority gazetteers: the National Land and Property Gazetteer for England and Wales, the One Scotland Address Gazetteer for Scotland. It carries the Royal Mail delivery point where one has been matched, property level coordinates, a classification (`classification_code`), the key identifiers (`uprn`, `parent_uprn`, `udprn`, `usrn`, `toid`), the contributing authority (`gss_code`), coordinate quality (`rpc`) and the change the latest supply applied (`change_code`). Ordnance Survey publishes around 35 million records and refreshes them weekly. How it differs from the neighbouring datasets: - **AddressBase Premium** (`abp`) is the full gazetteer: around 40 million UPRNs including historic and provisional records, the local authority address breakdown (`pao_*`, `sao_*`), lifecycle (`logical_status`, `blpu_state`), Welsh alternatives, the street record and cross references to the Valuation Office Agency and ONS, refreshed every six weeks. AddressBase Core carries none of these. Use it when one approved address per UPRN, with coordinates and a classification, is enough. - **Royal Mail PAF** (`paf`) lists delivery points only, keyed by UDPRN. AddressBase Core keys on UPRN and also holds non-postal objects (substations, car parks, land parcels, parent shells) with no delivery point. On those records `udprn` is `0` and `delivery_point_suffix` is empty. Where a record matches PAF, `ab` renders the same `line_1` to `line_3` as `paf` for that UDPRN, bar a handful of records with a trailing range in the building name, which AddressBase Core keeps whole. - The Ordnance Survey end of life notice for autumn 2027 covers AddressBase and AddressBase Plus, not AddressBase Core. - `id` string, required: Global unique internally generated identifier for an address - `country_iso` string, required: 3 letter country code (ISO 3166-1) - `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' | 'rm' | '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. Takes the address elements left after `line_1` and `line_2` are filled; where the address needs more than three lines the remaining elements are joined into `line_3`, comma separated. May be empty. - `premise` string, required: A pre-computed string which sensibly combines the building name, sub-building and building number fields into a single, simple premise string. Ideal if you want to pull premise information and thoroughfare information separately instead of using the address lines. - `uprn` string, required: Unique Property Reference Number (UPRN) assigned by the LLPG Custodian or Ordnance Survey. - `udprn` integer, required: Royal Mail's Unique Delivery Point Reference Number (UDPRN). `0` where the record has no matching PAF delivery point. - `parent_uprn` string, required: UPRN of the parent record where a parent-child relationship exists. Empty where the record has no parent. - `usrn` integer, required: Unique Street Reference Number assigned by the Street Name and Numbering Custodian or by 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' followed by up to sixteen digits. May be empty. - `classification_code` string, required: A code that describes the classification of the address record to a maximum of a secondary level. The first letter is the primary class (e.g. `R` residential, `C` commercial, `L` land), the second the secondary class (e.g. `RD` dwelling). - `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 defining the Latitude location in accordance with the ETRS89 coordinate reference system. - `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. Note this can differ from the post town 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. May be empty. - `post_town` string, required: The town or city in which the Royal Mail sorting office servicing this address record is located. AddressBase populates `POST_TOWN` only where it differs from `TOWN_NAME`, so this field falls back to the town name when the raw value is empty. - `gss_code` string, required: The Office for National Statistics Governmental Statistical Service (GSS) code representing the contributing Local Authority. - `rpc` integer, 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-time, 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. May be empty. - `change_code` 'I' | 'U' | 'D', required: The type of change last applied to the record. `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. May be empty. - `building_number` string, required: The building number is a number or range of numbers given to a single address or a group of addresses. May be empty. - `sub_building` string, required: The sub-building name and/or number for the address record. May be empty. - `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. May be empty. - `organisation` string, required: The organisation name is the business name given, when appropriate, to an address record. May be empty. - `country` string, required: Full country names (ISO 3166) - `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. Source: ONS. May be empty. - `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. - AbpAddress: A property record from Ordnance Survey's AddressBase Premium, Ordnance Survey's most detailed address dataset for Great Britain. Each record is a Basic Land and Property Unit (BLPU) keyed by its UPRN. Alongside the Royal Mail delivery point it carries the local authority address (`pao_*`, `sao_*`, `usrn`), classification (`classification_code`), lifecycle (`logical_status`, `blpu_state`), coordinates, Welsh alternatives (`welsh_*`), the street record (`street_*`) and cross references to OS MasterMap (`toid`), the Valuation Office Agency (`council_tax_ref`, `ndr_ref`) and ONS (`ons_ward_code`, `ons_parish_code`). Ordnance Survey publishes around 40 million records and refreshes them every six weeks. How it differs from the neighbouring datasets: - **AddressBase Core** (`ab`) is a weekly, flat cut of the current approved records: one row per UPRN with coordinates, a two-character classification and the key identifiers. It carries no history, no provisional records, no Welsh alternatives, no local authority address breakdown and no street, VOA or ONS cross references. - **Royal Mail PAF** (`paf`) lists delivery points, keyed by UDPRN. The vast majority of PAF addresses are matched to a UPRN, but there will always be a small number (~1%) with no corresponding record on AddressBase Premium. PAF holds around 30 million GB delivery points against AddressBase Premium's 40 million UPRNs; the difference is non-postal objects (substations, car parks, sites under construction), provisional and historic records. Every GB PAF delivery point appears here as the `dpa_*` record. - **OS NGD Address** carries the same content restructured into feature types with daily currency. AddressBase Premium is not being retired. The Ordnance Survey end of life notice for autumn 2027 covers AddressBase and AddressBase Plus only. - `uprn` string, required: Unique Property Reference Number - a persistent identifier for a Basic Land and Property Unit (BLPU). Up to 12 digits. Primary key for the BLPU spine. Carried as a string to preserve precision (12-digit values can exceed Number.MAX_SAFE_INTEGER). - `parent_uprn` string, nullable: UPRN of the parent record where a parent-child relationship exists (flats sharing a building entrance, sub-units of a parent property). - `logical_status` integer, required: Logical lifecycle status of the BLPU. `1` Approved, `6` Provisional, `8` Historical. BLPU records do not take value `3` (alternative). - `blpu_state` string, nullable: Physical state of the BLPU. `1` Under construction, `2` In use, `3` Unoccupied / vacant / derelict, `4` No longer existing, `6` Planning permission granted. - `blpu_state_date` string, date-time, nullable: Date the BLPU achieved its current state. - `country` string, required: Country containing the BLPU, determined by intersection with OS Boundary-Line. `E` England, `W` Wales, `S` Scotland, `N` Northern Ireland, `L` Channel Islands, `M` Isle of Man, `J` not assigned to a country. - `latitude` number, double, required: Latitude coordinate in the ETRS89 coordinate reference system. - `longitude` number, double, required: Longitude coordinate in the ETRS89 coordinate reference system. - `x_coordinate` number, double, required: X location in metres on the OSGB36 British National Grid (precision 8, scale 2). - `y_coordinate` number, double, required: Y location in metres on the OSGB36 British National Grid (precision 9, scale 2). - `rpc` integer, nullable: Representative Point Code - reliability of the BLPU's coordinate, as assessed by the local authority custodian. `1` Central internal, `2` General internal, `3` Transitional, `4` Street location, `5` Postcode unit, `9` Low accuracy. - `local_custodian_code` integer, required: 4-digit identifier of the Local Authority responsible for maintaining the record. - `addressbase_postal` string, required: Whether the address can receive mail per AddressBase rules. `D` linked to PAF, `N` not a postal address, `C` postal with a PAF-linked parent, `L` postal based on Local Authority information. - `postcode_locator` string, required: Royal Mail PAF postcode, locally assigned by the custodian, or spatially derived where no PAF match exists. Up to 8 characters. - `multi_occ_count` integer, required: Count of child UPRNs for this record where parent-child relationships exist. - `blpu_start_date` string, date-time, nullable: Date the address record was inserted into the database. - `blpu_end_date` string, date-time, nullable: Date the address record was closed in the database. - `blpu_last_update_date` string, date-time, nullable: Date of the most recent attribute change on the BLPU record. - `blpu_entry_date` string, date-time, nullable: Date the record was inserted into the Local Authority database. - `udprn` string, nullable: Royal Mail's Unique Delivery Point Reference Number - primary key for the Delivery Point Address (DPA) record. Up to 8 digits. NULL for non-postal UPRNs. - `organisation_name` string, nullable: Royal Mail-recognised organisation name from DPA, falling back to the AddressBase Organisation record's `organisation` when DPA is absent. Title-cased. - `legal_name` string, nullable: Registered legal name from the AddressBase Organisation record. - `department_name` string, nullable: Subdivision of an organisation that receives mail at a distinct delivery point. Requires `organisation_name` to be present. Title-cased. - `sub_building_name` string, nullable: Property subdivision identifier (e.g. flat number). Requires `building_name` or `building_number`. Title-cased. Falls back to the LPI's `sao_text` when there is no delivery point. - `building_name` string, nullable: Descriptive name applied to a single building or small group of buildings. Title-cased. Falls back to the LPI's SAO number/range plus `pao_text` when there is no delivery point. - `building_number` integer, nullable: Numeric identifier for a single building or small group of buildings. Complex number formats (e.g. "12A") go in `building_name` or `sub_building_name`. Falls back to the LPI's `pao_start_number` when there is no delivery point and that number is a bare integer - a suffixed or ranged PAO number is folded onto `thoroughfare` instead. - `dependent_thoroughfare` string, nullable: Named thoroughfare within another named thoroughfare. Requires `thoroughfare` to be present. Title-cased. - `thoroughfare` string, nullable: Road, track or named access route with Royal Mail delivery points. Title-cased. Falls back to the LPI street's `street_description` (with a suffixed or ranged PAO number prefixed) when there is no delivery point. - `double_dependent_locality` string, nullable: Estate or area name used to distinguish similar thoroughfares within a dependent locality. Requires `dependent_locality`. Title-cased. - `dependent_locality` string, nullable: Subdivision of a post town to differentiate same-name thoroughfares. Title-cased. Falls back to the LPI street's `street_locality` when there is no delivery point. - `post_town` string, nullable: Town or city of the Royal Mail sorting office serving this record. Capitalised. Falls back to the LPI street's `street_town` when there is no delivery point; NULL when neither is present. - `postcode` string, required: Royal Mail postcode from DPA, falling back to BLPU's `postcode_locator` when no Royal Mail delivery point exists. Uppercased, with single space between outward and inward portions. - `postcode_type` string, nullable: Royal Mail postal-user category. `S` Small user (e.g. a residential property), `L` Large user (e.g. a large commercial company). - `delivery_point_suffix` string, nullable: Two-character code uniquely identifying an individual delivery point within a postcode (Royal Mail DPS). - `po_box_number` string, nullable: Post Office Box number. - `welsh_dependent_thoroughfare` string, nullable: Welsh translation of `dependent_thoroughfare`. Requires `welsh_thoroughfare`. - `welsh_thoroughfare` string, nullable: Welsh translation of `thoroughfare`. - `welsh_double_dependent_locality` string, nullable: Welsh translation of `double_dependent_locality`. Requires `welsh_dependent_locality`. - `welsh_dependent_locality` string, nullable: Welsh translation of `dependent_locality`. - `welsh_post_town` string, nullable: Welsh translation of `post_town`. - `dpa_process_date` string, date-time, nullable: Date the PAF record was processed into the database. - `dpa_start_date` string, date-time, nullable: Date the address record was matched to the Delivery Point Address. - `dpa_end_date` string, date-time, nullable: Date the PAF record no longer existed in the database. - `dpa_last_update_date` string, date-time, nullable: Date any attribute on the DPA record was last changed. - `dpa_entry_date` string, date-time, nullable: Date the PAF record was first loaded by GeoPlace. - `classification_code` string, nullable: Current AddressBase classification code (e.g. `RD` residential, `CR` commercial retail). Top-level categories: `R` Residential, `C` Commercial, `L` Land, `M` Military, `O` Other, `P` Parent shell, `U` Unclassified, `X` Dual use, `Z` Object of interest. NULL when no current classification row exists for the UPRN. - `class_scheme` string, nullable: Name of the classification scheme applied to this record. - `scheme_version` number, nullable: Version number of the classification scheme in use (e.g. `1.0`). - `classification_start_date` string, date-time, nullable: Date the classification record was first loaded into the database. - `classification_end_date` string, date-time, nullable: Date the classification record ceased to exist. - `classification_last_update_date` string, date-time, nullable: Date of the most recent attribute change on the classification record. - `classification_entry_date` string, date-time, nullable: Date the associated address record was inserted into the Local Authority database. - `organisation_start_date` string, date-time, nullable: Date the organisation record was initially loaded into the database. - `organisation_end_date` string, date-time, nullable: Date the organisation record ceased to exist. - `organisation_last_update_date` string, date-time, nullable: Date of the most recent attribute change on the organisation record. - `organisation_entry_date` string, date-time, nullable: Date the UPRN was entered into the Local Authority database. - `lpi_key` string, nullable: Unique identifier and primary key for the LPI record. - `lpi_language` string, nullable: Language used for this LPI record. `ENG` English, `CYM` Welsh, `GAE` Gaelic (Scottish), `BIL` Bilingual. - `lpi_logical_status` integer, nullable: Logical status of the LPI record. `1` Approved, `3` Alternative, `6` Provisional, `8` Historical. - `lpi_start_date` string, date-time, nullable: Date the LPI was first loaded into the database. - `lpi_end_date` string, date-time, nullable: Date the LPI record ceased to exist. - `lpi_last_update_date` string, date-time, nullable: Date of the most recent attribute change on the LPI record. - `lpi_entry_date` string, date-time, nullable: Date the LPI record was inserted into the Local Authority database. - `sao_start_number` integer, nullable: Number of the Secondary Addressable Object, or range start. Requires `pao_start_number` or `pao_text` to be present. - `sao_start_suffix` string, nullable: Suffix appended to `sao_start_number`. Requires `sao_start_number`. - `sao_end_number` integer, nullable: End number of the SAO range. Requires `sao_start_number`. - `sao_end_suffix` string, nullable: Suffix appended to `sao_end_number`. Requires `sao_end_number`. - `sao_text` string, nullable: Building name or description for the Secondary Addressable Object (e.g. "FLAT 1", "UNIT B"). Requires `pao_start_number` or `pao_text`. - `pao_start_number` integer, nullable: Number of the Primary Addressable Object, or range start. Mandatory if `pao_text` is absent. - `pao_start_suffix` string, nullable: Suffix appended to `pao_start_number`. Requires `pao_start_number`. - `pao_end_number` integer, nullable: End number of the PAO range. Requires `pao_start_number`. - `pao_end_suffix` string, nullable: Suffix appended to `pao_end_number`. Requires `pao_end_number`. - `pao_text` string, nullable: Building name or description for the Primary Addressable Object. Mandatory if `pao_start_number` is absent. - `usrn` string, nullable: Unique Street Reference Number linking this LPI to its Street record. Up to 8 digits. - `usrn_match_indicator` string, nullable: Confidence of the LPI to Street linkage. `1` Matched manually to the nearest accessible Street, `2` Matched spatially to the nearest USRN. - `area_name` string, nullable: Third-level geographic area name such as island or property group. - `level` string, nullable: Vertical position of the property (e.g. "GROUND FLOOR"). - `official_flag` string, nullable: Whether the LPI corresponds to an entry in the official Street Name and Numbering register. `Y` Official address, `N` Unofficial address. - `street_record_type` integer, nullable: Description of the street record type. `1` Official designated Street Name, `2` Street Description, `3` Numbered Street, `4` Unofficial Street Description, `9` Description used for LLPG Access. - `swa_org_ref_naming` integer, nullable: Code identifying the Street Naming and Numbering Authority or Local Highway Authority (DfT-allocated). - `street_state` string, nullable: Current state of the street. `1` Under construction, `2` Open, `4` Permanently closed. - `street_state_date` string, date-time, nullable: Date when the street achieved its current state. - `street_surface` string, nullable: Surface finish of the street. `1` Metalled, `2` Unmetalled, `3` Mixed. - `street_classification` string, nullable: Primary classification of the street record. `4` Pedestrian way or footpath, `6` Cycletrack or cycleway, `8` All vehicles, `9` Restricted byway, `10` Bridleway. - `street_start_date` string, date-time, nullable: Date this street record or version was inserted into the database. - `street_last_update_date` string, date-time, nullable: Date when any attribute of the street record was last changed. - `street_record_entry_date` string, date-time, nullable: Date the street record was entered into the Local Authority database. - `street_start_x` number, double, nullable: X coordinate (BNG) for the street start point. - `street_start_y` number, double, nullable: Y coordinate (BNG) for the street start point. - `street_start_lat` number, double, nullable: Latitude (ETRS89) for the street start point. - `street_start_long` number, double, nullable: Longitude (ETRS89) for the street start point. - `street_end_x` number, double, nullable: X coordinate (BNG) for the street end point. - `street_end_y` number, double, nullable: Y coordinate (BNG) for the street end point. - `street_end_lat` number, double, nullable: Latitude (ETRS89) for the street end point. - `street_end_long` number, double, nullable: Longitude (ETRS89) for the street end point. - `street_tolerance` integer, nullable: Accuracy of street-coordinate data capture, in metres. - `street_description` string, nullable: Street name, description or street number. - `street_locality` string, nullable: Geographical area within a town. - `street_town` string, nullable: Name of the town. Required for Street Record Types `1` and `2`; optional for types `3`, `4` and `9`. - `adminstrative_area` string, nullable: Local Highway Authority name (administrative area / county / unitary authority). Field name spelling preserved verbatim from OS (`ADMINSTRATIVE_AREA`). - `sd_language` string, nullable: Language of the street descriptor. `ENG` English, `CYM` Welsh, `GAE` Gaelic (Scottish), `BIL` Bilingual. - `sd_start_date` string, date-time, nullable: Date the street descriptor record was first created in the database. - `sd_end_date` string, date-time, nullable: Date the street descriptor record ceased to exist. - `sd_last_update_date` string, date-time, nullable: Date of the most recent attribute change on the street descriptor record. - `sd_entry_date` string, date-time, nullable: Date the street descriptor record was entered into the Local Authority database. - `toid` string, nullable: OS MasterMap Topography Layer TOID (cross-reference source `7666MT`) linked to the UPRN. - `toid_address` string, nullable: OS MasterMap Address Layer 2 TOID (cross-reference source `7666MA`) linked to the UPRN. - `toid_highways` string, nullable: OS MasterMap Highways TOID (cross-reference source `7666MI`) linked to the UPRN. - `council_tax_ref` string, nullable: Centrally created Valuation Office Agency council tax reference (cross-reference source `7666VC`) linked to the UPRN. - `ndr_ref` string, nullable: Centrally created Valuation Office Agency non-domestic rates reference (cross-reference source `7666VN`) linked to the UPRN. - `ons_ward_code` string, nullable: Office for National Statistics ward code (cross-reference source `7666OW`) linked to the UPRN. - `ons_parish_code` string, nullable: Office for National Statistics parish code (cross-reference source `7666OP`) linked to the UPRN. - `id` string, required: Stable identifier for the record, `abp_` prefixed to the UPRN. Accepted by the resolve endpoints. - `dataset` 'abp', required: Dataset this record belongs to. - `country_iso` 'GBR', required: ISO 3166-1 alpha-3 code for the country covered by the dataset. Always `GBR` - use `country` for the England / Wales / Scotland split. - `suggestion_line` string, required: Single-line address used for autocomplete suggestions: the address line components, then the post town, then the outward half of the postcode, comma separated. Repeated components are collapsed. - UspsAddress: The USPS ZIP + 4 record backing a `usps` address. Carries the complete USPS field set for the delivery point, including elements the standard address format does not expose. - `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 - EcadAddress: Address elements shared by every Eircode (GeoDirectory) dataset. Not returned on its own - see `EcafAddress` and `EcadAddress`. Unavailable elements are returned as an empty string, never `null`. - `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, e.g. `Accounts Department`. If the department element exists, then the organisation must also exist. - `organisation` string, required: Organisation name, e.g. `Oak Tree Limited`. - `sub_building_name` string, required: The sub-building refers to an apartment, flat or unit within a building, e.g. `Flat 1`. - `building_name` string, required: The name given to the building, e.g. `Rose Cottage`. Prepended by sub building, if any, when the sub building does not appear on a line to itself. The building name is omitted if it is the same as either the Organisation or Building Group. - `building_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 numbers 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, 65, 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, e.g. `Marrian Terrace`. - `primary_thoroughfare` string, required: The name of the thoroughfare on which premises are located, e.g. `Griffith Road`. It may appear on a line by itself or be appended to either a sub building or building number. Addresses with thoroughfares can sometimes have the thoroughfare excluded where a Building Group exists, such as a Retail Centre or Business Park, and the thoroughfare is not part of the Postal Address. - `secondary_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 Phoist, describes post towns in the following manner: "A provincial postal address may include the name of a town or village several miles distant, with which the addressee has little or no connection, and, in some places, especially if this residence happens to be near a county boundary, the name of the neighbouring county instead of the county in which he actually resides. The explanation is that the main mail despatches have to be sent for more detailed sub division to certain centres known as POST TOWNS, chosen because of their accessibility and convenience." - `post_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 address or postcode (WGS84). Can be a positive or negative decimal. E.g. -0.1283983 Returns an empty string if no location data is available. - string: Empty string `""` if not available - number: Represents longitude - `latitude` union, required: The latitude of the address or postcode (WGS84). Can be a positive or negative decimal. E.g. `51.5083983`. Returns an empty string if no location data is available. - string: Empty string `""` if not available - number: Represents latitude - `ecad_id` string, required: Unique ECAD identifier for the postal address. Up to 10 digits. - `organisation_id` string, required: GeoDirectory identifier for the organisation. Empty string if the address has no organisation. - `address_point_id` string, required: GeoDirectory identifier for the address point. - `building_id` string, required: GeoDirectory identifier for the building. - `building_group_id` string, required: GeoDirectory identifier for the building group. Empty string if the address has no building group. - `primary_thoroughfare_id` string, required: GeoDirectory identifier for the primary thoroughfare. - `secondary_thoroughfare_id` string, required: GeoDirectory identifier for the secondary thoroughfare. Empty string if the address has no secondary thoroughfare. - `primary_locality_id` string, required: GeoDirectory identifier for the primary locality. Empty string if the address has no primary locality. - `secondary_locality_id` string, required: GeoDirectory identifier for the secondary locality. Empty string if the address has no secondary locality. - `post_town` string, required: The name of the post town associated with the premises for postal delivery purposes. Returned in the language given by `language`, and mirrors `tertiary_locality` for this dataset. The post town is a significant element of the Postal Address, however it is not always populated in an address. The official post office guide, Eolaí an Phoist, describes post towns in the following manner: "A provincial postal address may include the name of a town or village several miles distant, with which the addressee has little or no connection, and, in some places, especially if this residence happens to be near a county boundary, the name of the neighbouring county instead of the county in which he actually resides. The explanation is that the main mail despatches have to be sent for more detailed sub division to certain centres known as post towns, chosen because of their accessibility and convenience." - `post_town_id` string, required: GeoDirectory identifier for the post town. - `post_county_id` string, required: GeoDirectory identifier for the post county. Empty string if the address has no post county. - `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: Gaeltacht 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` 'Y' | 'N' | '', required: A Yes/No field, indicating whether or not the building is a holiday home. Empty string if unknown. - `under_construction` 'Y' | 'N' | '', required: A Yes/No field, indicating whether or not the building is under construction. Empty string if unknown. - `building_use` 'R' | 'C' | 'B' | 'U' | '', required: Can be one of: - `R` Residential - `C` Commercial - `B` Both - `U` Unknown Empty string if the building carries no use information. - `vacant` 'Y' | 'N' | '', required: A Yes/No field, indicating whether the building is vacant. Empty string if unknown. - `org_vacant` 'Y' | 'N' | '', required: A Yes/No field, indicating whether the organisation is vacant. Empty string if unknown or the address has no organisation. - `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 the Electoral Division, from the 2017 data. Electoral Divisions are legally defined administrative areas in Ireland. There are 3,441 Electoral Divisions, each a sub-division of a County. Note that this field is subject to breaking changes if a new generation of government data IDs is released. Currently this uses 2017 IDs. Contact us to be notified ahead of this change. - `small_area_id` string, required: Unique Identifier for the Small Area, from the 2017 data. Small Area boundaries are sub-divisions of Electoral Divisions. A normal Small Area comprises approximately 80-120 dwellings, created by the National Institute of Regional and Spatial Analysis (NIRSA) on behalf of Ordnance Survey Ireland (OSi) in consultation with the Central Statistics Office (CSO). Note that this field is subject to breaking changes if a new generation of government data IDs is released. Currently this uses 2017 IDs. Contact us to be notified ahead of this change. - `townland_id` string, required: Unique Identifier for the townland, from the 2017 data. A townland is a small geographical division of land commonly used in Ireland, and the building block for higher-level Electoral Divisions. Townland names may not be unique within a County. Note that this field is subject to breaking changes if a new generation of government data IDs is released. Currently this uses 2017 IDs. Contact us to be notified ahead of this change. - `gaeltacht_id` string, required: Unique Identifier for the Gaeltacht area, from the 2017 data. There are 7 Gaeltacht areas. Empty string if the address is not in a Gaeltacht. Note that this field is subject to breaking changes if a new generation of government data IDs is released. Currently this uses 2017 IDs. Contact us to be notified ahead of this change. - `postaim_presort_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: Address elements shared by every Eircode (GeoDirectory) dataset. Not returned on its own - see `EcafAddress` and `EcadAddress`. Unavailable elements are returned as an empty string, never `null`. - `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, e.g. `Accounts Department`. If the department element exists, then the organisation must also exist. - `organisation` string, required: Organisation name, e.g. `Oak Tree Limited`. - `sub_building_name` string, required: The sub-building refers to an apartment, flat or unit within a building, e.g. `Flat 1`. - `building_name` string, required: The name given to the building, e.g. `Rose Cottage`. Prepended by sub building, if any, when the sub building does not appear on a line to itself. The building name is omitted if it is the same as either the Organisation or Building Group. - `building_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 numbers 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, 65, 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, e.g. `Marrian Terrace`. - `primary_thoroughfare` string, required: The name of the thoroughfare on which premises are located, e.g. `Griffith Road`. It may appear on a line by itself or be appended to either a sub building or building number. Addresses with thoroughfares can sometimes have the thoroughfare excluded where a Building Group exists, such as a Retail Centre or Business Park, and the thoroughfare is not part of the Postal Address. - `secondary_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 Phoist, describes post towns in the following manner: "A provincial postal address may include the name of a town or village several miles distant, with which the addressee has little or no connection, and, in some places, especially if this residence happens to be near a county boundary, the name of the neighbouring county instead of the county in which he actually resides. The explanation is that the main mail despatches have to be sent for more detailed sub division to certain centres known as POST TOWNS, chosen because of their accessibility and convenience." - `post_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 address or postcode (WGS84). Can be a positive or negative decimal. E.g. -0.1283983 Returns an empty string if no location data is available. - string: Empty string `""` if not available - number: Represents longitude - `latitude` union, required: The latitude of the address or postcode (WGS84). Can be a positive or negative decimal. E.g. `51.5083983`. Returns an empty string if no location data is available. - string: 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. - HereAddress: An address from HERE Technologies' map data, covering 230 countries and territories across twelve regional datasets named in `dataset`. Each address carries its address lines, house number (`address`), street name, HERE's administrative hierarchy (`order1_name`, `order2_name`, `order8_name`, `builtup_name`), a postal code where the country has one, display and delivery coordinates and, where HERE holds them, the building, unit, level and unit name. Depth varies by country, from building level down to region level only. HERE refreshes the data quarterly. Conventions: - A record is one of four kinds, named after the dataset in `id`: `ap` an address point, `ar` an address range, `poi` a point of interest, `loc` a locality. Postal Addressing records are `pap` and `par`. - `id` is the dataset, the kind, HERE's key and the language code. A range id carries a further segment holding the interpolated house number (`herewe_ar|74024700!27769096|8|de`). - Text fields are empty strings, never null. Coordinates are empty strings when absent. - Only `line_1` and `line_2` are ever populated. `line_1` is the building name line where the record has one, otherwise the street line. Ranges, points of interest and localities produce at most one line. - Casing is as HERE ships it. Only the Postal Addressing fields are title cased. - `language` is the ISO 639-1 code for the record. A street named in more than one language yields one record per language, identical but for the language segment of `id`. - `id` string, required: Global unique internally generated identifier for an address - `country_iso` string, required: Three character country code based on ISO Standard 3166. - `dataset` 'herewe' | 'heret' | 'heresa' | 'hereo' | 'herena' | 'heremeas' | 'heremea' | 'herem' | 'herei' | 'herehk' | 'hereee' | 'hereap', required: HERE regional dataset the address was sourced from. - `language` string, required: ISO 639-1 language code of the record, mapped down from HERE's three-letter code. Taken from the address point, the road for a range, the point of interest or the administrative place for a locality. - `line_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. Always the empty string `""` for HERE records, which produce at most two lines. - `line_4` string, required: Fourth address line. Always the empty string `""` for HERE records, which produce at most two lines. - `line_5` string, required: Fifth address line. Always the empty string `""` for HERE records, which produce at most two lines. - `address` string, required: Address / House Number uniquely identifying the address along the specified road link. 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. Can be empty string `""` if not present. - `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. Can be empty string `""` if not present. - `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. Can be empty string `""` if not present. - `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.) Can be empty string `""` if not present. - `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. Can be empty string `""` if not present. - `poi_name` string, required: Name of the point of interest. Populated for point of interest records only. Can be empty string `""` if not present. - `building_unit_name` string, required: Name of the Building associated with a Micro Point Address. Can be empty string `""` if not present. - `level_name` string, required: Name of floor or level within a building associated with a Micro Point Address. Can be empty string `""` if not present. - `unit_name` string, required: Name of the unit (suite, etc) associated with a Micro Point Address. Can be empty string `""` if not present. - `suppl_address_info` string, required: Additional address or building information. Can be empty string `""` if not present. - `building_grp_name` string, required: Name of the group of buildings with which the address is associated. Can be empty string `""` if not present. - GnafAddress: An Australian address from the Geocoded National Address File (G-NAF), published by Geoscape. Covers Australia and the external territories of Cocos (Keeling) Islands, Christmas Island and Norfolk Island. Every attribute is always present. The API returns fields with no value as an empty string `""`. The API returns attributes sourced from a one-to-many table (address aliases, site geocodes, locality aliases, street locality aliases) as a single comma separated string, with one element per related record. Related lists share an ordering, so the nth element of each describes the same record. - `id` string, required: Global unique internally generated identifier for an address - `dataset` 'gnaf', required - `country` 'Australia' | 'Cocos (Keeling) Islands' | 'Christmas Island' | 'Norfolk Island', required: Full country names (ISO 3166) - `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) - `line_1` string, required: First address line. The building name where one is recorded, otherwise the street line. Can be empty string `""` if not present. - `line_2` string, required: Second address line. The street line where `line_1` carries a building name. 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. For a ranged address this is the number matched from the query, not the whole range. Can be empty string `""` if not present. - `latitude` union, required: The latitude of the address or postcode (WGS84). Can be a positive or negative decimal. E.g. `51.5083983`. Returns an empty string if no location data is available. - string: Empty string `""` if not available - number: Represents latitude - `longitude` union, required: The longitude of the address or postcode (WGS84). Can be a positive or negative decimal. E.g. -0.1283983 Returns an empty string if no location data is available. - string: Empty string `""` if not available - number: Represents longitude - `address_detail_pid` string, required: The Persistent Identifier is unique to the real world feature this record represents. - `date_created` string, date-time, required: ISO 8601 date-time this record was created. - `date_last_modified` string, required: ISO 8601 date-time this record was last modified (not retired/recreated in line with ICSM standard). Empty string `""` if the record has never been modified. - `date_retired` string, required: ISO 8601 date-time this record was retired. Empty string `""` if the record is current. - `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: Flat/unit number prefix. Field length: up to two alphanumeric characters (AS4590:2006 5.5.1.2). - `flat_number` union, required - string: Empty string `""` if not available - integer: 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 - integer: 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 - integer: 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 - integer: 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: Identifier of the street locality this address sits on. Not mandatory - some G-NAF records do not require a street (e.g. a remote rural property). - `alias_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 - integer: Reflects how many contributor databases this address appears in (0 = 1 database, 1 = 2 databases etc.). `-1` indicates the address appears in no contributor database. - `level_geocoded_code` integer, 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: Comma separated alias types for this address (e.g. "Synonym"), one per alias record. - `geocode_type_code` string, required: Unique abbreviation for the geocode type of the default geocode. - `default_latitude` union, required - string: Empty string `""` if not available - number: Latitude of the default geocode (GDA2020). Same value as `latitude`. - `default_longitude` union, required - string: Empty string `""` if not available - number: Longitude of the default geocode (GDA2020). Same value as `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 the 2016 mesh block match e.g. 1. - `mb_2021_match_code` string, required: Code for the 2021 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: Comma separated identifiers relating to each geocoded site (e.g. "Transformer 75658"), one per site geocode record. - `site_geocode_type_code` string, required: Comma separated abbreviations for each site geocode feature (e.g. "PRCL") (SAWG 7.4.1), one per site geocode record. - `reliability_code` string, required: Comma separated spatial precision of each site geocode, expressed as a number in the range 1 (unique identification of feature) to 6 (feature associated to region i.e. postcode). - `site_boundary_extent` string, required: Comma separated measurements (metres) of each site geocode from other geocodes associated with the same address persistent identifier. - `site_planimetric_accuracy` string, required: Comma separated planimetric accuracy of each site geocode. - `elevation` string, required: Comma separated elevation of each site geocode. This field is not currently populated. - `site_longitude` string, required: Comma separated longitude of each site geocode (GDA2020). - `site_latitude` string, required: Comma separated latitude of each site geocode (GDA2020). - `geocode_type_priority_order` union, required - string: Empty string `""` if not available - integer: Priority order of the default geocode type, 1 (most precise) to 29 (least precise). 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` string, required: Comma separated priority order of each site geocode type, 1 (most precise) to 29 (least precise), one per site geocode record. - `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 - integer: = 5 if suburb locality, else = 6. Spatial precision of the geocode expressed as a number in the range 1 (unique identification of feature) to 6 (feature associated to region i.e. postcode). - `locality_alias_name` string, required: Comma separated alias names for the locality or suburb. - `locality_alias_postcode` string, required: Comma separated postcodes, one per locality alias. - `locality_alias_type_code` string, required: Comma separated alias type codes, one per locality alias. - `locality_planimetric_accuracy` union, required - string: Empty string `""` if not available - integer: Planimetric accuracy of the locality geocode (if known). - `locality_latitude` union, required - string: Empty string `""` if not available - number: Locality latitude (GDA2020). - `locality_longitude` union, required - string: Empty string `""` if not available - number: Locality longitude (GDA2020). - `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: Comma separated join type codes, one per primary/secondary link on this address. Each is 1 OR 2 when the root address:- Code 1: Automatically generated when the primary and secondary addresses share the same street number, street name (and type) and locality name components. Code 2: Manually generated where the primary and secondary addresses MAY or MAY NOT share the same street number, street name (and type) and locality name components - `state_name` string, required: The state or territory name, title cased. 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. "Barney". - `street_type_code` string, required: The street type code. e.g. "Street". - `street_suffix_code` string, required: The street suffix code. e.g. "West". - `gnaf_street_confidence` union, required - string: Empty string `""` if not available - integer: The street confidence level. - `street_locality_gnaf_reliability_code` union, required - string: Empty string `""` if not available - integer: Always = 4. Spatial precision of the geocode expressed as a 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: Comma separated street alias names. e.g. "Poplar". - `street_locality_alias_street_type_code` string, required: Comma separated street type codes, one per street alias. e.g. "Place". - `street_locality_alias_street_suffix_code` string, required: Comma separated street suffix codes, one per street alias. e.g. "West". - `street_locality_alias_type_code` string, required: Comma separated alias type codes, one per street alias. - `street_locality_boundary_extent` union, required - string: Empty string `""` if not available - integer: Measurement (metres) of the street locality geocode from other geocodes associated with the same address persistent identifier. - `street_locality_planimetric_accuracy` union, required - string: Empty string `""` if not available - integer: Planimetric accuracy of the street locality geocode (if known). - `street_locality_latitude` union, required - string: Empty string `""` if not available - number: Street locality latitude (GDA2020). - `street_locality_longitude` union, required - string: Empty string `""` if not available - number: Street locality longitude (GDA2020). - `street_type_name` string, required: Abbreviation of the street type. e.g. "St". - `street_locality_alias_street_type_name` string, required: Comma separated abbreviations of the street type, one per street alias. e.g. "St". - KadasterAddress: A Netherlands address as recorded in the Kadaster BAG (Basisregistratie Adressen en Gebouwen), the Dutch national register of addresses and buildings. Fields are grouped by the BAG object they originate from: the verblijfsobject (unprefixed) and the related `nummeraanduidingen_`, `pand_`, `openbare_ruimte_` and `woonplaats_` objects. - `id` string, required: Global unique internally generated identifier for an address - `dataset` 'kadaster', required: Dataset the address originates from. - `country` 'Netherlands', required: Full country names (ISO 3166) - `country_iso` 'NLD', required: 3 letter country code (ISO 3166-1) - `country_iso_2` 'NL', required: 2 letter country code (ISO 3166-1) - `line_1` string, required: First address line: street name followed by house number. Empty string `""` if not available. - `language` 'nl', required: Language represented by 2 letter ISO Code (639-1) - `address` string, required: House number, uniquely identifying the address along the specified street. Combines huisnummer, huisletter and huisnummertoevoeging. Empty string `""` if not available. - `identificatie` string, required: The unique identifier of a BAG verblijfsobject. - `latitude` union, required: The latitude of the address or postcode (WGS84). Can be a positive or negative decimal. E.g. `51.5083983`. Returns an empty string if no location data is available. - string: Empty string `""` if not available - number: Represents latitude - `longitude` union, required: The longitude of the address or postcode (WGS84). Can be a positive or negative decimal. E.g. -0.1283983 Returns an empty string if no location data is available. - string: Empty string `""` if not available - number: Represents longitude - `gebruiksdoel` string, required: The purpose of use of the verblijfsobject. E.g. `woonfunctie` (residential), `kantoorfunctie` (office), `winkelfunctie` (retail). - `oppervlakte` integer, required: The floor area of the verblijfsobject in square metres. - `status` string, required: Verblijfsobject status. E.g. `Verblijfsobject in gebruik` (in use). - `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-time, required: Date on which the verblijfsobject source document was created. - `documentnummer` string, required: The unique identifier of the verblijfsobject source document. - `voorkomenidentificatie` union, required - '': Empty string `""` if not available - integer: The identifier of this instance of the verblijfsobject history. - `begin_geldigheid` string, required: The time at which a version of a verblijfsobject is valid in reality in accordance with the effective date in the source document. ISO 8601 timestamp. Empty string `""` if not available. - `eind_geldigheid` string, required: The time at which a version of a verblijfsobject is no longer valid in reality. ISO 8601 timestamp. Empty string `""` if not available. - `tijdstip_registratie` string, required: The time at which a version of a verblijfsobject is registered by the bronhouder. ISO 8601 timestamp. Empty string `""` if not available. - `eind_registratie` string, required: The time at which a version of a verblijfsobject is no longer valid according to the bronhouder. ISO 8601 timestamp. Empty string `""` if not available. - `tijdstip_registratie_lv` string, required: The time at which a version of a verblijfsobject is registered in the Landelijke Voorziening BAG. ISO 8601 timestamp. Empty string `""` if not available. - `tijdstip_eind_registratie_lv` string, required: The time at which a version of a verblijfsobject is no longer valid in the Landelijke Voorziening BAG. ISO 8601 timestamp. Empty string `""` if not available. - `nummeraanduidingen_identificatie` string, required: The unique identifier of a BAG nummeraanduidingen object. Empty string `""` if not available. - `nummeraanduidingen_huisnummer` string, required: The house number assigned to a nummeraanduiding object by or on behalf of the municipal council. Empty string `""` if not available. - `nummeraanduidingen_huisnummertoevoeging` string, required: A further addition to a house number, or to a combination of house number and house letter, granted by or on behalf of the municipal council with regard to a nummeraanduiding object. Empty string `""` if not available. - `nummeraanduidingen_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. Empty string `""` if not available. - `nummeraanduidingen_postcode` string, required: A code determined by PostNL associated with a specific combination of a street name and a house number. Normalised to `1234 AB`. Empty string `""` if not available. - `nummeraanduidingen_type_adresseerbaar_object` string, required: The nature of the nummeraanduiding object. Currently always `Verblijfsobject`. Empty string `""` if not available. - `nummeraanduidingen_status` string, required: The status of the nummeraanduiding object. E.g. `Naamgeving uitgegeven` (name issued), `Naamgeving ingetrokken` (name withdrawn). Empty string `""` if not available. - `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, required: Date on which the nummeraanduidingen object source document was created. ISO 8601 timestamp. Empty string `""` if not available. - `nummeraanduidingen_documentnummer` string, required: The unique identifier of the nummeraanduidingen object source document. Empty string `""` if not available. - `nummeraanduidingen_voorkomenidentificatie` union, required - '': Empty string `""` if not available - integer: The identifier of this instance of the nummeraanduidingen object history. - `nummeraanduidingen_begin_geldigheid` string, 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. ISO 8601 timestamp. Empty string `""` if not available. - `nummeraanduidingen_eind_geldigheid` string, required: The time at which a version of a nummeraanduidingen object is no longer valid in reality. ISO 8601 timestamp. Empty string `""` if not available. - `nummeraanduidingen_tijdstip_registratie` string, required: The time at which a version of a nummeraanduidingen object is registered by the bronhouder. ISO 8601 timestamp. Empty string `""` if not available. - `nummeraanduidingen_eind_registratie` string, required: The time at which a version of a nummeraanduidingen object is no longer valid according to the bronhouder. ISO 8601 timestamp. Empty string `""` if not available. - `nummeraanduidingen_tijdstip_registratie_lv` string, required: The time at which a version of a nummeraanduidingen object is registered in the Landelijke Voorziening BAG. ISO 8601 timestamp. Empty string `""` if not available. - `nummeraanduidingen_tijdstip_eind_registratie_lv` string, required: The time at which a version of a nummeraanduidingen object is no longer valid in the Landelijke Voorziening BAG. ISO 8601 timestamp. Empty string `""` if not available. - `pand_identificatie` string, required: The unique identifier of a BAG pand object. Empty string `""` if not available. - `pand_oorspronkelijk_bouwjaar` union, required - '': Empty string `""` if not available - integer: The year in which a building was, or will be, originally completed. - `pand_status` string, required: The status of the pand object. E.g. `Pand in gebruik` (building in use). Empty string `""` if not available. - `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, required: Date on which the pand object source document was created. ISO 8601 timestamp. Empty string `""` if not available. - `pand_documentnummer` string, required: The unique identifier of the pand object source document. Empty string `""` if not available. - `pand_voorkomenidentificatie` union, required - '': Empty string `""` if not available - integer: The identifier of this instance of the pand object history. - `pand_begin_geldigheid` string, 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. ISO 8601 timestamp. Empty string `""` if not available. - `pand_eind_geldigheid` string, required: The time at which a version of a pand object is no longer valid in reality. ISO 8601 timestamp. Empty string `""` if not available. - `pand_tijdstip_registratie` string, required: The time at which a version of a pand object is registered by the bronhouder. ISO 8601 timestamp. Empty string `""` if not available. - `pand_eind_registratie` string, required: The time at which a version of a pand object is no longer valid according to the bronhouder. ISO 8601 timestamp. Empty string `""` if not available. - `pand_tijdstip_registratie_lv` string, required: The time at which a version of a pand object is registered in the Landelijke Voorziening BAG. ISO 8601 timestamp. Empty string `""` if not available. - `pand_tijdstip_eind_registratie_lv` string, required: The time at which a version of a pand object is no longer valid in the Landelijke Voorziening BAG. ISO 8601 timestamp. Empty string `""` if not available. - `openbare_ruimte_identificatie` string, required: The unique identifier of a BAG openbare ruimte object. Empty string `""` if not available. - `openbare_ruimte_naam` string, required: The name assigned to an openbare ruimte object by or on behalf of the municipal council. Usually the street name. Empty string `""` if not available. - `openbare_ruimte_type` string, required: The nature of the openbare ruimte object. E.g. `Weg` (road), `Water`, `Spoorbaan` (railway). Empty string `""` if not available. - `openbare_ruimte_status` string, required: The status of the openbare ruimte object. E.g. `Naamgeving uitgegeven` (name issued). Empty string `""` if not available. - `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, required: Date on which the openbare ruimte object source document was created. ISO 8601 timestamp. Empty string `""` if not available. - `openbare_ruimte_documentnummer` string, required: The unique identifier of the openbare ruimte object source document. Empty string `""` if not available. - `openbare_ruimte_voorkomenidentificatie` union, required - '': Empty string `""` if not available - integer: The identifier of this instance of the openbare ruimte object history. - `openbare_ruimte_begin_geldigheid` string, 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. ISO 8601 timestamp. Empty string `""` if not available. - `openbare_ruimte_eind_geldigheid` string, required: The time at which a version of an openbare ruimte object is no longer valid in reality. ISO 8601 timestamp. Empty string `""` if not available. - `openbare_ruimte_tijdstip_registratie` string, required: The time at which a version of an openbare ruimte object is registered by the bronhouder. ISO 8601 timestamp. Empty string `""` if not available. - `openbare_ruimte_eind_registratie` string, required: The time at which a version of an openbare ruimte object is no longer valid according to the bronhouder. ISO 8601 timestamp. Empty string `""` if not available. - `openbare_ruimte_tijdstip_registratie_lv` string, required: The time at which a version of an openbare ruimte object is registered in the Landelijke Voorziening BAG. ISO 8601 timestamp. Empty string `""` if not available. - `openbare_ruimte_tijdstip_eind_registratie_lv` string, required: The time at which a version of an openbare ruimte object is no longer valid in the Landelijke Voorziening BAG. ISO 8601 timestamp. Empty string `""` if not available. - `openbare_ruimte_verkorte_naam` string, required: An abbreviated name assigned to an openbare ruimte object if its name is longer than 24 characters. Empty string `""` if not available. - `woonplaats_identificatie` string, required: The unique identifier of a BAG woonplaats object. Empty string `""` if not available. - `woonplaats_naam` string, required: The name assigned to a woonplaats object by or on behalf of the municipal council. The town or city name. Empty string `""` if not available. - `woonplaats_status` string, required: The status of the woonplaats object. E.g. `Woonplaats aangewezen` (place of residence designated). Empty string `""` if not available. - `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, required: Date on which the woonplaats object source document was created. ISO 8601 timestamp. Empty string `""` if not available. - `woonplaats_documentnummer` string, required: The unique identifier of the woonplaats object source document. Empty string `""` if not available. - `woonplaats_voorkomenidentificatie` union, required - '': Empty string `""` if not available - integer: The identifier of this instance of the woonplaats object history. - `woonplaats_begin_geldigheid` string, 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. ISO 8601 timestamp. Empty string `""` if not available. - `woonplaats_eind_geldigheid` string, required: The time at which a version of a woonplaats object is no longer valid in reality. ISO 8601 timestamp. Empty string `""` if not available. - `woonplaats_tijdstip_registratie` string, required: The time at which a version of a woonplaats object is registered by the bronhouder. ISO 8601 timestamp. Empty string `""` if not available. - `woonplaats_eind_registratie` string, required: The time at which a version of a woonplaats object is no longer valid according to the bronhouder. ISO 8601 timestamp. Empty string `""` if not available. - `woonplaats_tijdstip_registratie_lv` string, required: The time at which a version of a woonplaats object is registered in the Landelijke Voorziening BAG. ISO 8601 timestamp. Empty string `""` if not available. - `woonplaats_tijdstip_eind_registratie_lv` string, required: The time at which a version of a woonplaats object is no longer valid in the Landelijke Voorziening BAG. ISO 8601 timestamp. Empty string `""` if not available. - `provincie` 'Drenthe' | 'Flevoland' | 'Friesland' | 'Gelderland' | 'Groningen' | 'Limburg' | 'Noord-Brabant' | 'Noord-Holland' | 'Overijssel' | 'Utrecht' | 'Zeeland' | 'Zuid-Holland' | '', required: Province the address falls in, derived from the postcode. Empty string `""` if not available. - KartverketAddress: An address from Matrikkelen, Norway's official cadastre and address register, published by Kartverket (the Norwegian Mapping Authority). Covers Norway (`NOR`) and Svalbard and Jan Mayen (`SJM`). Records come from the cadastre address, apartment level and road address files, so the fields available depend on which file the address came from. Any field which is not present is returned as an empty string `""`. - `id` string, required: Global unique internally generated identifier for an address - `dataset` 'kartverket', required - `country` 'Norway' | 'Svalbard and Jan Mayen', required: Full country names (ISO 3166) - `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) - `line_1` string, required: First address line. `adressetilleggsnavn` where present, otherwise the official address text without it. Can be empty string `""` if not present. - `line_2` string, required: Second address line. The official address text without `adressetilleggsnavn`, where line 1 carries that name. Can be empty string `""` if not present. - `language` 'no', required: Language represented by 2 letter ISO Code (639-1) - `address` string, required: Number uniquely identifying the address within its street or farm. `nummer` and `bokstav` for a vegadresse, otherwise the cadastral `gardsnummer`/`bruksnummer`. Any `bruksenhetsnummer_tekst` is appended after a hyphen. Can be empty string `""` if not present. - `latitude` union, required: The latitude of the address or postcode (WGS84). Can be a positive or negative decimal. E.g. `51.5083983`. Returns an empty string if no location data is available. - string: Empty string `""` if not available - number: Represents latitude - `longitude` union, required: The longitude of the address or postcode (WGS84). Can be a positive or negative decimal. E.g. -0.1283983 Returns an empty string if no location data is available. - string: Empty string `""` if not available - number: Represents longitude - `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 - integer: 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 - integer: 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` integer, required: The number of a farm unit in the land register, unique within each municipality. - `bruksnummer` integer, required: A unique identification number automatically assigned to each individual unit within a farm. - `festenummer` union, required - string: Empty string `""` if not available - integer: The number of a fixture within a gardsnummer/bruksnummer. - `seksjonsnummer` union, required - string: Empty string `""` if not available - integer: The number of a section within a gardsnummer/bruksnummer and possibly a festenummer. - `undernummer` union, required - string: Empty string `""` if not available - integer: 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` integer, required: EPSG code of the coordinate reference system used by `nord` and `oest`. `25833` = EUREF89 UTM zone 33. - `nord` string, required: Northward (northing) coordinate of address, in the coordinate reference system given by `epsg_kode`. - `oest` string, required: Eastward (easting) coordinate of address, in the coordinate reference system given by `epsg_kode`. - `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 - integer: Constituency code within a kommune. - `valgkretsnavn` string, required: Name of constituency. Can be empty string `""` if not present. - `oppdateringsdato` string, date-time, required: Date of last change to the object data. - `datauttaksdato` string, date-time, required: Date of extraction from database. - `adresse_id` string, required: Address local identifier assigned by the data supplier. - `uuid_adresse` string, uuid, required: Address identifier realised as UUID managed by the cadastral system. - `uuid_bruksenhet` string, required: Unit of usage identifier realised 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 realised 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 realised 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 realised 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. Derived from `kommunenummer`. Can be empty string `""` if not present. - `landsdel` string, required: Name of region. Derived from `fylke`. Can be empty string `""` if not present. - SdfiAddress: An address from Danmarks Adresseregister (DAR), the official Danish address register maintained by the municipalities and distributed by Styrelsen for Dataforsyning og Infrastruktur (SDFI). Covers both access addresses (`adgangsadresser`, a building entrance) and unit addresses (`adresser`, a flat or office within a building). Access addresses carry no floor, door, `kvh` or `adgangsadresse_*` values, which the API returns as empty strings. Field names follow the Danish source. Fields the source spells with ASCII substitutions (`aendret`, `dor`) are returned with their Danish characters (`ændret`, `dør`). - `id` string, required: Global unique internally generated identifier for an address - `dataset` 'sdfi', required - `country` 'Denmark', required: Full country names (ISO 3166) - `country_iso` 'DNK', required: 3 letter country code (ISO 3166-1) - `country_iso_2` 'DK', required: 2 letter country code (ISO 3166-1) - `address` string, required: House number uniquely identifying the address along the street. Same value as `husnr`. Can be empty string `""` if not present. - `line_1` string, required: First address line: street name and house number, followed by floor and door for a unit address. Can be empty string `""` if not present. - `line_2` string, required: Second address line: the supplementary city name (`supplerendebynavn`) where present. Can be empty string `""` if not present. - `language` 'da', required: Language represented by 2 letter ISO Code (639-1) - `latitude` union, required: The latitude of the address or postcode (WGS84). Can be a positive or negative decimal. E.g. `51.5083983`. Returns an empty string if no location data is available. - string: Empty string `""` if not available - number: Represents latitude - `longitude` union, required: The longitude of the address or postcode (WGS84). Can be a positive or negative decimal. E.g. -0.1283983 Returns an empty string if no location data is available. - string: Empty string `""` if not available - number: Represents longitude - `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. - `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. Can be empty string `""` if not present. - `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: A Canadian civic address from the National Address Register (NAR), published by Statistics Canada under the Statistics Canada Open Licence. Each address carries its civic number, street, municipality, province and postal code, a point coordinate, and its census subdivision, federal electoral district and economic region, in English and French. Statistics Canada publishes around 17.2 million addresses and refreshes them annually. 99.5% carry a full postal code and 95.7% carry a latitude and longitude. Conventions: - One record per address. `id` is `cannar_` followed by `addr_guid`, a pipe and the language code (`cannar_|en`). The suffix selects the English or French form of the record, so preserve it verbatim when resolving an address. - `language` is `en` or `fr`. The API derives it rather than reading it from the file: a French street type gives `fr`, and the types both languages share (`AV`, `PROM`, `ROUTE`, `RTE`) give `fr` in Quebec and New Brunswick and `en` elsewhere. An address appears under one language only. There is no paired English and French copy of the same record. The `csd_*`, `fed_*` and `er_*` name pairs are returned in both languages whatever the record's `language`. - `line_1` is the number and street. A hyphen joins the apartment or suite number to the civic number (`306-1 Finch Bay`). A letter civic number suffix joins without a space (`5A`), a numeric one with a space (`1 1/2`). The street comes from the `mail_street_*` fields where `mail_street_name` is present and from the `official_street_*` fields otherwise. In English the street type follows the name (`Iron Horse Dr`), except `Route`, which precedes it. In French the type is lower cased and precedes the name (`rue d'Andermatt`). - `line_2` carries the PO Box or Rural Route line from `bu_n_civic_add` (`PO Box 377`, `RR 4`). There is no third line. `address` is the number component of `line_1` on its own, apartment included (`5A`, `306-1`). - The API title cases `mail_street_name`, `mail_street_type`, `mail_mun_name` and `official_street_type`. Every other text field is as Statistics Canada ships it, so `mail_prov_abvn`, `mail_postal_code`, `mail_street_dir` and `official_street_dir` stay upper case and the `csd_*`, `fed_*` and `er_*` names keep their supplied case. - No field is null. A value absent upstream is an empty string `""`, including `latitude` and `longitude` where the location has no coordinate. - `latitude` and `longitude` repeat `reppoint_latitude` and `reppoint_longitude`: the WGS84 representative point of the location record, shared by every address at the same `loc_guid`. `bg_x` and `bg_y` are the building's coordinates in EPSG:3347, returned as strings. - `id` string, required: Global unique internally generated identifier for an address - `dataset` 'cannar', required - `country` 'Canada', required: Full country names (ISO 3166) - `country_iso` 'CAN', required: 3 letter country code (ISO 3166-1) - `country_iso_2` 'CA', required: 2 letter country code (ISO 3166-1) - `language` 'en' | 'fr', required: Language represented by 2 letter ISO Code (639-1) - `address` string, required: House number, prefixed with the apartment or suite number and a hyphen where one is present. E.g. `1425` or `10-123 1/2`. Can be empty string `""` if not present. - `line_1` string, required: First address line. House number and street. Can be empty string `""` if not present. - `line_2` string, required: Second address line. Carries the PO Box or Rural Route delivery information where present. Can be empty string `""` if not present. - `latitude` union, required: The latitude of the address or postcode (WGS84). Can be a positive or negative decimal. E.g. `51.5083983`. Returns an empty string if no location data is available. - string: Empty string `""` if not available - number: Represents latitude - `longitude` union, required: The longitude of the address or postcode (WGS84). Can be a positive or negative decimal. E.g. -0.1283983 Returns an empty string if no location data is available. - string: Empty string `""` if not available - number: Represents longitude - `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. E.g. `A` or `1/2`. 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. E.g. `St`, `Ave`. Can be empty string `""` if not present. - `official_street_dir` string, required: Official street direction. E.g. `N`, `SE`. Can be empty string `""` if not present. - `prov_code` string, required: Province code. E.g. `59` for British Columbia. - `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. Returned as supplied by the provider, without a space between the forward sortation area and local delivery unit. Can be empty string `""` if not present. - `bg_dls_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: X coordinate of the building in the EPSG:3347 projected grid, in metres, returned as a string. Can be empty string `""` if not present. - `bg_y` string, required: Y coordinate of the building in the EPSG:3347 projected grid, in metres, returned as a string. Can be empty string `""` if not present. - `bu_n_civic_add` string, required: Additional delivery information for the mailing address, such as a PO Box or Rural Route. Upper cased, with the first `BOX` token recased to `Box` (`PO Box 377`). Can be empty string `""` if not present. - `bu_use` string, required: Building usage code. 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 address or postcode (WGS84). Can be a positive or negative decimal. E.g. `51.5083983`. Returns an empty string if no location data is available. - string: Empty string `""` if not available - number: Represents latitude - `reppoint_longitude` union, required: The longitude of the address or postcode (WGS84). Can be a positive or negative decimal. E.g. -0.1283983 Returns an empty string if no location data is available. - string: Empty string `""` if not available - number: Represents longitude - FodbosaAddress: A Belgian address from BeSt Address, the open address register published by FOD BOSA (Federal Public Service Policy and Support), covering Flanders, Wallonia and the Brussels Capital Region. Each address carries its street, house number and, where one exists, box number, the municipality (`municipality_id` is the NIS code), `postcode`, `region_code` and coordinates in both WGS84 (`epsg_4326_*`, mirrored as numeric `latitude` and `longitude`) and Belgian Lambert 72 (`epsg_31370_*`, in metres). Street, municipality and post town names come in Dutch, French and German. FOD BOSA publishes around 6.6 million current addresses and refreshes them weekly. Conventions: - One record per address point per language. The API emits an address once for each language in which it has a street name, or, for the few rows with no street name in any language, each language in which it has a municipality name. A bilingual Brussels address therefore exists as both a Dutch and a French record, sharing `address_id` but differing in `id`, `language` and `line_1`. `id` is `fodbosa_` followed by `address_id`, `street_id`, `municipality_id` and the language code, pipe separated (`fodbosa_1000000|3048|21007|fr`). The resolve endpoints read the trailing language code to find the record. - Every property is always present. A value the register does not hold is an empty string `""`, never null. `latitude` and `longitude` are empty strings when the WGS84 pair does not parse. - `line_1` is the street name and `house_number` joined by a space, with the box number appended after ` - ` and prefixed `bus` in Dutch and German or `boîte` in French: `rue Rodenbach 5 - boîte bt08`. Absent parts are dropped with their separator. There are no further address lines. - `streetname_*` and `municipality_name_*` keep FOD BOSA's casing. `postname_*` is title cased because the register supplies it in upper case (`GENT` becomes `Gent`). The street name inside `line_1` is normalised further: double quotes and a trailing parenthetical are removed, and in French the leading street type is lower cased, so a `streetname_fr` of `Rue Rodenbach` appears in `line_1` as `rue Rodenbach`. - Only `current` addresses are indexed. The register's `proposed`, `retired` and `rejected` records, around 7% of the file, are not served. - FOD BOSA re-surveys address points between vintages, so a coordinate can move by a metre or so between weekly refreshes. - `id` string, required: Global unique internally generated identifier for an address - `dataset` 'fodbosa', required: Dataset the address originates from. - `country` 'Belgium', required: Full country names (ISO 3166) - `country_iso` 'BEL', required: 3 letter country code (ISO 3166-1) - `country_iso_2` 'BE', required: 2 letter country code (ISO 3166-1) - `language` 'de' | 'fr' | 'nl', required: Language represented by 2 letter ISO Code (639-1) - `address` string, required: House number, duplicated from `house_number` for consistency with other datasets. It does not identify the address on its own: boxes on the same number differ only by `box_number`. Can be empty string `""` if not present. - `line_1` string, required: First address line. Street name, house number and, where present, box number, rendered in the address language. Can be empty string `""` if not present. - `latitude` union, required: The latitude of the address or postcode (WGS84). Can be a positive or negative decimal. E.g. `51.5083983`. Returns an empty string if no location data is available. - string: Empty string `""` if not available - number: Represents latitude - `longitude` union, required: The longitude of the address or postcode (WGS84). Can be a positive or negative decimal. E.g. -0.1283983 Returns an empty string if no location data is available. - string: Empty string `""` if not available - number: Represents longitude - `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. String form of `latitude`. - `epsg_4326_lon` string, required: Longitude of the address in the WGS84 (EPSG:4326) coordinate system. String form of `longitude`. - `address_id` string, required: Address local identifier assigned by the data supplier. Not unique on its own - the three regional files each number from scratch, so the same identifier can appear once per region. Use `id`, or `(address_id, street_id, municipality_id)`, to identify an address. - `box_number` string, required: Box or apartment 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 (NIS code) 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. 4 digits, first digit non-zero. - `postname_fr` string, required: Post town name in French. Can be empty string `""` if not present. Brussels Capital Region addresses carry no post names - use `municipality_name_fr` instead. - `postname_nl` string, required: Post town name in Dutch. Can be empty string `""` if not present. Brussels Capital Region addresses carry no post names - use `municipality_name_nl` instead. - `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. One of `BE-BRU` (Brussels Capital Region), `BE-VLG` (Flanders) or `BE-WAL` (Wallonia). - `status` string, required: Address lifecycle status assigned by the data supplier. Only `current` addresses are indexed and served, so this is always `current`. The supplier's remaining codes (`proposed`, `reserved`, `retired`, `rejected`) are filtered out. - MoisAddress: A South Korean road name address (도로명주소) as published by the Ministry of the Interior and Safety (MOIS). Every address is indexed twice, once in Hangul and once in Revised Romanization. `line_1` and `line_2` follow the language of the matched document; the API returns the underlying MOIS fields under their original Hangul names. Korean-named fields are empty strings when the source record does not carry a value. - `id` string, required: Global unique internally generated identifier for an address - `dataset` 'mois', required: Dataset the address originates from. - `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: Jibeon (land lot) number: `지번본번_번지` and `지번부번_호` joined by a hyphen. 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. Can be empty string `""` if not present. - `법정리명` 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: Romanised 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. Can be empty string `""` if not present. - `도로명코드_고시일자` 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: Romanised 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. Can be empty string `""` if not present. - `건물부번` 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: Jibeon (land lot) main number. Can be empty string `""` if not present. - `지번부번_호` string, required: Jibeon (land lot) sub-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). Can be empty string `""` if not present. - `산여부` 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. Can be empty string `""` if not present. - `시도명_로마자` string, required: Romanised city name. Can be empty string `""` if not present. - `시군구_건물명` string, required: District (sigungu) building name, as recorded in the address DB (주소DB). 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: Romanised district name. Can be empty string `""` if not present. - `시군구용_건물명` string, required: District (sigungu) building name, as recorded in the building and PO box DBs (건물DB, 사서함주소DB). 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: A Japanese address from the Universal Postal Union's address file for Japan. Each address carries its postal code, prefecture, city, district and neighbourhood, a block or house number range and, where present, a building and an organisation name, in kanji, hiragana and Hepburn romanisation. - Records are number ranges, not delivery points. One record covers `str_from_num` to `str_to_num` under the `str_evenodd` scheme, so a single record can stand for many premises. `address` is the one number selected from that range for the query, and `id` carries it after a `|`. - There is no sub-premise detail. The finest elements are the block or house number and a building name. There is no unit, floor or sub-building field. - The dataset carries no coordinates. `latitude` and `longitude` are always the empty string. - The API indexes every address once per script, so the same address comes back as separate records with separate `id`s. `script` is `Hani` (kanji), `Hira` (hiragana) or `Latn` (Hepburn romanisation), and `language` is `ja` on all three. `en` is reserved for English building name synonyms and is not expected in practice. Conventions: - `line_1` is the block or house number alone and repeats `address`. There is no `line_2` or `line_3`. Build the rest of the address from `prefecture`, `city`, `district`, `neighbourhood` and `building_name`. - A kanji or hiragana address is written as `〒`, the postcode, a space, then prefecture, city, district, neighbourhood, number and building name run together with no separators: `〒070-8006 北海道旭川市神楽六条十三丁目12-2`. A romanised address is the same elements comma separated after a bare postcode: `070-8006, Hokkaido, Asahikawa-shi, Kagura 6jo 13-Chome, 12-2`. - On the romanised variant the API title cases the display fields and lower cases the Latin locality suffix before joining it on, giving `Asahikawa-shi` and `Nasu-machi`. The raw source fields are as supplied, so every `*_trans` field stays upper case. - No field is null. A value the source does not carry is the empty string, and every field is present on every record. - `id` is `upujp_` followed by a URL-safe base64 MD5 of the address line, suffixed `|` and the number when the record covers a range and one number has been resolved (`upujp_2ry6tOmv4gOAWU2v5CVxBw|12-2`). - Alongside the resolved fields the record carries the source columns under their original names: `org_*` (organisation), `str_*` (street, number range and building), `sub_*` (district and neighbourhood) and `loc_*` (locality and administrative divisions 1 to 3). Most are empty for a typical residential address. - `id` string, required: Global unique internally generated identifier for an address - `dataset` 'upujp', required: Indicates the provenance of an address - `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) - `script` 'Hani' | 'Hira' | 'Latn', required: ISO 15924 script of the address elements. `Hani` = Kanji, `Hira` = Hiragana, `Latn` = Latin. - `address` string, required: Address / House Number uniquely identifying the address along the specified street. Can be empty string `""` if not present. - `line_1` string, required: The block or house number alone, identical to `address`. There is no `line_2` or `line_3`; build the rest of the address from `prefecture`, `city`, `district`, `neighbourhood` and `building_name`. 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. - `latitude` union, required: The latitude of the address or postcode (WGS84). Can be a positive or negative decimal. E.g. `51.5083983`. Returns an empty string if no location data is available. - string: Empty string `""` if not available - number: Represents latitude - `longitude` union, required: The longitude of the address or postcode (WGS84). Can be a positive or negative decimal. E.g. -0.1283983 Returns an empty string if no location data is available. - string: Empty string `""` if not available - number: Represents longitude - `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: An address from the Adressregister, Austria's official address register published by the Bundesamt für Eich- und Vermessungswesen (BEV) under Open Government Data Austria. One record per building at an address: the address (`adrcd`) is joined to its building (`subcd`, `objektnummer`), municipality, locality, street and census district lookups. Field names follow the German source. House numbers are decomposed into up to four number/letter/connector parts (`hausnrzahl1`-`hausnrzahl4`) and supplied pre-combined (`hnr_adr_zusammen`, `hnr_geb_zusammen`, `address`). Values sourced from list columns (`kgnr`, `objfunktkennziffer`) are returned comma-separated. - `id` string, required: Global unique internally generated identifier for an address - `dataset` 'bev', required - `country` 'Austria', required: Full country names (ISO 3166) - `country_iso` 'AUT', required: 3 letter country code (ISO 3166-1) - `country_iso_2` 'AT', required: 2 letter country code (ISO 3166-1) - `language` 'de', required: Language represented by 2 letter ISO Code (639-1) - `address` string, required: Complete house number: `hnr_adr_zusammen` combined with `hnr_geb_zusammen`. Can be empty string `""` if not present. - `line_1` string, required: First address line. The building or farmstead name (`hofname`) where one is present, otherwise the street line (street name plus `address`). Can be empty string `""` if not present. - `line_2` string, required: Second address line. The street line (street name plus `address`) where `line_1` holds the building name. Empty string `""` where the address has no building name. - `latitude` union, required: The latitude of the address or postcode (WGS84). Can be a positive or negative decimal. E.g. `51.5083983`. Returns an empty string if no location data is available. - string: Empty string `""` if not available - number: Represents latitude - `longitude` union, required: The longitude of the address or postcode (WGS84). Can be a positive or negative decimal. E.g. -0.1283983 Returns an empty string if no location data is available. - string: Empty string `""` if not available - number: Represents longitude - `adrcd` string, required: Unique identifier of the address - `kgnr` string, required: Comma-separated cadastral numbers (Katastralgemeindenummer) of the land parcels 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 Can be empty string `""` if not present. - `hausnrzahl1` integer, required: House number part 1 - `hausnrbuchstabe1` string, required: House letter part 1 Can be empty string `""` if not present. - `hausnrverbindung1` string, required: House number connector 1. `-` indicates `hausnrzahl1` to `hausnrzahl2` is a range. Can be empty string `""` if not present. - `hausnrzahl2` union, required - string: Empty string `""` if not available - integer: House number part 2 - `hausnrbuchstabe2` string, required: House letter part 2 Can be empty string `""` if not present. - `hausnrbereich` string, required: House number range scheme (even, odd, all or not specified), as German source text - `hnr_adr_zusammen` string, required: Complete house number of the address (combination of house number parts and letters) Can be empty string `""` if not present. - `gnradresse` integer, required: Parcel number used as an address when no house number is present. `0` where unused. - `hofname` string, required: Name of building or building complex (e.g. farmstead), title cased Can be empty string `""` if not present. - `rw` string, required: Easting / X coordinate in the coordinate reference system given by `epsg` - `hw` string, required: Northing / Y coordinate in the coordinate reference system given by `epsg` - `epsg` integer, required: Coordinate reference system identifier for `rw` and `hw` - `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: Comma-separated building function codes for the building (e.g. `01` pharmacy, `04` fire department, `08` school, `99` no function assigned) Can be empty string `""` if not present. - `hauptadresse` integer, required: `1` where this is the primary address for the associated building, `0` otherwise - `hausnrverbindung2` string, required: House number connector 2 Can be empty string `""` if not present. - `hausnrzahl3` union, required - string: Empty string `""` if not available - integer: House number part 3 - `hausnrbuchstabe3` string, required: House letter part 3 Can be empty string `""` if not present. - `hausnrverbindung3` string, required: House number connector 3 Can be empty string `""` if not present. - `hausnrzahl4` union, required - string: Empty string `""` if not available - integer: House number part 4 - `hausnrbuchstabe4` string, required: House letter part 4 Can be empty string `""` if not present. - `hausnrgebaeudebez` string, required: Building description Can be empty string `""` if not present. - `hnr_geb_zusammen` string, required: Complete building designation (combination of house number and building designation) Can be empty string `""` if not present. - `eigenschaft` string, required: Code indicating the primary use or function of the building (e.g. `01` one apartment, `02` two or more apartments, `05` office building) - `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") Can be empty string `""` if not present. - `szusadrbest` integer, 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 - BanAddress: Address from France's Base Adresse Nationale (BAN), the official open national address database published via Etalab. BAN reaches house-number level only (`numero` + street + commune) - it carries no sub-premise (unit, floor, building) data. - `id` string, required: Global unique internally generated identifier for an address - `dataset` 'ban', required - `country` 'France', required: Full country names (ISO 3166) - `country_iso` 'FRA', required: 3 letter country code (ISO 3166-1) - `country_iso_2` 'FR', required: 2 letter country code (ISO 3166-1) - `language` 'fr', required: Language represented by 2 letter ISO Code (639-1) - `address` string, required: The house number of the address (`numero`), without any suffix. Can be empty string `""` if not present. - `line_1` string, nullable, required: First address line (house number, suffix, and street name). Can be `null` if not present. - `line_2` string, nullable, required: Second address line (postcode and municipality name). Can be `null` if not present. - `latitude` union, required: The latitude of the address or postcode (WGS84). Can be a positive or negative decimal. E.g. `51.5083983`. Returns an empty string if no location data is available. - string: Empty string `""` if not available - number: Represents latitude - `longitude` union, required: The longitude of the address or postcode (WGS84). Can be a positive or negative decimal. E.g. -0.1283983 Returns an empty string if no location data is available. - string: Empty string `""` if not available - number: Represents longitude - `id_fantoir` string, nullable, required: FANTOIR street identifier - `numero` integer, nullable, required: House number - `rep` string, nullable, required: House number suffix / répétition (`bis`, `ter`, `quater`, etc.) - `nom_voie` string, required: Street name - `code_postal` string, nullable, required: 5-digit postal code - `code_insee` string, required: INSEE commune code (2-digit département + 3-digit commune) - `nom_commune` string, required: Municipality name - `code_insee_ancienne_commune` string, nullable, required: INSEE code of the pre-fusion commune (for merged municipalities) - `nom_ancienne_commune` string, nullable, required: Name of the pre-fusion commune (for merged municipalities) - `x` string, nullable, required: Lambert 93 easting coordinate - `y` string, nullable, required: Lambert 93 northing coordinate - `lon` string, nullable, required: Longitude (WGS84) as returned from source data - `lat` string, nullable, required: Latitude (WGS84) as returned from source data - `type_position` string, nullable, required: Positional accuracy type (`entrée`, `bâtiment`, `parcelle`, `délivrance postale`, etc.) - `alias` string, nullable, required: Address alias - `nom_ld` string, nullable, required: Lieu-dit (named place) label - `libelle_acheminement` string, nullable, required: Postal routing label - `nom_afnor` string, nullable, required: AFNOR-normalised street name - `source_position` string, nullable, required: Source of position data (`commune`, `IGN`, etc.) - `source_nom_voie` string, nullable, required: Source of street name data - `certification_commune` boolean, nullable, required: Whether the municipality has certified this address - `cad_parcelles` string, nullable, required: Cadastral parcel reference(s) - SwtAddress: An address in the Swisstopo dataset, which covers Switzerland and Liechtenstein. Fields are grouped by the upstream Swisstopo product they come from: the building address directory (`gebaeudeadressverzeichnis`), the street directory (`strassenverzeichnis`) and the official directory of towns and cities (`amtovz`). Records marked as multilingual upstream are split into one address per street name, so `language` identifies the language of the street name. - `id` string, required: Global unique internally generated identifier for an address - `dataset` 'swt', required - `country` 'Switzerland' | 'Liechtenstein', required: Full country names (ISO 3166) - `country_iso` 'CHE' | 'LIE', required: 3 letter country code (ISO 3166-1) - `country_iso_2` 'CH' | 'LI', required: 2 letter country code (ISO 3166-1) - `language` 'de' | 'fr' | 'it' | 'rm', required: Language represented by 2 letter ISO Code (639-1) - `canton` string, required: Canton name, in the language of the address (e.g. `"Basel-Stadt"`, `"Grigioni"`, `"Grischun"`). For Liechtenstein addresses this is the district. Can be empty string `""` if not present. - `address` string, required: House number. Same value as `adr_number`. Can be empty string `""` if not present. - `line_1` string, required: First address line. The building name where present, otherwise the street name and house number. Can be empty string `""` if not present. - `line_2` string, required: Second address line. The street name and house number where `line_1` holds a building name. Can be empty string `""` if not present. - `latitude` union, required: The latitude of the address or postcode (WGS84). Can be a positive or negative decimal. E.g. `51.5083983`. Returns an empty string if no location data is available. - string: Empty string `""` if not available - number: Represents latitude - `longitude` union, required: The longitude of the address or postcode (WGS84). Can be a positive or negative decimal. E.g. -0.1283983 Returns an empty string if no location data is available. - string: Empty string `""` if not available - number: Represents longitude - `adr_egaid` integer, required: Federal building address identifier (Eidgenössischer Gebäudeadressidentifikator). - `str_esid` integer, required: Federal street identifier (Eidgenössischer Strassenidentifikator). Joins the address to the street directory. - `bdg_egid` integer, required: Federal building identifier (Eidgenössischer Gebäudeidentifikator). - `adr_edid` integer, required: Entrance identifier within the building. - `stn_label` string, required: Street name label. For French and Italian addresses the leading street type is lowercased (e.g. `"rue de la Gare"`). - `adr_number` string, required: House/address number (e.g. `"12"`, `"12A"`). Can be empty string `""` if not present. - `bdg_category` string, required: Building category from the Federal Building and Dwelling Register (GWR), e.g. `"residential"`, `"non_residential"`. - `bdg_name` string, required: Building name. Can be empty string `""` if not present. - `zip_label` string, required: Postal code and locality label (e.g. `"8001 Zürich"`). - `com_fosnr` integer, required: Federal municipality number assigned by the Federal Statistical Office (FSO/BFS). - `com_name` string, required: Municipality name. - `com_canton` string, required: Canton abbreviation (e.g. `"ZH"`, `"BE"`). Can be empty string `""` if not present. - `adr_status` string, required: Address status from the GWR, e.g. `"real"`, `"projected"`. - `adr_official` boolean, required: Whether the address is an official address. - `adr_modified` string, required: Date the address record was last modified, formatted `DD.MM.YYYY`. - `adr_easting` string, required: Easting coordinate of the address in the Swiss coordinate system CH1903+/LV95 (EPSG:2056), in metres. - `adr_northing` string, required: Northing coordinate of the address in the Swiss coordinate system CH1903+/LV95 (EPSG:2056), in metres. - `str_type` string, required: Street type, e.g. `"Street"`, `"Area"`. - `str_status` string, required: Street status, e.g. `"real"`, `"projected"`. - `str_official` boolean, required: Whether the street name is official. - `str_modified` string, required: Date the street record was last modified, formatted `DD.MM.YYYY`. - `str_easting` string, required: Easting coordinate of the street centroid in the Swiss coordinate system CH1903+/LV95 (EPSG:2056), in metres. - `str_northing` string, required: Northing coordinate of the street centroid in the Swiss coordinate system CH1903+/LV95 (EPSG:2056), in metres. - `ortschaftsname` string, required: Locality name from the Official Directory of Towns and Cities (Amtliches Ortschaftenverzeichnis). Can be empty string `""` if the address does not match a locality record. - `plz4` string, required: 4-digit Swiss postal code, zero padded. Can be empty string `""` if the address does not match a locality record. - `zusatzziffer` string, nullable, required: 2-digit supplementary code distinguishing localities that share a 4-digit postal code. `null` if the address does not match a locality record. - `zip_id` integer, nullable, required: Unique identifier for the postal code record. `null` if the address does not match a locality record. - `gemeindename` string, nullable, required: Municipality name (Gemeindename) from the locality directory. `null` if the address does not match a locality record. - `bfs_nr` integer, nullable, required: Federal municipality number assigned by the Federal Statistical Office (BFS-Nr). `null` if the address does not match a locality record. - `kantonskürzel` string, required: Canton abbreviation from the locality directory (e.g. `"ZH"`, `"GE"`). Can be empty string `""` if not present. - `sprache` string, nullable, required: Language of the address, mirroring `language`. - `validity` string, nullable, required: Date the postal code record became valid, formatted `YYYY-MM-DD`. ## Other responses - `404`: Resource not found - `default`: Error --- [API](https://skmtc.dev/addresszen/apis/api-reference.md) · [All operations](https://skmtc.dev/addresszen/apis/api-reference/llms.txt) · [OpenAPI document](https://skmtc.dev/addresszen/apis/api-reference/revisions/cac119db15c0?raw)