The tap-coingecko extractor pulls data from Coingecko that can then be sent to a destination using a loader .
Airbyte Usage Notice
This connector uses tap-airbyte-wrapper to call the underlying Airbyte source Docker container. This means you must have Docker installed and running prior to usage. We also recommend using Meltano version 2.13.0 or later.Container-based connectors can introduce deployment challenges including the potential need to run Docker-in-Docker (not currently supported by services like AWS ECS, Meltano Cloud, etc. see FAQ and Airbyte's ECS deployment docs for more details). Before using this variant we recommend considering if/how you will be able to deploy container-based connectors to production.
For more context on how this Airbyte integration works please checkout out the FAQ in the Meltano Docs .
Alternate Implementations
Getting Started
Prerequisites
If you haven't already, follow the initial steps of the Getting Started guide :
Installation and configuration
-
Add the tap-coingecko extractor to your
project using
:meltano add -
Configure the tap-coingecko
settings
using
:meltano config -
Test that extractor settings are valid using
:meltano config
meltano add tap-coingecko --variant airbytemeltano config tap-coingecko set --interactivemeltano config tap-coingecko 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-coingecko
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
- 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-coingecko
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:
-
airbyte_config.api_key -
airbyte_config.coin_id -
airbyte_config.days -
airbyte_config.end_date -
airbyte_config.start_date -
airbyte_config.vs_currency -
airbyte_spec.image -
airbyte_spec.tag -
docker_mounts
Expand To Show SDK Settings
You can also list these settings using
meltano config
list
subcommand:
meltano config tap-coingecko 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.
Airbyte Config Api Key (airbyte_config.api_key)
-
Environment variable:
TAP_COINGECKO_AIRBYTE_CONFIG_API_KEY
API Key (for pro users)
Configure this setting directly using the following Meltano command:
meltano config tap-coingecko set airbyte_config api_key [value]
Airbyte Config Coin Id (airbyte_config.coin_id)
-
Environment variable:
TAP_COINGECKO_AIRBYTE_CONFIG_COIN_ID
CoinGecko coin ID (e.g. bitcoin). Can be retrieved from the
/coins/list
endpoint.
Configure this setting directly using the following Meltano command:
meltano config tap-coingecko set airbyte_config coin_id [value]
Airbyte Config Days (airbyte_config.days)
-
Environment variable:
TAP_COINGECKO_AIRBYTE_CONFIG_DAYS
The number of days of data for market chart.
Configure this setting directly using the following Meltano command:
meltano config tap-coingecko set airbyte_config days [value]
Airbyte Config End Date (airbyte_config.end_date)
-
Environment variable:
TAP_COINGECKO_AIRBYTE_CONFIG_END_DATE
The end date for the historical data stream in dd-mm-yyyy format.
Configure this setting directly using the following Meltano command:
meltano config tap-coingecko set airbyte_config end_date [value]
Airbyte Config Start Date (airbyte_config.start_date)
-
Environment variable:
TAP_COINGECKO_AIRBYTE_CONFIG_START_DATE
The start date for the historical data stream in dd-mm-yyyy format.
Configure this setting directly using the following Meltano command:
meltano config tap-coingecko set airbyte_config start_date [value]
Airbyte Config Vs Currency (airbyte_config.vs_currency)
-
Environment variable:
TAP_COINGECKO_AIRBYTE_CONFIG_VS_CURRENCY
The target currency of market data (e.g. usd, eur, jpy, etc.)
Configure this setting directly using the following Meltano command:
meltano config tap-coingecko set airbyte_config vs_currency [value]
Airbyte Spec Image (airbyte_spec.image)
-
Environment variable:
TAP_COINGECKO_AIRBYTE_SPEC_IMAGE -
Default Value:
airbyte/source-coingecko-coins
Airbyte image to run
Configure this setting directly using the following Meltano command:
meltano config tap-coingecko set airbyte_spec image [value]
Airbyte Spec Tag (airbyte_spec.tag)
-
Environment variable:
TAP_COINGECKO_AIRBYTE_SPEC_TAG -
Default Value:
latest
Airbyte image tag
Configure this setting directly using the following Meltano command:
meltano config tap-coingecko set airbyte_spec tag [value]
Docker Mounts (docker_mounts)
-
Environment variable:
TAP_COINGECKO_DOCKER_MOUNTS
Docker mounts to make available to the Airbyte container. Expects a list of maps containing source, target, and type as is documented in the docker --mount documentation
Configure this setting directly using the following Meltano command:
meltano config tap-coingecko set docker_mounts [value]Expand To Show SDK Settings
Flattening Enabled (flattening_enabled)
-
Environment variable:
TAP_COINGECKO_FLATTENING_ENABLED
'True' to enable schema flattening and automatically expand nested properties.
Configure this setting directly using the following Meltano command:
meltano config tap-coingecko set flattening_enabled [value]
Flattening Max Depth (flattening_max_depth)
-
Environment variable:
TAP_COINGECKO_FLATTENING_MAX_DEPTH
The max depth to flatten schemas.
Configure this setting directly using the following Meltano command:
meltano config tap-coingecko set flattening_max_depth [value]
Stream Map Config (stream_map_config)
-
Environment variable:
TAP_COINGECKO_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-coingecko set stream_map_config [value]
Stream Maps (stream_maps)
-
Environment variable:
TAP_COINGECKO_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-coingecko 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
