CoinGeckoApi (coin_gecko_api v0.1.0) View Source

Documentation for CoinGeckoApi.

This interface is based on version 3 of the api. Base URL is "https://api.coingecko.com/api/v3/" Also check out CoinGecko api for more information at https://www.coingecko.com/en/api.

Link to this section Summary

Functions

coins(id \\ "bitcoin", params \\ %{"tickers" => "true", "market_data" => "true", "community_data" => "true", "developer_data" => "true", "sparkline" => "false"})

Get current data (name, price, market, ... including exchange tickers) for a coin

coins_id_contract_contract_address(id \\ "ethereum", contract_address \\ "0xc00e94cb662c3520282e6f5717214004a7f26888")

Get coin info from contract address

coins_id_contract_contract_address_market_chart(id \\ "ethereum", contract_address \\ "0xc00e94cb662c3520282e6f5717214004a7f26888", params \\ %{"vs_currency" => "usd", "days" => "100"})

Get historical market data include price, market cap, and 24h volume (granularity auto) from a contract address

coins_id_contract_contract_address_market_chart_range(id \\ "ethereum", contract_address \\ "0xc00e94cb662c3520282e6f5717214004a7f26888", params \\ %{"vs_currency" => "usd", "from" => "1392577232", "to" => "1422577232"})

Get historical market data include price, market cap, and 24h volume (granularity auto) from a contract address

coins_id_history(id \\ "bitcoin", params \\ %{"date" => "01-01-2015"})

Get historical data (name, price, market, stats) at a given date for a coin

coins_id_market_chart(id \\ "bitcoin", params \\ %{"vs_currency" => "usd", "days" => "100"})

Get historical market data include price, market cap, and 24h volume (granularity auto)

coins_id_market_chart_range(id \\ "bitcoin", params \\ %{"vs_currency" => "usd", "from" => "1392577232", "to" => "1422577232"})

Get historical market data include price, market cap, and 24h volume within a range of timestamp (granularity auto)

coins_id_ohlc(id \\ "bitcoin", params \\ %{"vs_currency" => "usd", "days" => "90"})

Get coin's OHLC (beta)

coins_id_status_updates(id \\ "bitcoin", params \\ %{})

Get status updates for a given coin (beta)

coins_id_tickers(id \\ "bitcoin", params \\ %{})

Get coin tickers (paginated to 100 items)

coins_list()

List all supported coins id, name and symbol (no pagination required) returns a list with objects like this: %{"id" => "1", "name" => "coin_name", "symbol" => "coin_symbol"}

coins_markets(params \\ %{"vs_currency" => "usd", "ids" => "bitcoin", "order" => "market_cap_desc", "per_page" => "100", "sparkline" => "false"})

Use this to obtain all the coins market data (price, market cap, volume)

derivatives()

List all derivative tickers

derivatives_exchanges()

List all derivative exchanges

derivatives_exchanges_id(exchange_id \\ "bitmex")

show derivative exchange data

derivatives_exchanges_list()

List all derivative exchanges name and identifier

events(params \\ %{})

Get events, paginated by 100

events_countries()

Get list of event countries

events_types()

Get list of event types

exchange_rates()

get BTC-to-Currency exchange rates

exchanges()

List all exchanges

exchanges_id(id \\ "binance")

get exchange volume in BTC and top 100 tickers only

exchanges_id_status_updates(id \\ "binance", params \\ %{})

get status updates for a given exchange (beta)

exchanges_id_volume_chart(id \\ "binance", days \\ "100")

Get volume_chart data for a given exchange (beta)

exchanges_list()

List all supported market id and name

finance_platforms()

List all finance platforms

finance_products()

List all finance products

get_api(api_path)

get_api_params(api_path, params \\ %{})

global()

Get cryptocurrency global data

global_decentralized_finance_defi()

Get cryptocurrency global decentralized finance (defi_ data)

indexes()

List all market indexes

indexes_list()

list market indexes id and name

ping()

Ping API

search_trending()

Get trending search coins on coingecko from last 24 hours

simple_price(params \\ %{"ids" => "bitcoin", "vs_currencies" => "usd", "include_market_cap" => "true", "include_24hr_vol" => "true", "include_24hr_change" => "true", "include_last_updated_at" => "true"})

Get the current price of any cryptocurrencies in any other supported currencies that you need. returns object like this: %{"bitcoin" => %{"usd" => 35861}}

simple_supported_vs_currencies()

Get list of supported_vs_currencies

simple_token_price(params \\ %{"contract_addresses" => "0xc00e94cb662c3520282e6f5717214004a7f26888", "vs_currencies" => "usd", "include_market_cap" => "true", "include_24hr_vol" => "true", "include_24hr_change" => "true", "include_last_updated_at" => "true"})

Get current price of tokens (using contract addresses) for a given platform in any other currency that you need. returns object like this

Link to this section Functions

coins(id \\ "bitcoin", params \\ %{"tickers" => "true", "market_data" => "true", "community_data" => "true", "developer_data" => "true", "sparkline" => "false"})

