Autocomplete på postnumre

Postnumre, der starter med de indtastede cifre eller har et distriktsnavn, der indeholder teksten.

GEThttps://api.grundfast.dk/v1/postnumre/autocomplete

Erstatter DAWA’s /postnumre/autocomplete. q matcher både starten af nummeret (80 finder 8000) og hvor som helst i distriktsnavnet, uden hensyn til store og små bogstaver og med tolerance for oe/aa i stedet for ø/å. Der returneres højst 20 hits.

Svaret har samme form som /v1/postnumre; total er antallet af postnumre i hele listen, ikke antallet af hits.

Godkendelse · API-nøgle

Send din nøgle som Authorization: Bearer gf_live_… — eller gf_test_… for gratis sandbox-kald. Se Godkendelse og nøgler.

Afregning

Ét kald pr. forespørgsel.

Eksempel

curl "https://api.grundfast.dk/v1/postnumre/autocomplete?q=aarhus" \
  -H "Authorization: Bearer $GRUNDFAST_API_KEY"

Svar · eksempel200json

{
  "antal": 3,
  "total": 1089,
  "postnumre": [
    { "nr": "8000", "navn": "Aarhus C", "stormodtager": false },
    { "nr": "8200", "navn": "Aarhus N", "stormodtager": false },
    { "nr": "8210", "navn": "Aarhus V", "stormodtager": false }
  ],
  "meta": {
    "kilde": "Datafordeler DAR (postnumre) via Grundfast",
    "grundfast_version": "0.1.0"
  }
}

Parametre

qstringquerypåkrævet: Starten af et postnummer eller en del af distriktsnavnet. Kun de første 64 tegn bruges.Eksempel: aarhus
stormodtagerebooleanqueryvalgfri: Søg også i de historiske stormodtager-postnumre.Standard:false

Felter i svaret

totalinteger: Antal postnumre i hele listen — ikke antallet af hits.
postnumre[]object[]: Højst 20 hits som { nr, navn, stormodtager }, sorteret efter nummer.
antalinteger: Antal postnumre i postnumre — kun de bedste hits, ikke hele korpuset.

Statuskoder

Status	Betydning
200	Svaret er leveret.
400	`q` mangler eller er tom.
401	Nøglen mangler eller er ugyldig.
429	Burst-grænsen eller månedskvoten er nået. Se `Retry-After`.

Fejl har altid formen { "error": "…" }. Se Fejl og statuskoder for, hvad der kan prøves igen.

Prøv det

Live-kald fra siden

Kræver din nøgle

Bruges ofte sammen med

Læs mere om DAWA-kompatibel, og hvad data kan bruges til, på produktsiden.

curl "https://api.grundfast.dk/v1/postnumre/autocomplete?q=aarhus" \
  -H "Authorization: Bearer $GRUNDFAST_API_KEY"

Svar · eksempel200json

{
  "antal": 3,
  "total": 1089,
  "postnumre": [
    { "nr": "8000", "navn": "Aarhus C", "stormodtager": false },
    { "nr": "8200", "navn": "Aarhus N", "stormodtager": false },
    { "nr": "8210", "navn": "Aarhus V", "stormodtager": false }
  ],
  "meta": {
    "kilde": "Datafordeler DAR (postnumre) via Grundfast",
    "grundfast_version": "0.1.0"
  }
}