The tap-fxmacrodata extractor pulls data from FXMacroData 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-fxmacrodata extractor to your
project using
:meltano add -
Configure the tap-fxmacrodata
settings using
:meltano config -
Test that extractor settings are valid using
:meltano config
meltano add tap-fxmacrodatameltano config tap-fxmacrodata set --interactivemeltano config tap-fxmacrodata testNext steps
USD macro data is public, so the tap runs without an API key. Indicator slugs differ per currency: sync the data_catalogue stream first to see what a currency publishes, then list the slugs you want in indicators.
If you run into any issues, learn how to get help.
Capabilities
The current capabilities for
tap-fxmacrodata
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-fxmacrodata 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
with the meltano configlist
subcommand:
meltano config tap-fxmacrodata 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_FXMACRODATA_API_KEY
FXMacroData API key. USD macro data is public, so the tap runs without one; a key widens it to the other seventeen currencies, the full history, and FX.
Configure this setting directly using the following Meltano command:
meltano config tap-fxmacrodata set api_key [value]API URL (api_url)
-
Environment variable:
TAP_FXMACRODATA_API_URL -
Default Value:
https://api.fxmacrodata.com/v1
Override the API base URL. Rarely needed.
Configure this setting directly using the following Meltano command:
meltano config tap-fxmacrodata set api_url [value]Currencies (currencies)
-
Environment variable:
TAP_FXMACRODATA_CURRENCIES -
Default Value:
["USD"]
Currency codes to extract, for example ["USD", "EUR"].
Configure this setting directly using the following Meltano command:
meltano config tap-fxmacrodata set currencies [value]Max Key Length (flattening_max_key_length)
-
Environment variable:
TAP_FXMACRODATA_FLATTENING_MAX_KEY_LENGTH
The maximum length of a flattened key.
Configure this setting directly using the following Meltano command:
meltano config tap-fxmacrodata set flattening_max_key_length [value]Flattening Separator (flattening_separator)
-
Environment variable:
TAP_FXMACRODATA_FLATTENING_SEPARATOR
The separator to use when flattening keys.
Configure this setting directly using the following Meltano command:
meltano config tap-fxmacrodata set flattening_separator [value]Fx Pairs (fx_pairs)
-
Environment variable:
TAP_FXMACRODATA_FX_PAIRS
Currency pairs for the forex_rates stream, for example ["EUR/USD"]. Leave unset to skip FX.
Configure this setting directly using the following Meltano command:
meltano config tap-fxmacrodata set fx_pairs [value]Indicators (indicators)
-
Environment variable:
TAP_FXMACRODATA_INDICATORS
Indicator slugs for the announcements stream, for example ["inflation", "policy_rate"]. Sync the data_catalogue stream first to see what a currency publishes. Leave unset to skip announcements.
Configure this setting directly using the following Meltano command:
meltano config tap-fxmacrodata set indicators [value]Start Date (start_date)
-
Environment variable:
TAP_FXMACRODATA_START_DATE
Earliest reference date to extract for dated streams.
Configure this setting directly using the following Meltano command:
meltano config tap-fxmacrodata set start_date [value]Expand To Show SDK Settings
Batch Compression Format (batch_config.encoding.compression)
-
Environment variable:
TAP_FXMACRODATA_BATCH_CONFIG_ENCODING_COMPRESSION
Compression format to use for batch files.
Configure this setting directly using the following Meltano command:
meltano config tap-fxmacrodata set batch_config encoding.compression [value]Batch Encoding Format (batch_config.encoding.format)
-
Environment variable:
TAP_FXMACRODATA_BATCH_CONFIG_ENCODING_FORMAT
Format to use for batch files.
Configure this setting directly using the following Meltano command:
meltano config tap-fxmacrodata set batch_config encoding.format [value]Batch Storage Prefix (batch_config.storage.prefix)
-
Environment variable:
TAP_FXMACRODATA_BATCH_CONFIG_STORAGE_PREFIX
Prefix to use when writing batch files.
Configure this setting directly using the following Meltano command:
meltano config tap-fxmacrodata set batch_config storage.prefix [value]Batch Storage Root (batch_config.storage.root)
-
Environment variable:
TAP_FXMACRODATA_BATCH_CONFIG_STORAGE_ROOT
Root path to use when writing batch files.
Configure this setting directly using the following Meltano command:
meltano config tap-fxmacrodata set batch_config storage.root [value]Faker Locale (faker_config.locale)
-
Environment variable:
TAP_FXMACRODATA_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-fxmacrodata set faker_config locale [value]Faker Seed (faker_config.seed)
-
Environment variable:
TAP_FXMACRODATA_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-fxmacrodata set faker_config seed [value]Enable Schema Flattening (flattening_enabled)
-
Environment variable:
TAP_FXMACRODATA_FLATTENING_ENABLED
'True' to enable schema flattening and automatically expand nested properties.
Configure this setting directly using the following Meltano command:
meltano config tap-fxmacrodata set flattening_enabled [value]Max Flattening Depth (flattening_max_depth)
-
Environment variable:
TAP_FXMACRODATA_FLATTENING_MAX_DEPTH
The max depth to flatten schemas.
Configure this setting directly using the following Meltano command:
meltano config tap-fxmacrodata set flattening_max_depth [value]User Stream Map Configuration (stream_map_config)
-
Environment variable:
TAP_FXMACRODATA_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-fxmacrodata set stream_map_config [value]Stream Maps (stream_maps)
-
Environment variable:
TAP_FXMACRODATA_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-fxmacrodata 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-brightgreen){kind=icon}
