Dokumentasjon API

Parametere, filtre og eksempler for Firmalistens API.

POST/company/search

Kom i gang #

Søk som gjest eller med konto; API-token for Konto, Pro og Max finner du under Innstillinger.

Eksempel med token (utelat Authorization-headeren for gjestesøk):

curl 'https://firmalisten.no/company/search' \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer DITT_API_TOKEN' \
  --data '{
    "query": "rørlegger",
    "filter": { "county_code": "03" }
  }'

Parametere #

Alle felt er valgfrie. {} søker uten søketekst eller filtre.

Felt Type Beskrivelse
query string Fritekstsøk i firmanavn og organisasjonsnummer, med støtte for anførselstegn (") og ekskludering (-).
filter object Filtre kombinert med OG.
sort object Feltnavn med "asc" eller "desc".
limit integer Maksimalt antall returnerte treff. Minimum 0.
page integer (URL) Sidetall, f.eks. ?page=2. Standard 1, minimum 1.

Standard for limit: 10 uten token, 10 med Konto-token og 20 med Pro- eller Max-token. Se maksimum per abonnement.

Når du bare trenger antall treff, bruk "limit": 0 og les total_hits fra svaret. Da er hits tom og total_pages er 0.

Andre body-parametere ignoreres.

Filtre #

En verdi betyr likhet. En liste betyr ELLER. Ulike felt og flere operatorer på samme felt kombineres med OG.

{
  "filter": {
    "county_code": ["03", "32"],
    "type_code": "AS",
    "employees": { "gte": 5, "lte": 50 },
    "has_email": true
  }
}

Dette gir aksjeselskaper i Oslo eller Akershus med 5–50 ansatte og e-postadresse.

Operator Betydning Operator Betydning
eq Lik ne Ulik
gt Større enn gte Større enn eller lik
lt Mindre enn lte Mindre enn eller lik

Se filterfeltene, NACE-koder og fylkes- og kommunekoder.

Sortering #

{
  "sort": {
    "employees": "desc",
    "name": "asc"
  }
}

Feltene prioriteres i angitt rekkefølge, før tekstlig relevans. Bruk asc eller desc. Alle filterfelt unntatt roles kan brukes, uavhengig av abonnement. Uten sort brukes relevance synkende før tekstlig relevans.

Svar #

HTTP 200 med ok: true. Med Pro og Max returneres alle feltene i søkeindeksen for hvert firma, med cookie eller token. Eksempel med feltene Guest og Konto får:

{
  "ok": true,
  "data": {
    "hits": [
      {
        "orgnr": "123456789",
        "name": "Eksempel Rørlegger AS",
        "industry1_name": "VVS-arbeid",
        "county_name": "Oslo",
        "website": "https://example.com",
        "registered_at": "2020-01-15T00:00:00.000Z",
        "employees": 12,
        "relevance": 100
      }
    ],
    "query": "rørlegger",
    "processing_time_ms": 2,
    "limit": 10,
    "offset": 0,
    "page": 1,
    "total_pages": 1,
    "total_hits": 1
  }
}
Felt i data Innhold
hits Firma i resultatet. [] ved ingen treff.
query Søketeksten.
processing_time_ms Søkemotorens behandlingstid i ms.
limit Maksimalt antall returnerte treff.
total_hits Totalt antall treff, også utover plangrensen.
page Gjeldende side. Sider utover siste tilgjengelige side begrenses til siste side.
total_pages Antall sider innenfor abonnementets søkegrense; 0 uten treff.
offset Antall treff foran gjeldende side.

Bruksgrenser #

Alle abonnement tillater 100 forespørsler per minutt. Grensene deles per konto når du er autentisert, ellers per IP-adresse. Se treffgrenser per abonnement.

Feil #

Kontroller både HTTP-status og ok.

HTTP Svar Handling
200 ok: false, message, eventuelt fields Rett parametrene eller håndter søkefeilen.
400 Ugyldig forespørsel Kontroller JSON og HTTP-headere.
401 ok: false, message Bruk et gyldig Konto-, Pro- eller Max-token, eller utelat tokenet for cookie- eller gjestetilgang.
429 ok: false, message Vent før neste forsøk.

message beskriver feilen:

{
  "ok": false,
  "message": "Valideringsfeil",
  "fields": {
    "filter": ["Invalid filter"]
  }
}

fields følger bare med når søkeparametrene er ugyldige.

Filterfelt #

Guest, Konto og Pro #

Felt Type Enhet Beskrivelse
is_new boolean — Firmaet ble registrert i enhetsregisteret i løpet av den siste måneden.
is_active boolean — Firmaet er ikke registrert som konkurs, under avvikling, tvangsavvikling eller tvangsoppløsning.
has_employees boolean — Firmaet har minst én registrert ansatt.
has_website boolean — Firmaet har en registrert hjemmeside.
has_email boolean — Firmaet har en registrert e-postadresse.
has_phone boolean — Firmaet har et registrert telefon- eller mobilnummer.
income number NOK Driftsinntekter
expenses number NOK Driftskostnader
result number NOK Driftsresultat
equity number NOK Egenkapital
debt number NOK Gjeld
assets number NOK Eiendeler
operating_margin number % Driftsresultat / driftsinntekter × 100.
equity_ratio number % Egenkapital / eiendeler × 100.
employees number — Antall ansatte
bankrupt boolean — Konkurs
closed boolean — Under avvikling
shut boolean — Under tvangsavvikling
in_vat_registry boolean — Registrert i Merverdiavgiftsregisteret
in_company_registry boolean — Registrert i Foretaksregisteret
in_voluntary_registry boolean — Registrert i Frivillighetsregisteret
in_foundation_registry boolean — Registrert i Stiftelsesregisteret
registered_at date — Registreringsdato
founded_at date — Stiftelsesdato
sector_code string — Sektorkode
type_code string — Kode for organisasjonsform
industry1_code string — Primær NACE-kode
categories array — Kategorier
county_code string — Fylkeskode
municipality_code string — Kommunekode
{
  "filter": {
    "income": { "gte": 1000000 },
    "operating_margin": { "gte": 10.5, "lte": 20 },
    "equity_ratio": { "gte": 20, "lte": 80 }
  }
}

Max #

Alle feltene ovenfor, pluss:

Felt Type Enhet Beskrivelse
orgnr string — Organisasjonsnummer
name string — Firmanavn
type_name string — Organisasjonsform
ba_street string — Forretningsadresse: gateadresse
ba_area_name string — Forretningsadresse: poststed
ba_area_code string — Forretningsadresse: postnummer
ba_municipality_name string — Forretningsadresse: kommunenavn
ba_municipality_code string — Forretningsadresse: kommunekode
ba_county_name string — Forretningsadresse: fylkesnavn
ba_county_code string — Forretningsadresse: fylkeskode
ba_country_name string — Forretningsadresse: land
ba_country_code string — Forretningsadresse: landkode
pa_street string — Postadresse: gateadresse
pa_area_name string — Postadresse: poststed
pa_area_code string — Postadresse: postnummer
pa_municipality_name string — Postadresse: kommunenavn
pa_municipality_code string — Postadresse: kommunekode
pa_county_name string — Postadresse: fylkesnavn
pa_county_code string — Postadresse: fylkeskode
pa_country_name string — Postadresse: land
pa_country_code string — Postadresse: landkode
industry1_name string — Primær bransje
industry2_name string — Sekundær bransje
industry2_code string — Sekundær NACE-kode
industry3_name string — Tertiær bransje
industry3_code string — Tertiær NACE-kode
sector_name string — Institusjonell sektor
phone string — Telefonnummer
mobile string — Mobilnummer
fax string — Faksnummer
website string — Hjemmeside
email string — E-postadresse
contact string — Kontaktperson
has_contact_data boolean — Har kontaktinformasjon
roles array — Roller i firmaet
accounting_year number — Regnskapsår
last_accounting_year number — Siste innsendte regnskapsår
has_accounting_data boolean — Har regnskapsdata
municipality_name string — Kommunenavn
county_name string — Fylkesnavn
country_name string — Land
country_code string — Landkode
industry_name string — Bransjenavn
industry_code string — Bransjekode
lang string — Språkkode
summary string — Virksomhetsbeskrivelse
relevance number — Relevansverdi
created_at date — Opprettet i databasen
updated_at date — Oppdatert i databasen

Trenger du hjelp med API-et? Kontakt oss.

Til toppen ↑
Database sist oppdatert 8. oktober 2026 kl. 12:21.