API-dokumentation

Eftersom detta API är dynamiskt och innehållet anpassas till konfiguration är vissa delar inte applicerbara i alla lägen. Exempelvis ID för olika komponenter (datadefinitioner, attributsök, dataslag, etc.) och attribut kan variera efter installation och anpassning

Den här dokumentet visar översiktlig åtkomst för grundläggande åtkomst till fastighetsinformation via API.

Autentisering

I de flesta fall krävs en API-nyckel i form av en JSON Web Token (JWT) som genereras och ges ut av en administratör. JWT-nyckeln är oftas låst till en specifik IP-adress och med begränsad giltighetstid.

Attributsök

Parametrar för fastighet: search=fib.fastighet.update, data=dd.fib.fastighet.search

Parametrar för fastighetåtgärd: search=fib.fastighet.fastighetsatgard.update, data=dd.fib.fastighet.fastighetsatgard.search

Parametrar för belägenhetsadress: search=fib.adress.update, data=dd.fib.adress.search

Beskrivning

Hämta en eller flera dataenheter med attributsök och få svar med resultat från datadefinition.

Sökväg

/services/api/v1/data/fetch/search

Request-parametrar

Namn

Beskrivning

Default

Obligatorisk

Namn

Beskrivning

Default

Obligatorisk

search

Referens till attributsök

 

Ja

data

Referens till datadefinition för resultat

 

Ja

includeKey

Inkludera nyckel i svar

Ja

Nej

metadata

Inkludera metadata för datadefinition

Nej

Nej

rowFormat

Radformat.

object eller array

object

Nej

start

Första raden vid paginering

 

Nej

limit

Begränsa antal rader vid paginering

 

Nej

Anrop skickas med Headers: Accept: application/jsonoch Content-Type: application/x-www-form-urlencoded

Exempel

curl -X POST \ "https://<SERVER>/weave/services/api/v1/data/fetch/search?search=fib.fastighet.update&data=dd.fib.fastighet&includeKey=false&metadata=true&rowFormat=array&limit=1" \ "Authorization: Bearer <TOKEN>" \ -H "Content-Type: application/x-www-form-urlencoded" \ -H "Accept: application/json" \ -H "Authorization: Bearer <TOKEN>" \ -d "date_from=2024-05-22T00:00:00&date_to=2024-05-23T23:59:59"

Svar

{ "total": 2, "metadata": [ { "id": "objektidentitet", "label": "Objektidentitet", "type": "string", "key": true }, { "id": "status", "label": "Status", "type": "string" }, { "id": "objektversion", "label": "Objektversion", "type": "int" }, { "id": "versiongiltigfran", "label": "Versiongiltigfran", "type": "datetime" }, { "id": "senasteandringallmannadelen", "label": "Senasteandringallmannadelen", "type": "date" }, { "id": "typ", "label": "Typ", "type": "string" }, { "id": "lanskod", "label": "Lanskod", "type": "string" }, { "id": "kommunkod", "label": "Kommunkod", "type": "string" }, { "id": "trakt", "label": "Trakt", "type": "string" }, { "id": "block", "label": "Block", "type": "string" }, { "id": "enhet", "label": "Enhet", "type": "int" }, { "id": "_3dutrymme", "label": " 3dutrymme", "type": "boolean" }, { "id": "agarlagenhetsfastighet", "label": "Agarlagenhetsfastighet", "type": "boolean" }, { "id": "arealuppgiftosaker", "label": "Arealuppgiftosaker", "type": "boolean" }, { "id": "urholkasav3dutrymme", "label": "Urholkasav3dutrymme", "type": "boolean" }, { "id": "urholkasavagarlagenhetsfastighet", "label": "Urholkasavagarlagenhetsfastighet", "type": "boolean" }, { "id": "totallandareal", "label": "Totallandareal", "type": "float" }, { "id": "totalvattenareal", "label": "Totalvattenareal", "type": "float" }, { "id": "totalareal", "label": "Totalareal", "type": "float" }, { "id": "vaningsplan", "label": "Vaningsplan", "type": "string" }, { "id": "omraden_antal", "label": "Omraden Antal", "type": "int" } ], "results": [ [ "909a6a7c-ceb0-90ec-e040-ed8f66444c3f", "LEVANDE", 2, "2024-05-22T18:34:22", "2024-05-22", "FASTIGHET", "21", "80", "FINNBÖLE", "5", 8, false, false, false, false, false, 176598, 0, 176598, null, 5 ] ] }

