API'et udstiller Danmarks postnumre samt tilhørende funktionalitet.
Søg efter postnumre. Returnerer de postnumre som opfylder kriteriet. Bemærk, at DAGI ikke indeholder erhvervspostnumre (fx 1790 og 8245), og at disse derfor ikke kan fremsøges igennem DAWA.
Bemærk, at postnumrenes geografi som udgangspunkt også medtager havområder (https://vis.dataforsyningen.dk/postnumre), hvilket ikke er det der ønskes i de fleste tilfælde. Ønskes landafgrænsede postnumre tilføjes parameteren landpostnumre https://vis.dataforsyningen.dk/postnumre?landpostnumre).GET https://api.dataforsyningen.dk/postnumre
Navn | Beskrivelse |
---|---|
nr | Postnummer. 4 cifre. (Flerværdisøgning mulig). |
navn | Postnummernavn (Flerværdisøgning mulig). |
kommunekode | Kommunekode. 4 cifre. Eksempel: 0101 for Københavns kommune. (Flerværdisøgning mulig). |
q | Søgetekst. Der søges i postnummernavnet. Alle ord i søgeteksten skal matche postnummernavnet. Wildcard * er tilladt i slutningen af hvert ord. Der returneres højst 1000 resultater ved anvendelse af parameteren. |
autocomplete | Udfør søgning som autocomplete-søgning. |
stormodtagere | Hvis denne parameter er sat til 'true', vil stormodtager-postnumre medtages i resultatet. Default er false. |
landpostnumre | Hvis denne parameter er sat vil den returnerede geometri for postnumre være afgrænset af kyster. |
srid | Angiver SRID for det koordinatsystem, som geospatiale parametre er angivet i. Default er 4326 (WGS84 / Geografiske koordinater). For ETRS89 / UTM zone 32 Nord anvender du 25832 |
cirkel | Find de postnumre, som overlapper den cirkel angivet af koordinatet (x,y) og radius r. Som koordinatsystem kan anvendes ETRS89/UTM32 eller WGS84/geografisk. Radius angives i meter. cirkel={x},{y},{r}. |
polygon | Find de postnumre, som overlapper det angivne polygon. Polygonet specificeres som et array af koordinater på samme måde som koordinaterne specificeres i GeoJSON's polygon. Bemærk at polygoner skal være lukkede, dvs. at første og sidste koordinat skal være identisk. Som koordinatsystem kan anvendes (ETRS89/UTM32 eller) WGS84/geografisk. Dette angives vha. srid parameteren, se ovenover. Eksempel: polygon=[[[10.3,55.3],[10.4,55.3],[10.4,55.31],[10.4,55.31],[10.3,55.3]]]. |
callback | Output leveres i JSONP format. Se Dataformater. |
format | Output leveres i andet format end JSON. Se Dataformater. |
noformat | Parameteren angiver, at whitespaceformatering skal udelades |
ndjson | Output leveres i Newline Delimited JSON |
side | Angiver hvilken siden som skal leveres. Se Paginering. |
per_side | Antal resultater per side. Se Paginering. |
struktur | Struktur parameteren angiver om der ønskes en flad eller en nestet svarstruktur. Default er nestet for JSON, og flad for GeoJSON. |
Hent alle postnumre
https://api.dataforsyningen.dk/postnumre
Find postnummer 8600
https://api.dataforsyningen.dk/postnumre?nr=8600
Find alle postnumre som benyttes i kommune 751 Aarhus
https://api.dataforsyningen.dk/postnumre?kommunekode=751
Find postnummer for postnummernavn Silkeborg
https://api.dataforsyningen.dk/postnumre?navn=Silkeborg
Find alle postnumre som indeholder ordet strand
https://api.dataforsyningen.dk/postnumre?q=strand
Find alle postnumre som indeholder aar*
https://api.dataforsyningen.dk/postnumre?q=aar*
Modtag postnummer med id.
GET https://api.dataforsyningen.dk/postnumre/{nr}
Navn | Beskrivelse |
---|---|
nr | Postnummer. 4 cifre. |
landpostnumre | Hvis denne parameter er sat vil den returnerede geometri for postnumre være afgrænset af kyster. |
struktur | Struktur parameteren angiver om der ønskes en flad eller en nestet svarstruktur. Default er nestet for JSON, og flad for GeoJSON. |
Hent postnummer for København NV
https://api.dataforsyningen.dk/postnumre/2400
Autocomplete på postnumre. Der kan anvendes de samme parametre som ved søgning, men bemærk at q parameteren fortolkes anderledes. Læs mere under autocomplete.
GET https://api.dataforsyningen.dk/postnumre/autocomplete
Navn | Beskrivelse |
---|---|
nr | Postnummer. 4 cifre. (Flerværdisøgning mulig). |
navn | Postnummernavn (Flerværdisøgning mulig). |
kommunekode | Kommunekode. 4 cifre. Eksempel: 0101 for Københavns kommune. (Flerværdisøgning mulig). |
q | Se beskrivelse under autocomplete |
autocomplete | Udfør søgning som autocomplete-søgning. |
stormodtagere | Hvis denne parameter er sat til 'true', vil stormodtager-postnumre medtages i resultatet. Default er false. |
callback | Output leveres i JSONP format. Se Dataformater. |
format | Output leveres i andet format end JSON. Se Dataformater. |
noformat | Parameteren angiver, at whitespaceformatering skal udelades |
ndjson | Output leveres i Newline Delimited JSON |
side | Angiver hvilken siden som skal leveres. Se Paginering. |
per_side | Antal resultater per side. Se Paginering. |
Find alle postnumre som indeholder strand i postnummerbetegnelsen
https://api.dataforsyningen.dk/postnumre/autocomplete?q=strand
Modtage postnummeret for det punkt der angives med x- og y-parametrene
GET https://api.dataforsyningen.dk/postnumre/reverse
Navn | Beskrivelse |
---|---|
x | X koordinat. (Hvis ETRS89/UTM32 anvendes angives øst-værdien.) Hvis WGS84/geografisk anvendes angives bredde-værdien. |
y | Y koordinat. (Hvis ETRS89/UTM32 anvendes angives nord-værdien.) Hvis WGS84/geografisk anvendes angives længde-værdien. |
srid | Angiver SRID for det koordinatsystem, som geospatiale parametre er angivet i. Default er 4326 (WGS84 / Geografiske koordinater). For ETRS89 / UTM zone 32 Nord anvender du 25832 |
callback | Output leveres i JSONP format. Se Dataformater. |
format | Output leveres i andet format end JSON. Se Dataformater. |
noformat | Parameteren angiver, at whitespaceformatering skal udelades |
ndjson | Output leveres i Newline Delimited JSON |
landpostnumre | Hvis denne parameter er sat vil den returnerede geometri for postnumre være afgrænset af kyster. |
struktur | Struktur parameteren angiver om der ønskes en flad eller en nestet svarstruktur. Default er nestet for JSON, og flad for GeoJSON. |
Returner postnummeret for punktet angivet af WGS84/geografisk koordinatet (12.5851471984198, 55.6832383751223)
https://api.dataforsyningen.dk/postnumre/reverse?x=12.5851471984198&y=55.6832383751223
Returner postnummeret for punktet angivet af ETRS89/UTM32 koordinatet (725369.59, 6176652.55)
https://api.dataforsyningen.dk/postnumre/reverse?x=725369.59&y=6176652.55&srid=25832
Navn | Type | Optionelt | Beskrivelse | ||||
---|---|---|---|---|---|---|---|
href | string | nej | Postnummerets unikke URL. | ||||
nr | string | nej | Unik identifikation af det postnummeret. Postnumre fastsættes af Post Danmark. Repræsenteret ved fire cifre. Eksempel: ”2400” for ”København NV”. | ||||
navn | string | nej | Det navn der er knyttet til postnummeret, typisk byens eller bydelens navn. Repræsenteret ved indtil 20 tegn. Eksempel: ”København NV”. | ||||
stormodtageradresser | array | ja | Hvis postnummeret er et stormodtagerpostnummer rummer feltet adresserne på stormodtageren. | ||||
href | string | nej | Adgangsadressens unikke URL. | ||||
id | string | nej | Adgangsadressens unikke UUID. | ||||
bbox | array | ja | Bounding box for postnummeret | ||||
item | number | nej | |||||
visueltcenter | array | ja | Det visuelle center for postnummeret. Kan f.eks. anvendes til placering af labels på et kort. | ||||
item | number | nej | |||||
kommuner | array | nej | De kommuner hvis areal overlapper postnumeret areal. | ||||
href | string | nej | Kommunens unikke URL. | ||||
kode | string | nej | Kommunekoden. 4 cifre. | ||||
navn | string | ja | Kommunens navn. | ||||
ændret | string | ja | Tidspunkt for seneste ændring registreret i DAWA. Opdateres ikke hvis ændringen kun vedrører geometrien (se felterne geo_ændret og geo_version). | ||||
geo_ændret | string | ja | Tidspunkt for seneste ændring af geometrien registreret i DAWA. | ||||
geo_version | integer | ja | Versionsangivelse for geometrien. Inkrementeres hver gang geometrien ændrer sig i DAWA. | ||||
dagi_id | string | ja | Postnummerets unikke ID i DAGI. Heltal som string. |