coingecko-api

Coingecko API client for PHP

A simple, intuitive and composable API Client for the CoinGecko REST API Service.

API Version Support

• ✔️ API v3
• ✔️ Community Endpoint
• ✔️ Pro Endpoint

Requirements

• ✔️ php: 8.x
• ✔️ guzzlehttp/guzzle: ^7.5

Installation

The best and the easiest way to use this library is thru composer. You can also download the source directly and require it to your project.

Just take note of the requirements.

[ Composer ]

see packagist.org

OR

[ Direct Download ]

📥 Get it from the release

Library

[ Classes ]

This library provides 2 main classes which you can use depending on the type of endpoints you are accessing.

📦 CoinGeckoApiClient

This is the main class that allows building the API endpoints and sending the request.

This is always required.

📦 CoinGeckoUrlBuilder

CoinGecko API endpoints require a URL query which is a set of key value pairs encoded in the URL. This class enables to dynamically create them with ease without worrying the position or the casing of the keys.

Although by design can be achieved by using the CoinGeckoApiClient class alone, using the CoinGeckoUrlBuilder gives you a finer control over the parameters you set and more flexibility in managing the endpoints you're building.

This class is optional depending on the endpoint you need.

Usage

Accessing the API endpoints are fairly straightforward. If not for convenience, you don't really need a set of manuals to start using this library. You can just go directly to the CoinGecko REST API Official Documenation, find the endpoint you need and start building your request.

Let's use some examples.

🔹 Endpoint request "without"🚫 URL query

🌐 endpoint: /ping

🔹 Endpoint request "with"✔️ URL query

🌐 endpoint: /coins/categoreis

🔹 Endpoint request with path parameter(id)

🌐 endpoint: /exchanges/{id}/volume_chart

🔹 Endpoint request with path parameter(id) and URL Query

🌐 endpoint: /coins/{id}

Features

Set Method

• Before forming the endpoint, always start calling the set() method to make a clean object before building a request.

  Parameter Positioning

• The parameter position is not important. It can be set anywhere as long as it is required by the endpoint.

Send Methods ( Community vs Pro )

• There are 2 methods provided to send a request. The send() and the sendPro()
• send ⇨ used to send a request to Community API endpoints.

• sendPro ⇨ used to send a request to the exclusive Pro API endpoints. This method requires the x_cg_pro_api_key parameter key encoded in the URL for the request to be accepted.

• Both optionally accepts instance of CoinGeckoUrlBuilder() class.
• Aside from the x_cg_pro_api_key parameter key, there is no major difference between these 2 methods. Both are used the same way.

CoinGeckoUrlBuilder() Method Call with Prefix

• Method name for building a query string using CoinGeckoUrlBuilder() always have a prefix with.

• (i.e. withId() for id, withVsCurrency() for vs_currency)

Bonus Quirks

There are some benefits of using this CoinGecko client libray.

Aside from it's not required to learn any methods to use and the parameter positioning of each methods, there are other features which might not be essential but are available and ready to be used to provide manageability and flexibility to your coding.

1. Use of reset() instead of set()

⚠️ Calling set() is always the preferred way but you can also build request using the reset() method to cleanup resource. Just make sure to separate the call to send() method to avoid ParseError.

2. Case-insensitive method names

Endpoint name and URL parameter key name are case-insensitive. This means calling ping(), PING() and Ping() are treated the same thing. Additionally you can also use underscore(_) as a separator for names like VS_CURRENCY or vs_Currency. They will be handled properly.

3. Request reusability

API Usage

📋Endpoint List

1. companies (beta)

🌐 ping

1. 📋 endpoint : /ping

Check API server status

[ method ] :
ping()

💡 sample usage

🌐 simple

1. 📋 endpoint : /simple/price

Get the current price of any cryptocurrencies in any other supported currencies that you need.

[ method ] :
simple()->price()

🔑 URL Keys : 7
✔️ withIds('string')❗️
✔️ withVsCurrencies('string')❗️
✔️ withIncludeMarketCap('string')
✔️ withInclude24hrVol('string')
✔️ withInclude24hrChange('string')
✔️ withIncludeLastUpdatedAt('string')
✔️ withPrecision('string')

2. 📋 endpoint : /simple/token_price/{id}

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

[ method ] :
simple()->tokenPrice('{id}')

