CoinGecko Connector - Ismena website

info@ismena.com

CoinGecko Connector

Connector Details

Type

Virtual machines, Single VM , BYOL

Runs on

Google Compute Engine

Last Update

24 October, 2024

Category

Overview

The CoinGecko Connector provides seamless integration enabling access to real-time and historical cryptocurrency market data, including prices, market cap, volume, metadata for over 17,000 coins, exchange data, NFT data, and on-chain DEX data powered by GeckoTerminal. This connector acts as a proxy to streamline data retrieval by forwarding requests to the CoinGecko.

Integration Overview

This document outlines the integration points of the CoinGecko Connector, detailing each endpoint’s purpose, required parameters, and usage workflow. The connector forwards HTTP GET requests to the CoinGecko API, handling query parameters and API key authentication.

Supported Integration Action Points

ping: Checks the status of the CoinGecko API server.
getCoinPrice: Retrieves current prices for one or more coins by their IDs, names, or symbols.
getSupportedCurrencies: Lists supported currencies for price queries.
search: Searches for coins, categories, and markets.
getGlobalData: Retrieves global cryptocurrency market data.
getAssetPlatforms: Lists supported blockchain platforms.
getCoinsList: Retrieves a list of all supported coins.
getCoinsMarkets: Queries coins with market data like price, market cap, and volume.
getCoinById: Retrieves detailed metadata and market data for a specific coin by ID.
getCoinMarketChart: Retrieves historical market data for a coin over a specified period.
getCoinMarketChartRange: Retrieves historical market data for a coin within a specific date range.
getCoinByContract: Retrieves coin data by its contract address on a specific platform.
getExchanges: Lists supported exchanges with active trading volumes.
getExchangesList: Lists all supported exchanges, including those without active trading volumes.
getDerivatives: Lists all derivative products.
getDerivativeExchanges: Lists all derivative exchanges.
getNftsList: Lists supported NFT collections.
getNftById: Retrieves metadata and market data for a specific NFT collection by ID.
getNftByContract: Retrieves NFT collection data by its contract address on a specific platform.
getOnchainNetworks: Lists supported blockchain networks for on-chain DEX data.
getOnchainDexes: Lists supported decentralized exchanges (DEXes) on a specific blockchain network.
getOnchainPool: Retrieves market data for a specific liquidity pool.
getOnchainTokenPrice: Retrieves token prices by contract addresses on a specific blockchain network.
getOnchainToken: Retrieves market data for a specific token by its contract address.
getOnchainTokenInfo: Retrieves metadata for a specific token by its contract address.
getOnchainPoolOHLCV: Retrieves OHLCV (Open, High, Low, Close, Volume) chart data for a specific liquidity pool.
getOnchainPoolTrades: Retrieves recent trades for a specific liquidity pool.

Detailed Integration Documentation

Check API Status

Action	ping
Purpose	Checks the status of the CoinGecko API server to ensure it is operational.
Parameters	Required: x_cg_demo_api_key: API key for authentication (string, e.g., YOUR-API-KEY). Optional: None.
Configuration	Ensure the connector is configured with the correct base URL via the CONNECTOR_ENV_COINGECKO_BASE_URL environment variable.
Output	Successful: Returns a JSON object with: gecko_says: Status message (string, e.g., (V3) To the Moon!). Failure: Returns error details (e.g., 429: Rate limit exceeded).
Workflow Example	Configure the connector with the base URL via the CONNECTOR_ENV_COINGECKO_BASE_URL environment variable. Execute the ping action with the x_cg_demo_api_key header. Verify the response to confirm API availability.

Get Coin Prices

