diff --git a/dist/openapi.json b/dist/openapi.json index cb120eb..550ba08 100644 --- a/dist/openapi.json +++ b/dist/openapi.json @@ -3780,7 +3780,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\n - `bev` (AUT) Austria Dataset", + "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\n - `kds` (DNK) KDS Dataset", "enum": [ "paf", "pafw", @@ -3811,7 +3811,8 @@ "fodbosa", "mois", "upujp", - "bev" + "bev", + "kds" ] }, "CountryISO": { @@ -9914,6 +9915,511 @@ } } }, + "KdsAddress": { + "required": [ + "id", + "dataset", + "country", + "country_iso", + "country_iso_2", + "language", + "address", + "line_1", + "line_2", + "latitude", + "longitude", + "forretningshændelse", + "forretningsområde", + "forretningsproces", + "id_namespace", + "id_lokalId", + "registreringFra", + "registreringsaktør", + "registreringTil", + "status", + "virkningFra", + "virkningsaktør", + "virkningTil", + "adresse_adressebetegnelse", + "adresse_dørbetegnelse", + "adresse_etagebetegnelse", + "adressepunkt_oprindelse_kilde", + "adressepunkt_oprindelse_nøjagtighedsklasse", + "adressepunkt_oprindelse_registrering", + "adressepunkt_oprindelse_tekniskStandard", + "adressepunkt_position_x", + "adressepunkt_position_y", + "husnummer_adgangsadressebetegnelse", + "husnummer_vejmidte", + "husnummer_husnummertekst", + "afstemningsomraadenummer", + "afstemningsområde_navn", + "afstemningsstedNavn", + "kommuneinddeling_kommunekode", + "kommuneinddeling_navn", + "LAU1vaerdi", + "kommuneinddeling_udenforKommuneinddeling", + "MRafstemningsomraadenummer", + "menighedsradsafstemningsomrade_navn", + "LAU2vaerdi", + "sogneinddeling_sognekode", + "sogneinddeling_navn", + "supplerendebynavn_navn", + "navngivenvej_beskrivelse", + "navngivenvej_udtaltVejnavn", + "navngivenvej_vejadresseringsnavn", + "navngivenvej_vejnavn", + "navngivenvej_vejnavnebeliggenhed_oprindelse_kilde", + "navngivenvej_vejnavnebeliggenhed_oprindelse_nøjagtighedsklasse", + "navngivenvej_vejnavnebeliggenhed_oprindelse_registrering", + "navngivenvej_vejnavnebeliggenhed_oprindelse_tekniskStandard", + "navngivenvejkommunedel_vejkode", + "postnummer_navn", + "postnummer_postnr", + "opstillingskredsnummer", + "opstillingskreds_navn", + "valgkredsnummer", + "storkredsnummer", + "storkreds_navn", + "valglandsdelsbogstav", + "valglandsdels_navn", + "postnummerinddeling_ergadepostnummer", + "nuts2vaerdi", + "regionsinddeling_regionskode", + "regionsinddeling_navn", + "politikreds_myndighedskode", + "politikredsnummer", + "politikreds_navn", + "retskreds_myndighedskode", + "retskredsnummer", + "retskreds_navn", + "nuts3vaerdi", + "landsdel_navn" + ], + "properties": { + "id": { + "$ref": "#/components/schemas/ID" + }, + "dataset": { + "type": "string", + "enum": [ + "kds" + ] + }, + "country_iso": { + "description": " 3 letter country code (ISO 3166-1)\n", + "enum": [ + "DNK" + ] + }, + "country_iso_2": { + "type": "string", + "description": " 2 letter country code (ISO 3166-1)\n", + "enum": [ + "DK" + ] + }, + "country": { + "type": "string", + "description": " Full country names (ISO 3166)\n", + "enum": [ + "Denmark" + ] + }, + "language": { + "enum": [ + "da" + ], + "description": "Language represented by 2 letter ISO Code (639-1)\n" + }, + "address": { + "type": "string", + "description": "Address / House Number uniquely identifying the address along the specified street.\n\nCan be empty string `\"\"` if not present.\n", + "example": "95" + }, + "line_1": { + "type": "string", + "description": "First address line.\n\nMay include street name, house number, floor number and door number.\n", + "example": "Vænget 19" + }, + "line_2": { + "type": "string", + "description": "Second address line.\n\nMay include supplementary city name. Can be empty string `\"\"` if not present.\n", + "example": "Benløse" + }, + "longitude": { + "$ref": "#/components/schemas/Longitude" + }, + "latitude": { + "$ref": "#/components/schemas/Latitude" + }, + "forretningshændelse": { + "type": "string", + "description": "Business event type that triggered the record.\n", + "example": "2" + }, + "forretningsområde": { + "type": "string", + "description": "Business domain or subject area the record belongs to.\n", + "example": "54.15.10.08" + }, + "forretningsproces": { + "type": "string", + "description": "Business process that produced or last modified the record.\n", + "example": "0" + }, + "id_namespace": { + "type": "string", + "description": "Namespace URI that qualifies the local identifier.\n", + "example": "http://data.gov.dk/dar/adresse" + }, + "id_lokalId": { + "type": "string", + "description": "Local unique identifier for the address object within its namespace.\n", + "example": "0000090e-e9f3-4ffe-a0a5-2852666d158c" + }, + "registreringFra": { + "type": "string", + "description": "Start of the registration period (when the record became valid in the register).\n", + "example": "2021-06-21T07:54:04.191Z" + }, + "registreringsaktør": { + "type": "string", + "description": "Actor (authority or system) responsible for the registration of the address record.\n", + "example": "DAR" + }, + "registreringTil": { + "type": "string", + "description": "End of the registration period.\n\nCan be empty string `\"\"` if the address is still active.\n" + }, + "status": { + "type": "string", + "description": "Current lifecycle status of the object.\n", + "example": "4" + }, + "virkningFra": { + "type": "string", + "description": "Start of the real-world validity period (when the address record takes effect in reality).\n", + "example": "2021-06-21T07:54:04.191Z" + }, + "virkningsaktør": { + "type": "string", + "description": "Actor (authority or system) responsible for the real-world change that prompted the record.\n", + "example": "AjourføreDarSystem" + }, + "virkningTil": { + "type": "string", + "description": "End of the real-world validity period.\n\nCan be empty string `\"\"` if the address is still valid.\n", + "example": "2026-02-14T00:00:00.000Z" + }, + "adresse_adressebetegnelse": { + "type": "string", + "description": "Full formatted address.\n\nCommonly consisting of street name, house number, floor, door, supplementary city name, postal code and postal city name.\n", + "example": "Æghøjvej 2, Vandet, 8620 Kjellerup" + }, + "adresse_dørbetegnelse": { + "type": "string", + "description": "Door/unit designation within a building.\n\nCan be empty string `\"\"` if not present.\n", + "example": "tv" + }, + "adresse_etagebetegnelse": { + "type": "string", + "description": "Floor designation within a building.\n\nCan be empty string `\"\"` if not present.\n", + "example": "st" + }, + "adressepunkt_oprindelse_kilde": { + "type": "string", + "description": "Source of the address point geometry.\n\nCan be empty string `\"\"` if not present.\n", + "example": "Ekstern" + }, + "adressepunkt_oprindelse_nøjagtighedsklasse": { + "type": "string", + "description": "Accuracy class of the address point position.\n\nCan be empty string `\"\"` if not present.\n", + "example": "A" + }, + "adressepunkt_oprindelse_registrering": { + "type": "string", + "description": "Date the address point geometry was registered in its source system.\n\nCan be empty string `\"\"` if not present.\n", + "example": "2004-08-16T22:00:00.000Z" + }, + "adressepunkt_oprindelse_tekniskStandard": { + "type": "string", + "description": "Technical standard used to establish the address point position.\n\nCan be empty string `\"\"` if not present.\n", + "example": "TN" + }, + "adressepunkt_position_x": { + "oneOf": [ + { + "type": "string", + "description": "Can be empty string `\"\"` if not present." + }, + { + "type": "number", + "description": "X coordinate of the geometric position of the address point using EPSG 25832.\n", + "example": 691256.48 + } + ] + }, + "adressepunkt_position_y": { + "oneOf": [ + { + "type": "string", + "description": "Can be empty string `\"\"` if not present." + }, + { + "type": "number", + "description": "Y coordinate of the geometric position of the address point using EPSG 25832.\n", + "example": 6191928.04 + } + ] + }, + "husnummer_adgangsadressebetegnelse": { + "type": "string", + "description": "Full formatted access address.\n\nCommonly consisting of street name, house number, floor, door, supplementary city name, postal code and postal city name.\n\nCan be empty string `\"\"` if not present.\n", + "example": "Sydkajen 16, 3600 Frederikssund" + }, + "husnummer_vejmidte": { + "type": "string", + "description": "Composite identifier formed by combining the municipality code and the road code, separated by a hyphen.\n\nCan be empty string `\"\"` if not present.\n", + "example": "0250-1248" + }, + "husnummer_husnummertekst": { + "type": "string", + "description": "House number text as it appears on the address.\n\nCan be empty string `\"\"` if not present.\n", + "example": "16" + }, + "afstemningsomraadenummer": { + "type": "string", + "description": "Polling district number\n\nCan be empty string `\"\"` if not present.\n", + "example": "01" + }, + "afstemningsområde_navn": { + "type": "string", + "description": "Name of the polling district\n\nCan be empty string `\"\"` if not present.\n", + "example": "Frederikssund Midt" + }, + "afstemningsstedNavn": { + "type": "string", + "description": "Name of the polling station\n\nCan be empty string `\"\"` if not present.\n", + "example": "Frederikssundhallen" + }, + "kommuneinddeling_kommunekode": { + "type": "string", + "description": "Four-digit municipality code\n\nCan be empty string `\"\"` if not present.\n", + "example": "0250" + }, + "kommuneinddeling_navn": { + "type": "string", + "description": "Name of the municipality\n\nCan be empty string `\"\"` if not present.\n", + "example": "Frederikssund" + }, + "LAU1vaerdi": { + "type": "string", + "description": "LAU level 1 value (EU Local Administrative Unit classification)\n\nCan be empty string `\"\"` if not present.\n", + "example": "250" + }, + "kommuneinddeling_udenforKommuneinddeling": { + "oneOf": [ + { + "type": "string", + "description": "Can be empty string `\"\"` if not present.\n" + }, + { + "type": "boolean", + "description": "Flag indicating the location falls outside a standard municipality division.\n", + "example": false + } + ] + }, + "MRafstemningsomraadenummer": { + "type": "string", + "description": "Parish council polling district number\n\nCan be empty string `\"\"` if not present.\n", + "example": "1" + }, + "menighedsradsafstemningsomrade_navn": { + "type": "string", + "description": "Name of the parish council polling district\n\nCan be empty string `\"\"` if not present.\n", + "example": "Gørslev" + }, + "LAU2vaerdi": { + "type": "string", + "description": "LAU level 2 value (EU Local Administrative Unit classification)\n\nCan be empty string `\"\"` if not present.\n", + "example": "7418" + }, + "sogneinddeling_sognekode": { + "type": "string", + "description": "Parish code\n\nCan be empty string `\"\"` if not present.\n", + "example": "7418" + }, + "sogneinddeling_navn": { + "type": "string", + "description": "Name of the parish\n\nCan be empty string `\"\"` if not present.\n", + "example": "Frederikssund" + }, + "supplerendebynavn_navn": { + "type": "string", + "description": "Supplementary locality or village name used alongside the postal address.\n\nCan be empty string `\"\"` if not present.\n", + "example": "Blæsbjerg" + }, + "navngivenvej_beskrivelse": { + "type": "string", + "description": "Brief description of the origin or meaning of the road name.\n\nCan be empty string `\"\"` if not present.\n" + }, + "navngivenvej_udtaltVejnavn": { + "type": "string", + "description": "Phonetic/spoken form of the road name.\n\nCan be empty string `\"\"` if not present.\n", + "example": "Ærteholmsvej" + }, + "navngivenvej_vejadresseringsnavn": { + "type": "string", + "description": "Abbreviated road name containing no more than 20 characters.\n\nCan be empty string `\"\"` if not present.\n", + "example": "Sydkajen" + }, + "navngivenvej_vejnavn": { + "type": "string", + "description": "Official full road name\n\nCan be empty string `\"\"` if not present.\n", + "example": "Blåbærheden" + }, + "navngivenvej_vejnavnebeliggenhed_oprindelse_kilde": { + "type": "string", + "description": "Source of the road name location geometry.\n\nCan be empty string `\"\"` if not present.\n", + "example": "Ekstern" + }, + "navngivenvej_vejnavnebeliggenhed_oprindelse_nøjagtighedsklasse": { + "type": "string", + "description": "Accuracy class of the road name location geometry.\n\nCan be empty string `\"\"` if not present.\n", + "example": "B" + }, + "navngivenvej_vejnavnebeliggenhed_oprindelse_registrering": { + "type": "string", + "description": "Registration date of the road name location geometry.\n\nCan be empty string `\"\"` if not present.\n", + "example": "2018-05-03T15:57:30.356Z" + }, + "navngivenvej_vejnavnebeliggenhed_oprindelse_tekniskStandard": { + "type": "string", + "description": "Technical standard used for the road name location geometry.\n\nCan be empty string `\"\"` if not present.\n", + "example": "NO" + }, + "navngivenvejkommunedel_vejkode": { + "type": "string", + "description": "Road code identifying the road segment within a municipality.\n\nCan be empty string `\"\"` if not present.\n", + "example": "1248" + }, + "postnummer_navn": { + "type": "string", + "description": "Postal district name\n\nCan be empty string `\"\"` if not present.\n", + "example": "Fjenneslev" + }, + "postnummer_postnr": { + "type": "string", + "description": "Postal code\n\nCan be empty string `\"\"` if not present.\n", + "example": "4173" + }, + "opstillingskredsnummer": { + "type": "string", + "description": "Nomination constituency number\n\nCan be empty string `\"\"` if not present.\n", + "example": "83" + }, + "opstillingskreds_navn": { + "type": "string", + "description": "Name of the nomination constituency\n\nCan be empty string `\"\"` if not present.\n", + "example": "Ringkøbing" + }, + "valgkredsnummer": { + "type": "string", + "description": "Electoral constituency number\n\nCan be empty string `\"\"` if not present.\n", + "example": "4" + }, + "storkredsnummer": { + "type": "string", + "description": "Multi-member constituency number\n\nCan be empty string `\"\"` if not present.\n", + "example": "3" + }, + "storkreds_navn": { + "type": "string", + "description": "Name of the multi-member constituency\n\nCan be empty string `\"\"` if not present.\n", + "example": "Nordsjælland" + }, + "valglandsdelsbogstav": { + "type": "string", + "description": "Letter identifying the electoral region\n\nCan be empty string `\"\"` if not present.\n", + "example": "A" + }, + "valglandsdels_navn": { + "type": "string", + "description": "Name of the electoral region\n\nCan be empty string `\"\"` if not present.\n", + "example": "Hovedstaden" + }, + "postnummerinddeling_ergadepostnummer": { + "oneOf": [ + { + "type": "string", + "description": "Can be empty string `\"\"` if not present.\n" + }, + { + "type": "boolean", + "description": "Flag indicating whether the postal code is a street-level code.\n", + "example": false + } + ] + }, + "nuts2vaerdi": { + "type": "string", + "description": "NUTS level 2 code (EU regional classification)\n\nCan be empty string `\"\"` if not present.\n", + "example": "DK01" + }, + "regionsinddeling_regionskode": { + "type": "string", + "description": "Region code\n\nCan be empty string `\"\"` if not present.\n", + "example": "1084" + }, + "regionsinddeling_navn": { + "type": "string", + "description": "Name of the region\n\nCan be empty string `\"\"` if not present.\n", + "example": "Region Hovedstaden" + }, + "politikreds_myndighedskode": { + "type": "string", + "description": "Police district code\n\nCan be empty string `\"\"` if not present.\n", + "example": "1468" + }, + "politikredsnummer": { + "type": "string", + "description": "Police district number\n\nCan be empty string `\"\"` if not present.\n", + "example": "9" + }, + "politikreds_navn": { + "type": "string", + "description": "Name of the police district\n\nCan be empty string `\"\"` if not present.\n", + "example": "Nordsjællands Politi" + }, + "retskreds_myndighedskode": { + "type": "string", + "description": "Judicial district code\n\nCan be empty string `\"\"` if not present.\n", + "example": "1115" + }, + "retskredsnummer": { + "type": "string", + "description": "Judicial district number\n\nCan be empty string `\"\"` if not present.\n", + "example": "18" + }, + "retskreds_navn": { + "type": "string", + "description": "Name of the judicial district\n\nCan be empty string `\"\"` if not present.\n", + "example": "Retten i Hillerød" + }, + "nuts3vaerdi": { + "type": "string", + "description": "NUTS level 3 code (EU sub-regional classification)\n\nCan be empty string `\"\"` if not present.\n", + "example": "DK013" + }, + "landsdel_navn": { + "type": "string", + "description": "Name of the statistical subdivision\n\nCan be empty string `\"\"` if not present.\n", + "example": "Nordsjælland" + } + } + }, "GbrGlobalAddress": { "title": "Global Address", "description": "Global (non-UK) address in the UK address format", @@ -10066,6 +10572,9 @@ }, { "$ref": "#/components/schemas/BevAddress" + }, + { + "$ref": "#/components/schemas/KdsAddress" } ] }, @@ -10756,6 +11265,32 @@ } } }, + "ApiKeyMonthlyLimit": { + "title": "API Key Monthly Limit", + "type": "object", + "required": [ + "limit", + "consumed" + ], + "properties": { + "limit": { + "x-nullable": true, + "nullable": true, + "minimum": 0, + "example": 10000, + "type": "integer", + "description": "`number` or `null`. The monthly lookup limit currently set on your key.\n`null` means the limit is currently disabled.", + "format": "int32" + }, + "consumed": { + "minimum": 0, + "example": 2500, + "type": "integer", + "description": "Number of lookups performed this month which count towards your monthly limit.", + "format": "int32" + } + } + }, "ApiKeyIndividualLimit": { "title": "API Key Individual Limit", "type": "object", @@ -10833,7 +11368,8 @@ "fodbosa", "mois", "upujp", - "bev" + "bev", + "kds" ], "properties": { "paf": { @@ -10999,6 +11535,11 @@ "type": "boolean", "description": "Austria: BEV Address File", "example": true + }, + "kds": { + "type": "boolean", + "description": "Denmark: KDS Address File", + "example": true } } }, @@ -11055,6 +11596,7 @@ "required": [ "lookups_remaining", "daily_limit", + "monthly_limit", "individual_limit", "allowed_urls", "redact_days", @@ -11074,6 +11616,9 @@ "daily_limit": { "$ref": "#/components/schemas/ApiKeyDailyLimit" }, + "monthly_limit": { + "$ref": "#/components/schemas/ApiKeyMonthlyLimit" + }, "individual_limit": { "$ref": "#/components/schemas/ApiKeyIndividualLimit" }, @@ -11158,6 +11703,21 @@ } } }, + "monthly_limit": { + "title": "Monthly Rate Limit", + "type": "object", + "properties": { + "limit": { + "x-nullable": true, + "nullable": true, + "minimum": 0, + "example": 10000, + "type": "integer", + "description": "`number` or `null`. The monthly lookup limit currently set on your key.\n`null` means the limit is currently disabled.", + "format": "int32" + } + } + }, "individual_limit": { "title": "API Key Individual Limit", "type": "object", @@ -11347,6 +11907,11 @@ "type": "boolean", "description": "Austria: BEV Address File", "example": true + }, + "kds": { + "type": "boolean", + "description": "Denmark: KDS Address File", + "example": true } } } @@ -12910,6 +13475,9 @@ }, { "$ref": "#/components/schemas/BevAddress" + }, + { + "$ref": "#/components/schemas/KdsAddress" } ] } diff --git a/dist/openapi.yaml b/dist/openapi.yaml index 83d8583..a7f2e71 100644 --- a/dist/openapi.yaml +++ b/dist/openapi.yaml @@ -3141,6 +3141,7 @@ components: - `mois` (KOR) South Korea Dataset - `upujp` (JPN) Japan UPU Address File - `bev` (AUT) Austria Dataset + - `kds` (DNK) KDS Dataset enum: - paf - pafw @@ -3172,6 +3173,7 @@ components: - mois - upujp - bev + - kds CountryISO: title: ISO Country Code (3) type: string @@ -9562,6 +9564,595 @@ components: type: string description: | Name of the census district + KdsAddress: + required: + - id + - dataset + - country + - country_iso + - country_iso_2 + - language + - address + - line_1 + - line_2 + - latitude + - longitude + - forretningshændelse + - forretningsområde + - forretningsproces + - id_namespace + - id_lokalId + - registreringFra + - registreringsaktør + - registreringTil + - status + - virkningFra + - virkningsaktør + - virkningTil + - adresse_adressebetegnelse + - adresse_dørbetegnelse + - adresse_etagebetegnelse + - adressepunkt_oprindelse_kilde + - adressepunkt_oprindelse_nøjagtighedsklasse + - adressepunkt_oprindelse_registrering + - adressepunkt_oprindelse_tekniskStandard + - adressepunkt_position_x + - adressepunkt_position_y + - husnummer_adgangsadressebetegnelse + - husnummer_vejmidte + - husnummer_husnummertekst + - afstemningsomraadenummer + - afstemningsområde_navn + - afstemningsstedNavn + - kommuneinddeling_kommunekode + - kommuneinddeling_navn + - LAU1vaerdi + - kommuneinddeling_udenforKommuneinddeling + - MRafstemningsomraadenummer + - menighedsradsafstemningsomrade_navn + - LAU2vaerdi + - sogneinddeling_sognekode + - sogneinddeling_navn + - supplerendebynavn_navn + - navngivenvej_beskrivelse + - navngivenvej_udtaltVejnavn + - navngivenvej_vejadresseringsnavn + - navngivenvej_vejnavn + - navngivenvej_vejnavnebeliggenhed_oprindelse_kilde + - navngivenvej_vejnavnebeliggenhed_oprindelse_nøjagtighedsklasse + - navngivenvej_vejnavnebeliggenhed_oprindelse_registrering + - navngivenvej_vejnavnebeliggenhed_oprindelse_tekniskStandard + - navngivenvejkommunedel_vejkode + - postnummer_navn + - postnummer_postnr + - opstillingskredsnummer + - opstillingskreds_navn + - valgkredsnummer + - storkredsnummer + - storkreds_navn + - valglandsdelsbogstav + - valglandsdels_navn + - postnummerinddeling_ergadepostnummer + - nuts2vaerdi + - regionsinddeling_regionskode + - regionsinddeling_navn + - politikreds_myndighedskode + - politikredsnummer + - politikreds_navn + - retskreds_myndighedskode + - retskredsnummer + - retskreds_navn + - nuts3vaerdi + - landsdel_navn + properties: + id: + $ref: '#/components/schemas/ID' + dataset: + type: string + enum: + - kds + country_iso: + description: |2 + 3 letter country code (ISO 3166-1) + enum: + - DNK + country_iso_2: + type: string + description: |2 + 2 letter country code (ISO 3166-1) + enum: + - DK + country: + type: string + description: |2 + Full country names (ISO 3166) + enum: + - Denmark + language: + enum: + - da + description: | + Language represented by 2 letter ISO Code (639-1) + address: + type: string + description: | + Address / House Number uniquely identifying the address along the specified street. + + Can be empty string `""` if not present. + example: '95' + line_1: + type: string + description: | + First address line. + + May include street name, house number, floor number and door number. + example: Vænget 19 + line_2: + type: string + description: | + Second address line. + + May include supplementary city name. Can be empty string `""` if not present. + example: Benløse + longitude: + $ref: '#/components/schemas/Longitude' + latitude: + $ref: '#/components/schemas/Latitude' + forretningshændelse: + type: string + description: | + Business event type that triggered the record. + example: '2' + forretningsområde: + type: string + description: | + Business domain or subject area the record belongs to. + example: 54.15.10.08 + forretningsproces: + type: string + description: | + Business process that produced or last modified the record. + example: '0' + id_namespace: + type: string + description: | + Namespace URI that qualifies the local identifier. + example: http://data.gov.dk/dar/adresse + id_lokalId: + type: string + description: | + Local unique identifier for the address object within its namespace. + example: 0000090e-e9f3-4ffe-a0a5-2852666d158c + registreringFra: + type: string + description: | + Start of the registration period (when the record became valid in the register). + example: '2021-06-21T07:54:04.191Z' + registreringsaktør: + type: string + description: | + Actor (authority or system) responsible for the registration of the address record. + example: DAR + registreringTil: + type: string + description: | + End of the registration period. + + Can be empty string `""` if the address is still active. + status: + type: string + description: | + Current lifecycle status of the object. + example: '4' + virkningFra: + type: string + description: | + Start of the real-world validity period (when the address record takes effect in reality). + example: '2021-06-21T07:54:04.191Z' + virkningsaktør: + type: string + description: | + Actor (authority or system) responsible for the real-world change that prompted the record. + example: AjourføreDarSystem + virkningTil: + type: string + description: | + End of the real-world validity period. + + Can be empty string `""` if the address is still valid. + example: '2026-02-14T00:00:00.000Z' + adresse_adressebetegnelse: + type: string + description: | + Full formatted address. + + Commonly consisting of street name, house number, floor, door, supplementary city name, postal code and postal city name. + example: Æghøjvej 2, Vandet, 8620 Kjellerup + adresse_dørbetegnelse: + type: string + description: | + Door/unit designation within a building. + + Can be empty string `""` if not present. + example: tv + adresse_etagebetegnelse: + type: string + description: | + Floor designation within a building. + + Can be empty string `""` if not present. + example: st + adressepunkt_oprindelse_kilde: + type: string + description: | + Source of the address point geometry. + + Can be empty string `""` if not present. + example: Ekstern + adressepunkt_oprindelse_nøjagtighedsklasse: + type: string + description: | + Accuracy class of the address point position. + + Can be empty string `""` if not present. + example: A + adressepunkt_oprindelse_registrering: + type: string + description: | + Date the address point geometry was registered in its source system. + + Can be empty string `""` if not present. + example: '2004-08-16T22:00:00.000Z' + adressepunkt_oprindelse_tekniskStandard: + type: string + description: | + Technical standard used to establish the address point position. + + Can be empty string `""` if not present. + example: TN + adressepunkt_position_x: + oneOf: + - type: string + description: Can be empty string `""` if not present. + - type: number + description: | + X coordinate of the geometric position of the address point using EPSG 25832. + example: 691256.48 + adressepunkt_position_y: + oneOf: + - type: string + description: Can be empty string `""` if not present. + - type: number + description: | + Y coordinate of the geometric position of the address point using EPSG 25832. + example: 6191928.04 + husnummer_adgangsadressebetegnelse: + type: string + description: | + Full formatted access address. + + Commonly consisting of street name, house number, floor, door, supplementary city name, postal code and postal city name. + + Can be empty string `""` if not present. + example: Sydkajen 16, 3600 Frederikssund + husnummer_vejmidte: + type: string + description: | + Composite identifier formed by combining the municipality code and the road code, separated by a hyphen. + + Can be empty string `""` if not present. + example: 0250-1248 + husnummer_husnummertekst: + type: string + description: | + House number text as it appears on the address. + + Can be empty string `""` if not present. + example: '16' + afstemningsomraadenummer: + type: string + description: | + Polling district number + + Can be empty string `""` if not present. + example: '01' + afstemningsområde_navn: + type: string + description: | + Name of the polling district + + Can be empty string `""` if not present. + example: Frederikssund Midt + afstemningsstedNavn: + type: string + description: | + Name of the polling station + + Can be empty string `""` if not present. + example: Frederikssundhallen + kommuneinddeling_kommunekode: + type: string + description: | + Four-digit municipality code + + Can be empty string `""` if not present. + example: '0250' + kommuneinddeling_navn: + type: string + description: | + Name of the municipality + + Can be empty string `""` if not present. + example: Frederikssund + LAU1vaerdi: + type: string + description: | + LAU level 1 value (EU Local Administrative Unit classification) + + Can be empty string `""` if not present. + example: '250' + kommuneinddeling_udenforKommuneinddeling: + oneOf: + - type: string + description: | + Can be empty string `""` if not present. + - type: boolean + description: | + Flag indicating the location falls outside a standard municipality division. + example: false + MRafstemningsomraadenummer: + type: string + description: | + Parish council polling district number + + Can be empty string `""` if not present. + example: '1' + menighedsradsafstemningsomrade_navn: + type: string + description: | + Name of the parish council polling district + + Can be empty string `""` if not present. + example: Gørslev + LAU2vaerdi: + type: string + description: | + LAU level 2 value (EU Local Administrative Unit classification) + + Can be empty string `""` if not present. + example: '7418' + sogneinddeling_sognekode: + type: string + description: | + Parish code + + Can be empty string `""` if not present. + example: '7418' + sogneinddeling_navn: + type: string + description: | + Name of the parish + + Can be empty string `""` if not present. + example: Frederikssund + supplerendebynavn_navn: + type: string + description: | + Supplementary locality or village name used alongside the postal address. + + Can be empty string `""` if not present. + example: Blæsbjerg + navngivenvej_beskrivelse: + type: string + description: | + Brief description of the origin or meaning of the road name. + + Can be empty string `""` if not present. + navngivenvej_udtaltVejnavn: + type: string + description: | + Phonetic/spoken form of the road name. + + Can be empty string `""` if not present. + example: Ærteholmsvej + navngivenvej_vejadresseringsnavn: + type: string + description: | + Abbreviated road name containing no more than 20 characters. + + Can be empty string `""` if not present. + example: Sydkajen + navngivenvej_vejnavn: + type: string + description: | + Official full road name + + Can be empty string `""` if not present. + example: Blåbærheden + navngivenvej_vejnavnebeliggenhed_oprindelse_kilde: + type: string + description: | + Source of the road name location geometry. + + Can be empty string `""` if not present. + example: Ekstern + navngivenvej_vejnavnebeliggenhed_oprindelse_nøjagtighedsklasse: + type: string + description: | + Accuracy class of the road name location geometry. + + Can be empty string `""` if not present. + example: B + navngivenvej_vejnavnebeliggenhed_oprindelse_registrering: + type: string + description: | + Registration date of the road name location geometry. + + Can be empty string `""` if not present. + example: '2018-05-03T15:57:30.356Z' + navngivenvej_vejnavnebeliggenhed_oprindelse_tekniskStandard: + type: string + description: | + Technical standard used for the road name location geometry. + + Can be empty string `""` if not present. + example: 'NO' + navngivenvejkommunedel_vejkode: + type: string + description: | + Road code identifying the road segment within a municipality. + + Can be empty string `""` if not present. + example: '1248' + postnummer_navn: + type: string + description: | + Postal district name + + Can be empty string `""` if not present. + example: Fjenneslev + postnummer_postnr: + type: string + description: | + Postal code + + Can be empty string `""` if not present. + example: '4173' + opstillingskredsnummer: + type: string + description: | + Nomination constituency number + + Can be empty string `""` if not present. + example: '83' + opstillingskreds_navn: + type: string + description: | + Name of the nomination constituency + + Can be empty string `""` if not present. + example: Ringkøbing + valgkredsnummer: + type: string + description: | + Electoral constituency number + + Can be empty string `""` if not present. + example: '4' + storkredsnummer: + type: string + description: | + Multi-member constituency number + + Can be empty string `""` if not present. + example: '3' + storkreds_navn: + type: string + description: | + Name of the multi-member constituency + + Can be empty string `""` if not present. + example: Nordsjælland + valglandsdelsbogstav: + type: string + description: | + Letter identifying the electoral region + + Can be empty string `""` if not present. + example: A + valglandsdels_navn: + type: string + description: | + Name of the electoral region + + Can be empty string `""` if not present. + example: Hovedstaden + postnummerinddeling_ergadepostnummer: + oneOf: + - type: string + description: | + Can be empty string `""` if not present. + - type: boolean + description: | + Flag indicating whether the postal code is a street-level code. + example: false + nuts2vaerdi: + type: string + description: | + NUTS level 2 code (EU regional classification) + + Can be empty string `""` if not present. + example: DK01 + regionsinddeling_regionskode: + type: string + description: | + Region code + + Can be empty string `""` if not present. + example: '1084' + regionsinddeling_navn: + type: string + description: | + Name of the region + + Can be empty string `""` if not present. + example: Region Hovedstaden + politikreds_myndighedskode: + type: string + description: | + Police district code + + Can be empty string `""` if not present. + example: '1468' + politikredsnummer: + type: string + description: | + Police district number + + Can be empty string `""` if not present. + example: '9' + politikreds_navn: + type: string + description: | + Name of the police district + + Can be empty string `""` if not present. + example: Nordsjællands Politi + retskreds_myndighedskode: + type: string + description: | + Judicial district code + + Can be empty string `""` if not present. + example: '1115' + retskredsnummer: + type: string + description: | + Judicial district number + + Can be empty string `""` if not present. + example: '18' + retskreds_navn: + type: string + description: | + Name of the judicial district + + Can be empty string `""` if not present. + example: Retten i Hillerød + nuts3vaerdi: + type: string + description: | + NUTS level 3 code (EU sub-regional classification) + + Can be empty string `""` if not present. + example: DK013 + landsdel_navn: + type: string + description: | + Name of the statistical subdivision + + Can be empty string `""` if not present. + example: Nordsjælland GbrGlobalAddress: title: Global Address description: Global (non-UK) address in the UK address format @@ -9674,6 +10265,7 @@ components: - $ref: '#/components/schemas/MoisAddress' - $ref: '#/components/schemas/UpujpAddress' - $ref: '#/components/schemas/BevAddress' + - $ref: '#/components/schemas/KdsAddress' postcode_outward: type: string description: Not available for non-UK addresses @@ -10208,6 +10800,29 @@ components: type: integer description: Number of lookups performed today which count towards your daily limit. format: int32 + ApiKeyMonthlyLimit: + title: API Key Monthly Limit + type: object + required: + - limit + - consumed + properties: + limit: + x-nullable: true + nullable: true + minimum: 0 + example: 10000 + type: integer + description: |- + `number` or `null`. The monthly lookup limit currently set on your key. + `null` means the limit is currently disabled. + format: int32 + consumed: + minimum: 0 + example: 2500 + type: integer + description: Number of lookups performed this month which count towards your monthly limit. + format: int32 ApiKeyIndividualLimit: title: API Key Individual Limit type: object @@ -10279,6 +10894,7 @@ components: - mois - upujp - bev + - kds properties: paf: type: boolean @@ -10411,6 +11027,10 @@ components: type: boolean description: 'Austria: BEV Address File' example: true + kds: + type: boolean + description: 'Denmark: KDS Address File' + example: true ApiKeyAutomatedTopup: title: API Key Automated Topup description: Automated topup status @@ -10458,6 +11078,7 @@ components: required: - lookups_remaining - daily_limit + - monthly_limit - individual_limit - allowed_urls - redact_days @@ -10474,6 +11095,8 @@ components: format: int32 daily_limit: $ref: '#/components/schemas/ApiKeyDailyLimit' + monthly_limit: + $ref: '#/components/schemas/ApiKeyMonthlyLimit' individual_limit: $ref: '#/components/schemas/ApiKeyIndividualLimit' allowed_urls: @@ -10537,6 +11160,20 @@ components: `number` or `null`. The daily lookup limit currently set on your key. `null` means the limit is currently disabled. format: int32 + monthly_limit: + title: Monthly Rate Limit + type: object + properties: + limit: + x-nullable: true + nullable: true + minimum: 0 + example: 10000 + type: integer + description: |- + `number` or `null`. The monthly lookup limit currently set on your key. + `null` means the limit is currently disabled. + format: int32 individual_limit: title: API Key Individual Limit type: object @@ -10692,6 +11329,10 @@ components: type: boolean description: 'Austria: BEV Address File' example: true + kds: + type: boolean + description: 'Denmark: KDS Address File' + example: true KeyUsageResult: title: Key Usage type: object @@ -11942,6 +12583,7 @@ components: - $ref: '#/components/schemas/MoisAddress' - $ref: '#/components/schemas/UpujpAddress' - $ref: '#/components/schemas/BevAddress' + - $ref: '#/components/schemas/KdsAddress' UsaResolveAddressResponse: title: Address Retrieve Response (USA) type: object diff --git a/openapi.ts b/openapi.ts index c01fb0d..af82f73 100644 --- a/openapi.ts +++ b/openapi.ts @@ -1135,6 +1135,7 @@ export interface components { * - `mois` (KOR) South Korea Dataset * - `upujp` (JPN) Japan UPU Address File * - `bev` (AUT) Austria Dataset + * - `kds` (DNK) KDS Dataset * @enum {string} */ Dataset: @@ -1167,7 +1168,8 @@ export interface components { | "fodbosa" | "mois" | "upujp" - | "bev"; + | "bev" + | "kds"; /** * ISO Country Code (3) * @description 3 letter country code (ISO 3166-1) @@ -5877,6 +5879,547 @@ export interface components { /** @description Name of the census district */ zaehlsprengelname: string; }; + KdsAddress: { + id: components["schemas"]["ID"]; + /** @enum {string} */ + dataset: "kds"; + /** + * @description 3 letter country code (ISO 3166-1) + * + * @enum {undefined} + */ + country_iso: "DNK"; + /** + * @description 2 letter country code (ISO 3166-1) + * + * @enum {string} + */ + country_iso_2: "DK"; + /** + * @description Full country names (ISO 3166) + * + * @enum {string} + */ + country: "Denmark"; + /** + * @description Language represented by 2 letter ISO Code (639-1) + * + * @enum {undefined} + */ + language: "da"; + /** + * @description Address / House Number uniquely identifying the address along the specified street. + * + * Can be empty string `""` if not present. + * + * @example 95 + */ + address: string; + /** + * @description First address line. + * + * May include street name, house number, floor number and door number. + * + * @example Vænget 19 + */ + line_1: string; + /** + * @description Second address line. + * + * May include supplementary city name. Can be empty string `""` if not present. + * + * @example Benløse + */ + line_2: string; + longitude: components["schemas"]["Longitude"]; + latitude: components["schemas"]["Latitude"]; + /** + * @description Business event type that triggered the record. + * + * @example 2 + */ + forretningshændelse: string; + /** + * @description Business domain or subject area the record belongs to. + * + * @example 54.15.10.08 + */ + forretningsområde: string; + /** + * @description Business process that produced or last modified the record. + * + * @example 0 + */ + forretningsproces: string; + /** + * @description Namespace URI that qualifies the local identifier. + * + * @example http://data.gov.dk/dar/adresse + */ + id_namespace: string; + /** + * @description Local unique identifier for the address object within its namespace. + * + * @example 0000090e-e9f3-4ffe-a0a5-2852666d158c + */ + id_lokalId: string; + /** + * @description Start of the registration period (when the record became valid in the register). + * + * @example 2021-06-21T07:54:04.191Z + */ + registreringFra: string; + /** + * @description Actor (authority or system) responsible for the registration of the address record. + * + * @example DAR + */ + registreringsaktør: string; + /** + * @description End of the registration period. + * + * Can be empty string `""` if the address is still active. + */ + registreringTil: string; + /** + * @description Current lifecycle status of the object. + * + * @example 4 + */ + status: string; + /** + * @description Start of the real-world validity period (when the address record takes effect in reality). + * + * @example 2021-06-21T07:54:04.191Z + */ + virkningFra: string; + /** + * @description Actor (authority or system) responsible for the real-world change that prompted the record. + * + * @example AjourføreDarSystem + */ + virkningsaktør: string; + /** + * @description End of the real-world validity period. + * + * Can be empty string `""` if the address is still valid. + * + * @example 2026-02-14T00:00:00.000Z + */ + virkningTil: string; + /** + * @description Full formatted address. + * + * Commonly consisting of street name, house number, floor, door, supplementary city name, postal code and postal city name. + * + * @example Æghøjvej 2, Vandet, 8620 Kjellerup + */ + adresse_adressebetegnelse: string; + /** + * @description Door/unit designation within a building. + * + * Can be empty string `""` if not present. + * + * @example tv + */ + adresse_dørbetegnelse: string; + /** + * @description Floor designation within a building. + * + * Can be empty string `""` if not present. + * + * @example st + */ + adresse_etagebetegnelse: string; + /** + * @description Source of the address point geometry. + * + * Can be empty string `""` if not present. + * + * @example Ekstern + */ + adressepunkt_oprindelse_kilde: string; + /** + * @description Accuracy class of the address point position. + * + * Can be empty string `""` if not present. + * + * @example A + */ + adressepunkt_oprindelse_nøjagtighedsklasse: string; + /** + * @description Date the address point geometry was registered in its source system. + * + * Can be empty string `""` if not present. + * + * @example 2004-08-16T22:00:00.000Z + */ + adressepunkt_oprindelse_registrering: string; + /** + * @description Technical standard used to establish the address point position. + * + * Can be empty string `""` if not present. + * + * @example TN + */ + adressepunkt_oprindelse_tekniskStandard: string; + adressepunkt_position_x: string | number; + adressepunkt_position_y: string | number; + /** + * @description Full formatted access address. + * + * Commonly consisting of street name, house number, floor, door, supplementary city name, postal code and postal city name. + * + * Can be empty string `""` if not present. + * + * @example Sydkajen 16, 3600 Frederikssund + */ + husnummer_adgangsadressebetegnelse: string; + /** + * @description Composite identifier formed by combining the municipality code and the road code, separated by a hyphen. + * + * Can be empty string `""` if not present. + * + * @example 0250-1248 + */ + husnummer_vejmidte: string; + /** + * @description House number text as it appears on the address. + * + * Can be empty string `""` if not present. + * + * @example 16 + */ + husnummer_husnummertekst: string; + /** + * @description Polling district number + * + * Can be empty string `""` if not present. + * + * @example 01 + */ + afstemningsomraadenummer: string; + /** + * @description Name of the polling district + * + * Can be empty string `""` if not present. + * + * @example Frederikssund Midt + */ + afstemningsområde_navn: string; + /** + * @description Name of the polling station + * + * Can be empty string `""` if not present. + * + * @example Frederikssundhallen + */ + afstemningsstedNavn: string; + /** + * @description Four-digit municipality code + * + * Can be empty string `""` if not present. + * + * @example 0250 + */ + kommuneinddeling_kommunekode: string; + /** + * @description Name of the municipality + * + * Can be empty string `""` if not present. + * + * @example Frederikssund + */ + kommuneinddeling_navn: string; + /** + * @description LAU level 1 value (EU Local Administrative Unit classification) + * + * Can be empty string `""` if not present. + * + * @example 250 + */ + LAU1vaerdi: string; + kommuneinddeling_udenforKommuneinddeling: string | boolean; + /** + * @description Parish council polling district number + * + * Can be empty string `""` if not present. + * + * @example 1 + */ + MRafstemningsomraadenummer: string; + /** + * @description Name of the parish council polling district + * + * Can be empty string `""` if not present. + * + * @example Gørslev + */ + menighedsradsafstemningsomrade_navn: string; + /** + * @description LAU level 2 value (EU Local Administrative Unit classification) + * + * Can be empty string `""` if not present. + * + * @example 7418 + */ + LAU2vaerdi: string; + /** + * @description Parish code + * + * Can be empty string `""` if not present. + * + * @example 7418 + */ + sogneinddeling_sognekode: string; + /** + * @description Name of the parish + * + * Can be empty string `""` if not present. + * + * @example Frederikssund + */ + sogneinddeling_navn: string; + /** + * @description Supplementary locality or village name used alongside the postal address. + * + * Can be empty string `""` if not present. + * + * @example Blæsbjerg + */ + supplerendebynavn_navn: string; + /** + * @description Brief description of the origin or meaning of the road name. + * + * Can be empty string `""` if not present. + */ + navngivenvej_beskrivelse: string; + /** + * @description Phonetic/spoken form of the road name. + * + * Can be empty string `""` if not present. + * + * @example Ærteholmsvej + */ + navngivenvej_udtaltVejnavn: string; + /** + * @description Abbreviated road name containing no more than 20 characters. + * + * Can be empty string `""` if not present. + * + * @example Sydkajen + */ + navngivenvej_vejadresseringsnavn: string; + /** + * @description Official full road name + * + * Can be empty string `""` if not present. + * + * @example Blåbærheden + */ + navngivenvej_vejnavn: string; + /** + * @description Source of the road name location geometry. + * + * Can be empty string `""` if not present. + * + * @example Ekstern + */ + navngivenvej_vejnavnebeliggenhed_oprindelse_kilde: string; + /** + * @description Accuracy class of the road name location geometry. + * + * Can be empty string `""` if not present. + * + * @example B + */ + navngivenvej_vejnavnebeliggenhed_oprindelse_nøjagtighedsklasse: string; + /** + * @description Registration date of the road name location geometry. + * + * Can be empty string `""` if not present. + * + * @example 2018-05-03T15:57:30.356Z + */ + navngivenvej_vejnavnebeliggenhed_oprindelse_registrering: string; + /** + * @description Technical standard used for the road name location geometry. + * + * Can be empty string `""` if not present. + * + * @example NO + */ + navngivenvej_vejnavnebeliggenhed_oprindelse_tekniskStandard: string; + /** + * @description Road code identifying the road segment within a municipality. + * + * Can be empty string `""` if not present. + * + * @example 1248 + */ + navngivenvejkommunedel_vejkode: string; + /** + * @description Postal district name + * + * Can be empty string `""` if not present. + * + * @example Fjenneslev + */ + postnummer_navn: string; + /** + * @description Postal code + * + * Can be empty string `""` if not present. + * + * @example 4173 + */ + postnummer_postnr: string; + /** + * @description Nomination constituency number + * + * Can be empty string `""` if not present. + * + * @example 83 + */ + opstillingskredsnummer: string; + /** + * @description Name of the nomination constituency + * + * Can be empty string `""` if not present. + * + * @example Ringkøbing + */ + opstillingskreds_navn: string; + /** + * @description Electoral constituency number + * + * Can be empty string `""` if not present. + * + * @example 4 + */ + valgkredsnummer: string; + /** + * @description Multi-member constituency number + * + * Can be empty string `""` if not present. + * + * @example 3 + */ + storkredsnummer: string; + /** + * @description Name of the multi-member constituency + * + * Can be empty string `""` if not present. + * + * @example Nordsjælland + */ + storkreds_navn: string; + /** + * @description Letter identifying the electoral region + * + * Can be empty string `""` if not present. + * + * @example A + */ + valglandsdelsbogstav: string; + /** + * @description Name of the electoral region + * + * Can be empty string `""` if not present. + * + * @example Hovedstaden + */ + valglandsdels_navn: string; + postnummerinddeling_ergadepostnummer: string | boolean; + /** + * @description NUTS level 2 code (EU regional classification) + * + * Can be empty string `""` if not present. + * + * @example DK01 + */ + nuts2vaerdi: string; + /** + * @description Region code + * + * Can be empty string `""` if not present. + * + * @example 1084 + */ + regionsinddeling_regionskode: string; + /** + * @description Name of the region + * + * Can be empty string `""` if not present. + * + * @example Region Hovedstaden + */ + regionsinddeling_navn: string; + /** + * @description Police district code + * + * Can be empty string `""` if not present. + * + * @example 1468 + */ + politikreds_myndighedskode: string; + /** + * @description Police district number + * + * Can be empty string `""` if not present. + * + * @example 9 + */ + politikredsnummer: string; + /** + * @description Name of the police district + * + * Can be empty string `""` if not present. + * + * @example Nordsjællands Politi + */ + politikreds_navn: string; + /** + * @description Judicial district code + * + * Can be empty string `""` if not present. + * + * @example 1115 + */ + retskreds_myndighedskode: string; + /** + * @description Judicial district number + * + * Can be empty string `""` if not present. + * + * @example 18 + */ + retskredsnummer: string; + /** + * @description Name of the judicial district + * + * Can be empty string `""` if not present. + * + * @example Retten i Hillerød + */ + retskreds_navn: string; + /** + * @description NUTS level 3 code (EU sub-regional classification) + * + * Can be empty string `""` if not present. + * + * @example DK013 + */ + nuts3vaerdi: string; + /** + * @description Name of the statistical subdivision + * + * Can be empty string `""` if not present. + * + * @example Nordsjælland + */ + landsdel_navn: string; + }; /** * Global Address * @description Global (non-UK) address in the UK address format @@ -5944,7 +6487,8 @@ export interface components { | components["schemas"]["FodbosaAddress"] | components["schemas"]["MoisAddress"] | components["schemas"]["UpujpAddress"] - | components["schemas"]["BevAddress"]; + | components["schemas"]["BevAddress"] + | components["schemas"]["KdsAddress"]; /** * @description Not available for non-UK addresses * @enum {string} @@ -6414,6 +6958,22 @@ export interface components { */ consumed: number; }; + /** API Key Monthly Limit */ + ApiKeyMonthlyLimit: { + /** + * Format: int32 + * @description `number` or `null`. The monthly lookup limit currently set on your key. + * `null` means the limit is currently disabled. + * @example 10000 + */ + limit: number | null; + /** + * Format: int32 + * @description Number of lookups performed this month which count towards your monthly limit. + * @example 2500 + */ + consumed: number; + }; /** API Key Individual Limit */ ApiKeyIndividualLimit: { /** @@ -6599,6 +7159,11 @@ export interface components { * @example true */ bev: boolean; + /** + * @description Denmark: KDS Address File + * @example true + */ + kds: boolean; }; /** * API Key Automated Topup @@ -6642,6 +7207,7 @@ export interface components { */ lookups_remaining: number; daily_limit: components["schemas"]["ApiKeyDailyLimit"]; + monthly_limit: components["schemas"]["ApiKeyMonthlyLimit"]; individual_limit: components["schemas"]["ApiKeyIndividualLimit"]; /** @description A list of allowed URLs. An empty list means that allowed URLs are disabled. */ allowed_urls: string[]; @@ -6684,6 +7250,16 @@ export interface components { */ limit?: number | null; }; + /** Monthly Rate Limit */ + monthly_limit?: { + /** + * Format: int32 + * @description `number` or `null`. The monthly lookup limit currently set on your key. + * `null` means the limit is currently disabled. + * @example 10000 + */ + limit?: number | null; + }; /** API Key Individual Limit */ individual_limit?: { /** @@ -6849,6 +7425,11 @@ export interface components { * @example true */ bev?: boolean; + /** + * @description Denmark: KDS Address File + * @example true + */ + kds?: boolean; }; }; /** Key Usage */ @@ -7798,7 +8379,8 @@ export interface components { | components["schemas"]["FodbosaAddress"] | components["schemas"]["MoisAddress"] | components["schemas"]["UpujpAddress"] - | components["schemas"]["BevAddress"]; + | components["schemas"]["BevAddress"] + | components["schemas"]["KdsAddress"]; }; /** Address Retrieve Response (USA) */ UsaResolveAddressResponse: { diff --git a/package-lock.json b/package-lock.json index 0307ff5..240d1d1 100644 --- a/package-lock.json +++ b/package-lock.json @@ -6,7 +6,7 @@ "packages": { "": { "name": "@ideal-postcodes/openapi", - "version": "4.14.0", + "version": "4.14.1", "license": "Copyright IDDQD Limited", "devDependencies": { "@cablanchard/semantic-release": "~1.3.4",