diff --git a/dist/openapi.json b/dist/openapi.json index cce499f..fca776a 100644 --- a/dist/openapi.json +++ b/dist/openapi.json @@ -41,7 +41,7 @@ }, { "name": "Licensees", - "description": "The Licensee resource represents an alternate legal End User of our data who may not be same entity as the owners of the account.\n\nThe concept of Licensees underpins our sublicensing platform, which allows users to license multiple external organisations or individuals to access data under the same account.\n\nSublicensing is ideal for platform vendors, who provide services to multiple clients who in turn each have their own users.\n" + "description": "The Licensee resource represents an alternate legal End User of our data who may not be the same entity as the owners of the account.\n\nThe concept of Licensees underpins our sublicensing platform, which allows users to license multiple external organisations or individuals to access data under the same account.\n\nSublicensing is ideal for platform vendors, who provide services to multiple clients who in turn each have their own users.\n" }, { "name": "Configs", @@ -346,7 +346,7 @@ ], "summary": "Retrieve by UMPRN", "operationId": "UMPRN", - "description": "Returns a multiple occupancy address identifited via its UMPRN (Multiple Residence Unique ID).\n\nUMPRNs are a unique numeric code for any Multiple Residence household on the optional Multiple Residence dataset.\n\n## Testing\n\nTo test your implementation of our API we have a range of test UMPRNs that yield both successful and unsuccessful responses to your request. They are the following\n\n- `0` Returns a successful UMPRN lookup response `2000`\n- `-1` Returns \"UMPRN not found\", error `4044`\n- `-2` Returns \"no lookups remaining\", error `4020`\n- `-3` Returns \"daily (or individual) lookup limit breached\", error `4021`\n\nTest request undergo the usual authentication and restriction rules. This is to help surface any issues that occur during implementation and does not cost you a lookup.\n\n### Pricing\n\nPer lookup charges apply. Empty responses are not charged.\n", + "description": "Returns a multiple occupancy address identified via its UMPRN (Multiple Residence Unique ID).\n\nUMPRNs are a unique numeric code for any Multiple Residence household on the optional Multiple Residence dataset.\n\n## Testing\n\nTo test your implementation of our API we have a range of test UMPRNs that yield both successful and unsuccessful responses to your request. They are the following\n\n- `0` Returns a successful UMPRN lookup response `2000`\n- `-1` Returns \"UMPRN not found\", error `4044`\n- `-2` Returns \"no lookups remaining\", error `4020`\n- `-3` Returns \"daily (or individual) lookup limit breached\", error `4021`\n\nTest request undergo the usual authentication and restriction rules. This is to help surface any issues that occur during implementation and does not cost you a lookup.\n\n### Pricing\n\nPer lookup charges apply. Empty responses are not charged.\n", "parameters": [ { "name": "umprn", @@ -461,7 +461,7 @@ ], "summary": "Availability", "operationId": "KeyAvailability", - "description": "Returns public information on your API Key.\n\nThis endpoint can be used for the following:\n- Determine if the key is currently useable via the `available` property\n- Determine available contexts for a an API Key\n- Identify the currently likely context of a user given their location\n\nYou may pass both API Keys (beginning `ak_`) and Sub-licensed Keys (beginning `sl_`).\n", + "description": "Returns public information on your API Key.\n\nThis endpoint can be used for the following:\n - Determine if the key is currently usable via the `available` property\n - Determine available contexts for an API Key\n- Identify the currently likely context of a user given their location\n\nYou may pass both API Keys (beginning `ak_`) and Sub-licensed Keys (beginning `sl_`).\n", "parameters": [ { "$ref": "#/components/parameters/ApiKeyPathParam" @@ -743,7 +743,7 @@ "UK" ], "summary": "Cleanse Address", - "description": "The address cleanse API attempts to return the closest matching address for any given address inputs. We also return a number of Match Level indicators that describe the degree to which the suggested address matches the input address. The more impaired the input address, the harder it is to cleanse.\n\n## Confidence Score\n\nThe confidence score is a number ranging between 0 and 1. Where 1 implies a full match and 0 implies no major elements completely match. Each incorrect, missing or misspelled element will subtract from the overall confidence score.\n\n### Deciding on an Acceptable Confidence Score Threshold\n\nDifferent address cleanse projects can have radically different inputs. However, within each project, the inputs tend to repeat the same errors. For instance, some input datasets may be exclusively inputted manually and be prone to typos. Others may have a persistently missing datapoint such as organistation name or postcode. For this reason, it is important to understand that there is no absolute Confidence Score threshold. Instead, the acceptable confidence score must be determined on a project by project basis based on systematic errors present in the data and business goals.\n\nWhen determining an acceptable Confidence Score threshold you should load a subset of the dataset into a spreadsheet application like Excel and sort on the score. Scrolling from top-to-bottom you will be able to observe matches from best to worst. As you start to hit the lower quality searches, you will be able to roughly determine:\n- Which confidence scores indicate ambigious matches (i.e. up to building level only)\n- Which confidence scores indicate a poor or no match (i.e. the nearest matching address is too far from the input address)\n\nDepending on your business goals, you can also use the Match Levels to determine an acceptable match. For instance, do you need to match up to the throroughfare or building name only? Are accurate organisation names an important feature?\n", + "description": "The address cleanse API attempts to return the closest matching address for any given address inputs. We also return a number of Match Level indicators that describe the degree to which the suggested address matches the input address. The more impaired the input address, the harder it is to cleanse.\n\n## Confidence Score\n\nThe confidence score is a number ranging between 0 and 1. Where 1 implies a full match and 0 implies no major elements completely match. Each incorrect, missing or misspelled element will subtract from the overall confidence score.\n\n### Deciding on an Acceptable Confidence Score Threshold\n\nDifferent address cleanse projects can have radically different inputs. However, within each project, the inputs tend to repeat the same errors. For instance, some input datasets may be exclusively inputted manually and be prone to typos. Others may have a persistently missing datapoint such as organisation name or postcode. For this reason, it is important to understand that there is no absolute Confidence Score threshold. Instead, the acceptable confidence score must be determined on a project by project basis based on systematic errors present in the data and business goals.\n\nWhen determining an acceptable Confidence Score threshold you should load a subset of the dataset into a spreadsheet application like Excel and sort on the score. Scrolling from top-to-bottom you will be able to observe matches from best to worst. As you start to hit the lower quality searches, you will be able to roughly determine:\n - Which confidence scores indicate ambiguous matches (i.e. up to building level only)\n- Which confidence scores indicate a poor or no match (i.e. the nearest matching address is too far from the input address)\n\nDepending on your business goals, you can also use the Match Levels to determine an acceptable match. For instance, do you need to match up to the thoroughfare or building name only? Are accurate organisation names an important feature?\n", "operationId": "AddressCleanse", "parameters": [ { @@ -854,7 +854,7 @@ "US" ], "summary": "Verify Address", - "description": "The address verify API validates, corrects, and standardizes individual addresses based on USPS's Coding Accuracy Support System (CASS).\n\nThe address verify API accepts the 3 combination of inputs:\n\n- Free-form address submitted as a single string in `query`\n - Example: \"123 Main St, Springfield, CO 81073-1119\"\n- Only free-form and zip code address components submitted as separate parameters:\n - `query` for the street address\n - `zip_code` for the ZIP code\n - Example:\n - `query`: \"123 Main St, Springfield CO\"\n - `zip_code`: \"81073-1119\"\n- Only free-form, city and state address components submitted as separate parameters:\n - `query` for the street address\n - `city` for the city\n - `state` for the state\n - Example:\n - `query`: \"123 Main St\"\n - `city`: \"Springfield\"\n - `state`: \"CO\"\n", + "description": "The address verify API validates, corrects, and standardizes individual addresses based on USPS's Coding Accuracy Support System (CASS).\n\nThe address verify API accepts the 3 combination of inputs:\n\n- Free-form address submitted as a single string in `query`\n - Example: \"123 Main St, Springfield, CO 81073-1119\"\n- Only free-form and zip code address components submitted as separate parameters:\n - `query` for the first address line\n - `zip_code` for the ZIP code\n - Example:\n - `query`: \"123 Main St, Springfield CO\"\n - `zip_code`: \"81073-1119\"\n- Only free-form, city and state address components submitted as separate parameters:\n - `query` for the first address line\n - `city` for the city\n - `state` for the state\n - Example:\n - `query`: \"123 Main St\"\n - `city`: \"Springfield\"\n - `state`: \"CO\"\n", "operationId": "AddressVerify", "parameters": [ { @@ -885,7 +885,7 @@ "properties": { "query": { "type": "string", - "description": "Freeform address input to verify.\n\nCan be submitted standalone, or with the following address components:\n- `zip_code`\n- `city` and `state`\n", + "description": "Address input to verify.\n\nIf submitting a freeform address verification query, enter the full address. E.g. `query=123 Main St, Springfield, CO, 81073`\n\nOtherwise, query can be accompanied with the following address components:\n- `zip_code`\n- `city` and `state`\n\nIf zip_code or `city` and `state` or supplied, please omit this information from query by using it purely for the first address line. E.g. `query=123 Main St`\n", "example": "123 Main St, Springfield, CO 81073" }, "zip_code": { @@ -1473,7 +1473,7 @@ "Place Search" ], "summary": "Find Place", - "description": "Query for geographical places across countries. Each query will return a list of place suggestions, which consists of a place name, descriptive name and id.\n\nThis API returns geographical information such as countries, capitals, administrative areas and more. It is ideal for correctly identifying a place along with any other details like geolocation.\n\n## Implementing Place Autocomplete\n\nExtracting the full information of a place is a 2 step process:\n\n1. Retrieve place suggestions via /places\n2. Retrieve the entire place with the ID provided in the suggestion\n\n## Suggestion Format\n\nEach place suggestion contains a descriptive name which you can provide to users to uniquely idenfity a place.\n\n## Rate Limiting and Cost\n\nThe rate limit for the Autocomplete API is 3000 requests per 5 minutes. HTTP Headers inform about the current rate limit.\n\nAutocomplete API usage does not impact your balance, but resolving a suggestion to a full address requires a paid request. Autocomplete requests without subsequent paid requests may result in rate limitation or suspension.\n", + "description": "Query for geographical places across countries. Each query will return a list of place suggestions, which consists of a place name, descriptive name and id.\n\nThis API returns geographical information such as countries, capitals, administrative areas and more. It is ideal for correctly identifying a place along with any other details like geolocation.\n\n## Implementing Place Autocomplete\n\nExtracting the full information of a place is a 2 step process:\n\n1. Retrieve place suggestions via /places\n2. Retrieve the entire place with the ID provided in the suggestion\n\n## Suggestion Format\n\nEach place suggestion contains a descriptive name which you can provide to users to uniquely identify a place.\n\n## Rate Limiting and Cost\n\nThe rate limit for the Autocomplete API is 3000 requests per 5 minutes. HTTP Headers inform about the current rate limit.\n\nAutocomplete API usage does not impact your balance, but resolving a suggestion to a full address requires a paid request. Autocomplete requests without subsequent paid requests may result in rate limitation or suspension.\n", "operationId": "FindPlace", "parameters": [ { @@ -3777,7 +3777,7 @@ "Dataset": { "title": "Dataset", "type": "string", - "description": "Indicates the provenance of an address.\n\n - `paf` (GBR) Postcode Address File\n - `usps` (USA) USPS Zip+4\n - `mr` (GBR) Multiple Residence File\n - `nyb` (GBR) Not Yet Built File\n - `pafa` (GBR) Alias File\n - `pafw` (GBR) Welsh File\n - `ab` (GBR) AddressBase Core\n - `ecaf` (IRL) Eircode ECAF\n - `ecad` (IRL) Eircode ECAD\n - `herewe` (Western Europe) Western Europe Dataset\n - `heret` (Taiwan) Taiwan Dataset\n - `heresa` (South America) South America Dataset\n - `hereo` (Oceania) Oceania Dataset\n - `herena` (North America) North America Dataset\n - `herei` (India) India Dataset\n - `heremea` (Middle East and Africa) Middle East and Africa Dataset\n - `herem` (Macau) Macau Dataset\n - `herehk` (Hong Kong) Hong Kong Dataset\n - `hereee` (Eastern Europe) Eastern Europe Dataset\n - `hereap` (Asia Pacific) Asia Pacific Dataset\n - `gnaf` (AUS) Geoscape Geocoded National Address File\n - `kadaster` (NLD) Kadaster BAG 2.0 Address File\n - `kartverket` (NOR) Norway Dataset\n - `sdfi` (DNK) Denmark Dataset\n - `cannar` (CAN) Canada National Address Register Dataset\n - `fodbosa` (BEL) Belgium Dataset\n - `mois` (KOR) South Korea Dataset\n - `upujp` (JPN) Japan UPU Address File", + "description": "Indicates the provenance of an address.\n\n - `paf` (GBR) Postcode Address File\n - `usps` (USA) USPS Zip+4\n - `mr` (GBR) Multiple Residence File\n - `nyb` (GBR) Not Yet Built File\n - `pafa` (GBR) Alias File\n - `pafw` (GBR) Welsh File\n - `ab` (GBR) AddressBase Core\n - `ecaf` (IRL) Eircode ECAF\n - `ecad` (IRL) Eircode ECAD\n - `herewe` (Western Europe) Western Europe Dataset\n - `heret` (Taiwan) Taiwan Dataset\n - `heresa` (South America) South America Dataset\n - `hereo` (Oceania) Oceania Dataset\n - `herena` (North America) North America Dataset\n - `herei` (India) India Dataset\n - `heremea` (Middle East and Africa) Middle East and Africa Dataset\n - `herem` (Macau) Macau Dataset\n - `herehk` (Hong Kong) Hong Kong Dataset\n - `hereee` (Eastern Europe) Eastern Europe Dataset\n - `hereap` (Asia Pacific) Asia Pacific Dataset\n - `gnaf` (AUS) Geoscape Geocoded National Address File\n - `kadaster` (NLD) Kadaster BAG 2.0 Address File\n - `kartverket` (NOR) Norway Dataset\n - `sdfi` (DNK) Denmark Dataset\n - `cannar` (CAN) Canada National Address Register Dataset\n - `fodbosa` (BEL) Belgium Dataset\n - `mois` (KOR) South Korea Dataset\n - `upujp` (JPN) Japan UPU Address File\n - `bev` (AUT) Austria Dataset", "enum": [ "paf", "pafw", @@ -3807,7 +3807,8 @@ "cannar", "fodbosa", "mois", - "upujp" + "upujp", + "bev" ] }, "CountryISO": { @@ -9582,6 +9583,336 @@ } } }, + "BevAddress": { + "required": [ + "id", + "dataset", + "country", + "country_iso", + "country_iso_2", + "language", + "address", + "line_1", + "latitude", + "longitude", + "adrcd", + "kgnr", + "gkz", + "okz", + "plz", + "skz", + "zaehlsprengel", + "hausnrtext", + "hausnrzahl1", + "hausnrbuchstabe1", + "hausnrverbindung1", + "hausnrzahl2", + "hausnrbuchstabe2", + "hausnrbereich", + "hnr_adr_zusammen", + "gnradresse", + "hofname", + "rw", + "hw", + "epsg", + "quelladresse", + "bestimmungsart", + "subcd", + "objektnummer", + "objfunktkennziffer", + "hauptadresse", + "hausnrverbindung2", + "hausnrzahl3", + "hausnrbuchstabe3", + "hausnrverbindung3", + "hausnrzahl4", + "hausnrbuchstabe4", + "hausnrgebaeudebez", + "hnr_geb_zusammen", + "eigenschaft", + "gemeindename", + "ortsname", + "strassenname", + "strassennamenzusatz", + "szusadrbest", + "zustellort", + "zustellort_id", + "zaehlsprengelname" + ], + "properties": { + "id": { + "$ref": "#/components/schemas/ID" + }, + "dataset": { + "type": "string", + "enum": [ + "bev" + ] + }, + "country_iso": { + "description": " 3 letter country code (ISO 3166-1)\n", + "enum": [ + "AUT" + ] + }, + "country_iso_2": { + "type": "string", + "description": " 2 letter country code (ISO 3166-1)\n", + "enum": [ + "AT" + ] + }, + "country": { + "type": "string", + "description": " Full country names (ISO 3166)\n", + "enum": [ + "Austria" + ] + }, + "language": { + "enum": [ + "de" + ], + "description": "Language represented by 2 letter ISO Code (639-1)\n" + }, + "address": { + "type": "string", + "description": "Combination of hnr_adr_zusammen and hnr_geb_zusammen, the full house number and text\nCan be empty string `\"\"` if not present.\n", + "example": "40" + }, + "line_1": { + "type": "string", + "description": "First address line.\nCan be empty string `\"\"` if not present.\n", + "example": "Poltenweg 40" + }, + "longitude": { + "$ref": "#/components/schemas/Longitude" + }, + "latitude": { + "$ref": "#/components/schemas/Latitude" + }, + "adrcd": { + "type": "string", + "description": "Id of the address\n" + }, + "kgnr": { + "type": "string", + "description": "Cadastral number of the municipality\n" + }, + "gkz": { + "type": "string", + "description": "Municipality code identifier\n" + }, + "okz": { + "type": "string", + "description": "Locality Code identifier\n" + }, + "plz": { + "type": "string", + "description": "Postal Code\n" + }, + "skz": { + "type": "string", + "description": "Street Code Identifier\n" + }, + "zaehlsprengel": { + "type": "string", + "description": "Census District Identifier\n" + }, + "hausnrtext": { + "type": "string", + "description": "Text before house number\n" + }, + "hausnrzahl1": { + "oneOf": [ + { + "type": "string", + "description": "Empty string `\"\"` if not available\n" + }, + { + "type": "number", + "description": "House number part 1\n" + } + ] + }, + "hausnrbuchstabe1": { + "type": "string", + "description": "House number first part of the letter\n" + }, + "hausnrverbindung1": { + "type": "string", + "description": "House number connection - Stg. = Staircase, Obj. = Property, Parz. = Parcel\n" + }, + "hausnrzahl2": { + "oneOf": [ + { + "type": "string", + "description": "Empty string `\"\"` if not available\n" + }, + { + "type": "number", + "description": "House number part 2\n" + } + ] + }, + "hausnrbuchstabe2": { + "type": "string", + "description": "House number second part of the letter\n" + }, + "hausnrbereich": { + "type": "string", + "description": "House number valid range (only even/only odd/all) keine angabe = not specified\n" + }, + "hnr_adr_zusammen": { + "type": "string", + "description": "Complete house number (combination of house number parts and letters)\n" + }, + "gnradresse": { + "type": "number", + "description": "Property address number\n" + }, + "hofname": { + "type": "string", + "description": "The hof name is a local term for individual buildings or building complexes, such as farmsteads\n" + }, + "rw": { + "type": "string", + "description": "X coordinate (ETRS89 / LAEA Europe)\n" + }, + "hw": { + "type": "string", + "description": "Y coordinate (ETRS89 / LAEA Europe)\n" + }, + "epsg": { + "type": "number", + "description": "Coordinate reference system identifier\n" + }, + "quelladresse": { + "type": "string", + "description": "Source of the address (official survey, postal service, etc.)\n" + }, + "bestimmungsart": { + "type": "string", + "description": "Type of coordinate determination (official, customary, etc.)\n" + }, + "subcd": { + "type": "string", + "description": "Sub Code to distinguish multiple buildings at the same address\n" + }, + "objektnummer": { + "type": "string", + "description": "Object Number of the building\n" + }, + "objfunktkennziffer": { + "oneOf": [ + { + "type": "string", + "description": "Building Function Code, see ReadMe for details\n" + }, + { + "type": "string[]", + "description": "Array containing all Building Function Codes related to address\n" + } + ] + }, + "hauptadresse": { + "oneOf": [ + { + "type": "string", + "description": "Empty string `\"\"` if not available\n" + }, + { + "type": "number", + "description": "Main address, one postal per address (1 = Postal, 0 = Identification)\n" + } + ] + }, + "hausnrverbindung2": { + "type": "string", + "description": "House number 2nd connection - Stg. = Staircase, Obj. = Property, Parz. = Parcel\n" + }, + "hausnrzahl3": { + "oneOf": [ + { + "type": "string", + "description": "Empty string `\"\"` if not available\n" + }, + { + "type": "number", + "description": "House number part 3\n" + } + ] + }, + "hausnrbuchstabe3": { + "type": "string", + "description": "House number third part of the letter\n" + }, + "hausnrverbindung3": { + "type": "string", + "description": "House number 3rd connection - Stg. = Staircase, Obj. = Property, Parz. = Parcel\n" + }, + "hausnrzahl4": { + "oneOf": [ + { + "type": "string", + "description": "Empty string `\"\"` if not available\n" + }, + { + "type": "number", + "description": "House number part 4\n" + } + ] + }, + "hausnrbuchstabe4": { + "type": "string", + "description": "House number fourth part of the letter\n" + }, + "hausnrgebaeudebez": { + "type": "string", + "description": "Building distinction (e.g., \"House\", \"Building\", \"Villa\", etc.)\n" + }, + "hnr_geb_zusammen": { + "type": "string", + "description": "Full building designation (combination of house number and building designation)\n" + }, + "eigenschaft": { + "type": "string", + "description": "Prominent feature of the property (See ReadMe for details)\n" + }, + "gemeindename": { + "type": "string", + "description": "Name of the municipality\n" + }, + "ortsname": { + "type": "string", + "description": "Name of the locality\n" + }, + "strassenname": { + "type": "string", + "description": "Name of the street\n" + }, + "strassennamenzusatz": { + "type": "string", + "description": "Street name addition (e.g., \"Allee\", \"Strasse\", etc.)\n" + }, + "szusadrbest": { + "type": "number", + "description": "Number of addresses associated with the street\n" + }, + "zustellort": { + "type": "string", + "description": "Delivery location (usually the same as the street name)\n" + }, + "zustellort_id": { + "type": "string", + "description": "Delivery location code identifier\n" + }, + "zaehlsprengelname": { + "type": "string", + "description": "Census District Identifier\n" + } + } + }, "GbrGlobalAddress": { "title": "Global Address", "description": "Global (non-UK) address in the UK address format", @@ -9731,6 +10062,9 @@ }, { "$ref": "#/components/schemas/UpujpAddress" + }, + { + "$ref": "#/components/schemas/BevAddress" } ] }, @@ -10509,7 +10843,8 @@ "cannar", "fodbosa", "mois", - "upujp" + "upujp", + "bev" ], "properties": { "paf": { @@ -10670,6 +11005,11 @@ "type": "boolean", "description": "Japan: UPU Address File", "example": true + }, + "bev": { + "type": "boolean", + "description": "Austria: BEV Address File", + "example": true } } }, @@ -11013,6 +11353,11 @@ "type": "boolean", "description": "Japan: UPU Address File", "example": true + }, + "bev": { + "type": "boolean", + "description": "Austria: BEV Address File", + "example": true } } } @@ -12581,6 +12926,9 @@ }, { "$ref": "#/components/schemas/UpujpAddress" + }, + { + "$ref": "#/components/schemas/BevAddress" } ] } diff --git a/dist/openapi.yaml b/dist/openapi.yaml index 2f37957..a2ddace 100644 --- a/dist/openapi.yaml +++ b/dist/openapi.yaml @@ -103,7 +103,7 @@ tags: description: Monitor and manage API Keys - name: Licensees description: | - The Licensee resource represents an alternate legal End User of our data who may not be same entity as the owners of the account. + The Licensee resource represents an alternate legal End User of our data who may not be the same entity as the owners of the account. The concept of Licensees underpins our sublicensing platform, which allows users to license multiple external organisations or individuals to access data under the same account. @@ -407,7 +407,7 @@ paths: summary: Retrieve by UMPRN operationId: UMPRN description: | - Returns a multiple occupancy address identifited via its UMPRN (Multiple Residence Unique ID). + Returns a multiple occupancy address identified via its UMPRN (Multiple Residence Unique ID). UMPRNs are a unique numeric code for any Multiple Residence household on the optional Multiple Residence dataset. @@ -517,8 +517,8 @@ paths: Returns public information on your API Key. This endpoint can be used for the following: - - Determine if the key is currently useable via the `available` property - - Determine available contexts for a an API Key + - Determine if the key is currently usable via the `available` property + - Determine available contexts for an API Key - Identify the currently likely context of a user given their location You may pass both API Keys (beginning `ak_`) and Sub-licensed Keys (beginning `sl_`). @@ -731,13 +731,13 @@ paths: ### Deciding on an Acceptable Confidence Score Threshold - Different address cleanse projects can have radically different inputs. However, within each project, the inputs tend to repeat the same errors. For instance, some input datasets may be exclusively inputted manually and be prone to typos. Others may have a persistently missing datapoint such as organistation name or postcode. For this reason, it is important to understand that there is no absolute Confidence Score threshold. Instead, the acceptable confidence score must be determined on a project by project basis based on systematic errors present in the data and business goals. + Different address cleanse projects can have radically different inputs. However, within each project, the inputs tend to repeat the same errors. For instance, some input datasets may be exclusively inputted manually and be prone to typos. Others may have a persistently missing datapoint such as organisation name or postcode. For this reason, it is important to understand that there is no absolute Confidence Score threshold. Instead, the acceptable confidence score must be determined on a project by project basis based on systematic errors present in the data and business goals. When determining an acceptable Confidence Score threshold you should load a subset of the dataset into a spreadsheet application like Excel and sort on the score. Scrolling from top-to-bottom you will be able to observe matches from best to worst. As you start to hit the lower quality searches, you will be able to roughly determine: - - Which confidence scores indicate ambigious matches (i.e. up to building level only) + - Which confidence scores indicate ambiguous matches (i.e. up to building level only) - Which confidence scores indicate a poor or no match (i.e. the nearest matching address is too far from the input address) - Depending on your business goals, you can also use the Match Levels to determine an acceptable match. For instance, do you need to match up to the throroughfare or building name only? Are accurate organisation names an important feature? + Depending on your business goals, you can also use the Match Levels to determine an acceptable match. For instance, do you need to match up to the thoroughfare or building name only? Are accurate organisation names an important feature? operationId: AddressCleanse parameters: - $ref: '#/components/parameters/ApiKeyParam' @@ -832,13 +832,13 @@ paths: - Free-form address submitted as a single string in `query` - Example: "123 Main St, Springfield, CO 81073-1119" - Only free-form and zip code address components submitted as separate parameters: - - `query` for the street address + - `query` for the first address line - `zip_code` for the ZIP code - Example: - `query`: "123 Main St, Springfield CO" - `zip_code`: "81073-1119" - Only free-form, city and state address components submitted as separate parameters: - - `query` for the street address + - `query` for the first address line - `city` for the city - `state` for the state - Example: @@ -868,11 +868,15 @@ paths: query: type: string description: | - Freeform address input to verify. + Address input to verify. - Can be submitted standalone, or with the following address components: + If submitting a freeform address verification query, enter the full address. E.g. `query=123 Main St, Springfield, CO, 81073` + + Otherwise, query can be accompanied with the following address components: - `zip_code` - `city` and `state` + + If zip_code or `city` and `state` or supplied, please omit this information from query by using it purely for the first address line. E.g. `query=123 Main St` example: 123 Main St, Springfield, CO 81073 zip_code: type: string @@ -1349,7 +1353,7 @@ paths: ## Suggestion Format - Each place suggestion contains a descriptive name which you can provide to users to uniquely idenfity a place. + Each place suggestion contains a descriptive name which you can provide to users to uniquely identify a place. ## Rate Limiting and Cost @@ -3135,6 +3139,7 @@ components: - `fodbosa` (BEL) Belgium Dataset - `mois` (KOR) South Korea Dataset - `upujp` (JPN) Japan UPU Address File + - `bev` (AUT) Austria Dataset enum: - paf - pafw @@ -3165,6 +3170,7 @@ components: - fodbosa - mois - upujp + - bev CountryISO: title: ISO Country Code (3) type: string @@ -9251,6 +9257,302 @@ components: Language used for the locality names. Can be empty string `""` if not present. + BevAddress: + required: + - id + - dataset + - country + - country_iso + - country_iso_2 + - language + - address + - line_1 + - latitude + - longitude + - adrcd + - kgnr + - gkz + - okz + - plz + - skz + - zaehlsprengel + - hausnrtext + - hausnrzahl1 + - hausnrbuchstabe1 + - hausnrverbindung1 + - hausnrzahl2 + - hausnrbuchstabe2 + - hausnrbereich + - hnr_adr_zusammen + - gnradresse + - hofname + - rw + - hw + - epsg + - quelladresse + - bestimmungsart + - subcd + - objektnummer + - objfunktkennziffer + - hauptadresse + - hausnrverbindung2 + - hausnrzahl3 + - hausnrbuchstabe3 + - hausnrverbindung3 + - hausnrzahl4 + - hausnrbuchstabe4 + - hausnrgebaeudebez + - hnr_geb_zusammen + - eigenschaft + - gemeindename + - ortsname + - strassenname + - strassennamenzusatz + - szusadrbest + - zustellort + - zustellort_id + - zaehlsprengelname + properties: + id: + $ref: '#/components/schemas/ID' + dataset: + type: string + enum: + - bev + country_iso: + description: |2 + 3 letter country code (ISO 3166-1) + enum: + - AUT + country_iso_2: + type: string + description: |2 + 2 letter country code (ISO 3166-1) + enum: + - AT + country: + type: string + description: |2 + Full country names (ISO 3166) + enum: + - Austria + language: + enum: + - de + description: | + Language represented by 2 letter ISO Code (639-1) + address: + type: string + description: | + Combination of hnr_adr_zusammen and hnr_geb_zusammen, the full house number and text + Can be empty string `""` if not present. + example: '40' + line_1: + type: string + description: | + First address line. + Can be empty string `""` if not present. + example: Poltenweg 40 + longitude: + $ref: '#/components/schemas/Longitude' + latitude: + $ref: '#/components/schemas/Latitude' + adrcd: + type: string + description: | + Id of the address + kgnr: + type: string + description: | + Cadastral number of the municipality + gkz: + type: string + description: | + Municipality code identifier + okz: + type: string + description: | + Locality Code identifier + plz: + type: string + description: | + Postal Code + skz: + type: string + description: | + Street Code Identifier + zaehlsprengel: + type: string + description: | + Census District Identifier + hausnrtext: + type: string + description: | + Text before house number + hausnrzahl1: + oneOf: + - type: string + description: | + Empty string `""` if not available + - type: number + description: | + House number part 1 + hausnrbuchstabe1: + type: string + description: | + House number first part of the letter + hausnrverbindung1: + type: string + description: | + House number connection - Stg. = Staircase, Obj. = Property, Parz. = Parcel + hausnrzahl2: + oneOf: + - type: string + description: | + Empty string `""` if not available + - type: number + description: | + House number part 2 + hausnrbuchstabe2: + type: string + description: | + House number second part of the letter + hausnrbereich: + type: string + description: | + House number valid range (only even/only odd/all) keine angabe = not specified + hnr_adr_zusammen: + type: string + description: | + Complete house number (combination of house number parts and letters) + gnradresse: + type: number + description: | + Property address number + hofname: + type: string + description: | + The hof name is a local term for individual buildings or building complexes, such as farmsteads + rw: + type: string + description: | + X coordinate (ETRS89 / LAEA Europe) + hw: + type: string + description: | + Y coordinate (ETRS89 / LAEA Europe) + epsg: + type: number + description: | + Coordinate reference system identifier + quelladresse: + type: string + description: | + Source of the address (official survey, postal service, etc.) + bestimmungsart: + type: string + description: | + Type of coordinate determination (official, customary, etc.) + subcd: + type: string + description: | + Sub Code to distinguish multiple buildings at the same address + objektnummer: + type: string + description: | + Object Number of the building + objfunktkennziffer: + oneOf: + - type: string + description: | + Building Function Code, see ReadMe for details + - type: string[] + description: | + Array containing all Building Function Codes related to address + hauptadresse: + oneOf: + - type: string + description: | + Empty string `""` if not available + - type: number + description: | + Main address, one postal per address (1 = Postal, 0 = Identification) + hausnrverbindung2: + type: string + description: | + House number 2nd connection - Stg. = Staircase, Obj. = Property, Parz. = Parcel + hausnrzahl3: + oneOf: + - type: string + description: | + Empty string `""` if not available + - type: number + description: | + House number part 3 + hausnrbuchstabe3: + type: string + description: | + House number third part of the letter + hausnrverbindung3: + type: string + description: | + House number 3rd connection - Stg. = Staircase, Obj. = Property, Parz. = Parcel + hausnrzahl4: + oneOf: + - type: string + description: | + Empty string `""` if not available + - type: number + description: | + House number part 4 + hausnrbuchstabe4: + type: string + description: | + House number fourth part of the letter + hausnrgebaeudebez: + type: string + description: | + Building distinction (e.g., "House", "Building", "Villa", etc.) + hnr_geb_zusammen: + type: string + description: | + Full building designation (combination of house number and building designation) + eigenschaft: + type: string + description: | + Prominent feature of the property (See ReadMe for details) + gemeindename: + type: string + description: | + Name of the municipality + ortsname: + type: string + description: | + Name of the locality + strassenname: + type: string + description: | + Name of the street + strassennamenzusatz: + type: string + description: | + Street name addition (e.g., "Allee", "Strasse", etc.) + szusadrbest: + type: number + description: | + Number of addresses associated with the street + zustellort: + type: string + description: | + Delivery location (usually the same as the street name) + zustellort_id: + type: string + description: | + Delivery location code identifier + zaehlsprengelname: + type: string + description: | + Census District Identifier GbrGlobalAddress: title: Global Address description: Global (non-UK) address in the UK address format @@ -9362,6 +9664,7 @@ components: - $ref: '#/components/schemas/FodbosaAddress' - $ref: '#/components/schemas/MoisAddress' - $ref: '#/components/schemas/UpujpAddress' + - $ref: '#/components/schemas/BevAddress' postcode_outward: type: string description: Not available for non-UK addresses @@ -9972,6 +10275,7 @@ components: - fodbosa - mois - upujp + - bev properties: paf: type: boolean @@ -10100,6 +10404,10 @@ components: type: boolean description: 'Japan: UPU Address File' example: true + bev: + type: boolean + description: 'Austria: BEV Address File' + example: true ApiKeyAutomatedTopup: title: API Key Automated Topup description: Automated topup status @@ -10377,6 +10685,10 @@ components: type: boolean description: 'Japan: UPU Address File' example: true + bev: + type: boolean + description: 'Austria: BEV Address File' + example: true KeyUsageResult: title: Key Usage type: object @@ -11630,6 +11942,7 @@ components: - $ref: '#/components/schemas/FodbosaAddress' - $ref: '#/components/schemas/MoisAddress' - $ref: '#/components/schemas/UpujpAddress' + - $ref: '#/components/schemas/BevAddress' UsaResolveAddressResponse: title: Address Retrieve Response (USA) type: object diff --git a/openapi.ts b/openapi.ts index d68c35b..6b875fc 100644 --- a/openapi.ts +++ b/openapi.ts @@ -63,7 +63,7 @@ export interface paths { }; "/umprn/{umprn}": { /** - * Returns a multiple occupancy address identifited via its UMPRN (Multiple Residence Unique ID). + * Returns a multiple occupancy address identified via its UMPRN (Multiple Residence Unique ID). * * UMPRNs are a unique numeric code for any Multiple Residence household on the optional Multiple Residence dataset. * @@ -89,8 +89,8 @@ export interface paths { * Returns public information on your API Key. * * This endpoint can be used for the following: - * - Determine if the key is currently useable via the `available` property - * - Determine available contexts for a an API Key + * - Determine if the key is currently usable via the `available` property + * - Determine available contexts for an API Key * - Identify the currently likely context of a user given their location * * You may pass both API Keys (beginning `ak_`) and Sub-licensed Keys (beginning `sl_`). @@ -153,13 +153,13 @@ export interface paths { * * ### Deciding on an Acceptable Confidence Score Threshold * - * Different address cleanse projects can have radically different inputs. However, within each project, the inputs tend to repeat the same errors. For instance, some input datasets may be exclusively inputted manually and be prone to typos. Others may have a persistently missing datapoint such as organistation name or postcode. For this reason, it is important to understand that there is no absolute Confidence Score threshold. Instead, the acceptable confidence score must be determined on a project by project basis based on systematic errors present in the data and business goals. + * Different address cleanse projects can have radically different inputs. However, within each project, the inputs tend to repeat the same errors. For instance, some input datasets may be exclusively inputted manually and be prone to typos. Others may have a persistently missing datapoint such as organisation name or postcode. For this reason, it is important to understand that there is no absolute Confidence Score threshold. Instead, the acceptable confidence score must be determined on a project by project basis based on systematic errors present in the data and business goals. * * When determining an acceptable Confidence Score threshold you should load a subset of the dataset into a spreadsheet application like Excel and sort on the score. Scrolling from top-to-bottom you will be able to observe matches from best to worst. As you start to hit the lower quality searches, you will be able to roughly determine: - * - Which confidence scores indicate ambigious matches (i.e. up to building level only) + * - Which confidence scores indicate ambiguous matches (i.e. up to building level only) * - Which confidence scores indicate a poor or no match (i.e. the nearest matching address is too far from the input address) * - * Depending on your business goals, you can also use the Match Levels to determine an acceptable match. For instance, do you need to match up to the throroughfare or building name only? Are accurate organisation names an important feature? + * Depending on your business goals, you can also use the Match Levels to determine an acceptable match. For instance, do you need to match up to the thoroughfare or building name only? Are accurate organisation names an important feature? */ post: operations["AddressCleanse"]; }; @@ -172,13 +172,13 @@ export interface paths { * - Free-form address submitted as a single string in `query` * - Example: "123 Main St, Springfield, CO 81073-1119" * - Only free-form and zip code address components submitted as separate parameters: - * - `query` for the street address + * - `query` for the first address line * - `zip_code` for the ZIP code * - Example: * - `query`: "123 Main St, Springfield CO" * - `zip_code`: "81073-1119" * - Only free-form, city and state address components submitted as separate parameters: - * - `query` for the street address + * - `query` for the first address line * - `city` for the city * - `state` for the state * - Example: @@ -331,7 +331,7 @@ export interface paths { * * ## Suggestion Format * - * Each place suggestion contains a descriptive name which you can provide to users to uniquely idenfity a place. + * Each place suggestion contains a descriptive name which you can provide to users to uniquely identify a place. * * ## Rate Limiting and Cost * @@ -1134,6 +1134,7 @@ export interface components { * - `fodbosa` (BEL) Belgium Dataset * - `mois` (KOR) South Korea Dataset * - `upujp` (JPN) Japan UPU Address File + * - `bev` (AUT) Austria Dataset * @enum {string} */ Dataset: @@ -1165,7 +1166,8 @@ export interface components { | "cannar" | "fodbosa" | "mois" - | "upujp"; + | "upujp" + | "bev"; /** * ISO Country Code (3) * @description 3 letter country code (ISO 3166-1) @@ -5735,6 +5737,131 @@ export interface components { } & { script: unknown; }; + BevAddress: { + id: components["schemas"]["ID"]; + /** @enum {string} */ + dataset: "bev"; + /** + * @description 3 letter country code (ISO 3166-1) + * + * @enum {undefined} + */ + country_iso: "AUT"; + /** + * @description 2 letter country code (ISO 3166-1) + * + * @enum {string} + */ + country_iso_2: "AT"; + /** + * @description Full country names (ISO 3166) + * + * @enum {string} + */ + country: "Austria"; + /** + * @description Language represented by 2 letter ISO Code (639-1) + * + * @enum {undefined} + */ + language: "de"; + /** + * @description Combination of hnr_adr_zusammen and hnr_geb_zusammen, the full house number and text + * Can be empty string `""` if not present. + * + * @example 40 + */ + address: string; + /** + * @description First address line. + * Can be empty string `""` if not present. + * + * @example Poltenweg 40 + */ + line_1: string; + longitude: components["schemas"]["Longitude"]; + latitude: components["schemas"]["Latitude"]; + /** @description Id of the address */ + adrcd: string; + /** @description Cadastral number of the municipality */ + kgnr: string; + /** @description Municipality code identifier */ + gkz: string; + /** @description Locality Code identifier */ + okz: string; + /** @description Postal Code */ + plz: string; + /** @description Street Code Identifier */ + skz: string; + /** @description Census District Identifier */ + zaehlsprengel: string; + /** @description Text before house number */ + hausnrtext: string; + hausnrzahl1: string | number; + /** @description House number first part of the letter */ + hausnrbuchstabe1: string; + /** @description House number connection - Stg. = Staircase, Obj. = Property, Parz. = Parcel */ + hausnrverbindung1: string; + hausnrzahl2: string | number; + /** @description House number second part of the letter */ + hausnrbuchstabe2: string; + /** @description House number valid range (only even/only odd/all) keine angabe = not specified */ + hausnrbereich: string; + /** @description Complete house number (combination of house number parts and letters) */ + hnr_adr_zusammen: string; + /** @description Property address number */ + gnradresse: number; + /** @description The hof name is a local term for individual buildings or building complexes, such as farmsteads */ + hofname: string; + /** @description X coordinate (ETRS89 / LAEA Europe) */ + rw: string; + /** @description Y coordinate (ETRS89 / LAEA Europe) */ + hw: string; + /** @description Coordinate reference system identifier */ + epsg: number; + /** @description Source of the address (official survey, postal service, etc.) */ + quelladresse: string; + /** @description Type of coordinate determination (official, customary, etc.) */ + bestimmungsart: string; + /** @description Sub Code to distinguish multiple buildings at the same address */ + subcd: string; + /** @description Object Number of the building */ + objektnummer: string; + objfunktkennziffer: string | unknown; + hauptadresse: string | number; + /** @description House number 2nd connection - Stg. = Staircase, Obj. = Property, Parz. = Parcel */ + hausnrverbindung2: string; + hausnrzahl3: string | number; + /** @description House number third part of the letter */ + hausnrbuchstabe3: string; + /** @description House number 3rd connection - Stg. = Staircase, Obj. = Property, Parz. = Parcel */ + hausnrverbindung3: string; + hausnrzahl4: string | number; + /** @description House number fourth part of the letter */ + hausnrbuchstabe4: string; + /** @description Building distinction (e.g., "House", "Building", "Villa", etc.) */ + hausnrgebaeudebez: string; + /** @description Full building designation (combination of house number and building designation) */ + hnr_geb_zusammen: string; + /** @description Prominent feature of the property (See ReadMe for details) */ + eigenschaft: string; + /** @description Name of the municipality */ + gemeindename: string; + /** @description Name of the locality */ + ortsname: string; + /** @description Name of the street */ + strassenname: string; + /** @description Street name addition (e.g., "Allee", "Strasse", etc.) */ + strassennamenzusatz: string; + /** @description Number of addresses associated with the street */ + szusadrbest: number; + /** @description Delivery location (usually the same as the street name) */ + zustellort: string; + /** @description Delivery location code identifier */ + zustellort_id: string; + /** @description Census District Identifier */ + zaehlsprengelname: string; + }; /** * Global Address * @description Global (non-UK) address in the UK address format @@ -5801,7 +5928,8 @@ export interface components { | components["schemas"]["CannarAddress"] | components["schemas"]["FodbosaAddress"] | components["schemas"]["MoisAddress"] - | components["schemas"]["UpujpAddress"]; + | components["schemas"]["UpujpAddress"] + | components["schemas"]["BevAddress"]; /** * @description Not available for non-UK addresses * @enum {string} @@ -6451,6 +6579,11 @@ export interface components { * @example true */ upujp: boolean; + /** + * @description Austria: BEV Address File + * @example true + */ + bev: boolean; }; /** * API Key Automated Topup @@ -6696,6 +6829,11 @@ export interface components { * @example true */ upujp?: boolean; + /** + * @description Austria: BEV Address File + * @example true + */ + bev?: boolean; }; }; /** Key Usage */ @@ -7644,7 +7782,8 @@ export interface components { | components["schemas"]["CannarAddress"] | components["schemas"]["FodbosaAddress"] | components["schemas"]["MoisAddress"] - | components["schemas"]["UpujpAddress"]; + | components["schemas"]["UpujpAddress"] + | components["schemas"]["BevAddress"]; }; /** Address Retrieve Response (USA) */ UsaResolveAddressResponse: { @@ -9005,7 +9144,7 @@ export interface operations { }; }; /** - * Returns a multiple occupancy address identifited via its UMPRN (Multiple Residence Unique ID). + * Returns a multiple occupancy address identified via its UMPRN (Multiple Residence Unique ID). * * UMPRNs are a unique numeric code for any Multiple Residence household on the optional Multiple Residence dataset. * @@ -9068,8 +9207,8 @@ export interface operations { * Returns public information on your API Key. * * This endpoint can be used for the following: - * - Determine if the key is currently useable via the `available` property - * - Determine available contexts for a an API Key + * - Determine if the key is currently usable via the `available` property + * - Determine available contexts for an API Key * - Identify the currently likely context of a user given their location * * You may pass both API Keys (beginning `ak_`) and Sub-licensed Keys (beginning `sl_`). @@ -9365,13 +9504,13 @@ export interface operations { * * ### Deciding on an Acceptable Confidence Score Threshold * - * Different address cleanse projects can have radically different inputs. However, within each project, the inputs tend to repeat the same errors. For instance, some input datasets may be exclusively inputted manually and be prone to typos. Others may have a persistently missing datapoint such as organistation name or postcode. For this reason, it is important to understand that there is no absolute Confidence Score threshold. Instead, the acceptable confidence score must be determined on a project by project basis based on systematic errors present in the data and business goals. + * Different address cleanse projects can have radically different inputs. However, within each project, the inputs tend to repeat the same errors. For instance, some input datasets may be exclusively inputted manually and be prone to typos. Others may have a persistently missing datapoint such as organisation name or postcode. For this reason, it is important to understand that there is no absolute Confidence Score threshold. Instead, the acceptable confidence score must be determined on a project by project basis based on systematic errors present in the data and business goals. * * When determining an acceptable Confidence Score threshold you should load a subset of the dataset into a spreadsheet application like Excel and sort on the score. Scrolling from top-to-bottom you will be able to observe matches from best to worst. As you start to hit the lower quality searches, you will be able to roughly determine: - * - Which confidence scores indicate ambigious matches (i.e. up to building level only) + * - Which confidence scores indicate ambiguous matches (i.e. up to building level only) * - Which confidence scores indicate a poor or no match (i.e. the nearest matching address is too far from the input address) * - * Depending on your business goals, you can also use the Match Levels to determine an acceptable match. For instance, do you need to match up to the throroughfare or building name only? Are accurate organisation names an important feature? + * Depending on your business goals, you can also use the Match Levels to determine an acceptable match. For instance, do you need to match up to the thoroughfare or building name only? Are accurate organisation names an important feature? */ AddressCleanse: { parameters: { @@ -9470,13 +9609,13 @@ export interface operations { * - Free-form address submitted as a single string in `query` * - Example: "123 Main St, Springfield, CO 81073-1119" * - Only free-form and zip code address components submitted as separate parameters: - * - `query` for the street address + * - `query` for the first address line * - `zip_code` for the ZIP code * - Example: * - `query`: "123 Main St, Springfield CO" * - `zip_code`: "81073-1119" * - Only free-form, city and state address components submitted as separate parameters: - * - `query` for the street address + * - `query` for the first address line * - `city` for the city * - `state` for the state * - Example: @@ -9538,12 +9677,16 @@ export interface operations { content: { "application/json": { /** - * @description Freeform address input to verify. + * @description Address input to verify. * - * Can be submitted standalone, or with the following address components: + * If submitting a freeform address verification query, enter the full address. E.g. `query=123 Main St, Springfield, CO, 81073` + * + * Otherwise, query can be accompanied with the following address components: * - `zip_code` * - `city` and `state` * + * If zip_code or `city` and `state` or supplied, please omit this information from query by using it purely for the first address line. E.g. `query=123 Main St` + * * @example 123 Main St, Springfield, CO 81073 */ query: string; @@ -10176,7 +10319,7 @@ export interface operations { * * ## Suggestion Format * - * Each place suggestion contains a descriptive name which you can provide to users to uniquely idenfity a place. + * Each place suggestion contains a descriptive name which you can provide to users to uniquely identify a place. * * ## Rate Limiting and Cost *