Snabbsök

Beskrivning

Sök dataenheter med sökord och få svar med förslag på träffar. Svaret innehåller ID för dataenhet, geografisk position samt benämning.

Sökväg

/services/api/v1/index/search

Request-parametrar

Namn

Beskrivning

Default

Obligatorisk

Namn

Beskrivning

Default

Obligatorisk

entity

Referens till dataslag

 

Ja

query

Sökord

 

Ja

crs

Referenssystem för koordinater

Samma som lagrad i datakälla

Nej

start

Första raden vid paginering

0

Nej

limit

Begränsa antal rader vid paginering

10

Nej

greedy

 

true

Nej

type

Söktyp

exact - använd sökterm

wildcard - Lägger till * i slutet av frågan

fuzzy - lägger till ~ i slutet av frågan

wildcard

Nej

Exempel

curl -X GET \ "https://test.ikartan.se/weave/services/api/v1/index/search?entity=fib.adress&query=myggda%203&crs=EPSG%3A3006&start=0&limit=1" \ -H "Content-Type: application/x-www-form-urlencoded" \ -H "Accept: application/json" \ -H "Authorization: Bearer <TOKEN>"

Svar

Hämta attribut från ID

Beskrivning

Hämta en eller flera dataenheter med ID och få svar med resultat från datadefinition.

Sökväg

services/api/v1/data/fetch/ids

Request-parametrar

Namn

Beskrivning

Default

Obligatorisk

Namn

Beskrivning

Default

Obligatorisk

data

Referens till datadefinition för resultat

 

Ja

includeKey

Inkludera nyckel i svar

Ja

Nej

metadata

Inkludera metadata för datadefinition

Nej

Nej

rowFormat

Radformat. object eller array

object

Nej

start

Första raden vid paginering

 

Nej

limit

Begränsa antal rader vid paginering

 

Nej

Exempel

Svar

Hämta geografisk information

Beskrivning

Hämta en eller flera dataenheter som GeoJSON Feature Collection med ID. Svaret innehåller geografisk position samt attribut från datadefinition.

Sökväg

services/api/v1/geometry/entities/feature

Request-parametrar

Body: Form-encode

Namn

Beskrivning

Default

Obligatorisk

Namn

Beskrivning

Default

Obligatorisk

datadefinition

Referens till datadefinition för resultat

 

Ja

entity

Referens till dataslag

 

Ja

ids

Lista med ID som efterfrågas. 1…n

 

Ja

crs

Referenssystem för koordinater

4326

Nej

Exempel

Attributsök

Attributsök är en sökdefinition för att söka ut eller filtrera en datatyp baserat på attribut eller egenskaper. Resultatet av en attributsökning är en lista med referenser/id som exempelvis användas för att hämta attributinformation (se Datadefinition nedan).

Mer information om attributsök finns här

Fastighet

fib.fastighet.update

Sök fastighet som förändrats inom datumspann.

Parametrar

Namn

Beskrivning

Obligatorisk

Namn

Beskrivning

Obligatorisk

municipality_code

Visa enbart poster som tillhör en kommun. Anges som kommunkod, exempelvis 2180 för Gävle

Nej

date_from

Tidigast Datum/tid för förändring.

Skrivs i formatet yyyy-MM-dd'T'HH:mm:ss

Nej

date_to

Senast Datum/tid för förändring.

Skrivs i formatet yyyy-MM-dd'T'HH:mm:ss

