Parametere, grenser og svar er hentet fra OpenAPI-dokumentet API-et serverer, og feilkodene fra den samme tabellen API-et bruker. Beskrivelsene av parameterne står på engelsk, som i kontrakten.
Innhold
Med nøkkel
https://api.approach.no/api/v1/addresses
GET
/catalog
uten 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.
Tar ingen parametere.
Svar og feilkoder
HTTP
Betydning
Koder i svaret
200
Section catalog (each section with its category, kind, sensitivity and time shape), the categories in display order, packages and the defaults an unqualified request gets.
List modellene Datakilde beregner selv. Hver modell er en vanlig seksjon med en modellblokk i beskrivelsen: spørsmålet den svarer på, typen metode, inndata, hva den er kontrollert mot og hovedfeltene. Hent én med ?include=<id>, eller alle for en adresse med ?package=models. Hver post har method, method_version, inputs og validation, og første forbehold sier hva anslaget ikke er.
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.
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.
Curated include preset from /catalog; cannot be combined with include. Section grants still apply. With neither include nor package the default package (core, see /catalog defaults) is returned; package=all returns every section.
meta spørring
string
full | compact standard compact
compact (default) serializes source as {id, version, access, max_age_hours, max_age_days} and quality without present_by_field and value_fields: the descriptor is the /catalog entry for that id and version. full repeats each section's complete source descriptor and per-field quality.
limit spørring
integer
1–100 standard 100
—
address_id innhold
string
^[0-9]{1,18}$
—
house_number innhold
integer
1–99999
—
include innhold
array<string>
—
—
letter innhold
string
—
—
postal_code innhold
string
^[0-9]{4}$
—
street_name innhold
string
1–255 tegn
—
Svar og feilkoder
HTTP
Betydning
Koder i svaret
200
Resolved address; inspect partial, failed_sections and each section status. A request with neither include nor package returns every section and says so in X-Sections-Hint.
Finn aktuelle adresser med tekst. Prefiks- og eksaktmatch på gatenavn, nummer, bokstav og postnummer, med skrivefeiltolerante forslag når ingenting matcher. Finnes gaten, men ikke husnummeret, kommer de nærmeste numrene på gaten tilbake, merket som det (match_mode nearest_number). Et stedsnavn i søket (Storgata 12 Tromsø, Rådhusgata Stavanger) avgrenser treffene til stedet, og place.status sier fra når gaten ikke finnes der. Valgfrie filtre på postal_code, municipality_code eller municipality. Returnerer adresseidentiteter.
Parametere
Navn
Type
Grenser og standard
Beskrivelse
q spørring
string
2–160 tegn
At least 2 characters. Street prefix, optional house number/letter and place or postcode (Storgata 12 Oslo; Storgata 12A, Bergen; Storgata 12 A, 0155), a 2–4 digit postcode prefix, or postal-area/municipality name prefix. A place after the house number, or a whole place name ending a street query without one (Rådhusgata Stavanger), is matched against postal area and municipality name, ignoring case and æ/ø/å (Tromso finds TROMSØ), and restricts the candidates to that place; the response's place says whether the street is there. When the typed street exists but its house number does not, match_mode=nearest_number returns the nearest existing numbers. When an informative street prefix has no result, match_mode=closest returns typo-tolerant street suggestions. Omit q when supplying a geographic filter. A search without a house letter includes all letters; exact /resolve retains its stricter meaning.
postal_code spørring
string
^[0-9]{4}$
Exact four-digit postcode filter
municipality_code spørring
string
^[0-9]{4}$
Exact four-digit municipality code; cannot combine with municipality
municipality spørring
string
2–100 tegn
Municipality name prefix, at least 2 characters; cannot combine with municipality_code
limit spørring
integer
1–20 standard 10
Maximum candidate count; has_more indicates that the query should be narrowed
cursor spørring
string
—
Opaque next_cursor from the previous page of the same query; paging is limited to the first 1000 results
Svar og feilkoder
HTTP
Betydning
Koder i svaret
200
Explicit candidates only. Empty candidates are a valid no-match result; never automatically choose the first record.
—
400
Invalid, repeated, conflicting or unknown query parameter
Active address access required; cadastral discovery needs address_details, source identities additionally buildings, and dwelling choices additionally dwelling_units. Full property filters without buildings grant are rejected.
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.
Curated include preset from /catalog; cannot be combined with include. Section grants still apply. With neither include nor package the default package (core, see /catalog defaults) is returned; package=all returns every section.
meta spørring
string
full | compact standard compact
compact (default) serializes source as {id, version, access, max_age_hours, max_age_days} and quality without present_by_field and value_fields: the descriptor is the /catalog entry for that id and version. full repeats each section's complete source descriptor and per-field quality.
limit spørring
integer
1–100 standard 100
—
Svar og feilkoder
HTTP
Betydning
Koder i svaret
200
Resolved address; inspect partial, failed_sections and each section status. A request with neither include nor package returns every section and says so in X-Sections-Hint.
compact (default) serializes source as {id, version, access, max_age_hours, max_age_days} and quality without present_by_field and value_fields: the descriptor is the /catalog entry for that id and version. full repeats each section's complete source descriptor and per-field quality.
limit spørring
integer
1–100 standard 100
—
Svar og feilkoder
HTTP
Betydning
Koder i svaret
200
Resolved address; inspect partial, failed_sections and each section status. A request with neither include nor package returns every section and says so in X-Sections-Hint.
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.
Parametere
Navn
Type
Grenser og standard
Beskrivelse
address_id sti · påkrevd
string
^[0-9]+$
—
from spørring
string
^\d{4}(-(0[1-9]|1[0-2]))?$
—
to spørring
string
^\d{4}(-(0[1-9]|1[0-2]))?$
—
format spørring
string
json | csv standard json
—
Svar og feilkoder
HTTP
Betydning
Koder i svaret
200
Permitted series only, with original period and geographic grain
Matrikkelkontekst for en adresse. Registrerte matrikkelenheter knyttet til adressen. Bruk limit og cursor for neste side med adressekandidater. Kildekontrollert paginering krever også matrikkelenhet_id.
Parametere
Navn
Type
Grenser og standard
Beskrivelse
address_id sti · påkrevd
string
^[0-9]{1,18}$
—
limit spørring
integer
1–100 standard 10
Address candidates per property per page
cursor spørring
string
—
Opaque next_cursor bound to the property. Source-checked pagination also requires matrikkelenhet_id; fallback cursors bind kommune/gnr/bnr.
fnr spørring
string
^[0-9]{1,8}$
Optional exact feste number from a checked Matrikkel snapshot. Omitted means all choices, 0 means explicit zero; unknown never matches zero. Returns 422 if no authorized checked identity is available.
snr spørring
string
^[0-9]{1,8}$
Optional exact section number from a checked snapshot. Omitted means all choices, 0 means explicit zero. Returns 422 if no authorized checked identity is available.
matrikkelenhet_id spørring
string
^[0-9]{1,18}$
Select one official property ID; required with a source-checked next_cursor
Svar og feilkoder
HTTP
Betydning
Koder i svaret
200
Explicit candidates only. Empty candidates are a valid no-match result; never automatically choose the first record.
—
400
Invalid, repeated, conflicting or unknown query parameter
Active address access required; cadastral discovery needs address_details, source identities additionally buildings, and dwelling choices additionally dwelling_units. Full property filters without buildings grant are rejected.
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.
Parametere
Navn
Type
Grenser og standard
Beskrivelse
municipality_code spørring · påkrevd
string
^[0-9]{4}$
Municipality code or positive registered gnr/bnr. Leading zeroes on gnr/bnr are normalized.
gnr spørring · påkrevd
string
^[0-9]{1,8}$
Municipality code or positive registered gnr/bnr. Leading zeroes on gnr/bnr are normalized.
bnr spørring · påkrevd
string
^[0-9]{1,8}$
Municipality code or positive registered gnr/bnr. Leading zeroes on gnr/bnr are normalized.
limit spørring
integer
1–100 standard 10
Address candidates per property per page
cursor spørring
string
—
Opaque next_cursor bound to the property. Source-checked pagination also requires matrikkelenhet_id; fallback cursors bind kommune/gnr/bnr.
fnr spørring
string
^[0-9]{1,8}$
Optional exact feste number from a checked Matrikkel snapshot. Omitted means all choices, 0 means explicit zero; unknown never matches zero. Returns 422 if no authorized checked identity is available.
snr spørring
string
^[0-9]{1,8}$
Optional exact section number from a checked snapshot. Omitted means all choices, 0 means explicit zero. Returns 422 if no authorized checked identity is available.
matrikkelenhet_id spørring
string
^[0-9]{1,18}$
Select one official property ID; required with a source-checked next_cursor
Svar og feilkoder
HTTP
Betydning
Koder i svaret
200
Explicit candidates only. Empty candidates are a valid no-match result; never automatically choose the first record.
—
400
Invalid, repeated, conflicting or unknown query parameter
Active address access required; cadastral discovery needs address_details, source identities additionally buildings, and dwelling choices additionally dwelling_units. Full property filters without buildings grant are rejected.
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.
Tar ingen parametere.
Svar og feilkoder
HTTP
Betydning
Koder i svaret
200
Current authenticated customer only; no caller-supplied customer or key identifier.
Uten nøkkel og uten konto, med et lavere fast tak og bare feltene i den gjennomgåtte publiseringspolicyen. https://api.approach.no/api/v1/address-demo
GET
/search
uten nøkkel
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.
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.
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.
Disse headerne kan leses av klienten, også fra nettleseren på et tillatt domene. Listen er den samme som API-et oppgir i Access-Control-Expose-Headers.
Header
Innhold
X-RateLimit-Limit
Kalltaket for tidsvinduet i X-RateLimit-Window. Kunden kan også ha time-, døgn-, uke- eller månedstak.
X-RateLimit-Remaining
Kall igjen i tidsvinduet i X-RateLimit-Window; null når dette vinduet avviste kallet.
X-RateLimit-Reset
Når det gjeldende tidsvinduet nullstilles, som Unix-sekunder.
X-RateLimit-Window
Gjeldende tidsvindu: minute, hour, day, week eller month. Kalendervinduer bruker Oslo-tid; gjentatt høsttime har egne vinduer.
Retry-After
Ved 429 eller midlertidig 503: antall sekunder å vente før nytt forsøk.
X-Request-Billing
Hvordan kallet faktureres, f.eks. allowance_trial, allowance_prepaid, subscription_postpaid, not_billed_test for et testoppslag som ikke belaster kvoten, not_billed_free på søk, resolve, properties, /access og /usage (telles aldri), eller not_billed_partial_failure når oppslaget ikke telles. Settes på svar som måles og på gratisruter.
X-Request-Budget
Taket som gjelder: produksjonskvoten for prøve- og forhåndsbetalte kontoer, månedstaket for avtalte planer. Mangler når kontoen ikke har tak eller en selvbetjent testnøkkel ikke belaster produksjonskvoten.
X-Request-Budget-Used
Oppslag telt denne kalendermåneden (norsk tid) på avtalte planer.
X-Request-Budget-Remaining
Det som er igjen under X-Request-Budget. Negativt mens en betalende konto bruker kredittkvoten.
X-Request-Balance-Ore
Forhåndsbetalt saldo, i øre, som betaler for kall utover kvoten.
X-Request-ID
Id-en til kallet, alltid tildelt av oss. Det er id-en bruksloggen på kontosiden viser. Oppgi den når du melder fra om et problem.
X-Client-Request-ID
Din egen X-Request-ID, sendt tilbake når den er skrivbar ASCII uten mellomrom og høyst 128 tegn, så kallet kan finnes igjen i dine logger.
ETag
På katalog, kontrakt (openapi.json), dekning og datasettkatalog: en validator. Send den tilbake som If-None-Match, så svarer API-et 304 Not Modified så lenge ingenting er endret.
X-Sections-Hint
På en profil som ikke valgte seksjoner, eller ba om package=all: hvilken pakke som gjaldt (standard er core) og hvordan du snevrer inn eller utvider med include eller package. Mangler når include eller en annen pakke enn all ble oppgitt.
Content-Disposition
På en nedlasting (dataproduktresultat, jobbresultat, serie-CSV eller adressehistorikk som CSV): foreslått filnavn.
X-Data-Product
På et dataproduktresultat: produktet og versjonen som ga det, som id@versjon.
X-Data-Licence
På et dataproduktresultat: lisensen dataene leveres under.
X-Series-Licence
På et serierespons: id-en til lisensen serien er utgitt under. Link peker til teksten.
X-Data-Points
På et serierespons: hvor mange observasjoner det inneholder.
X-Billable-Units
På et serierespons: enhetene som belastes for det, én per påbegynte tusen observasjoner og minst én.
Link
På et serierespons: lisensteksten, som rel="license". På en utfaset seksjon eller et utfaset datasett: endringsloggen som rel="deprecation" (og rel="sunset" når en dato er satt), og erstatningen som rel="successor-version" der det finnes én.
Deprecation
På en utfaset seksjon eller et utfaset datasett (RFC 9745): når den ble utfaset, som @ fulgt av Unix-sekunder. Den svarer fortsatt; planlegg overgangen til etterfølgeren.
Sunset
På en utfaset seksjon eller et utfaset datasett med en sluttdato (RFC 8594): HTTP-datoen den slutter å svare etter. Fraværende så lenge ingen dato er satt.
X-Dataset-Schema-Version
På nedlasting av datasett-øyeblikksbilde: skjemaversjonen til filen, så et datavarehus kan oppdage en endring før det laster den.
X-Dataset-Refresh-Id
På nedlasting av datasett-øyeblikksbilde: oppdateringen filen ble skrevet etter. Sammenlign med oppdateringen et /records- eller /changes-kall oppgir.
X-Content-SHA256
På nedlasting av datasett-øyeblikksbilde: SHA-256 av filen, for å kontrollere overføringen.
X-Test-Customer
true når nøkkelen eller økten tilhører en testkunde: en kunde Approach har laget for å prøve en kundes tilgang uten å røre den. Kall fra en testkunde faktureres aldri og telles ikke med. Mangler ellers.
Pakker
En pakke er et ferdig utvalg seksjoner for package-parameteren, ikke en rettighet. Seksjonstilgangene gjelder like fullt etter at pakken er utvidet.
core6 seksjoner
Kjerneprofil. Den lille standardprofilen med adresseidentitet, bygninger og boenheter med kildestatus, kartlagte faresoner og reguleringsplan. Velg flere pakker eller seksjoner ved behov. Pakken fastslår ikke at kildene er komplette og gir ingen nye tilganger.
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_screen19 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_nuisance13 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_restrictions16 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.
models26 seksjoner
Datakildes modeller. Alle anslagene Datakilde beregner selv, som støy per kilde (vei, bane, fly), setninger under bygningen, stormflomargin, snølast, solpotensial og innsatstid for brannvesenet. Hver post har method, method_version, inputs og validation; et anslag er aldri det offisielle tallet det tilnærmer. Samme tilganger og oppslagstelling som alle seksjoner.