Datakilde API-referanse

Kom i gang

Den offentlige demoen svarer uten nøkkel. Prøv den først — det er den raskeste måten å finne ut om dataene holder for formålet ditt.

curl "https://api.approach.no/api/v1/address-demo/search?q=Storgata%201"
curl "https://api.approach.no/api/v1/address-demo/285717643"

Det autentiserte API-et bruker samme adresse-ID-er, og tar en API-nøkkel i X-API-Key-headeren. Nøkler utstedes per organisasjon, med eksplisitte seksjonstilganger — en pakke gir aldri tilgang til en ny kilde.

curl -H "X-API-Key: $APPROACH_API_KEY" \
  "https://api.approach.no/api/v1/addresses/285717643?include=address_details,hazard_zones"

Opprett konto og hent en nøkkel — ti gratis kall med prøvenøkkelen, deretter kvoter du kjøper fra kontosiden. Trenger du tilpassede data? Data fra Matrikkelen og andre tilgangsbegrensede kilder krever en egen avtale og slås på per konto.

Innlogging og API-nøkler

Når du bruker kontosidene, fornyes innloggingen automatisk i opptil sju dager. Deretter logger du inn igjen. Utlogging avslutter denne økten. Tilbakestilling av passord avslutter alle øktene.

API-nøkler er separate fra innloggingen og fornyes ikke automatisk. Opprett en ny nøkkel på kontosiden, lagre den sikkert, oppdater integrasjonen og bekreft at den virker før du tilbakekaller den gamle. Knappen «Roter» tilbakekaller den gamle nøkkelen med en gang. Utlogging og passordbytte tilbakekaller ikke API-nøkler. Ved mistanke om lekkasje: tilbakekall nøkkelen straks.

401: kontroller nøkkelen og utløpsdatoen. 403: kontroller tilganger. 402: kontroller kvote eller abonnement. 429: vent som angitt i Retry-After før du prøver igjen. En ny nøkkel gir ikke ny kvote.

Bedriftspilot, nye data og hjelp

Start med ett bruksområde og fem prioriterte felt. Avtal 20–50 testadresser, datatilganger og en egnet kvote med oss før dere bygger prototypen. Den vanlige prøvenøkkelen har ti kall og gir ikke tilgang til alle feltene i katalogen.

Send oss feltene dere savner, ønsket oppdateringshyppighet og eksempler på hva dataene skal brukes til. Nye kilder og bedre dekning prioriteres etter behov, kvalitet og bruksrettigheter; katalogen viser det som er tilgjengelig nå.

Nøkler tilhører personen som opprettet dem, selv når de bruker firmaets avtale. Før personen slutter eller sletter kontoen: la en annen administrator opprette en erstatningsnøkkel, oppdater og test integrasjonen, og tilbakekall den gamle nøkkelen.

Ved feil: oppgi tidspunkt, endepunkt, HTTP-status og Request ID fra Forbruk og logger. Ikke send API-nøkler eller passord.

Kontakt oss om pilot, nye data eller hjelp

Fra søk til første oppslag

Kjør på serveren. Sett APPROACH_API_KEY i miljøet og send den i X-API-Key-headeren. Søk, og la brukeren velge adresse-ID før oppslaget. Nøkler skal ikke ligge i nettleserkode eller kildekontroll.

// Node.js: keep the key on your server, in an environment variable.
const base = 'https://api.approach.no/api/v1/addresses';
const headers = { 'X-API-Key': process.env.APPROACH_API_KEY };
const search = await fetch(base + '/search?q=Storgata%2012', { headers });
if (!search.ok) throw new Error(await search.text());
const { candidates } = await search.json();
console.log(candidates); // Let your user choose; do not silently pick a home.
// After selection, set ADDRESS_ID to that candidate's address_id.
if (process.env.ADDRESS_ID) {
  const response = await fetch(base + '/' + process.env.ADDRESS_ID + '/sections/address_details', { headers });
  if (!response.ok) throw new Error(await response.text());
  console.log(await response.json());
} // Inspect status, freshness and source.

Prøv et kall herfra

Uten nøkkel og uten konto. Svaret under er det API-et returnerte nå — ikke et eksempel som var riktig en gang. Hver seksjon har den samme knappen på sin egen side.

Endepunkter

Autentisert

https://api.approach.no/api/v1/addresses

GET/cataloguten nøkkel

List alle seksjoner og feltkontrakten deres. Katalogen er kontrakten. Den returnerer feltene, kilden, det geografiske nivået, maksimal nyttig alder og forbeholdene for hver seksjon, og den er det denne referansen genereres fra. Les den ved kjøretid i stedet for å låse en feltliste.

GET/openapi.jsonuten nøkkel

