Skip to content

Swisstopo Schema #305

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
RobertIdeal wants to merge 4 commits into
base: main
Choose a base branch
from
+804 −5
Open

Swisstopo Schema #305

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
e4aa958
schema from api
RobertIdeal Apr 14, 2026
fb56355
Changing spelling to kantonskürzel
RobertIdeal Apr 15, 2026
ece264d
description changes
RobertIdeal Apr 20, 2026
456cff9
Schema changes to match address
RobertIdeal Apr 30, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
324 changes: 322 additions & 2 deletions dist/openapi.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 - `swisstopo` (CHE) Switzerland and Liechtenstein Dataset",
"enum": [
"paf",
"pafw",
Expand Down Expand Up @@ -3811,7 +3811,8 @@
"fodbosa",
"mois",
"upujp",
"bev"
"bev",
"swisstopo"
]
},
"CountryISO": {
Expand Down Expand Up @@ -4926,6 +4927,7 @@
},
"post_county_id": {
"type": "string",
"nullable": true,
"description": "Post County ID",
"example": "10098783",
"maxLength": 10,
Expand Down Expand Up @@ -9914,6 +9916,310 @@
}
}
},
"SwisstopoAddress": {
"required": [
"id",
"dataset",
"country",
"country_iso",
"country_iso_2",
"language",
"canton",
"address",
"line_1",
"line_2",
"latitude",
"longitude",
"adr_egaid",
"bdg_egid",
"adr_edid",
"stn_label",
"adr_number",
"bdg_category",
"bdg_name",
"zip_label",
"com_fosnr",
"com_name",
"com_canton",
"adr_status",
"adr_official",
"adr_modified",
"adr_easting",
"adr_northing",
"str_esid",
"str_type",
"str_status",
"str_official",
"str_modified",
"str_easting",
"str_northing",
"ortschaftsname",
"plz4",
"zusatzziffer",
"zip_id",
"gemeindename",
"bfs_nr",
"kantonskürzel",
"sprache",
"validity"
],
"properties": {
"id": {
"$ref": "#/components/schemas/ID"
},
"dataset": {
"type": "string",
"enum": [
"swisstopo"
]
},
"country_iso": {
"description": " 3 letter country code (ISO 3166-1)\n",
"enum": [
"CHE",
"LIE"
]
},
"country_iso_2": {
"type": "string",
"description": " 2 letter country code (ISO 3166-1)\n",
"enum": [
"CH",
"LI"
]
},
"country": {
"type": "string",
"description": " Full country names (ISO 3166)\n",
"enum": [
"Switzerland",
"Liechtenstein"
]
},
"language": {
"enum": [
"de",
"fr",
"it",
"rm"
],
"description": "Language represented by 2 letter ISO Code (639-1)\n"
},
"canton": {
"type": "string",
"description": "Canton abbreviation, `\"\"` if not present.\n"
},
"address": {
"type": "string",
"description": "House number, `\"\"` if not present.\n",
"example": "40"
},
"line_1": {
"type": "string",
"description": "First address line.\n\nCan be empty string `\"\"` if not present.\n",
"example": "Villa Kranzmayer"
},
"line_2": {
"type": "string",
"description": "Second address line.\n\nCan be empty string `\"\"` if not present.\n",
"example": "Römerweg 48"
},
"longitude": {
"$ref": "#/components/schemas/Longitude"
},
"latitude": {
"$ref": "#/components/schemas/Latitude"
},
"street_latitude": {
"oneOf": [
{
"type": "string",
"description": "Empty string `\"\"` if not available"
},
{
"type": "number",
"description": "Latitude of the street centroid (WGS84)",
"minimum": -90,
"maximum": 90
}
]
},
"street_longitude": {
"oneOf": [
{
"type": "string",
"description": "Empty string `\"\"` if not available"
},
{
"type": "number",
"description": "Longitude of the street centroid (WGS84)",
"minimum": -180,
"maximum": 180
}
]
},
"adr_egaid": {
"type": "number",
"description": "Federal building address identifier (Eidgenössischer Gebäudeadressidentifikator).\n"
},
"geb_str_esid": {
"type": "number",
"description": "Street identifier from the building register linking the address to a street in the street register.\n"
},
"bdg_egid": {
"type": "number",
"description": "Federal building identifier (Eidgenössischer Gebäudeidentifikator).\n"
},
"adr_edid": {
"type": "number",
"description": "Entrance identifier within the building.\n"
},
"stn_label": {
"type": "string",
"description": "Street name label.\n"
},
"adr_number": {
"type": "string",
"description": "House/address number (e.g. `\"12\"`, `\"12A\"`).\n\nCan be empty string `\"\"` if not present.\n"
},
"bdg_category": {
"type": "string",
"description": "Building category from the Federal Building and Dwelling Register (GWR).\n"
},
"bdg_name": {
"type": "string",
"description": "Building name.\n\nCan be empty string `\"\"` if not present.\n"
},
"zip_label": {
"type": "string",
"description": "Postal code and locality label (e.g. `\"8001 Zürich\"`).\n"
},
"com_fosnr": {
"type": "number",
"description": "Federal municipality number assigned by the Federal Statistical Office (FSO/BFS).\n"
},
"com_name": {
"type": "string",
"description": "Municipality name.\n"
},
"com_canton": {
"type": "string",
"description": "Canton abbreviation (e.g. `\"ZH\"`, `\"BE\"`).\n\nCan be empty string `\"\"` if not present.\n"
},
"adr_status": {
"type": "string",
"description": "Address status from the GWR.\n"
},
"adr_official": {
"type": "boolean",
"description": "Whether the address is an official address.\n"
},
"adr_modified": {
"type": "string",
"description": "Date the address record was last modified.\n"
},
"adr_easting": {
"type": "string",
"description": "Easting coordinate of the address in the Swiss coordinate system CH1903+/LV95.\n"
},
"adr_northing": {
"type": "string",
"description": "Northing coordinate of the address in the Swiss coordinate system CH1903+/LV95.\n"
},
"str_esid": {
"type": "number",
"description": "Street identifier from the street register (Strassenverzeichnis).\n"
},
"str_type": {
"type": "string",
"description": "Street type.\n"
},
"str_status": {
"type": "string",
"description": "Street status.\n"
},
"str_official": {
"type": "boolean",
"description": "Whether the street name is official.\n"
},
"str_modified": {
"type": "string",
"description": "Date the street record was last modified.\n"
},
"str_easting": {
"type": "string",
"description": "Easting coordinate of the street centroid in the Swiss coordinate system CH1903+/LV95.\n"
},
"str_northing": {
"type": "string",
"description": "Northing coordinate of the street centroid in the Swiss coordinate system CH1903+/LV95.\n"
},
"str_parent": {
"type": "string",
"description": "Parent street identifier.\n\nCan be empty string `\"\"` if not present.\n"
},
"str_children": {
"type": "string",
"description": "Child street identifiers.\n\nCan be empty string `\"\"` if not present.\n"
},
"ortschaftsname": {
"type": "string",
"nullable": true,
"description": "Locality name from the Official Directory of Localities (Amtliches Ortschaftenverzeichnis).\n"
},
"plz4": {
"type": "string",
"nullable": true,
"description": "4-digit Swiss postal code.\n"
},
"zusatzziffer": {
"type": "string",
"nullable": true,
"description": "Additional digit disambiguating postal codes that share the same 4-digit code.\n"
},
"zip_id": {
"type": "number",
"nullable": true,
"description": "Unique identifier for the postal code record.\n"
},
"gemeindename": {
"type": "string",
"nullable": true,
"description": "Municipality name (Gemeindename).\n"
},
"bfs_nr": {
"type": "number",
"nullable": true,
"description": "Federal municipality number assigned by the Federal Statistical Office (BFS-Nr).\n"
},
"kantonskürzel": {
"type": "string",
"description": "Canton abbreviation (e.g. `\"ZH\"`, `\"GE\"`).\n\nCan be empty string `\"\"` if not present.\n"
},
"adressenanteil": {
"type": "string",
"description": "Proportion of addresses belonging to this locality record.\n"
},
"e": {
"type": "string",
"description": "Longitude of the locality centroid in WGS84 decimal degrees.\n"
},
"n": {
"type": "string",
"description": "Latitude of the locality centroid in WGS84 decimal degrees.\n"
},
"sprache": {
"type": "string",
"nullable": true,
"description": "Language of the record (e.g. `\"de\"`, `\"fr\"`, `\"it\"`, `\"rm\"`).\n"
},
"validity": {
"type": "string",
"nullable": true,
"description": "Validity period of the postal code record.\n"
}
}
},
"GbrGlobalAddress": {
"title": "Global Address",
"description": "Global (non-UK) address in the UK address format",
Expand Down Expand Up @@ -10066,6 +10372,9 @@
},
{
"$ref": "#/components/schemas/BevAddress"
},
{
"$ref": "#/components/schemas/SwisstopoAddress"
}
]
},
Expand Down Expand Up @@ -10880,6 +11189,7 @@
"mois",
"upujp",
"bev",
"swisstopo",
"gbrcleanse",
"uspscleanse"
],
Expand Down Expand Up @@ -11048,6 +11358,11 @@
"description": "Austria: BEV Address File",
"example": true
},
"swisstopo": {
"type": "boolean",
"description": "Switzerland and Liechtenstein: Swisstopo Address File",
"example": true
},
"gbrcleanse": {
"type": "boolean",
"description": "UK GBR Cleanse",
Expand Down Expand Up @@ -11459,6 +11774,11 @@
"description": "Austria: BEV Address File",
"example": true
},
"swisstopo": {
"type": "boolean",
"description": "Switzerland and Liechtenstein: Swisstopo Address File",
"example": true
},
"ab": {
"type": "boolean",
"description": "UK AddressBase dataset",
Expand Down
Loading
Loading