Hent et område

Ét administrativt område ud fra tema og kode: navnet altid, geometrien når den kan hentes.

GEThttps://api.grundfast.dk/v1/dagi/{tema}/{kode}

Navnet slås op i det medfølgende register og er derfor altid med for en kendt kode. Polygonen hentes fra Datafordelers DAGI-tjeneste og reprojiceres til WGS84 med hullerne bevaret: Frederiksberg er sin egen kommune og står som et hul i Københavns polygon, ikke som en del af den. geometri.coordinates er en almindelig GeoJSON-MultiPolygon, hvor hver del er [ydre ring, ...huller]; de oprindelige EPSG:25832-koordinater for hver dels ydre ring følger med i geometri.epsg25832_rings.

Geometrien er best-effort. Kan kilden ikke svare, får du stadig 200 med navnet og geometri: null, og meta.geometri_status siger hvorfor. Bliver en ældre, cachet polygon brugt, er geometri_status stale, og svaret har headeren X-Grundfast-Stale: true.

Koder på op til fire cifre nulpolstres, så 751 og 0751 giver det samme område. For en kommune er regionskode udfyldt; for de øvrige temaer er den null.

Endpointet svarer aldrig 502 eller 503 for en kendt kode. En nedetid hos kilden koster geometrien, ikke navnet — læs meta.geometri_status, før du tegner.

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.

Eksempel

curl "https://api.grundfast.dk/v1/dagi/kommune/0101" \
  -H "Authorization: Bearer $GRUNDFAST_API_KEY"

Svar · fra demo-endpointet, forkortet200json

{
  "tema": "kommune",
  "kode": "0101",
  "navn": "København",
  "regionskode": "1084",
  "geometri": {
    "type": "MultiPolygon",
    "coordinates": [
      [
        [
          [12.54504, 55.6407987],
          [12.545779, 55.6415865],
          [12.5456371, 55.6415996],
          [12.54504, 55.6407987]
        ]
      ],
      [
        [
          [12.5462383, 55.6498277],
          [12.5465926, 55.6497005],
          [12.5477644, 55.6507007],
          [12.5473467, 55.6508296],
          [12.5462383, 55.6498277]
        ]
      ]
    ],
    "epsg25832_rings": [
      [
        [723091, 6171803],
        [723124, 6171894],
        [723133, 6171893],
        [723091, 6171803]
      ],
      [
        [723115, 6172811],
        [723179, 6172926],
        [723206, 6172913],
        [723138, 6172798],
        [723115, 6172811]
      ]
    ]
  },
  "meta": {
    "kilde": "Datafordeler DAGI via Grundfast",
    "grundfast_version": "0.1.0",
    "geometri_status": "live"
  }
}

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

Parametre

temastringstipåkrævet: Den administrative inddeling, koden hører til.Værdier:regionkommunesognretskredspolitikredsopstillingskredsEksempel: kommune
kodestringstipåkrævet: Områdets DAGI-kode, fx 0751 (Aarhus Kommune) eller 1084 (Region Hovedstaden). Find koderne med /v1/dagi/:tema.Eksempel: 0101

Felter i svaret

navnstring | null: Områdets navn fra registret.
regionskodestring | null: Kun for kommuner: koden på den region, kommunen ligger i, fx 1082.
geometriMultiPolygon | null: Områdets polygon i WGS84 [lon, lat] plus de rå ringe i EPSG:25832. null, når geometrien ikke kunne hentes.
meta.geometri_statusstring: live (hentet nu eller frisk fra cache), stale (ældre cachet kopi), unavailable (ingen geometri at få) eller not_configured (kilden er ikke sat op i miljøet).

Statuskoder

Status	Betydning
200	Svaret er leveret.
400	`tema` er ikke et af de seks kendte temaer.
401	Nøglen mangler eller er ugyldig.
404	Koden findes ikke i det valgte tema.
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

Bruges ofte sammen med

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

curl "https://api.grundfast.dk/v1/dagi/kommune/0101" \
  -H "Authorization: Bearer $GRUNDFAST_API_KEY"

Svar · demo, forkortet200json

{
  "tema": "kommune",
  "kode": "0101",
  "navn": "København",
  "regionskode": "1084",
  "geometri": {
    "type": "MultiPolygon",
    "coordinates": [
      [
        [
          [12.54504, 55.6407987],
          [12.545779, 55.6415865],
          [12.5456371, 55.6415996],
          [12.54504, 55.6407987]
        ]
      ],
      [
        [
          [12.5462383, 55.6498277],
          [12.5465926, 55.6497005],
          [12.5477644, 55.6507007],
          [12.5473467, 55.6508296],
          [12.5462383, 55.6498277]
        ]
      ]
    ],
    "epsg25832_rings": [
      [
        [723091, 6171803],
        [723124, 6171894],
        [723133, 6171893],
        [723091, 6171803]
      ],
      [
        [723115, 6172811],
        [723179, 6172926],
        [723206, 6172913],
        [723138, 6172798],
        [723115, 6172811]
      ]
    ]
  },
  "meta": {
    "kilde": "Datafordeler DAGI via Grundfast",
    "grundfast_version": "0.1.0",
    "geometri_status": "live"
  }
}

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