Class BrregClient

Client for the open Enhetsregisteret company and sub-entity endpoints.

Index

Methods

get getSubEntity search searchAll

Methods

get

get(
organizationNumber: string,
options?: RequestOptions,
): Promise<OpenDataResponse<Company>>
Gets an organization by its nine-digit organization number.
Parameters
- organizationNumber: string
- Optionaloptions: RequestOptions
Returns Promise<OpenDataResponse<Company>>
- Defined in src/providers/brreg/client.ts:160

getSubEntity

getSubEntity(
organizationNumber: string,
options?: RequestOptions,
): Promise<OpenDataResponse<Company>>
Gets a public sub-entity by organization number.
Parameters
- organizationNumber: string
- Optionaloptions: RequestOptions
Returns Promise<OpenDataResponse<Company>>
- Defined in src/providers/brreg/client.ts:253

search

search(
parameters: CompanySearchParameters,
options?: RequestOptions,
): Promise<OpenDataResponse<CompanySearchResult>>
Searches open organizations with Brønnøysundregistrene pagination.
Parameters
- parameters: CompanySearchParameters
- Optionaloptions: RequestOptions
Returns Promise<OpenDataResponse<CompanySearchResult>>
- Defined in src/providers/brreg/client.ts:192

searchAll

searchAll(
parameters?: CompanySearchParameters,
options?: RequestOptions & PaginateOptions,
): AsyncGenerator<Company, void, undefined>
Iterates every matching organization, requesting each page on demand.

Bounded by maxItems and maxPages so an upstream change cannot produce an unbounded request loop.
Parameters
- parameters: CompanySearchParameters = {}
- Optionaloptions: RequestOptions & PaginateOptions
Returns AsyncGenerator<Company, void, undefined>
- Defined in src/providers/brreg/client.ts:238