The tap-openmeteo extractor pulls data from Open-Meteo 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:
Installation and configuration
-
Add the tap-openmeteo extractor to your
project using
:meltano add -
Configure the tap-openmeteo
settings using
:meltano config -
Test that extractor settings are valid using
:meltano config
meltano add tap-openmeteomeltano config tap-openmeteo set --interactivemeltano config tap-openmeteo testNext steps
Follow the remaining steps of the Getting Started guide:
If you run into any issues, learn how to get help.
Capabilities
The current capabilities for
tap-openmeteo
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
- activate-version
- batch
- catalog
- discover
- schema-flattening
- state
- stream-maps
- structured-logging
You can
override these capabilities or specify additional ones
in your meltano.yml by adding the capabilities key.
Settings
The
tap-openmeteo 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:
api_keyapi_urlazimuthcell_selectioncurrent_variablesdaily_variablesend_dateflattening_max_key_lengthforecast_daysforecast_hourshourly_variableslocationsminutely_15_variablesmodelspast_dayspast_hoursprecipitation_unitrequest_timeoutstart_datestreams_to_synctemperature_unittilttimeformattimezoneuser_agentwind_speed_unit
You can also list these settings using
with the meltano configlist
subcommand:
meltano config tap-openmeteo 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.
API Key (api_key)
-
Environment variable:
TAP_OPENMETEO_API_KEY
Optional API key for commercial use. Required for accessing reserved API resources. See https://open-meteo.com/en/pricing
Configure this setting directly using the following Meltano command:
meltano config tap-openmeteo set api_key [value]API URL (api_url)
-
Environment variable:
TAP_OPENMETEO_API_URL -
Default Value:
https://api.open-meteo.com
Base URL for the Open-Meteo API. Use 'https://customer-api.open-meteo.com' for commercial API access with an API key.
Configure this setting directly using the following Meltano command:
meltano config tap-openmeteo set api_url [value]Panel Azimuth (azimuth)
-
Environment variable:
TAP_OPENMETEO_AZIMUTH
Panel azimuth for global tilted irradiance. 0° = South, -90° = East, 90° = West, ±180° = North
Configure this setting directly using the following Meltano command:
meltano config tap-openmeteo set azimuth [value]Grid Cell Selection (cell_selection)
-
Environment variable:
TAP_OPENMETEO_CELL_SELECTION -
Default Value:
land
How to select grid cells: 'land' (finds suitable cell on land), 'sea' (prefers cells on sea), 'nearest' (selects nearest cell)
Configure this setting directly using the following Meltano command:
meltano config tap-openmeteo set cell_selection [value]Current Weather Variables (current_variables)
-
Environment variable:
TAP_OPENMETEO_CURRENT_VARIABLES -
Default Value:
["temperature_2m","relative_humidity_2m","apparent_temperature","is_day","precipitation","weather_code","cloud_cover","wind_speed_10m","wind_direction_10m"]
List of current weather variables to include in responses.
Configure this setting directly using the following Meltano command:
meltano config tap-openmeteo set current_variables [value]Daily Weather Variables (daily_variables)
-
Environment variable:
TAP_OPENMETEO_DAILY_VARIABLES -
Default Value:
["weather_code","temperature_2m_max","temperature_2m_min","precipitation_sum","sunrise","sunset"]
List of daily weather variables to fetch. Available: weather_code, temperature_2m_max, temperature_2m_min, apparent_temperature_max, apparent_temperature_min, sunrise, sunset, daylight_duration, sunshine_duration, uv_index_max, uv_index_clear_sky_max, precipitation_sum, rain_sum, showers_sum, snowfall_sum, precipitation_hours, precipitation_probability_max, wind_speed_10m_max, wind_gusts_10m_max, wind_direction_10m_dominant, shortwave_radiation_sum, et0_fao_evapotranspiration
Configure this setting directly using the following Meltano command:
meltano config tap-openmeteo set daily_variables [value]End Date (end_date)
-
Environment variable:
TAP_OPENMETEO_END_DATE
End date for historical data (YYYY-MM-DD format). If not set, defaults to yesterday.
Configure this setting directly using the following Meltano command:
meltano config tap-openmeteo set end_date [value]Max Key Length (flattening_max_key_length)
-
Environment variable:
TAP_OPENMETEO_FLATTENING_MAX_KEY_LENGTH
The maximum length of a flattened key.
Configure this setting directly using the following Meltano command:
meltano config tap-openmeteo set flattening_max_key_length [value]Forecast Days (forecast_days)
-
Environment variable:
TAP_OPENMETEO_FORECAST_DAYS -
Default Value:
7
Number of forecast days (0-16). Default is 7 days. Ignored if forecast_hours is set.
Configure this setting directly using the following Meltano command:
meltano config tap-openmeteo set forecast_days [value]Forecast Hours (forecast_hours)
-
Environment variable:
TAP_OPENMETEO_FORECAST_HOURS
Number of forecast hours. When set, takes priority over forecast_days for hourly/minutely streams.
Configure this setting directly using the following Meltano command:
meltano config tap-openmeteo set forecast_hours [value]Hourly Weather Variables (hourly_variables)
-
Environment variable:
TAP_OPENMETEO_HOURLY_VARIABLES -
Default Value:
["temperature_2m","relative_humidity_2m","precipitation","weather_code","wind_speed_10m","wind_direction_10m"]
List of hourly weather variables to fetch. Available: temperature_2m, relative_humidity_2m, dew_point_2m, apparent_temperature, precipitation_probability, precipitation, rain, showers, snowfall, snow_depth, weather_code, pressure_msl, surface_pressure, cloud_cover, cloud_cover_low, cloud_cover_mid, cloud_cover_high, visibility, evapotranspiration, et0_fao_evapotranspiration, vapour_pressure_deficit, wind_speed_10m, wind_speed_80m, wind_speed_120m, wind_speed_180m, wind_direction_10m, wind_direction_80m, wind_direction_120m, wind_direction_180m, wind_gusts_10m, temperature_80m, temperature_120m, temperature_180m, soil_temperature_0cm, soil_temperature_6cm, soil_temperature_18cm, soil_temperature_54cm, soil_moisture_0_to_1cm, soil_moisture_1_to_3cm, soil_moisture_3_to_9cm, soil_moisture_9_to_27cm, soil_moisture_27_to_81cm, uv_index, uv_index_clear_sky, is_day, sunshine_duration, shortwave_radiation, direct_radiation, diffuse_radiation, direct_normal_irradiance, global_tilted_irradiance, terrestrial_radiation, cape, freezing_level_height
Configure this setting directly using the following Meltano command:
meltano config tap-openmeteo set hourly_variables [value]Locations (locations)
-
Environment variable:
TAP_OPENMETEO_LOCATIONS
List of locations to fetch weather data for
Configure this setting directly using the following Meltano command:
meltano config tap-openmeteo set locations [value]15-Minutely Weather Variables (minutely_15_variables)
-
Environment variable:
TAP_OPENMETEO_MINUTELY_15_VARIABLES -
Default Value:
[]
List of 15-minutely weather variables. Only available in Central Europe and North America; other regions use interpolated hourly data. Available: temperature_2m, relative_humidity_2m, dew_point_2m, precipitation, rain, snowfall, weather_code, wind_speed_10m, wind_direction_10m, wind_gusts_10m, shortwave_radiation, direct_radiation, diffuse_radiation, sunshine_duration, visibility, cape, lightning_potential, is_day
Configure this setting directly using the following Meltano command:
meltano config tap-openmeteo set minutely_15_variables [value]Weather Models (models)
-
Environment variable:
TAP_OPENMETEO_MODELS -
Default Value:
[]
Specific weather models to use. Empty list uses 'best_match' which combines the best models for each location. Options include: ecmwf_ifs025, gfs_seamless, icon_seamless, meteofrance_seamless, jma_seamless, gem_seamless, etc.
Configure this setting directly using the following Meltano command:
meltano config tap-openmeteo set models [value]Past Days (past_days)
-
Environment variable:
TAP_OPENMETEO_PAST_DAYS -
Default Value:
0
Include past days in forecast (0-92). Default is 0. Ignored if past_hours is set.
Configure this setting directly using the following Meltano command:
meltano config tap-openmeteo set past_days [value]Past Hours (past_hours)
-
Environment variable:
TAP_OPENMETEO_PAST_HOURS
Number of past hours to include. When set, takes priority over past_days for hourly/minutely streams.
Configure this setting directly using the following Meltano command:
meltano config tap-openmeteo set past_hours [value]Precipitation Unit (precipitation_unit)
-
Environment variable:
TAP_OPENMETEO_PRECIPITATION_UNIT -
Default Value:
mm
Precipitation unit: 'mm' or 'inch'
Configure this setting directly using the following Meltano command:
meltano config tap-openmeteo set precipitation_unit [value]Request Timeout (request_timeout)
-
Environment variable:
TAP_OPENMETEO_REQUEST_TIMEOUT -
Default Value:
30
HTTP request timeout in seconds
Configure this setting directly using the following Meltano command:
meltano config tap-openmeteo set request_timeout [value]Start Date (start_date)
-
Environment variable:
TAP_OPENMETEO_START_DATE
Start date for historical data (YYYY-MM-DD format). Used for historical weather stream.
Configure this setting directly using the following Meltano command:
meltano config tap-openmeteo set start_date [value]Streams to Sync (streams_to_sync)
-
Environment variable:
TAP_OPENMETEO_STREAMS_TO_SYNC -
Default Value:
["weather_forecast","weather_hourly","weather_daily"]
List of streams to sync. Available: weather_forecast, weather_hourly, weather_daily, weather_current, weather_minutely_15, weather_historical
Configure this setting directly using the following Meltano command:
meltano config tap-openmeteo set streams_to_sync [value]Temperature Unit (temperature_unit)
-
Environment variable:
TAP_OPENMETEO_TEMPERATURE_UNIT -
Default Value:
celsius
Temperature unit: 'celsius' or 'fahrenheit'
Configure this setting directly using the following Meltano command:
meltano config tap-openmeteo set temperature_unit [value]Panel Tilt (tilt)
-
Environment variable:
TAP_OPENMETEO_TILT
Panel tilt angle for global tilted irradiance (0-90 degrees). 0° is horizontal, typically around 45°.
Configure this setting directly using the following Meltano command:
meltano config tap-openmeteo set tilt [value]Time Format (timeformat)
-
Environment variable:
TAP_OPENMETEO_TIMEFORMAT -
Default Value:
iso8601
Time format: 'iso8601' (e.g., 2024-01-01T00:00) or 'unixtime' (UNIX epoch seconds)
Configure this setting directly using the following Meltano command:
meltano config tap-openmeteo set timeformat [value]Default Timezone (timezone)
-
Environment variable:
TAP_OPENMETEO_TIMEZONE -
Default Value:
auto
Default timezone for all locations. Any timezone from the IANA time zone database is supported. Use 'auto' to resolve from coordinates or 'UTC' for GMT+0.
Configure this setting directly using the following Meltano command:
meltano config tap-openmeteo set timezone [value]User Agent (user_agent)
-
Environment variable:
TAP_OPENMETEO_USER_AGENT
Custom User-Agent header for API requests. Helps Open-Meteo track usage from your application.
Configure this setting directly using the following Meltano command:
meltano config tap-openmeteo set user_agent [value]Wind Speed Unit (wind_speed_unit)
-
Environment variable:
TAP_OPENMETEO_WIND_SPEED_UNIT -
Default Value:
kmh
Wind speed unit: 'kmh', 'ms', 'mph', or 'kn' (knots)
Configure this setting directly using the following Meltano command:
meltano config tap-openmeteo set wind_speed_unit [value]Expand To Show SDK Settings
Batch Compression Format (batch_config.encoding.compression)
-
Environment variable:
TAP_OPENMETEO_BATCH_CONFIG_ENCODING_COMPRESSION
Compression format to use for batch files.
Configure this setting directly using the following Meltano command:
meltano config tap-openmeteo set batch_config encoding.compression [value]Batch Encoding Format (batch_config.encoding.format)
-
Environment variable:
TAP_OPENMETEO_BATCH_CONFIG_ENCODING_FORMAT
Format to use for batch files.
Configure this setting directly using the following Meltano command:
meltano config tap-openmeteo set batch_config encoding.format [value]Batch Storage Prefix (batch_config.storage.prefix)
-
Environment variable:
TAP_OPENMETEO_BATCH_CONFIG_STORAGE_PREFIX
Prefix to use when writing batch files.
Configure this setting directly using the following Meltano command:
meltano config tap-openmeteo set batch_config storage.prefix [value]Batch Storage Root (batch_config.storage.root)
-
Environment variable:
TAP_OPENMETEO_BATCH_CONFIG_STORAGE_ROOT
Root path to use when writing batch files.
Configure this setting directly using the following Meltano command:
meltano config tap-openmeteo set batch_config storage.root [value]Faker Locale (faker_config.locale)
-
Environment variable:
TAP_OPENMETEO_FAKER_CONFIG_LOCALE
One or more LCID locale strings to produce localized output for: https://faker.readthedocs.io/en/master/#localization
Configure this setting directly using the following Meltano command:
meltano config tap-openmeteo set faker_config locale [value]Faker Seed (faker_config.seed)
-
Environment variable:
TAP_OPENMETEO_FAKER_CONFIG_SEED
Value to seed the Faker generator for deterministic output: https://faker.readthedocs.io/en/master/#seeding-the-generator
Configure this setting directly using the following Meltano command:
meltano config tap-openmeteo set faker_config seed [value]Enable Schema Flattening (flattening_enabled)
-
Environment variable:
TAP_OPENMETEO_FLATTENING_ENABLED
'True' to enable schema flattening and automatically expand nested properties.
Configure this setting directly using the following Meltano command:
meltano config tap-openmeteo set flattening_enabled [value]Max Flattening Depth (flattening_max_depth)
-
Environment variable:
TAP_OPENMETEO_FLATTENING_MAX_DEPTH
The max depth to flatten schemas.
Configure this setting directly using the following Meltano command:
meltano config tap-openmeteo set flattening_max_depth [value]User Stream Map Configuration (stream_map_config)
-
Environment variable:
TAP_OPENMETEO_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-openmeteo set stream_map_config [value]Stream Maps (stream_maps)
-
Environment variable:
TAP_OPENMETEO_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-openmeteo set stream_maps [value]Something missing?
This page is generated from a YAML file that you can contribute changes to.
Edit it on GitHub!Looking for help?
#plugins-general
channel.