Nej

Fastighetsåtgärd

fib.fastighet.fastighetsatgard.update

Sök efter fastighetsåtgärder som förändrats inom datumspann och/eller relativt en registerenhet.

Parametrar

Namn

Beskrivning

Obligatorisk

Namn

Beskrivning

Obligatorisk

property_reference

UUID-referens till registerenhet. Begränsa urvalet till fastighetåtgärder för en specifik registerenhet.

Nej

date_from

Tidigast Datum/tid för förändring.

Skrivs i formatet yyyy-MM-dd'T'HH:mm:ss

Nej

date_to

Senast Datum/tid för förändring.

Skrivs i formatet yyyy-MM-dd'T'HH:mm:ss

Nej

Belägenhetsadress

fib.address.update

Sök efter adressplatser som förändrats inom datumspann

Parametrar

Namn

Beskrivning

Obligatorisk

Namn

Beskrivning

Obligatorisk

registerenhet

Hämta adressplatser kopplade till en specifik registerenhet

Nej

municipality_code

Visa enbart poster som tillhör en kommun. Anges som kommunkod, exempelvis 2180 för Gävle

Nej

date_from

Tidigast Datum/tid för förändring.

Skrivs i formatet yyyy-MM-dd'T'HH:mm:ss

Nej

date_to

Senast Datum/tid för förändring.

Skrivs i formatet yyyy-MM-dd'T'HH:mm:ss

Nej

Datadefinition

En datadefinition är en modell för tabulär data. Den beskrivs med en eller flera attribut och typ samt ett nyckelattribut som identifierar raden. Dataresultat från en datadefinition sker genom referens med ID (referens till nyckelattribut) eller understött av exempelvis Attributsök.

Mer information om datadefinitioner finns här.

Fastighet

dd.fib.fastighet

Grundläggande attribut för fastigheter

Namn

Beskrivning

Typ

Multiplicitet

Namn

Beskrivning

Typ

Multiplicitet

objektidentitet

Universellt unik identitet (UUID) för registerenheten.

string

1

status

En registerenhet kan vara levande eller avregistrerad.

string

1

objektversion

Objektets versionsnummer.

integer

1

versiongiltigfran

Tidpunkt när versionen började gälla. (Avser ej informationens giltighet och beslutsdatum.)

datetime

0..1

senasteandringallmannadelen

Datum när registerenheten senast ändrades i fastighetsregistrets allmänna del.

date

0..1

avregistreringsaktbeteckning

Datum när registerenheten har avregistrerats.

string

0..1

avregistreringsatgardstyp

Fastighetsrättslig åtgärd som medfört att registerenheten har avregistrerats.

string

0..1

avregistreringsdatum

Beteckning för den akt vars innehåll medfört att registerenheten har avregistrerats.

string

0..1

typ

Anger om registerenheter avser en fastighet eller samfällighet

string

1

lanskod

Kod för det län som registerenheten ligger i enligt SCB:s regionala indelning.

string

1

kommunkod

Kod för den kommun som registerenheten ligger i enligt SCB:s kommunindelning.

string

1

trakt

Indelning av ett registerområde i trakt eller kvarter och utgörs av de registerenheter som har samma namn. Motsvarar i regel bynamnet på landsbygden och stadsdelsnamn eller liknande inom tätort.

string

1

block

Indelning av ett registerområde i trakt eller kvarter och utgörs av de registerenheter som har samma namn. Motsvarar i regel bynamnet på landsbygden och stadsdelsnamn eller liknande inom tätort.

string

0..1

enhet

Numrering inom ett block eller kvarter.

int

1

_3dutrymme

Registerenheten omfattar ett eller flera 3D-utrymmen.

boolean

1

agarlagenhetsfastighet

Registerenheten är en Ägarlägenhetsfastighet

boolean

1

arealuppgiftosaker

Registerenhetens totala areal kan vara osäker.

boolean

1

urholkasav3dutrymme