OpenAPI 3.1-dokument for hele API-et. Hver seksjon har et generert skjema for postene sine, så en klient generert fra dette dokumentet kjenner formen på hver seksjons poster i stedet for å behandle dem som fritt JSON.

POST/resolve

Slå opp en adresse og returner seksjonene. Tar enten en address_id eller nøyaktig gate, nummer, bokstav og postnummer — aldri et fritekstsøk. En adresse som treffer mer enn én post returnerer kandidatene i stedet for å gjette.

{"street_name":"Storgata","house_number":1,"postal_code":"0155","include":["address_details","hazard_zones"]}

GET/search

Finn aktuelle adresser med tekst. Prefiks- og eksaktmatch på gatenavn, nummer, bokstav og postnummer, med valgfrie filtre på postal_code, municipality_code eller municipality. Returnerer adresseidentiteter.

?q=Storgata%201&postal_code=0155

GET/{address_id}

Hent én adresse med alle eller utvalgte seksjoner. include velger seksjoner; package velger et kuratert utvalg. De to kan ikke kombineres. Seksjonene hentes parallelt, og hver bærer sin egen status.

?include=address_details,hazard_zones,ground_conditions

GET/{address_id}/sections/{section}

Hent én seksjon, med paginering. Send next_cursor fra forrige svar; en markør er bundet til sin adresse og seksjon og avvises alle andre steder.

?limit=25

GET/{address_id}/history

Eksporter tillatte tidsserier for området. Krever tilgang til history-endepunktet og de tilhørende profilseksjonene. Returnerer tillatte serier som JSON eller CSV. from/to godtar YYYY eller YYYY-MM. Manglende perioder betyr ikke null hendelser, og pågående perioder kan være foreløpige. Ett vellykket historikkall bruker ett oppslag av kvoten, uavhengig av antall rader.

?from=2024&to=2025&format=json

GET/{address_id}/properties

Matrikkelkontekst for en adresse. Registrerte matrikkelenheter knyttet til adressen. Bruk limit og cursor for neste side med adressekandidater. Kildekontrollert paginering krever også matrikkelenhet_id.

?limit=10

GET/properties

Finn adresser for en matrikkeleiendom. Oppgi municipality_code, gnr og bnr. Bruk limit og eiendomsbundet cursor for paginering. Fnr, snr og matrikkelenhet_id krever kontrollert kildeidentitet.

?municipality_code=0301&gnr=1&bnr=2&limit=10

GET/access

Se dine egne tilganger og når de utløper. Svarer bare for nøkkelen som kaller. Det finnes ingen kunde- eller nøkkelidentifikator fra kalleren, så én kunde kan ikke spørre om en annen.

GET/usage

Se ditt eget registrerte forbruk siste 30 dager. Samme avgrensning som /access.

GET/healthuten nøkkel

Oppetid og utrullet versjon. Rapporterer hvilken utgave som kjører, så en klient kan se hvilken kontraktsversjon som svarte.

Offentlig demo

https://api.approach.no/api/v1/address-demo

GET/search

Søk etter adresser uten nøkkel. Den åpne demoen. Samme matching som det autentiserte søket, med et lavere fast tak, og den returnerer bare adresseidentiteter.

?q=Storgata

GET/{address_id}

Les demoprojeksjonen for én adresse. Returnerer bare feltene som står i den gjennomgåtte publiseringspolicyen, for seksjonene som bærer dem. Lisensierte og personopplysninger er aldri med.

GET/catalog

List hva demoen publiserer. Demoens egen katalog, som merker hvilke seksjoner en anonym kaller kan lese verdier fra og hvilke som er listet, men begrenset.

Å lese et svar

Hver seksjon svarer for seg. En seksjon som feiler tar ikke resten med seg, og responsens partial sier at minst én ikke kunne leses. De to feltene du må forgrene på er status og freshness.

status

Verdi	Betydning
available	Kilden svarte, og det finnes minst én post på denne siden.
not_found	Kilden ble spurt og returnerte ingen poster for adressen. For kartlag gjelder dette det lokalt innlastede datasettet og dets dekning, ikke alle kartlagte områder eller fravær av fare.
restricted	Nøkkelen som kaller har ingen tilgang til denne seksjonen. Ingen poster returneres, og ingen ble lest.
unavailable	Seksjonen kunne ikke leses. error sier hvorfor: source_not_loaded betyr at tabellen ennå ikke er hentet inn, source_empty at den er hentet og ikke har rader noe sted (et varselfeed uten aktive varsler er tomt, ikke ødelagt), source_read_access_missing at API-rollen ikke får lese den, source_timeout at spørringen ikke ble ferdig, source_schema_outdated at en innsamler ennå ikke har oppgradert tabellen. Ingen av dem sier noe om adressen.

