Spring til indhold

Grundfast

Autocomplete på etage og dør

Type-ahead over enhedsadresser med etage og dør — sidste trin fra vej over husnummer til enhed.

GET/v1/adresser/autocomplete

Samme sti og parametre som DAWA’s /adresser/autocomplete, men Grundfasts svarform — uden koordinat. Med adgangsadresseid får du enhederne på en valgt adgangsadresse i læserækkefølge — kælder, stuen, 1. sal og op — indsnævret af q, når teksten indsnævrer dem. Uden søges der i enhedernes fulde adressetekst, fx "Vestergade 10, 2. th".

Hvert hit er { type: "adresse", tekst, vaerdi, adgangsadresse_id, etage, doer }, og vaerdi er enhedens UUID, som også slås op på /v1/adresse/{uuid}. En adgangsadresse uden etager — et parcelhus — har præcis én enhed med etage og doer som null.

Svaret har ingen koordinat og intet BFE-nummer — kun tekst og id. Skal du bruge koordinat og BFE i samme kald, så brug /v1/adresse/search; skal svaret have DAWA’s form med x/y, så brug /dawa/adresser/autocomplete. Hvilket adresse-endpoint skal jeg bruge?

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 — også pr. tastetryk.

Eksempel

curl -G "https://api.grundfast.dk/v1/adresser/autocomplete" \
  --data-urlencode "q=rådhuspladsen 1" \
  -H "Authorization: Bearer $GRUNDFAST_API_KEY"
Svar · eksempel, forkortet200
{
  "type": "adresse",
  "antal": 4,
  "resultater": [
    {
      "type": "adresse",
      "tekst": "Vestergade 10, st. th, 8000 Aarhus C",
      "vaerdi": "0a3f50a3-1e3c-32b8-e044-0003ba298018",
      "adgangsadresse_id": "0a3f507b-4a0a-32b8-e044-0003ba298018",
      "etage": "st",
      "doer": "th"
    },
    {
      "type": "adresse",
      "tekst": "Vestergade 10, 1. th, 8000 Aarhus C",
      "vaerdi": "0a3f50a3-1e3d-32b8-e044-0003ba298018",
      "adgangsadresse_id": "0a3f507b-4a0a-32b8-e044-0003ba298018",
      "etage": "1",
      "doer": "th"
    }
  ]
}

Forkortet: lange lister og geometrier er skåret ned — de viste værdier er uændrede.

Parametre

qstringquerypåkræveteller adgangsadresseid
Søgetekst, mindst 2 tegn. Påkrævet, medmindre adgangsadresseid er sat.Eksempel: rådhuspladsen 1
adgangsadresseidstring (UUID)queryvalgfri
List enhederne på denne adgangsadresse.

Felter i svaret

resultater[].vaerdistring (UUID)
Enhedens (DAR-adressens) UUID.
resultater[].adgangsadresse_idstring (UUID)
Den adgangsadresse, enheden hører til.
resultater[].etagestring | null
Etagen, fx "st", "1" eller "kl"; null for en enhed uden etage.
resultater[].doerstring | null
Døren, fx "th", "tv" eller "mf"; null for en enhed uden dør.

Statuskoder

StatusBetydning
200Svaret er leveret.
400Hverken q (mindst 2 tegn) eller adgangsadresseid er sat, eller adgangsadresseid er ikke et UUID.
401Nøglen mangler eller er ugyldig.
429Burst-grænsen eller månedskvoten er nået. Se Retry-After.
503Adresseindekset eller enhedsindekset (etage og dør) er ikke indlæst i dette miljø endnu.

Alle fejl har samme form. Byg logikken på type (fejlklassen) og vis message (dansk tekst med årsagen) til brugeren; hint kommer med, når vi kan se, hvad der skal rettes, og request_id er det, support skal bruge. Se Fejl og statuskoder for hver type, og hvad der kan prøves igen.

Fejlsvar · 404
{
  "error": "property not found",
  "type": "not_found",
  "code": "not_found",
  "message": "Ressourcen findes ikke.",
  "request_id": "6cbfa45a-a9ea-4140-9d42-ea752a70ff1f",
  "doc_url": "https://grundfast.dk/docs/fejl#not_found"
}

Prøv det

Live-kald fra siden

Kræver din nøgle

Nøglen bliver i denne fane og sendes kun til grundfast.dk. Kaldet tæller som et almindeligt kald — brug en gf_test_-nøgle for at prøve gratis. Opret en gratis nøgle

GET /v1/adresser/autocomplete?q=r%C3%A5dhuspladsen+1

Bruges ofte sammen med

Læs mere om Adresser: lister, autocomplete og reverse, og hvad data kan bruges til, på produktsiden.