API reference

Exceptions

class brreg.BrregError

Top-level exception.

All exceptions raised by the brreg library are subclasses of this exception.

class brreg.BrregRestError(msg, *, method, url, status_code): REST API exception.

Enhetsregisteret

Client

class brreg.enhetsregisteret.Client

Client for the Enhetregisteret API.

Ensures that HTTP connections are reused across requests.

It can be used as a context manager:

with Client() as client:
    enhet = client.get_enhet("915501680")

Or by manually opening and closing the client:

client = Client()
enhet = client.get_enhet("915501680")
client.close()

open()

Prepare the client for use.

This is called automatically when the client is created.

Return type:: None

close()

Close the client and any open HTTP connections.

This is called automatically if the client is used as a context manager.

Return type:: None

get_enhet(organisasjonsnummer)

Get Enhet given an organization number.

Return type:: Optional[Enhet]

get_underenhet(organisasjonsnummer)

Get Underenhet given an organization number.

Return type:: Optional[Underenhet]

get_roller(organisasjonsnummer)

Get Enhet given an organization number.

Return type:: List[RolleGruppe]

search_enhet(query)

Search for Enhet that matches the given query.

Parameters:: query (EnhetQuery) – The search query.
Return type:: Cursor[Enhet, EnhetQuery]

search_underenhet(query)

Search for Underenhet that matches the given query.

Parameters:: query (UnderenhetQuery) – The search query.
Return type:: Cursor[Underenhet, UnderenhetQuery]

Query objects

class brreg.enhetsregisteret.Query(**data)

The fields here are available on all queries.

sort: Optional[Literal['ASC', 'DESC']]: Sortering av resultatsett

size: Optional[Annotated[int]]: Sidestørrelse

page: Optional[Annotated[int]]: Sidenummer

class brreg.enhetsregisteret.EnhetQuery(**data)

The query type for enhet search.

navn: Optional[str]: Enhetens navn

organisasjonsnummer: Annotated[List[Annotated[str]]]: Organisasjonsnummeret til enheten

overordnet_enhet: Optional[Annotated[str]]: Organisasjonsnummeret til enhetens overordnede enhet

fra_antall_ansatte: Optional[Annotated[int]]: Minste antall ansatte hos enheten

til_antall_ansatte: Optional[Annotated[int]]: Største antall ansatte hos enheten

konkurs: Optional[bool]: Hvorvidt enheten er registrert som konkurs

registrert_i_mvaregisteret: Optional[bool]: Hvorvidt enheten er registrert i Mva-registeret

registert_i_foretaksregisteret: Optional[bool]: Hvorvidt enheten er registrert i Foretaksregisteret

registrert_i_stiftelsesregisteret: Optional[bool]: Hvorvidt enheten er registrert i Stiftelsesregisteret

registrert_i_frivillighetsregisteret: Optional[bool]: Hvorvidt enheten er registrert i Frivillighetsregisteret

frivillig_registrert_i_mvaregisteret: Annotated[List[str]]: Frivillig registrert i Merverdiavgiftsregisteret

under_tvangsavvikling_eller_trangsopplosning: Optional[bool]: Hvorvidt enheten er registrert som under tvangsavvikling eller tvangsopplosning

under_avvikling: Optional[bool]: Hvorvidt enheten er registrert som under avvikling

fra_registreringsdato_enhetsregisteret: Optional[date]: Tidligste registreringsdato i Enhetsregisteret

til_registreringsdato_enhetsregisteret: Optional[date]: Seneste registreringsdato i Enhetsregisteret

fra_stiftelsesdato: Optional[date]: Tidligste stiftelsesdato for enheten

til_stiftelsesdato: Optional[date]: Seneste stiftelsesdato for enheten

organisasjonsform: Annotated[List[str]]: Enhetens organisasjonsform

hjemmeside: Optional[str]: Enhetens hjemmeside

institusjonell_sektorkode: Annotated[List[Annotated[str]]]: Enhetens institusjonelle sektorkode

postadresse_kommunenummer: Annotated[List[Annotated[str]]]: Kommunenummer til enhetens postadresse

postadresse_postnummer: Annotated[List[Annotated[str]]]: Postnummeret til enhetens postadresse

postadresse_poststed: Optional[str]: Poststedet til enhetens postadresse

postadresse_landkode: Annotated[List[str]]: Landkode til enhetens postadresse

postadresse_adresse: Optional[str]: Adresse til enhetens postadresse