Action	getCoinPrice
Purpose	Retrieves current prices for one or more coins by their IDs, names, or symbols, with optional market cap, 24-hour volume, and price change data.
Parameters	Required: x_cg_demo_api_key: API key for authentication (string, e.g., YOUR-API-KEY). ids: Comma-separated list of coin IDs (string, e.g., bitcoin,ethereum). vs_currencies: Comma-separated list of currencies for prices (string, e.g., usd,eur). Optional: names: Comma-separated list of coin names (URL-encoded, string, e.g., Binance%20Coin). symbols: Comma-separated list of coin symbols (string, e.g., BTC,ETH). include_tokens: Set to all to include all tokens when searching by symbols (string, enum: all). include_market_cap: Include market cap in response (boolean, default: false). include_24hr_vol: Include 24-hour volume in response (boolean, default: false). include_24hr_change: Include 24-hour price change percentage (boolean, default: false). include_last_updated_at: Include last updated timestamp (boolean, default: false).
Configuration	Ensure the connector is configured with the correct base URL via the CONNECTOR_ENV_COINGECKO_BASE_URL environment variable.
Output	Successful: Returns a JSON object with: Coin IDs as keys and objects containing: usd: Price in USD (float, e.g., 117450). usd_market_cap: Market cap in USD (float, e.g., 2336206333790.3057). usd_24h_vol: 24-hour volume in USD (float, e.g., 23249849356.55227). usd_24h_change: 24-hour price change percentage (float, e.g., -0.30186180665803974). last_updated_at: Timestamp of last update (integer, e.g., 1752374062). Failure: Returns error details (e.g., 429: Rate limit exceeded).
Workflow Example	Execute the getCoinPrice action with x_cg_demo_api_key, ids=bitcoin,ethereum, vs_currencies=usd, and optional parameters like include_market_cap=true. Process the response to extract prices and other data for financial applications.

Get Supported Currencies

Action	getSupportedCurrencies
Purpose	Retrieves a list of supported currencies for price queries, useful for validating currency codes or building selection interfaces.
Parameters	Required: x_cg_demo_api_key: API key for authentication (string, e.g., YOUR-API-KEY). Optional: None.
Configuration	Ensure the connector is configured with the correct base URL via the CONNECTOR_ENV_COINGECKO_BASE_URL environment variable.
Output	Successful: Returns a JSON array of currency codes (e.g., ["usd", "eur"]). Failure: Returns error details (e.g., 429: Rate limit exceeded).
Workflow Example	Execute the getSupportedCurrencies action with x_cg_demo_api_key. Use the currency codes to populate a dropdown or validate inputs.

Search Coins, Categories, and Markets

Action	search
Purpose	Searches for coins, categories, and markets listed on CoinGecko, sorted by market cap in descending order.
Parameters	Required: x_cg_demo_api_key: API key for authentication (string, e.g., YOUR-API-KEY). query: Search query for coins, categories, or markets (string, e.g., bitcoin). Optional: None.
Configuration	Ensure the connector is configured with the correct base URL via the CONNECTOR_ENV_COINGECKO_BASE_URL environment variable.
Output	Successful: Returns a JSON object with: coins: Array of coin objects (see CoinMarketItem schema). exchanges: Array of exchange objects. categories: Array of category objects with id and name. Failure: Returns error details (e.g., 429: Rate limit exceeded).
Workflow Example	Execute the search action with x_cg_demo_api_key and query=bitcoin. Process the response to display search results in a user interface.

Get Global Cryptocurrency Data

Action	getGlobalData
Purpose	Retrieves global cryptocurrency market data, including active cryptocurrencies, total market cap, and volume.
Parameters	Required: x_cg_demo_api_key: API key for authentication (string, e.g., YOUR-API-KEY). Optional: None.
Configuration	Ensure the connector is configured with the correct base URL via the CONNECTOR_ENV_COINGECKO_BASE_URL environment variable.
Output	Successful: Returns a JSON object with: data: active_cryptocurrencies: Number of active cryptocurrencies (integer). total_market_cap: Object with market cap by currency (float). total_volume: Object with volume by currency (float). market_cap_percentage: Object with market cap percentages (float). Failure: Returns error details (e.g., 429: Rate limit exceeded).
Workflow Example	Execute the getGlobalData action with x_cg_demo_api_key. Use the data for market analysis or dashboard displays.

Get Asset Platforms

Action	getAssetPlatforms
Purpose	Retrieves a list of supported blockchain platforms (e.g., Ethereum, Solana).
Parameters	Required: x_cg_demo_api_key: API key for authentication (string, e.g., YOUR-API-KEY). Optional: None.
Configuration	Ensure the connector is configured with the correct base URL via the CONNECTOR_ENV_COINGECKO_BASE_URL environment variable.
Output	Successful: Returns a JSON array of platform objects with: id: Platform ID (string, e.g., ethereum). name: Platform name (string, e.g., Ethereum). chain_identifier: Chain ID (integer). Failure: Returns error details (e.g., 429: Rate limit exceeded).
Workflow Example	Execute the getAssetPlatforms action with x_cg_demo_api_key. Use the platforms to filter or display blockchain-specific data.