Registerenheten urholkas av ett eller flera 3D-utrymmen.

boolean

1

urholkasavagarlagenhetsfastighet

Registerenheten urholkas av en eller flera fastigheter som är av typen ägarlägenhetsfastighet.

boolean

1

totallandareal

Registerenhetens totala landareal. Anges i tiondels kvm med punkt som decimalavskiljare.

float

0..1

totalvattenareal

Registerenhetens totala vattenareal. Anges i tiondels kvm med punkt som decimalavskiljare.

float

0..1

totalareal

Registerenhetens totala areal avseende både land och vatten. Anges i tiondels kvm med punkt som decimalavskiljare. För tredimensionella utrymmen och ägarlägenheter redovisas ingen areal.

float

0..1

vaningsplan

 

string

0..1

omraden_antal

Antal områden registerenheten består av

int

0..1

geometry

Geografisk representation som mittpunkt av registerenhetens samtliga områden. Presenteras som Well Known Text (WKT) i Sweref99TM. Exempel: “POINT(607845.7 6722209.1)” en punkt i Gävle.

string

0..1

Fastighetsåtgärd

dd.fib.fastighet.fastighetsatgard

Attribut för fastighetsåtgärder

Namn

Beskrivning

Typ

Multiplicitet

Namn

Beskrivning

Typ

Multiplicitet

objektidentitet

Universellt unik identitet (UUID) för fastighetsåtgärden.

string

1

objektversion

Objektets versionsnummer.

integer

1

versiongiltigfran

Tidpunkt när versionen började gälla. (Avser ej informationens giltighet och beslutsdatum.)

datetime

0..1

objektidentitet_registerenhet

Universellt unik identitet (UUID) för fastigheten som åtgärden avser.

string

1

aktbeteckning

Identifierare (beteckning) på den akt som innehåller lantmäterimyndighetens eller inskrivningsmyndighetens beslut. Beteckningens uppbyggnad varierar och består t.ex. av länskod, årtal, kommunkod, sockenkod och ett löpnummer.

string

0..1

atgardsanmarkning

Förtydligande av åtgärd i klartext.

string

0..1

atgardsdatum

Datum då en åtgärd finns tillgänglig i registret. För historiska uppgifter redovisas ofta datum när beslut vunnit laga kraft.

string

0..1

atgardstyp1

Åtgärd enligt gällande eller äldre lagstiftning.

string

1

atgardstyp2

Åtgärd enligt gällande eller äldre lagstiftning. Anges om det är två eller fler åtgärder i ärendet.

string

0..1

atgardstyp3

Åtgärd enligt gällande eller äldre lagstiftning. Anges om det är tre eller fler åtgärder i ärendet.

string

0..1

littera

Hänvisning till del av identitet på område som kan förekomma i gamla akter.

string

0..1

lopnummer

Unik nummerserie avseende åtgärder för varje registerenhet. Löpnummer används för att hålla samman förändringar. Åtgärd 1-9999 innebär fastighetsrättslig åtgärd, högre än 9999 innebär teknisk åtgärd.

int

0..1

Ursprung fastighet

dd.fib.fastighet.ursprung

Attribut för en med referenser till ursprungsfastighet

Namn

Beskrivning

Typ

Multiplicitet

Namn

Beskrivning

Typ

Multiplicitet

objektidentitet

Universellt unik identitet (UUID) för ursprungposten relaterad registerenheten.

string

1

objektversion

Objektets versionsnummer.

integer

1

versiongiltigfran

Tidpunkt när versionen började gälla. (Avser ej informationens giltighet och beslutsdatum.)

datetime

0..1

objektidentitet_registerenhet

Universellt unik identitet (UUID) för registerenheten som ursprunget avser.

string

1

objektidentitet_referens

Universellt unik identitet (UUID) för ursprungliga registerenheten.

string

1

Lagfaren ägare

dd.fib.fastighet.lagfarenagare

Attribut för lagfaren ägare relativt en registerenhet.

Namn