🔑 URL Keys : 7
✔️ withContractAddresses('string')❗️
✔️ withVsCurrencies('string')❗️
✔️ withIncludeMarketCap('string')
✔️ withInclude24hrVol('string')
✔️ withInclude24hrChange('string')
✔️ withIncludeLastUpdatedAt('string')
✔️ withPrecision('string')

3. 📋 endpoint : /simple/supported_vs_currencies

Get list of supported_vs_currencies.

[ method ] :
simple()->supportedVsCurrencies()

💡 sample usage

🌐 coins

1. 📋 endpoint : /coins/list

List all supported coins id, name and symbol (no pagination required)

[ method ] :
coins()->list()

🔑 URL Keys : 1
✔️ withIncludePlatform('boolean')

2. 📋 endpoint : /coins/markets

List all supported coins price, market cap, volume, and market related data

[ method ] :
coins()->markets()

🔑 URL Keys : 8
✔️ withVsCurrency('string')❗️
✔️ withIds('string')
✔️ withCategory('string')
✔️ withOrder('string')
✔️ withPerPage('integer')
✔️ withPage('integer')
✔️ withSparkline('boolean')
✔️ withPriceChangePercentage('string')

3. 📋 endpoint : /coins/{id}

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

[ method ] :
coins('{id}')

🔑 URL Keys : 6
✔️ withLocalization('string')
✔️ withTickers('boolean')
✔️ withMarketData('boolean')
✔️ withCommunityData('boolean')
✔️ withDeveloperData('boolean')
✔️ withSparkline('boolean')

4. 📋 endpoint : /coins/{id}/tickers

Get coin tickers (paginated to 100 items)

[ method ] :
coins('{id}')->tickers()

🔑 URL Keys : 5
✔️ withExchangeIds('string')
✔️ withIncludeExchangeLogo('string')
✔️ withPage('integer')
✔️ withOrder('string')
✔️ withDepth('string')

5. 📋 endpoint : /coins/{id}/history

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

[ method ] :
coins('{id}')->history()

🔑 URL Keys : 2
✔️ withDate('string')❗️
✔️ withLocalization('string')

6. 📋 endpoint : /coins/{id}/market_chart

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

[ method ] :
coins('{id}')->marketChart()

🔑 URL Keys : 3
✔️ withVsCurrency('string')❗️
✔️ withDays('string')❗️
✔️ withInterval('string')

7. 📋 endpoint : /coins/{id}/market_chart/range

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

[ method ] :
coins('{id}')->marketChart()->range()

🔑 URL Keys : 3
✔️ withVsCurrency('string')❗️
✔️ withFrom('string')❗️
✔️ withTo('string')❗️

🌐 contract

1. 📋 endpoint : /coins/{id}/contract/{contract_address}

Get coin info from contract address

[ method ] :
coins('{id}')->contract('{contract_address}')

💡 sample usage

2. 📋 endpoint : /coins/{id}/contract/{contract_address}/market_chart/

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

[ method ] :
coins('{id}')->contract('{contract_address}')->marketChart()

🔑 URL Keys : 2
✔️ withVsCurrency('string')❗️
✔️ withDays('string')❗️

3. 📋 endpoint : /coins/{id}/contract/{contract_address}/market_chart/range

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

[ method ] :
coins('{id}')->contract('{contract_address}')->marketChart()->range()

🔑 URL Keys : 3
✔️ withVsCurrency('string')❗️
✔️ withFrom('string')❗️
✔️ withTo('string')❗️

🌐 coins

1. 📋 endpoint : /coins/{id}/ohlc

Get coin's OHLC

[ method ] :
coins('{id}')->ohlc()

🔑 URL Keys : 2
✔️ withVsCurrency('string')❗️
✔️ withDays('string')❗️

🌐 asset_platforms

1. 📋 endpoint : /asset_platforms

List all asset platforms (Blockchain networks)

[ method ] :
assetPlatforms()

🔑 URL Keys : 1
✔️ withFilter('string')

🌐 categories

1. 📋 endpoint : /coins/categories/list

List all categories

[ method ] :
coins()->categories()->list()

💡 sample usage

2. 📋 endpoint : /coins/categories

List all categories with market data

[ method ] :
coins()->categories()

🔑 URL Keys : 1
✔️ withOrder('string')

🌐 exchanges

1. 📋 endpoint : /exchanges

List all exchanges (Active with trading volumes)