kommunenummer: Annotated[List[Annotated[str]]]: Kommunenummer til enhetens forretningsadresse

forretningsadresse_postnummer: Annotated[List[Annotated[str]]]: Postnummeret til enhetens forretningsadresse

forretningsadresse_poststed: Optional[str]: Poststedet til enhetens forretningsadresse

forretningsadresse_landkode: Annotated[List[str]]: Landkode til enhetens forretningsadresse

forretningsadresse_adresse: Optional[str]: Adresse til enhetens forretningsadresse

naeringskode: Annotated[List[Annotated[str]]]: Enhetens næringskode

siste_innsendte_aarsregnskap: Annotated[List[str]]: Årstall for siste innsendte årsregnskap for enheten

class brreg.enhetsregisteret.UnderenhetQuery(**data)

The query type for underenhet search.

navn: Optional[str]: Underenhetens navn

organisasjonsnummer: Annotated[List[Annotated[str]]]: Organisasjonsnummeret til underenheten

overordnet_enhet: Optional[Annotated[str]]: Organisasjonsnummeret til underenhetens overordnede enhet

fra_antall_ansatte: Optional[Annotated[int]]: Minste antall ansatte hos underenheten

til_antall_ansatte: Optional[Annotated[int]]: Største antall ansatte hos underenheten

registrert_i_mvaregisteret: Optional[bool]: Hvorvidt underenheten er registrert i Mva-registeret

fra_registreringsdato_enhetsregisteret: Optional[date]: Tidligste registreringsdato i Enhetsregisteret

til_registreringsdato_enhetsregisteret: Optional[date]: Seneste registreringsdato i Enhetsregisteret

fra_oppstartsdato: Optional[date]: Tidligste oppstartsdato for enheten

til_oppstartsdato: Optional[date]: Seneste oppstartsdato for enheten

fra_dato_eierskifte: Optional[date]: Tidligste registreringsdato for eierskifte

til_dato_eierskifte: Optional[date]: Seneste registreringsdato for eierskifte

fra_nedleggelsesdato: Optional[date]: Tidligste nedleggelsesdato for enheten

til_nedleggelsesdato: Optional[date]: Seneste nedleggelsesdato for enheten

organisasjonsform: Annotated[List[str]]: Underenhetens organisasjonsform

hjemmeside: Optional[str]: Enhetens hjemmeside

postadresse_kommunenummer: Annotated[List[Annotated[str]]]: Kommunenummer til underenhetens postadresse

postadresse_postnummer: Annotated[List[Annotated[str]]]: Postnummeret til underenhetens postadresse

postadresse_poststed: Optional[str]: Poststedet til underenhetens postadresse

postadresse_landkode: Annotated[List[str]]: Landkode til underenhetens postadresse

postadresse_adresse: Optional[str]: Adresse til underenhetens postadresse

kommunenummer: Annotated[List[Annotated[str]]]: Kommunenummer til enhetens beliggenhetsadresse

beliggenhetsadresse_postnummer: Annotated[List[Annotated[str]]]: Postnummeret til enhetens beliggenhetsadresse

beliggenhetsadresse_poststed: Optional[str]: Poststedet til enhetens beliggenhetsadresse

beliggenhetsadresse_landkode: Annotated[List[str]]: Landkode til enhetens beliggenhetsadresse

beliggenhetsadresse_adresse: Optional[str]: Adresse til enhetens beliggenhetsadresse

naeringskode: Annotated[List[Annotated[str]]]: Underenhetens næringskode

Pagination objects

class brreg.enhetsregisteret.Cursor(operation, query, page)

Cursor for iterating over multiple pages of items.

page_numbers: range: Iterate over all page numbers in this cursor.

get_page(page_number)

Get a page by its 0-indexed page number.

Return type:: Optional[Page]

property pages: Iterator[Page]: Iterator over all pages in this cursor.

property items: Iterator[T]: Iterator over all items in this cursor.

class brreg.enhetsregisteret.Page(**data)

The fields here are available on all page objects.

items: List[TypeVar(T, bound= BaseModel)]: The items on this page.

page_size: int: The number of elements on this page.

page_number: int: The page number, starting at 0.

total_elements: int: The total number of elements available.

total_pages: int: The total number of pages available.

class brreg.enhetsregisteret.EnhetPage(**data)

Response type for enhet search.

items: List[Enhet]: The items on this page.

class brreg.enhetsregisteret.UnderenhetPage(**data)

Response type for underenhet search.

