Hopp til innhold

DOKUMENTASJON

Data og modeller via API og MCP.

Prøvetilgang på forespørsel · 100 oppslag i 14 dager · uten betalingskort

Be om prøvetilgang, så åpner vi kontoen din med 100 oppslag i 14 dager. Koble interne systemer til REST og KI-agenter til MCP. Hvert API har sin egen referanse med parametere, svar og feilkoder, generert fra kontrakten API-et faktisk serverer.

Det viktigste er ikke feltlistene. Det er forbeholdene: hva en verdi ikke betyr. En tom seksjon må leses sammen med kildestatus og dekning; den fastslår ikke fravær av fare.

API-versjon
1.33.0
Seksjoner
248
Felter
3 856
Med offentlige demofelter
172
Innhold

Kom i gang

  1. Be om tilgang. Be om prøvetilgang — prøvetilgangen åpnes etter en kort forespørsel. Vi åpner kontoen din, og den er den samme som for alle Approach-tjenester.
  2. Hent en prøvenøkkel under Konto → Datakilde: prøvenøkkelen har 100 kall som teller som oppslag, i 14 dager, med de åpne feltene fra demoen. Nøkkelen vises bare én gang: lagre den i miljøvariabelen APPROACH_API_KEY på serveren din, aldri i nettleserkode eller kildekontroll.
  3. Gjør det første kallet. Søk er gratis og teller ikke som oppslag. Svaret er adressekandidater; la brukeren velge, og bruk address_id-en videre.
    curl --disable --fail-with-body --silent --show-error --connect-timeout 10 --max-time 30 \
      -H "X-API-Key: ${APPROACH_API_KEY:?APPROACH_API_KEY is not set}" \
      'https://api.approach.no/api/v1/addresses/search?q=Storgata+1'
  4. Les koordinatene. Hver kandidat i søket, og address-objektet øverst i hver adresseprofil (også fra /resolve), har punktet i to systemer: lat og lon i WGS84-grader for kart og geokoding, og easting_utm33 og northing_utm33 i meter, EPSG:25833, som er Kartverkets autoritative koordinater. coordinate_system i svaret sier hvilket UTM-system som brukes. Seksjonen address_details har de samme fire feltene.
    curl --disable --fail-with-body --silent --show-error --connect-timeout 10 --max-time 30 \
      -H "X-API-Key: ${APPROACH_API_KEY:?APPROACH_API_KEY is not set}" \
      'https://api.approach.no/api/v1/addresses/search?q=Storgata+1' \
      | jq '.candidates[] | {address_id, lat, lon, easting_utm33, northing_utm33}'

Prøv uten nøkkel

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.

Hvor finner jeg adressefeltene i JSON?

Gate, husnummer, poststed og koordinater ligger i address øverst i det autentiserte profilsvaret, for eksempel address.street_name. Den offentlige demoen viser også denne åpne adresseidentiteten som address_details. Med full feltpolicy har sections.address_details.records derimot en egen kontrakt for matrikkelidentifikatorer og koordinater; ikke forvent alle gate- og postfeltene der.

imported_at er lokal importtid, ikke dokumentasjon på hvor fersk originalkilden er. Manglende eller null verdier betyr ikke at opplysningen er verifisert. Tilgang og feltpolicy gjelder fortsatt for hver seksjon.

Samme kall i ditt språk

De samme fire språkene og den samme koden som utprøvingen på kontosiden. Nøkkelen leses fra miljøet.

curl --disable --fail-with-body --silent --show-error --connect-timeout 10 --max-time 30 \
  -H "X-API-Key: ${APPROACH_API_KEY:?APPROACH_API_KEY is not set}" \
  'https://api.approach.no/api/v1/addresses/search?q=Storgata+1'

Å lese svaret

Hver seksjon har sin egen status og freshness. Forgren på dem før du bruker en verdi: available betyr at seksjonen returnerte poster, not_found at det tilgjengelige datagrunnlaget ikke ga poster for adressen, unavailable at seksjonen ikke kunne leses, og restricted at nøkkelen ikke har tilgang. Se reason og dekning; en tom seksjon er ikke et fravær i virkeligheten. Alle verdiene forklart.

Hele svaret eller et utvalg

Uten valg får du standardpakken core. Be om bestemte seksjoner med sections=a,b, en pakke med package=<id>, eller alt med package=all. Et utvalg er raskere, men koster det samme ene oppslaget per objekt per dag. Les hele veiledningen.

Nøkler og innlogging

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. Bruk «Roter» på kontosiden: du får en ny nøkkel, og den gamle virker videre i 24 timer så du rekker å bytte den inn. Vil du stoppe den gamle med en gang, kan du velge det i samme dialog. Utlogging og passordbytte tilbakekaller ikke API-nøkler. Ved mistanke om lekkasje: tilbakekall nøkkelen straks.

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.

Bedriftspilot og nye data

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 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å.

Kontakt oss om pilot, nye data eller hjelp

Fra en KI-assistent (MCP)