Beskrivning

Typ

Multiplicitet

Namn

Beskrivning

Typ

Multiplicitet

objektidentitet

Universellt unik identitet (UUID) för posten.

string

1

objektversion

Objektets versionsnummer.

integer

1

versiongiltigfran

Tidpunkt när versionen började gälla. (Avser ej informationens giltighet och beslutsdatum.)

datetime

0..1

inskrivningsdag

Den inskrivningsdag inskrivningen tillhör.

date

0..1

beslut

Beslut som fattats. Möjliga värden:

  • BEVILJAD

  • UPPSKOV

  • VILANDE

  • AVSLAG

  • AVVISAD

  • OKÄND

string

1

fornamn

Det förnamn som används som namn inkl. tilltalsnamn för fysisk person.

string

0..1

efternamn

Fysisk persons familjenamn.

string

0..1

organisationsnamn

Juridisk persons namn.

string

0..1

idnummer

Utgörs av personnummer, organisationsnummer, samordnings-nummer eller skattenummer (GD-nummer) som identifierar person.

string

0..1

taljare

Täljare i bråktal.

integer

0..1

namnare

Nämnare i bråktal.

integer

0..1

coadress

Care of adress.

string

0..1

utdelningsadress1

Adressen fortsätter här om adressen är lång.

string

0..1

utdelningsadress2

Adressen börjar här.

string

0..1

postnummer

Postnummer.

string

0..1

postort

Postort.

string

0..1

ua_utdelningsadress1

Utlandsadressens första rad.

string

0..1

ua_utdelningsadress2

Utlandsadressens andra rad.

string

0..1

ua_utdelningsadress3

Utlandsadressens tredje rad.

string

0..1

ua_utdelningsadress4

Utlandsadressens fjärde rad.

string

0..1

ua_land

Utlandsadressens Land.

string

0..1

Byggnad

dd.fib.fastighet.byggnad

Grundläggande attribut för byggnad kopplat till fastighet.

Namn

Beskrivning

Typ

Multiplicitet

Namn

Beskrivning

Typ

Multiplicitet

objektidentitet

Universellt unik identitet (UUID) för posten.

string

1

objektversion

Objektets versionsnummer.

integer

1

versiongiltigfran

Tidpunkt när versionen började gälla. (Avser ej informationens giltighet och beslutsdatum.)

datetime

0..1

objektstatus

Aktuell status för byggnadsobjektet. Status kan vara:

  • GÄLLANDE (en befintlig byggnad)

  • PLANERAD (byggnaden har godkänt/beviljat bygglov och är under uppförande)

  • GÄLLANDE_UNDER_UTREDNING (byggnaden har rivningslov)

string

1

husnummer

Unikt nummer på byggnaden inom den fastighet eller samfällighet som byggnaden ligger på.

int

0..1

huvudbyggnad

Byggnaden är huvudbyggnad i ett större komplex av byggnader.

boolean

0..1

nybyggnadsar

Årtal när byggnaden uppfördes.

int

0..1

tillbyggnadsar

Årtal för senaste tillbyggnad.

int

0..1

totalboarea

Hela boarean för alla ingående bostadslägenheter i en byggnad. Finns endast för byggnader som har bostadsändamål.

int

0..1

byggnadsyta

Geografiska ytan för byggnadens samtliga byggnadsdelar

int

1

Byggnadändamål

dd.fib.fastighet.byggnadandamal

Ändamål för en byggnad

Namn

Beskrivning

Typ

Multiplicitet

Namn

Beskrivning

Typ

Multiplicitet

andamal

Anger vilket ändamål byggnad används till. Ändamål kan vara:

  • BOSTAD

  • EKONOMIBYGGNAD

  • INDUSTRI

  • KOMPLEMENTBYGGNAD

  • OVRIGBYGGNAD

  • SAMHALLSFUNKTION

  • VERKSAMHET

string

1

huvudandamal

Byggnadens huvudändamål när byggnaden har flera ändamål.