items: List[Underenhet]: The items on this page.

Response objects

class brreg.enhetsregisteret.Enhet(**data)

Enhet på øverste nivå i registreringsstrukturen i Enhetsregisteret.

Eksempelvis enkeltpersonforetak, foreninger, selskap, sameier og andre som er registrert i Enhetsregisteret. Identifiseres med organisasjonsnummer.

organisasjonsnummer: str: Organisasjonsnummer

navn: str: Navn

organisasjonsform: Organisasjonsform: Organisasjonsform

hjemmeside: Optional[str]: Hjemmeside

postadresse: Optional[Adresse]: Enhetens postadresse

registreringsdato_enhetsregisteret: Annotated[Optional[date]]: Registreringsdato i Enhetsregisteret

registrert_i_mvaregisteret: Optional[bool]: Hvorvidt enheten er registrert i MVA-registeret

frivillig_mva_registrert_beskrivelser: List[str]: Enheter som i utgangspunktet ikke er mva-pliktig, kan søke om frivillig registrering i Merverdiavgiftsregisteret

naeringskode1: Optional[Naering]: Næringskode 1

naeringskode2: Optional[Naering]: Næringskode 2

naeringskode3: Optional[Naering]: Næringskode 3

hjelpeenhetskode: Optional[Naering]: Hjelpeenhetskode

antall_ansatte: Optional[int]: Antall ansatte

har_registrert_antall_ansatte: Optional[bool]: Angir om enheten har registrert ansatte

overordnet_enhet: Optional[str]: Organisasjonsnummeret til overordnet enhet i offentlig sektor

forretningsadresse: Optional[Adresse]: Forretningsadresse

stiftelsesdato: Annotated[Optional[date]]: Stiftelsesdato

institusjonell_sektorkode: Optional[InstitusjonellSektor]: Sektorkode

registrert_i_foretaksregisteret: Optional[bool]: Hvorvidt enheten er registrert i Foretaksregisteret

registrert_i_stiftelsesregisteret: Optional[bool]: Hvorvidt enheten er registrert i Stiftelsesregisteret

registrert_i_frivillighetsregisteret: Optional[bool]: Hvorvidt enheten er registrert i Frivillighetsregisteret

siste_innsendte_aarsregnskap: Optional[int]: År for siste innsendte årsregnskap

konkurs: Optional[bool]: Hvorvidt enheten er konkurs

konkursdato: Annotated[Optional[date]]: Kjennelsesdato for konkursen

under_avvikling: Optional[bool]: Hvorvidt enheten er under avvikling

under_tvangsavvikling_eller_tvangsopplosning: Optional[bool]: Hvorvidt enheten er under tvangsavvikling eller tvangsoppløsning

maalform: Optional[str]: Målform

vedtektsdato: Annotated[Optional[date]]: Enhetens vedtektsdato

vedtektsfestet_formaal: List[str]: Enhetens formål

aktivitet: List[str]: Enhetens aktivitet

nedleggelsesdato: Annotated[Optional[date]]: Nedleggelsesdato for underenheten

slettedato: Annotated[Optional[date]]: Dato under-/enheten ble slettet

class brreg.enhetsregisteret.Underenhet(**data)

Enhet på laveste nivå i registreringsstrukturen i Enhetsregisteret.

En underenhet kan ikke eksistere alene og har alltid knytning til en hovedenhet. Identifiseres med organisasjonsnummer.

organisasjonsnummer: str: Underenhetens organisasjonsnummer

navn: str: Underenhetens navn

organisasjonsform: Organisasjonsform: Underenhetens organisasjonsform

hjemmeside: Optional[str]: Underenhetens hjemmeside

postadresse: Optional[Adresse]: Underenhetens postadresse

registreringsdato_enhetsregisteret: Annotated[Optional[date]]: Underenhetens registreringsdato i Enhetsregisteret

registrert_i_mvaregisteret: Optional[bool]: Hvorvidt underenheten er registrert i MVA-registeret

frivillig_mva_registrert_beskrivelser: List[str]: Underenheter som i utgangspunktet ikke er mva-pliktig, kan søke om frivillig registrering i Merverdiavgiftsregisteret

naeringskode1: Optional[Naering]: Næringskode 1

naeringskode2: Optional[Naering]: Næringskode 2

naeringskode3: Optional[Naering]: Næringskode 3

hjelpeenhetskode: Optional[Naering]: Hjelpeenhetskode

antall_ansatte: Optional[int]: Antall ansatte