Get List of Supported Coins

Action	getCoinsList
Purpose	Retrieves a list of all supported coins with their IDs, names, and symbols.
Parameters	Required: x_cg_demo_api_key: API key for authentication (string, e.g., YOUR-API-KEY). Optional: include_platform: Include platform details like contract addresses (boolean, default: false).
Configuration	Ensure the connector is configured with the correct base URL via the CONNECTOR_ENV_COINGECKO_BASE_URL environment variable.
Output	Successful: Returns a JSON array of coin objects with: id: Coin ID (string, e.g., bitcoin). name: Coin name (string, e.g., Bitcoin). symbol: Coin symbol (string, e.g., BTC). platforms: Object with platform contract addresses (if include_platform=true). Failure: Returns error details (e.g., 429: Rate limit exceeded).
Workflow Example	Execute the getCoinsList action with x_cg_demo_api_key and optional include_platform=true. Use the coin list to populate a selection interface or validate coin IDs.

Get Coins with Market Data

Action	getCoinsMarkets
Purpose	Queries all supported coins with market data like price, market cap, and volume, with filtering options.
Parameters	Required: x_cg_demo_api_key: API key for authentication (string, e.g., YOUR-API-KEY). vs_currency: Currency for market data (string, e.g., usd). Optional: category: Filter by coin category (string). ids: Comma-separated list of coin IDs (string). names: Comma-separated list of coin names (URL-encoded, string). symbols: Comma-separated list of coin symbols (string). include_tokens: Set to all to include all tokens when searching by symbols (string, enum: all). order: Sort order (string, default: market_cap_desc). per_page: Results per page (integer, default: 100, max: 250). page: Page number for pagination (integer, default: 1).
Configuration	Ensure the connector is configured with the correct base URL via the CONNECTOR_ENV_COINGECKO_BASE_URL environment variable.
Output	Successful: Returns a JSON array of coin market objects with: id: Coin ID (string, e.g., the-open-network). coin_id: Numeric ID (integer, e.g., 17980). name: Coin name (string, e.g., Toncoin). symbol: Coin symbol (string, e.g., TON). market_cap_rank: Market cap rank (integer, e.g., 24). thumb: Thumbnail image URL (string). price_btc: Price in BTC (float). price: Price in specified currency (float). price_change_percentage_24h: 24-hour price change percentage (float). Failure: Returns error details (e.g., 429: Rate limit exceeded).
Workflow Example	Execute the getCoinsMarkets action with x_cg_demo_api_key, vs_currency=usd, and optional filters like category=stablecoin. Use the market data for portfolio tracking or market analysis.

Get Coin Data by ID

Action	getCoinById
Purpose	Retrieves detailed metadata and market data for a specific coin by its ID.
Parameters	Required: x_cg_demo_api_key: API key for authentication (string, e.g., YOUR-API-KEY). id: Coin ID (string, e.g., bitcoin). Optional: localization: Include localized description (boolean, default: true). tickers: Include ticker data (boolean, default: true). market_data: Include market data (boolean, default: true). community_data: Include community data (boolean, default: true). developer_data: Include developer data (boolean, default: true). sparkline: Include sparkline data for price trends (boolean, default: false).
Configuration	Ensure the connector is configured with the correct base URL via the CONNECTOR_ENV_COINGECKO_BASE_URL environment variable.
Output	Successful: Returns a JSON object with: id, name, symbol image: Object with image URLs (thumb, small, large) description: Object with descriptions by language market_data: Object with current_price, market_cap, total_volume last_updated: Last update timestamp (string, date-time) Failure: Returns error details (e.g., 429: Rate limit exceeded).
Workflow Example	Execute the getCoinById action with x_cg_demo_api_key and id=bitcoin. Use the metadata and market data for coin profiles or analytics.

Get Historical Market Data for a Coin