boolean

0..1

specifiktandamal

Anger mer specifikt byggnadens ändamål. Värdet är beror på ändamålet.

  • BOSTAD

    • FLERFAMILJSHUS

    • SMÅHUS_FRILIGGANDE

    • SMÅHUS_KEDJEHUS

    • SMÅHUS_MED_FLERA_LÄGENHETER

    • SMÅHUS_RADHUS

    • OSPECIFICERAD

  • INDUSTRI

    • ANNAN_TILLVERKNINGSINDUSTRI

    • INDUSTRIHOTELL

    • METALL_ELLER_MASKININDUSTRI

    • OSPECIFICERAD

    • TEXTILINDUSTRI

    • TRÄVARUINDUSTRI

    • ÖVRIG_INDUSTRIBYGGNAD

  • SAMHALLSFUNKTION

    • BADHUS

    • BRANDSTATION

    • BUSSTATION

    • DJURSJUKHUS

    • HÖGSKOLA

    • ISHALL

    • JÄRNVÄGSSTATION

    • KOMMUNHUS

    • KRIMINALVÅRDSANSTALT

    • KULTURBYGGNAD

    • MULTIARENA

    • OSPECIFICERAD

    • POLISSTATION

    • RIDHUS

    • SAMFUND

    • SJUKHUS

    • SKOLA

    • SPORTHALL

    • VÅRDCENTRAL

    • UNIVERSITET

string

0..1

totalboarea

Hela boarean för alla ingående bostadslägenheter i en byggnad.Finns endast för byggnader som har bostadsändamål.

int

0..1

Belägenhetsadress

dd.fib.address

Attribut för adressplatser

Namn

Beskrivning

Typ

Multiplicitet

Namn

Beskrivning

Typ

Multiplicitet

objektidentitet

Universellt unik identitet (UUID) för adressplatsen.

string

1

objektstatus

Belägenhetsadressens objektstatus. Alltid Gällande.

string

1

objektversion

Objektets versionsnummer.

integer

1

versiongiltigfran

Tidpunkt när versionen började gälla. (Avser ej informationens giltighet och beslutsdatum.)

datetime

0..1

kommunkod

Referens med kommunkod till den kommun den geografiska kommundelen tillhör. Exempel 2180.

string

1

kommunnamn

Referens med kommunnamn till den kommun den geografiska kommundelen tillhör. Exempel Gävle.

string

1

kommundel

Av kommunen fastställt namn för den geografiska kommundelen. Namnet ska vara unikt inom kommunen. Anger namn på kommundel för adressplatsen. Används för att skilja flera adressområden med samma namn inom en kommun.

string

1

adressplatstyp

Typ av adressplats. En av:

  • Gatuadressplats

  • Metertalsadressplats

  • Byadressplats

  • Gårdsadressplats

string

1

adressomrade

Namnet på adressområdet.Namnet är unikt inom den geografiska kommundelen. För en kommun kan samma fastställda namn på adressområdet finnas i flera geografiska kommundelar.

string

1

adressplatsnummer

Adressnummer som sätts på adressplatserna inom ett adressområde.

string

1

bokstavstillagg

Ett tillägg till adressplatsnumret i form av en eller två bokstäver.

string

0..1

postnummer

Adressplatsens postnummer fastställd av PostNord AB.

int

0..1

postort

Adressplatsens postort, fastställd av PostNord AB.

string

0..1

insamlingslage

Punktläge för adressplatsen. En av:

  • Byggnad

  • Ingång

  • Infart

  • Tomtplats

  • Ungefärligt lägesbestämd

  • Övrigt läge

string

1

registerenhet

Universellt unik identitet (UUID) för den registerenhet belägenhetsadressen tillhör

string

1

geometry

Geografisk representation av belägenhetsadressen. Presenteras som Well Known Text (WKT) i Sweref99TM. Exempel: “POINT(607845.7 6722209.1)” en punkt i Gävle.

string

0..1