Get current data (name, price, market, ... including exchange tickers) for a coin

coins_id_contract_contract_address(id \\ "ethereum", contract_address \\ "0xc00e94cb662c3520282e6f5717214004a7f26888")

Get coin info from contract address

coins_id_contract_contract_address_market_chart(id \\ "ethereum", contract_address \\ "0xc00e94cb662c3520282e6f5717214004a7f26888", params \\ %{"vs_currency" => "usd", "days" => "100"})

Get historical market data include price, market cap, and 24h volume (granularity auto) from a contract address

coins_id_contract_contract_address_market_chart_range(id \\ "ethereum", contract_address \\ "0xc00e94cb662c3520282e6f5717214004a7f26888", params \\ %{"vs_currency" => "usd", "from" => "1392577232", "to" => "1422577232"})

Get historical market data include price, market cap, and 24h volume (granularity auto) from a contract address

coins_id_history(id \\ "bitcoin", params \\ %{"date" => "01-01-2015"})

Get historical data (name, price, market, stats) at a given date for a coin

coins_id_market_chart(id \\ "bitcoin", params \\ %{"vs_currency" => "usd", "days" => "100"})

Get historical market data include price, market cap, and 24h volume (granularity auto)

coins_id_market_chart_range(id \\ "bitcoin", params \\ %{"vs_currency" => "usd", "from" => "1392577232", "to" => "1422577232"})

Get historical market data include price, market cap, and 24h volume within a range of timestamp (granularity auto)

coins_id_ohlc(id \\ "bitcoin", params \\ %{"vs_currency" => "usd", "days" => "90"})

Get coin's OHLC (beta)

Candle’s body:

1 - 2 days: 30 minutes 3 - 30 days: 4 hours 31 and before: 4 days

coins_id_status_updates(id \\ "bitcoin", params \\ %{})

Get status updates for a given coin (beta)

coins_id_tickers(id \\ "bitcoin", params \\ %{})

Get coin tickers (paginated to 100 items)

coins_list()

List all supported coins id, name and symbol (no pagination required) returns a list with objects like this: %{"id" => "1", "name" => "coin_name", "symbol" => "coin_symbol"}

coins_markets(params \\ %{"vs_currency" => "usd", "ids" => "bitcoin", "order" => "market_cap_desc", "per_page" => "100", "sparkline" => "false"})

Use this to obtain all the coins market data (price, market cap, volume)

derivatives()

List all derivative tickers

derivatives_exchanges()

List all derivative exchanges

derivatives_exchanges_id(exchange_id \\ "bitmex")

show derivative exchange data

derivatives_exchanges_list()

List all derivative exchanges name and identifier

events(params \\ %{})

Get events, paginated by 100

events_countries()

Get list of event countries

events_types()

Get list of event types

exchange_rates()

get BTC-to-Currency exchange rates

exchanges()

List all exchanges

exchanges_id(id \\ "binance")

get exchange volume in BTC and top 100 tickers only

exchanges_id_status_updates(id \\ "binance", params \\ %{})

get status updates for a given exchange (beta)

exchanges_id_volume_chart(id \\ "binance", days \\ "100")

Get volume_chart data for a given exchange (beta)

exchanges_list()

List all supported market id and name

finance_platforms()

List all finance platforms

finance_products()

List all finance products

get_api(api_path)

get_api_params(api_path, params \\ %{})

global()

Get cryptocurrency global data

global_decentralized_finance_defi()

Get cryptocurrency global decentralized finance (defi_ data)

indexes()

List all market indexes

indexes_list()

list market indexes id and name

ping()

Ping API

Examples

iex(1)> CoinGeckoApi.ping
%{"gecko_says" => "(V3) To the Moon!"}

search_trending()

Get trending search coins on coingecko from last 24 hours

simple_price(params \\ %{"ids" => "bitcoin", "vs_currencies" => "usd", "include_market_cap" => "true", "include_24hr_vol" => "true", "include_24hr_change" => "true", "include_last_updated_at" => "true"})

Get the current price of any cryptocurrencies in any other supported currencies that you need. returns object like this: %{"bitcoin" => %{"usd" => 35861}}

simple_supported_vs_currencies()

Get list of supported_vs_currencies

simple_token_price(params \\ %{"contract_addresses" => "0xc00e94cb662c3520282e6f5717214004a7f26888", "vs_currencies" => "usd", "include_market_cap" => "true", "include_24hr_vol" => "true", "include_24hr_change" => "true", "include_last_updated_at" => "true"})

Get current price of tokens (using contract addresses) for a given platform in any other currency that you need. returns object like this:

%{
  "0xc00e94cb662c3520282e6f5717214004a7f26888" => %{
    "last_updated_at" => 1611109511,
    "usd" => 213.46,
    "usd_24h_change" => -6.384358204432436,
    "usd_24h_vol" => 87929838.57157373,
    "usd_market_cap" => 888756153.0997704
  }
}