Class SsbClient

Client for Statistics Norway's current PxWeb API v2.

Index

Methods

getTableMetadata query queryRaw

Methods

getTableMetadata

getTableMetadata(
tableId: string,
options?: RequestOptions,
): Promise<OpenDataResponse<StatisticsTableMetadata>>
Fetches detailed JSON-stat2 metadata for an SSB table.
Parameters
- tableId: string
- Optionaloptions: RequestOptions
Returns Promise<OpenDataResponse<StatisticsTableMetadata>>
- Defined in src/providers/ssb/client.ts:61

query

query(
query: StatisticsQuery,
options?: RequestOptions,
): Promise<OpenDataResponse<StatisticsResult>>
Runs a validated SSB query and flattens the JSON-stat2 cube into rows.
Parameters
- query: StatisticsQuery
- Optionaloptions: RequestOptions
Returns Promise<OpenDataResponse<StatisticsResult>>
- Defined in src/providers/ssb/client.ts:95

queryRaw

queryRaw(
query: StatisticsQuery,
options?: RequestOptions,
): Promise<OpenDataResponse<JsonStatDataset>>
Runs a validated SSB query and returns the provider's JSON-stat2 dataset.
Parameters
- query: StatisticsQuery
- Optionaloptions: RequestOptions
Returns Promise<OpenDataResponse<JsonStatDataset>>
- Defined in src/providers/ssb/client.ts:110