Action	getCoinMarketChart
Purpose	Retrieves historical market data (price, market cap, volume) for a coin over a specified period.
Parameters	Required: x_cg_demo_api_key: API key for authentication (string, e.g., YOUR-API-KEY). id: Coin ID (string, e.g., bitcoin). vs_currency: Currency for market data (string, e.g., usd). days: Number of days for historical data (string, e.g., 1, 7, 30, max). Optional: interval: Data interval (string, enum: hourly, daily).
Configuration	Ensure the connector is configured with the correct base URL via the CONNECTOR_ENV_COINGECKO_BASE_URL environment variable.
Output	Successful: Returns a JSON object with: prices: Array of [timestamp, price] arrays. market_caps: Array of [timestamp, market_cap] arrays. total_volumes: Array of [timestamp, volume] arrays. Failure: Returns error details (e.g., 429: Rate limit exceeded).
Workflow Example	Execute the getCoinMarketChart action with x_cg_demo_api_key, id=bitcoin, vs_currency=usd, and days=7. Use the historical data for charting or trend analysis.

Get Historical Market Data by Date Range

Action	getCoinMarketChartRange
Purpose	Retrieves historical market data for a coin within a specific date range.
Parameters	Required: x_cg_demo_api_key: API key for authentication (string, e.g., YOUR-API-KEY). id: Coin ID (string, e.g., bitcoin). vs_currency: Currency for market data (string, e.g., usd). from: UNIX timestamp of start date (integer, e.g., 1585267200). to: UNIX timestamp of end date (integer, e.g., 1585353600). Optional: None
Configuration	Ensure the connector is configured with the correct base URL via the CONNECTOR_ENV_COINGECKO_BASE_URL environment variable.
Output	Successful: Returns a JSON object with: prices: Array of [timestamp, price] arrays. market_caps: Array of [timestamp, market_cap] arrays. total_volumes: Array of [timestamp, volume] arrays. Failure: Returns error details (e.g., 429: Rate limit exceeded).
Workflow Example	Execute the getCoinMarketChartRange action with x_cg_demo_api_key, id=bitcoin, vs_currency=usd, from=1585267200, and to=1585353600. Use the data for historical analysis or reporting.

Get Coin Data by Contract Address

Action	getCoinByContract
Purpose	Retrieves coin data for a specific contract address on a given platform.
Parameters	Required: x_cg_demo_api_key: API key for authentication (string, e.g., YOUR-API-KEY). id: Platform ID (string, e.g., ethereum). contract_address: Contract address of the token (string, e.g., 0xc02aaa39b223fe8d0a0e5c4f27ead9083c756cc2). Optional: localization: Include localized description (boolean, default: true). tickers: Include ticker data (boolean, default: true). market_data: Include market data (boolean, default: true). community_data: Include community data (boolean, default: true). developer_data: Include developer data (boolean, default: true). sparkline: Include sparkline data for price trends (boolean, default: false).
Configuration	Ensure the connector is configured with the correct base URL via the CONNECTOR_ENV_COINGECKO_BASE_URL environment variable.
Output	Successful: Returns a JSON object with: id: Coin ID (string, e.g., bitcoin). name: Coin name (string, e.g., Bitcoin). symbol: Coin symbol (string, e.g., BTC). image: Object with image URLs (thumb, small, large). description: Object with descriptions by language. market_data: Object with current_price, market_cap, total_volume. last_updated: Last update timestamp (string, date-time). Failure: Returns error details (e.g., 429: Rate limit exceeded).
Workflow Example	Execute the getCoinByContract action with x_cg_demo_api_key, id=ethereum, and contract_address=0xc02aaa39b223fe8d0a0e5c4f27ead9083c756cc2. Use the data for token-specific analytics or display.

Get List of Exchanges

Action	getExchanges
Purpose	Retrieves all supported exchanges with active trading volumes, including ID, name, and country.
Parameters	Required: x_cg_demo_api_key: API key for authentication (string, e.g., YOUR-API-KEY). Optional: per_page: Results per page (integer, default: 100). page: Page number for pagination (integer, default: 1).
Configuration	Ensure the connector is configured with the correct base URL via the CONNECTOR_ENV_COINGECKO_BASE_URL environment variable.
Output	Successful: Returns a JSON array of exchange objects with: id: Exchange ID (string, e.g., binance). name: Exchange name (string, e.g., Binance). country: Country of operation (string, e.g., Cayman Islands). trade_volume_24h_btc: 24-hour trade volume in BTC (float). Failure: Returns error details (e.g., 429: Rate limit exceeded).
Workflow Example	Execute the getExchanges action with x_cg_demo_api_key and optional per_page=50. Use the exchange data for market analysis or comparison.

Get List of All Exchanges