Den driftede MCP-serveren tilbyr Datakilde-verktøy med samme tilganger og kvoter som API-nøkkelen. MCP-endepunktet er https://mcp.approach.no/mcp. Det krever Authorization: Bearer med en personlig Datakilde-nøkkel. En connector uten innlogging gir ikke tilgang.

Claude · personlig connector

Claude tilbyr egendefinerte remote MCP-connectors på Free (én connector), Pro, Max, Team og Enterprise, og dokumenterer faste request-headere for API-nøkler. På Team og Enterprise må en eier først legge til connectoren for organisasjonen. Legg til MCP-adressen https://mcp.approach.no/mcp og Authorization-headeren Bearer med din personlige Datakilde-nøkkel. Koblingen er ikke testet ende til ende ennå.

Bruk bare din egen personlige connector og hold API-nøkkelen privat. Ikke legg en personlig nøkkel i en delt Team- eller Enterprise-connector: alle som bruker connectoren vil få nøkkelens Datakilde-tilgang.

Åpne Claude Connectors · Åpne Claudes offisielle guide til egendefinerte MCP-connectors

ChatGPT · egendefinert MCP

OpenAI oppgir at egendefinerte MCP-servere er tilgjengelige på ChatGPT Business og Enterprise/Edu på web. Arbeidsområdets tillatelser gjelder. Datakilde krever en Bearer-nøkkel, men tilbyr ikke per-bruker OAuth for MCP ennå og kan derfor ikke kobles trygt til ChatGPT. Ikke velg «No authentication», og ikke lim inn eller del en personlig nøkkel.

Les OpenAIs offisielle oppsettsveiledning

Bruk detaljene under bare i MCP-klienter som støtter en sikker, personlig Bearer-header. ChatGPT kan ikke bruke denne statiske nøkkelen; vent til Datakilde tilbyr OAuth for ChatGPT.

URL: https://mcp.approach.no/mcp
Authorization: Bearer $APPROACH_API_KEY

$APPROACH_API_KEY er en plassholder, ikke en nøkkel. Klienten erstatter den bare hvis den uttrykkelig støtter miljøvariabler; ellers lagre din personlige nøkkel i klientens sikre hemmelighetslager. Ingen npm-pakke er publisert ennå; OpenAPI-dokumentet kan brukes til å generere en vanlig API-klient.

Lagre nøkkelen i klientens hemmelighetslager; ikke legg den i URL, samtale, skjermbilde eller offentlig kode. En generisk HTTP-klient som støtter Authorization-header, er ikke i seg selv en bekreftet Claude-integrasjon.

Skrivebeskyttet betyr ikke gratis: oppslag kan telle mot abonnementets kvoter og fakturering. Verktøymerking er hint til klienten, ikke en tillatelse eller garanti for bekreftelse. Be assistenten innhente din uttrykkelige bekreftelse før den starter eller stopper overvåking; dette endrer kontoen og kan påvirke faktureringen. Kontroller klientens godkjenningsinnstillinger før bruk.

API-ene

Datakilde-nøkkelen kan brukes mot flere API-er når både seksjonstilgang og produktplan tillater det. Prosjekter har egne nøkler. En nøkkel er ikke et abonnement; kjøpt kvote åpner ikke avtalebeskyttede felt.

APIHva det girNøkkel og tilgangMåles iKontrakt
AdresserAdresse- og eiendomsoppslag, 248 seksjonerDatakilde-nøkkel · adresseseksjoneroppslagOpenAPI
SelskaperSelskapsoppslag på organisasjonsnummerSamme nøkkel · selskapsseksjoneroppslagOpenAPI
SelskapsovervåkingVarsler om hendelser for selskaper du følger, med webhookSamme nøkkel · eget overvåkingsabonnementfulgt selskap per månedOpenAPI
RegionerKommune- og fylkesdataSamme nøkkel · regionseksjoneroppslagOpenAPI
Tidsserier98 åpne tidsserierSamme nøkkel · egen seriekvotepåbegynte 1 000 datapunkterOpenAPI
ObservasjonerTrafikk, vær og vannstand ved en adresse som tidsserie og profilSamme nøkkel · adresseseksjonene variabelen hører tilinngår i oppslaget for adressenOpenAPI
DataprodukterFerdige svar for en adresse, en liste eller et helt områdeSamme nøkkel · adresseseksjoner og produktplancelleOpenAPI
SverigeEt punkt i Sverige: kommune, flomkart, brønner, vernet natur og varslerSamme nøkkel · Sverige-tilgangoppslagOpenAPI
ModellerApproachs beregninger for en adresse eller et punkt: støy, naturfare og merSamme nøkkel · modellkapabilitetoppslag per modellOpenAPI
ProsjekterKildebelagte prosjektforslag i kontoarbeidsrommetEgen Prosjekter-nøkkel · aktivt abonnementprofiloppslag · egen månedskvoteArbeidsrom

Datasett-API-et (hele tabeller med inkrementell synkronisering) har en egen tilgang og foreløpig bare sin OpenAPI-kontrakt.

Datakilde Prosjekter · kontoarbeidsrom

Et kildebelagt utvalg fra Oslobygg KFs investeringsforslag for 2027. Arbeidsrommet krever et aktivt Prosjekter-abonnement og egne Prosjekter-nøkler. Adresse-API-nøkler gir ikke tilgang. API-basen er /v1/datakilde/projects/api.

