Spring til indhold

Opret en eksport

Start et asynkront eksportjob over en liste af op til 5.000 BFE-numre eller adresse-id’er, serialiseret som CSV, NDJSON eller GeoJSON.

POST/v1/export

Eksporten slår hvert id op med samme cache og samme form som enkeltopslagene og skriver resultatet til én fil. Til bbr og matrikel sender du bfe, til adresse sender du uuid (DAR-id’er). Dubletter fjernes, og requested er antallet af unikke id’er. Det er ikke et udtræk af hele registret — kun de id’er, du sender.

Kaldet svarer med det samme med 201 og jobbet i status queued. Følg det med Hent en eksport, og hent filen med Download eksporten, når status er completed.

NDJSON indeholder hele objektet pr. linje. CSV er en flad udgave med de vigtigste kolonner: for bbr er det bfe_nummer, kommunekode, antal_bygninger, matrikelnummer og ejerlav_navn. GeoJSON er én FeatureCollection — bygningspunkter for bbr, jordstykkeomrids for matrikel og adressepunkter for adresse.

API’et svarer med { "job": { … } }. SDK’ens createExport() pakker det ud og returnerer selve jobbet.

Godkendelse · API-nøgle eller session

Virker med en Authorization: Bearer-nøgle eller med din login-session i dashboardet.

Kræver Scale-planen

På en lavere plan svarer endpointet 402. Se planerne.

Afregning

Én enhed pr. unikt id i anmodningen; id’er, der ikke kunne slås op, krediteres tilbage, når jobbet er færdigt.

Eksempel

curl -X POST "https://api.grundfast.dk/v1/export" \
  -H "Authorization: Bearer $GRUNDFAST_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"register":"bbr","format":"csv","bfe":[5651067,2425322]}'
Svar · eksempel201
{
  "job": {
    "id": "exp_k3v9q2m7x1r8t4w6y0z5b2nc",
    "register": "bbr",
    "format": "csv",
    "status": "queued",
    "requested": 2,
    "succeeded": 0,
    "failed": 0,
    "sizeBytes": null,
    "error": null,
    "createdAt": "2026-09-24T09:12:03.418Z",
    "completedAt": null,
    "resultAvailable": false
  }
}

Request-body

JSON med Content-Type: application/json.

registerstringbodypåkrævet
Hvilket register id’erne slås op i. Bestemmer, om listen hedder bfe eller uuid.Værdier:bbrmatrikeladresse
formatstringbodypåkrævet
Filformatet: csv (flad), ndjson (fuldt objekt pr. linje) eller geojson (FeatureCollection).Værdier:csvndjsongeojson
bfeinteger[]bodyvalgfri
1-5.000 BFE-numre. Påkrævet, når register er bbr eller matrikel.
uuidstring[]bodyvalgfri
1-5.000 DAR-adresse-id’er (UUID). Påkrævet, når register er adresse.

Felter i svaret

job.idstring
Jobbets id, fx exp_…. Bruges til at følge og hente eksporten.
job.statusstring
queued, processing, completed eller failed. Et nyt job er altid queued.
job.requestedinteger
Antallet af unikke id’er, jobbet skal slå op — det tal, kvoten tæller.

Statuskoder

StatusBetydning
201Oprettet — svaret beskriver det nye objekt.
400Kroppen er ugyldig: ukendt register eller format, den forkerte id-liste til registret, en tom liste, flere end 5.000 id’er eller et id i forkert format.
401Hverken en gyldig nøgle eller en session.
402Planen er under Scale.
403Nøglen er en admin-nøgle, eller kontoen er suspenderet.
429Burst-grænsen eller månedskvoten er nået; alle id’er i anmodningen tæller mod kvoten.

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

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

POST /v1/export

Bruges ofte sammen med