Action	getExchangesList
Purpose	Retrieves a list of all supported exchanges, including those without active trading volumes.
Parameters	Required: x_cg_demo_api_key: API key for authentication (string, e.g., YOUR-API-KEY). Optional: None
Configuration	Ensure the connector is configured with the correct base URL via the CONNECTOR_ENV_COINGECKO_BASE_URL environment variable.
Output	Successful: Returns a JSON array of exchange objects with: id: Exchange ID (string, e.g., binance). name: Exchange name (string, e.g., Binance). Failure: Returns error details (e.g., 429: Rate limit exceeded).
Workflow Example	Execute the getExchangesList action with x_cg_demo_api_key. Use the list to populate exchange selection interfaces.

Get List of Derivatives

Action	getDerivatives
Purpose	Retrieves a list of all derivative products.
Parameters	Required: x_cg_demo_api_key: API key for authentication (string, e.g., YOUR-API-KEY). Optional: include_tickers: Include ticker data (string, enum: all, unexpired, default: all).
Configuration	Ensure the connector is configured with the correct base URL via the CONNECTOR_ENV_COINGECKO_BASE_URL environment variable.
Output	Successful: Returns a JSON array of derivative objects with: id: Derivative ID (string). name: Derivative name (string). open_interest_btc: Open interest in BTC (float). trade_volume_24h_btc: 24-hour trade volume in BTC (float). Failure: Returns error details (e.g., 429: Rate limit exceeded).
Workflow Example	Execute the getDerivatives action with x_cg_demo_api_key and optional include_tickers=unexpired. Use the derivative data for financial analysis or reporting.

Get List of Derivative Exchanges

Action	getDerivativeExchanges
Purpose	Retrieves a list of all derivative exchanges.
Parameters	Required: x_cg_demo_api_key: API key for authentication (string, e.g., YOUR-API-KEY). Optional: order: Sort order (string, default: volume_24h_desc). per_page: Results per page (integer, default: 100). page: Page number for pagination (integer, default: 1).
Configuration	Ensure the connector is configured with the correct base URL via the CONNECTOR_ENV_COINGECKO_BASE_URL environment variable.
Output	Successful: Returns a JSON array of exchange objects (see Exchange schema). Failure: Returns error details (e.g., 429: Rate limit exceeded).
Workflow Example	Execute the getDerivativeExchanges action with x_cg_demo_api_key and optional order=volume_24h_desc. Use the data for derivative market analysis.

Get List of NFT Collections

Action	getNftsList
Purpose	Retrieves a list of supported NFT collections with their IDs, names, and symbols.
Parameters	Required: x_cg_demo_api_key: API key for authentication (string, e.g., YOUR-API-KEY). Optional: per_page: Results per page (integer, default: 100). page: Page number for pagination (integer, default: 1).
Configuration	Ensure the connector is configured with the correct base URL via the CONNECTOR_ENV_COINGECKO_BASE_URL environment variable.
Output	Successful: Returns a JSON array of NFT objects with: id: NFT collection ID (string, e.g., taiyo-robotics). name: NFT collection name (string, e.g., Taiyo Robotics). symbol: NFT collection symbol (string, e.g., TYR). Failure: Returns error details (e.g., 429: Rate limit exceeded).
Workflow Example	Execute the getNftsList action with x_cg_demo_api_key and optional per_page=50. Use the NFT list for selection interfaces or market tracking.

Get NFT Collection Data by ID

Action	getNftById
Purpose	Retrieves metadata and market data for a specific NFT collection by its ID.
Parameters	Required: x_cg_demo_api_key: API key for authentication (string, e.g., YOUR-API-KEY). id: NFT collection ID (string, e.g., taiyo-robotics). Optional: None
Configuration	Ensure the connector is configured with the correct base URL via the CONNECTOR_ENV_COINGECKO_BASE_URL environment variable.
Output	Successful: Returns a JSON object with: id: NFT collection ID (string, e.g., taiyo-robotics). name: NFT collection name (string, e.g., Taiyo Robotics). symbol: NFT collection symbol (string, e.g., TYR). floor_price: Object with native_currency and usd (float). market_cap: Object with native_currency and usd (float). volume_24h: Object with native_currency and usd (float). Failure: Returns error details (e.g., 429: Rate limit exceeded).
Workflow Example	Execute the getNftById action with x_cg_demo_api_key and id=taiyo-robotics. Use the data for NFT market analysis or display.