[ method ] :
exchanges()

🔑 URL Keys : 2
✔️ withPerPage('integer')
✔️ withPage('string')

2. 📋 endpoint : /exchanges/list

List all supported markets id and name (no pagination required)

[ method ] :
exchanges()->list()

💡 sample usage

3. 📋 endpoint : /exchanges/{id}

Get exchange volume in BTC and top 100 tickers only

[ method ] :
exchanges('{id}')

💡 sample usage

4. 📋 endpoint : /exchanges/{id}/tickers

Get exchange tickers (paginated, 100 tickers per page)

[ method ] :
exchanges('{id}')->tickers()

🔑 URL Keys : 5
✔️ withCoinIds('string')
✔️ withIncludeExchangeLogo('string')
✔️ withPage('integer')
✔️ withDepth('string')
✔️ withOrder('string')

🌐 indexes

1. 📋 endpoint : /indexes

List all market indexes

[ method ] :
indexes()

🔑 URL Keys : 2
✔️ withPerPage('integer')
✔️ withPage('integer')

2. 📋 endpoint : /indexes/{market_id}/{id}

get market index by market id and index id

[ method ] :
indexes('{market_id}','{id}')

💡 sample usage

3. 📋 endpoint : /indexes/list

list market indexes id and name

[ method ] :
indexes()->list()

💡 sample usage

🌐 derivatives

1. 📋 endpoint : /derivatives

List all derivative tickers

[ method ] :
derivatives()

🔑 URL Keys : 1
✔️ withIncludeTickers('string')

2. 📋 endpoint : /derivatives/exchanges

List all derivative exchanges

[ method ] :
derivatives()->exchanges()

🔑 URL Keys : 3
✔️ withOrder('string')
✔️ withPerPage('integer')
✔️ withPage('integer')

3. 📋 endpoint : /derivatives/exchanges/{id}

show derivative exchange data

[ method ] :
derivatives()->exchanges('{id}')

🔑 URL Keys : 1
✔️ withIncludeTickers('string')

4. 📋 endpoint : /derivatives/exchanges/list

List all derivative exchanges name and identifier

[ method ] :
derivatives()->exchanges()->list()

💡 sample usage

🌐 exchanges

1. 📋 endpoint : /exchanges/{id}/volume_chart

Get volume_chart data for a given exchange

[ method ] :
exchanges('{id}')->volumeChart()

🔑 URL Keys : 1
✔️ withDays('integer')❗️

🌐 nfts (beta)

1. 📋 endpoint : /nfts/list

List all supported NFT ids, paginated by 100 items per page, paginated to 100 items

[ method ] :
nfts()->list()

🔑 URL Keys : 4
✔️ withOrder('string')
✔️ withAssetPlatformId('string')
✔️ withPerPage('integer')
✔️ withPage('integer')

2. 📋 endpoint : /nfts/{id}

Get current data (name, price_floor, volume_24h ...) for an NFT collection

[ method ] :
nfts('{id}')

💡 sample usage

3. 📋 endpoint : /nfts/{asset_platform_id}/contract/{contract_address}

Get current data (name, price_floor, volume_24h ...) for an NFT collection

[ method ] :
nfts('{asset_platform_id}')->contract('{contract_address}')

💡 sample usage

🌐 exchange_rates

1. 📋 endpoint : /exchange_rates

Get BTC-to-Currency exchange rates

[ method ] :
exchangeRates()

💡 sample usage

🌐 search

1. 📋 endpoint : /search

Search for coins, categories and markets on CoinGecko

[ method ] :
search()

🔑 URL Keys : 1
✔️ withQuery('string')❗️

🌐 trending

1. 📋 endpoint : /search/trending

Get trending search coins (Top-7) on CoinGecko in the last 24 hours

[ method ] :
search()->trending()

💡 sample usage

🌐 global

1. 📋 endpoint : /global

Get cryptocurrency global data

[ method ] :
global()

💡 sample usage

2. 📋 endpoint : /global/decentralized_finance_defi

Get cryptocurrency global decentralized finance(defi) data

[ method ] :
global()->decentralizedFinanceDefi()

💡 sample usage

🌐 companies (beta)

1. 📋 endpoint : /companies/public_treasury/{coin_id}

Get public companies data

[ method ] :
companies()->publicTreasury('{coin_id}')

💡 sample usage