har_registrert_antall_ansatte: Optional[bool]: Angir om enheten har registrert ansatte

overordnet_enhet: Optional[str]: Underenhetens overordnede enhet

beliggenhetsadresse: Optional[Adresse]: Underenhetens beliggenhetsadresse

oppstartsdato: Annotated[Optional[date]]: Underenhetens oppstartsdato

dato_eierskifte: Annotated[Optional[date]]: Underenhetens dato for eierskifte

nedleggelsesdato: Annotated[Optional[date]]: Nedleggelsesdato for underenheten

slettedato: Annotated[Optional[date]]: Dato under-/enheten ble slettet

class brreg.enhetsregisteret.Adresse(**data)

adresse: List[Optional[str]]: Adresse

postnummer: Optional[str]: Postnummer

poststed: Optional[str]: Poststed

kommunenummer: Optional[str]: Kommunenummer

kommune: Optional[str]: Kommune

landkode: Optional[str]: Landkode

land: Optional[str]: Land

class brreg.enhetsregisteret.InstitusjonellSektor(**data)

kode: Optional[str]: Sektorkoden

beskrivelse: Optional[str]: Tekstlig beskrivelse av sektorkoden

class brreg.enhetsregisteret.Naering(**data)

Næringskode.

Næringskoden skal vise virksomhetens hovedaktivitet, og den skal primært dekke statistiske behov for Statistisk sentralbyrå (SSB).

kode: Optional[str]: Næringskoden

beskrivelse: Optional[str]: Tekstlig beskrivelse av næringskoden

class brreg.enhetsregisteret.Organisasjonsform(**data)

Organisasjonsform er virksomhetens formelle organisering.

Organisasjonsform gir retningslinjer overfor blant annet ansvarsforhold, skatt, revisjonsplikt, rettigheter og plikter.

kode: str: Organisasjonsformen

beskrivelse: str: Tekstlig beskrivelse av organisasjonsformen

utgaatt: Annotated[Optional[date]]: Dato når organisasjonsformen evt. ble ugyldig

class brreg.enhetsregisteret.RollerResponse(**data)

rollegrupper: List[RolleGruppe]: Liste med rollegrupper knyttet til enheten

class brreg.enhetsregisteret.RolleGruppe(**data)

type: RolleGruppeType: Rollegruppetype, og beskrivelse av typen

sist_endret: date: Dato for siste endring

roller: List[Rolle]: Liste med alle rollene i gruppen

class brreg.enhetsregisteret.RolleGruppeType(**data)

kode: str: Kode for rollegruppetype

beskrivelse: str: Beskrivelse av rollegruppetypen

class brreg.enhetsregisteret.Rolle(**data)

type: RolleType: Rolletype, og beskrivelse av typen

person: Optional[RollePerson]: Person som innehar rollen

enhet: Optional[RolleEnhet]: Enhet som innehar rollen

ansvarsandel: Optional[str]: Rollens ansvarsandel for selskapets forpliktelser, i brøk eller prosent

valgt_av: Optional[RolleType]: Kode og beskrivelse av hvem rollen representerer (ikke innehaver)

fratraadt: bool: Fratrådt fra rolle

fullmektige: List[RolleFullmektig]: Liste over fullmektige

rekkefolge: Optional[int]: Rekkefølgen på rollen i gruppen

class brreg.enhetsregisteret.RolleType(**data)

kode: str: Kode for rolletype

beskrivelse: str: Beskrivelse av rolletypen

class brreg.enhetsregisteret.RollePerson(**data)

fodselsdato: date: Personens fødselsdato

navn: RollePersonNavn: Personens fulle navn

verge: Optional[RollePerson]: Personens verge

er_doed: bool: Hvorvidt personen er død

class brreg.enhetsregisteret.RollePersonNavn(**data)

fornavn: str: Personens fornavn

mellomnavn: Optional[str]: Personens mellomnavn

etternavn: str: Personens etternavn

class brreg.enhetsregisteret.RolleEnhet(**data)

organisasjonsnummer: str: Unik id-nummer tilhørende enheten

organisasjonsform: Organisasjonsform: Organisasjonsformen til enheten

navn: List[str]: Enhetens navn

er_slettet: bool: Hvorvidt enheten er slettet

class brreg.enhetsregisteret.RolleFullmektig(**data)

navn: Optional[str]: Navn på fullmektig

adresse: List[str]: Adresser/adresselinjer knyttet til fullmektig