Get NFT Collection Data by Contract Address

Action	getNftByContract
Purpose	Retrieves metadata and market data for a specific NFT collection by its contract address on a given platform.
Parameters	Required: x_cg_demo_api_key: API key for authentication (string, e.g., YOUR-API-KEY). asset_platform_id: Platform ID (string, e.g., ethereum). contract_address: Contract address of the NFT collection (string). Optional: None.
Configuration	Ensure the connector is configured with the correct base URL via the CONNECTOR_ENV_COINGECKO_BASE_URL environment variable.
Output	Successful: Returns a JSON object (see NftData schema). Failure: Returns error details (e.g., 429: Rate limit exceeded).
Workflow Example	Execute the getNftByContract action with x_cg_demo_api_key, asset_platform_id=ethereum, and contract_address=<contract_address>. Use the data for NFT-specific analytics.

Get List of DEXes on a Network

Action	getOnchainDexes
Purpose	Retrieves a list of supported decentralized exchanges (DEXes) on a specific blockchain network.
Parameters	Required: x_cg_demo_api_key: API key for authentication (string, e.g., YOUR-API-KEY). network: Blockchain network ID (string, e.g., eth). Optional: None
Configuration	Ensure the connector is configured with the correct base URL via the CONNECTOR_ENV_COINGECKO_BASE_URL environment variable.
Output	Successful: Returns a JSON array of DEX objects with: id: DEX ID (string, e.g., uniswap_v3). name: DEX name (string, e.g., Uniswap V3). Failure: Returns error details (e.g., 429: Rate limit exceeded).
Workflow Example	Execute the getOnchainDexes action with x_cg_demo_api_key and network=eth. Use the DEX list for on-chain market analysis.

Get Token Prices by Contract Addresses

Action	getOnchainTokenPrice
Purpose	Retrieves prices for one or more tokens by their contract addresses on a specific blockchain network.
Parameters	Required: x_cg_demo_api_key: API key for authentication (string, e.g., YOUR-API-KEY). network: Blockchain network ID (string, e.g., eth). addresses: Comma-separated list of token contract addresses (string). Optional: None
Configuration	Ensure the connector is configured with the correct base URL via the CONNECTOR_ENV_COINGECKO_BASE_URL environment variable.
Output	Successful: Returns a JSON object with token addresses as keys and objects containing: price: Token price (string). price_usd: Token price in USD (string). Failure: Returns error details (e.g., 429: Rate limit exceeded).
Workflow Example	Execute the getOnchainTokenPrice action with x_cg_demo_api_key, network=eth, and addresses=0xc02aaa39b223fe8d0a0e5c4f27ead9083c756cc2. Use the token prices for on-chain analytics.

Get Token Data by Contract Address

Action	getOnchainToken
Purpose	Retrieves market data for a specific token by its contract address on a supported blockchain network.
Parameters	Required: x_cg_demo_api_key: API key for authentication (string, e.g., YOUR-API-KEY). network: Blockchain network ID (string, e.g., eth). address: Token contract address (string, e.g., 0xc02aaa39b223fe8d0a0e5c4f27ead9083c756cc2). Optional: None
Configuration	Ensure the connector is configured with the correct base URL via the CONNECTOR_ENV_COINGECKO_BASE_URL environment variable.
Output	Successful: Returns a JSON object (see OnchainPool schema). Failure: Returns error details (e.g., 429: Rate limit exceeded).
Workflow Example	Execute the getOnchainToken action with x_cg_demo_api_key, network=eth, and address=0xc02aaa39b223fe8d0a0e5c4f27ead9083c756cc2. Use the token data for market analysis.

Get Token Metadata by Contract Address

Action	getOnchainTokenInfo
Purpose	Retrieves metadata (name, symbol, coin ID) for a specific token by its contract address on a supported blockchain network.
Parameters	Required: x_cg_demo_api_key: API key for authentication (string, e.g., YOUR-API-KEY). network: Blockchain network ID (string, e.g., eth). address: Token contract address (string, e.g., 0xc02aaa39b223fe8d0a0e5c4f27ead9083c756cc2). Optional: None
Configuration	Ensure the connector is configured with the correct base URL via the CONNECTOR_ENV_COINGECKO_BASE_URL environment variable.
Output	Successful: Returns a JSON object with: id: Token ID (string, e.g., eth_0xc02aaa39b223fe8d0a0e5c4f27ead9083c756cc2). type: Type (string, e.g., token). attributes: name: Token name (string, e.g., Wrapped Ether). symbol: Token symbol (string, e.g., WETH). Failure: Returns error details (e.g., 429: Rate limit exceeded).
Workflow Example	Execute the getOnchainTokenInfo action with x_cg_demo_api_key, network=eth, and address=0xc02aaa39b223fe8d0a0e5c4f27ead9083c756cc2. Use the metadata for token identification or display.

