Spring til indhold

Grundfast

Slå jordstykker op i batch

Jordstykkerne for op til 50 ejendomme i ét kald, med et resultat eller en fejl for hvert BFE-nummer.

POST/v1/matrikel/ejendom:batch

Send en liste af BFE-numre, og få hver ejendoms jordstykker tilbage i samme form som fra Hent ejendommens jordstykker. Dubletter fjernes, før opslagene går i gang, og requested er antallet af unikke numre.

Svaret er 200, også når nogle af numrene fejler: de fejlede står i errors med deres egen status, og resten står i results. Kun en ugyldig krop giver 400. Punkt-i-tid-opslag understøttes ikke i batch.

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.

Kræver Pro-planen

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

Afregning

Kvoten tæller ét kald pr. unikt BFE-nummer; der faktureres kun for de numre, der blev slået op.

Eksempel

curl -X POST "https://api.grundfast.dk/v1/matrikel/ejendom:batch" \
  -H "Authorization: Bearer $GRUNDFAST_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"bfe":[5651067,2425322]}'
Svar · eksempel, forkortet200
{
  "results": [
    {
      "bfe": 5651067,
      "ejendom": {
        "bfe_nummer": 5651067,
        "type": "samlet_fast_ejendom",
        "jordstykker": [
          {
            "id": "1928359",
            "matrikelnummer": "138o",
            "ejerlav": {
              "kode": 2006552,
              "navn": "Silkeborg Markjorder"
            },
            "areal_m2": 460,
            "kommunekode": "0740",
            "geometri": {
              "type": "Polygon",
              "coordinates": [
                [
                  [
                    9.5326405,
                    56.1579596
                  ],
                  [
                    9.532631,
                    56.1579199
                  ],
                  [
                    9.5326084,
                    56.1578249
                  ],
                  [
                    9.5330829,
                    56.1577643
                  ],
                  [
                    9.5331362,
                    56.1578905
                  ],
                  [
                    9.5326405,
                    56.1579596
                  ]
                ]
              ],
              "epsg25832_ring": [
                [
                  533083.822,
                  6223788.017
                ],
                [
                  533083.267,
                  6223783.588
                ],
                [
                  533081.942,
                  6223773.004
                ],
                [
                  533111.469,
                  6223766.491
                ],
                [
                  533114.672,
                  6223780.561
                ],
                [
                  533083.822,
                  6223788.017
                ]
              ]
            }
          }
        ],
        "dagi": {
          "kommune": {
            "kode": "0740",
            "navn": "Silkeborg"
          },
          "region": {
            "kode": "1082",
            "navn": "Region Midtjylland"
          }
        },
        "meta": {
          "kilde": "Datafordeler Matriklen via Grundfast",
          "grundfast_version": "0.1.0"
        }
      },
      "stale": false
    }
  ],
  "errors": [],
  "requested": 2,
  "succeeded": 2,
  "failed": 0
}

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

Request-body

JSON med Content-Type: application/json.

bfeinteger[]bodypåkrævet
1-50 BFE-numre. Grænsen gælder listen, som den sendes — dubletter tæller med, indtil de fjernes.

Felter i svaret

results[]object[]
{ bfe, ejendom, stale } for hvert nummer, der kunne slås op. ejendom har samme form som et enkeltopslag.
results[].staleboolean
true når jordstykkerne blev serveret fra cache, fordi Matriklen var nede.
errors[]object[]
{ bfe, error, status } for hvert nummer, der fejlede — fx 404 for et ukendt BFE.
failedinteger
Antal fejlede numre. requested = succeeded + failed.

Statuskoder

StatusBetydning
200Svaret er leveret.
400Kroppen er ikke { bfe: number[] } med 1-50 positive heltal.
401Nøglen mangler eller er ugyldig.
402Planen er under Pro.
429Burst-grænsen eller månedskvoten er nået; hele batchens antal enheder tæller mod kvoten. 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

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/matrikel/ejendom:batch

Bruges ofte sammen med

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