PxWeb API

tap-pxwebapi (storebrand variant)🥈

PxWebApi - API for official statistics used by Statistical offices in several Nordic countries.

The tap-pxwebapi extractor pulls data from PxWeb API that can then be sent to a destination using a loader.

Getting Started

Prerequisites

If you haven't already, follow the initial steps of the Getting Started guide:

  1. Install Meltano
  2. Create your Meltano project

Installation and configuration

  1. Add the tap-pxwebapi extractor to your project using
    meltano add
    :
  2. meltano add extractor tap-pxwebapi
  3. Configure the tap-pxwebapi settings using
    meltano config
    :
  4. meltano config tap-pxwebapi set --interactive
  5. Test that extractor settings are valid using
    meltano config
    :
  6. meltano config tap-pxwebapi test

Next steps

If you run into any issues, learn how to get help.

Capabilities

The current capabilities for tap-pxwebapi may have been automatically set when originally added to the Hub. Please review the capabilities when using this extractor. If you find they are out of date, please consider updating them by making a pull request to the YAML file that defines the capabilities for this extractor.

This plugin has the following capabilities:

  • about
  • batch
  • catalog
  • discover
  • schema-flattening
  • state
  • stream-maps

You can override these capabilities or specify additional ones in your meltano.yml by adding the capabilities key.

Settings

The tap-pxwebapi settings that are known to Meltano are documented below. To quickly find the setting you're looking for, click on any setting name from the list:

You can also list these settings using

meltano config
with the list subcommand:

meltano config tap-pxwebapi list

You can override these settings or specify additional ones in your meltano.yml by adding the settings key.

Please consider adding any settings you have defined locally to this definition on MeltanoHub by making a pull request to the YAML file that defines the settings for this plugin.

Base URL (base_url)

  • Environment variable: TAP_PXWEBAPI_BASE_URL
  • Default Value: https://data.ssb.no/api/v0/

Base API URL


Configure this setting directly using the following Meltano command:

meltano config tap-pxwebapi set base_url [value]

Batch Config Encoding Compression (batch_config.encoding.compression)

  • Environment variable: TAP_PXWEBAPI_BATCH_CONFIG_ENCODING_COMPRESSION

Compression format to use for batch files.


Configure this setting directly using the following Meltano command:

meltano config tap-pxwebapi set batch_config encoding.compression [value]

Batch Config Encoding Format (batch_config.encoding.format)

  • Environment variable: TAP_PXWEBAPI_BATCH_CONFIG_ENCODING_FORMAT

Format to use for batch files.


Configure this setting directly using the following Meltano command:

meltano config tap-pxwebapi set batch_config encoding.format [value]

Batch Config Storage Prefix (batch_config.storage.prefix)

  • Environment variable: TAP_PXWEBAPI_BATCH_CONFIG_STORAGE_PREFIX

Prefix to use when writing batch files.


Configure this setting directly using the following Meltano command:

meltano config tap-pxwebapi set batch_config storage.prefix [value]

Batch Config Storage Root (batch_config.storage.root)

  • Environment variable: TAP_PXWEBAPI_BATCH_CONFIG_STORAGE_ROOT

Root path to use when writing batch files.


Configure this setting directly using the following Meltano command:

meltano config tap-pxwebapi set batch_config storage.root [value]

Flattening Enabled (flattening_enabled)

  • Environment variable: TAP_PXWEBAPI_FLATTENING_ENABLED

'True' to enable schema flattening and automatically expand nested properties.


Configure this setting directly using the following Meltano command:

meltano config tap-pxwebapi set flattening_enabled [value]

Flattening Max Depth (flattening_max_depth)

  • Environment variable: TAP_PXWEBAPI_FLATTENING_MAX_DEPTH

The max depth to flatten schemas.


Configure this setting directly using the following Meltano command:

meltano config tap-pxwebapi set flattening_max_depth [value]

Stream Map Config (stream_map_config)

  • Environment variable: TAP_PXWEBAPI_STREAM_MAP_CONFIG

User-defined config values to be used within map expressions.


Configure this setting directly using the following Meltano command:

meltano config tap-pxwebapi set stream_map_config [value]

Stream Maps (stream_maps)

  • Environment variable: TAP_PXWEBAPI_STREAM_MAPS

Config object for stream maps capability. For more information check out Stream Maps.


Configure this setting directly using the following Meltano command:

meltano config tap-pxwebapi set stream_maps [value]

Tables (tables)

  • Environment variable: TAP_PXWEBAPI_TABLES

Tables to read


Configure this setting directly using the following Meltano command:

meltano config tap-pxwebapi set tables [value]

Something missing?

This page is generated from a YAML file that you can contribute changes to.

Edit it on GitHub!

Looking for help?

If you're having trouble getting the tap-pxwebapi extractor to work, look for an existing issue in its repository, file a new issue, or join the Meltano Slack community and ask for help in the
#plugins-general
channel.

Install

meltano add extractor tap-pxwebapi

Maintenance Status

  • Maintenance Status
  • Built with the Meltano SDK

Repo

https://github.com/storebrand/tap-pxwebapi
  • Stars
  • Forks
  • Last Commit Date
  • Open Issues
  • Open PRs
  • Contributors
  • License

Maintainer

  • Storebrand

Meltano Stats

  • Projects (Last 3 Months)

Keywords

  • meltano_sdk