Get OHLCV Chart Data for a DEX Pool

Action	getOnchainPoolOHLCV
Purpose	Retrieves OHLCV (Open, High, Low, Close, Volume) chart data for a specific liquidity pool on a supported blockchain network.
Parameters	Required: x_cg_demo_api_key: API key for authentication (string, e.g., YOUR-API-KEY). network: Blockchain network ID (string, e.g., eth). pool_address: Contract address of the liquidity pool (string, e.g., 0x88e6a0c2ddd26feeb64f039a2c41296fcb3f5640). timeframe: Timeframe for OHLCV data (string, enum: hour, day, week). Optional: None
Configuration	Ensure the connector is configured with the correct base URL via the CONNECTOR_ENV_COINGECKO_BASE_URL environment variable.
Output	Successful: Returns a JSON object with: data: Array of objects with: timestamp: Timestamp (integer). open: Open price (string). high: High price (string). low: Low price (string). close: Close price (string). volume: Volume (string). Failure: Returns error details (e.g., 429: Rate limit exceeded).
Workflow Example	Execute the getOnchainPoolOHLCV action with x_cg_demo_api_key, network=eth, pool_address=0x88e6a0c2ddd26feeb64f039a2c41296fcb3f5640, and timeframe=day. Use the OHLCV data for charting or analysis.

Get Recent Trades for a DEX Pool

Action	getOnchainPoolTrades
Purpose	Retrieves the last 300 trades of a specific liquidity pool on a supported blockchain network in the past 24 hours.
Parameters	Required: x_cg_demo_api_key: API key for authentication (string, e.g., YOUR-API-KEY). network: Blockchain network ID (string, e.g., eth). pool_address: Contract address of the liquidity pool (string, e.g., 0x88e6a0c2ddd26feeb64f039a2c41296fcb3f5640). Optional: None
Configuration	Ensure the connector is configured with the correct base URL via the CONNECTOR_ENV_COINGECKO_BASE_URL environment variable.
Output	Successful: Returns a JSON array of trade objects with: transaction_hash: Transaction hash (string). amount_usd: Trade amount in USD (string). is_buy: Whether the trade is a buy (boolean). Failure: Returns error details (e.g., 429: Rate limit exceeded).
Workflow Example	Execute the getOnchainPoolTrades action with x_cg_demo_api_key, network=eth, and pool_address=0x88e6a0c2ddd26feeb64f039a2c41296fcb3f5640. Use the trade data for transaction analysis or monitoring.

Configuration

Base URL	Set the CONNECTOR_ENV_COINGECKO_BASE_URL environment variable to the appropriate CoinGecko API base URL.
Port	Set the CONNECTOR_ENV_PORT environment variable (default: 8081).
API Key	Provide the x_cg_demo_api_key header for all requests.

Workflow Example

Check API Status	Execute the ping action to verify API availability.
Fetch Coin Prices	Use the getCoinPrice action with ids=bitcoin,ethereum, vs_currencies=usd, and include_market_cap=true to retrieve prices and market data.
Explore Market Data	Use the getCoinsMarkets action with vs_currency=usd and category=stablecoin to analyze stablecoin market trends.
Retrieve Historical Data	Use the getCoinMarketChart action with id=bitcoin, vs_currency=usd, and days=30 for historical price trends.
Analyze On-Chain Data	Use the getOnchainPool action with network=eth and pool_address=0x88e6a0c2ddd26feeb64f039a2c41296fcb3f5640 to analyze DEX pool performance.

Pricing

bill-and-calculator-2023-11-27-05-25-06-utc 1

Request a Quote

Support

For Technical support please contact us on

custom-connectors-support@isolutions.sa

A tech solution company dedicated to providing innovation thus empowering businesses to thrive in the digital age.

Register to IBM x iSolution Event