freshness

Verdi	Betydning
cached	Postene har et kildetidsstempel innenfor seksjonens maksimale alder.
live	Hentet direkte fra kilden for dette oppslaget. Dette beskriver hentingen, ikke alderen eller fullstendigheten til kildens opplysninger.
stale	Postene har et kildetidsstempel eldre enn seksjonens maksimale alder. De returneres likevel; å avgjøre om det betyr noe er ditt.
unverified	Postene har ikke noe kildetidsstempel, så alderen er ukjent. Det er ikke en påstand om at de er ferske.

Paginering

Både seksjons- og eiendomsendepunktene paginerer. Send next_cursor som cursor med samme filtre. Seksjonsmarkører er bundet til adresse og seksjon; eiendomsmarkører er bundet til eiendommen. Kildekontrollert eiendom krever også matrikkelenhet_id.

Feil

Kode	Betydning
400	Ugyldig inndata, ukjent seksjon, eller en markør som ikke hører til denne adressen og seksjonen.
401	Ingen nøkkel, eller en som ikke kunne verifiseres.
402	Kontoens kallkvote er brukt opp. Se kvoten og kjøpsalternativene på kontosiden. Gjentatte forsøk fyller ikke opp kvoten.
403	Autentisert, men uten en aktiv adressetilgang — eller en seksjon denne nøkkelen ikke har tilgang til.
404	Ingen adresse passer.
409	Adressen traff mer enn én post. Kandidatene returneres; velg én og slå opp på address_id.
429	For mange kall per minutt. Retry-After sier hvor mange sekunder du må vente.
503	Selve adresseregisteret kunne ikke leses. Det er noe annet enn at en seksjon er utilgjengelig.

Pakker

En pakke er et ferdig utvalg seksjoner, ikke en rettighet. Seksjonstilgangene gjelder like fullt etter at pakken er utvidet.

home_profile4 seksjoner

Boligprofil. Adresseidentitet og lagrede boligopplysninger. Bygningsdekning og mottakers rett til dataene må kontrolleres; en pakke slår ikke fast at kilden er komplett, og gir ingen tilganger.

prevention_context10 seksjoner

Forebyggingskontekst. Observasjoner, varsler, kjente nødetatslokaler og kommunal kriminalitetsstatistikk. Kjøretid er ikke utrykningstid, og områdestatistikk er ingen risikoscore for en husstand.

area_context8 seksjoner

Områdekontekst. Valgfri kommunal statistikk og trafikksensorer i nærheten. Dette er kontekst for området, ikke egenskaper ved husstanden og ikke en sanntidstjeneste for trafikk.

hazard_screen17 seksjoner

Faresiling. Kartlagte naturfaresoner, hendelser og silingsscorer rundt adressen. Kartlagt betyr prioriterte områder; en tom seksjon betyr ukartlagt, ikke trygt, og ingenting her erstatter en vurdering på stedet.

environment_nuisance12 seksjoner

Miljø og ulemper. Støy, kraftnett og forurensning fra strategisk kartlegging og registre; soner og nærhet, ikke målinger ved fasaden.

neighbourhood_life15 seksjoner

Nærmiljø. Daglige målpunkter i luftlinje fra åpne registre og OpenStreetMap; forekomst og posisjon slik de er publisert, og OSM-innhold er ODbL.

outdoor_recreation12 seksjoner

Friluftsliv. Stier, friluftsområder, naturvern og modellert sol og utsikt rundt adressen.

planning_restrictions15 seksjoner

Planer og restriksjoner. Planer, kulturminnevern, servituttlignende begrensninger og endringssignaler rundt adressen. Begrensninger er indikasjoner som må bekreftes hos myndigheten, aldri en juridisk vurdering.

civil_protection11 seksjoner

Samfunnssikkerhet. Nødetatslokaler, tilfluktsrom og geografien til nødmeldetjenesten. Luftlinje er ikke utrykningstid.

local_economy9 seksjoner

Lokal økonomi. Aggregert nærings-, konkurs-, investor- og samfunnskontekst for postnummeret og distriktet; ingenting om enkeltpersoner eller husstander.

Alle seksjoner (176)

Seksjonsnavnene er på norsk. Feltnavn, feltbeskrivelser og forbehold står på engelsk, fordi det er språket i selve kontrakten — det API-et returnerer og det /catalog serverer.

Hver seksjon har sin egen side med felter, typer, kilde, dekning og forbehold — og en levende prøve for dem demoen publiserer.

Søk etter seksjon eller kildeBare seksjoner med åpen forhåndsvisning

Viser 24 av 176 seksjoner

Ett adresseoppslag, hele konteksten.