Åpne Prosjekter-arbeidsrommet

Autentisering

Send nøkkelen i X-API-Key-headeren på hvert kall. Nøkler utstedes per organisasjon, med eksplisitte seksjonstilganger; en pakke gir aldri tilgang til en ny kilde. Et kall uten gyldig nøkkel får 401 med en WWW-Authenticate-header, og et reason-felt som sier hvorfor nøkkelen ble avvist.

X-API-Key: $APPROACH_API_KEY

Hold nøkkelen på serveren. Nettleserkode, mobilapper og kildekontroll er steder den lekker fra. /access viser hva nøkkelen din har tilgang til, og når tilgangen utløper.

IP-begrensning

En nøkkel kan begrenses til opptil 50 IPv4- eller IPv6-adresser og CIDR-nettverk, når den lages eller senere under Nøkler på kontosiden. Adressen som sammenlignes, er den API-et ser som avsender (bak vår proxy: adressen proxyen skrev, aldri en X-Forwarded-For-header klienten sendte selv). Et kall fra en annen adresse får 403 ip_not_allowlisted med adressen API-et så i client_ip, og telles eller faktureres ikke. En tom liste betyr ingen begrensning. Endringer gjelder innen omtrent 15 sekunder. Nøkler med IP-begrensning kan ikke testes i API-testeren på kontosiden.

Hva som teller som et oppslag

Et oppslag er én adresse (eller ett selskap eller én region) per organisasjon per kalenderdøgn, norsk tid. Å hente en adresses profil, to av seksjonene og historikken samme dag er ett oppslag. Bare vellykkede svar (2xx) telles: en feil fra oss, en 429 eller en 4xx telles aldri.

KallTeller?
GET /addresses/{id}, /{id}/sections/{s}, /{id}/historyja, per adresse
GET /companies/{id}, /{id}/profile, /{id}/sections/{s}ja, per selskap
GET /regions/{id}, /{id}/sections/{s}ja, per region
GET /addresses/search, /propertiesnei, gratis
POST /addresses/resolvegratis når den bare identifiserer adressen (address_details); ellers ett oppslag, som GET /addresses/{id}
/access, /usage, /catalog, /openapi.jsonnei, gratis
Tidsserier, dataprodukter, overvåkingegne enheter, se hvert API

Prøvetilgang på forespørsel · 100 oppslag i 14 dager · uten betalingskort. Prøveoppslagene gjelder adresser, selskaper og regioner. I selvbetjent prøve- og forhåndsbetalt tilgang belaster testkall ikke denne kvoten, men har et daglig tak. Avtalte bedriftsabonnementer kan ha andre testgrenser og kan telle testoppslag ut over en fri månedskvote etter at faktureringen har startet. Testnøkler bruker samme API og data, ikke et eget testmiljø. Et oppslag der mer enn 20 % av de etterspurte seksjonene feilet hos oss, telles ikke; X-Request-Billing sier da not_billed_partial_failure. Et oppslag der ingen etterspurt seksjon ga data, telles heller ikke (not_billed_no_data). Priser og kvoter.

Grenser

Hver tilgang har et antall kall per minutt (prøvetilgangen har 60). X-RateLimit-Limit, -Remaining og -Reset står på svarene; over grensen svarer API-et 429 rate_limit_exceeded med Retry-After i sekunder. Vent så lenge før neste forsøk. En ny nøkkel gir ikke ny grense eller ny kvote: begge hører til organisasjonen.

Når kvoten er brukt opp, svarer API-et 402 med en kode som sier hvorfor: request_allowance_exhausted, monthly_safety_cap_reached eller product_plan_required. X-Request-Budget og X-Request-Budget-Remaining viser hvor du står. Alle feilkodene · Alle svarhodene

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. En markør som brukes et annet sted, gir 400 invalid_cursor.

Status og ferskhet

HTTP 200 bekrefter ikke at alle seksjoner lyktes. Hver seksjon svarer for seg; en feil tar ikke resten med seg. partial kan også være true når returnerte data er stale eller uten brukbare verdier, eller en delberegning mangler. Les seksjonenes status, freshness, quality og error sammen med partial_reasons og failed_sections; en tom failed_sections-liste betyr ikke komplett dekning.

status

VerdiBetydning
availableKilden svarte, og det finnes minst én post på denne siden.
not_foundKilden 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.
restrictedNøkkelen som kaller har ingen tilgang til denne seksjonen. Ingen poster returneres, og ingen ble lest.
unavailableSeksjonen 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

VerdiBetydning
cachedPostene har et kildetidsstempel innenfor seksjonens maksimale alder.
liveHentet direkte fra kilden for dette oppslaget. Dette beskriver hentingen, ikke alderen eller fullstendigheten til kildens opplysninger.
stalePostene har et kildetidsstempel eldre enn seksjonens maksimale alder. De returneres likevel; å avgjøre om det betyr noe er ditt.
unverifiedPostene har ikke noe kildetidsstempel, så alderen er ukjent. Det er ikke en påstand om at de er ferske.