Skip to content

Commit

Permalink
update: readme with all endpoints
Browse files Browse the repository at this point in the history
  • Loading branch information
@JulianToledano
JulianToledano committed Jan 25, 2025
1 parent 7e5f293 commit 8562122
Showing 1 changed file with 76 additions and 48 deletions.
124 changes: 76 additions & 48 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -11,64 +11,92 @@ Coingecko API client for golang.
## Endpoints

### Simple Endpoints
| Endpoint | Status | Function |
|------------------------------------------------------------|--|---------------------------|
| /ping | ✓ | Ping |
| /simple/price | ✓ | SimplePrice |
| /simple/token_price/{id} | ✓ | SimpleTokenPrice |
| /simple/supported_vs_currencies | ✓ | SimpleSupportedVsCurrency |
| Endpoint | Status | Function | Plan |
|------------------------------------------------------------|--|---------------------------|------|
| /ping | ✓ | Ping | 🦎 |
| /simple/price | ✓ | SimplePrice | 🦎 |
| /simple/token_price/{id} | ✓ | SimpleTokenPrice | 🦎 |
| /simple/supported_vs_currencies | ✓ | SimpleSupportedVsCurrency | 🦎 |

### Coins Endpoints
| Endpoint | Status | Function |
|------------------------------------------------------------|--|---------------------------|
| /coins/list | ✓ | CoinsList |
| /coins/markets | ✓ | CoinsMarket |
| /coins/{id} | ✓ | CoinsId |
| /coins/{id}/tickers | ✓ | CoinsIdTickers |
| /coins/{id}/history | ✓ | CoinsIdHistory |
| /coins/{id}/market_chart | ✓ | CoinsIdMarketChart |
| /coins/{id}/market_chart/range | ✓ | CoinsIdMarketChartRange |
| /coins/{id}/ohlc | ✓ | CoinsOhlc |
| /coins/{id}/contract/{contract_address} | ✓ | ContractInfo |
| /coins/{id}/contract/{contract_address}/market_chart/ | ✓ | ContractMarketChart |
| /coins/{id}/contract/{contract_address}/market_chart/range | ✓ | ContractMarketChartRange |
| /coins/categories/list | ✓ | CategoriesList |
| /coins/categories/ | ✓ | Categories |
| Endpoint | Status | Function | Plan |
|------------------------------------------|--|-------------------------|----|
| /coins/list | ✓ | CoinsList | 🦎 |
| /coins/top_gainers_losers | ✗ | | 💼 |
| /coins/list/new | ✗ | | 💼 |
| /coins/markets | ✓ | CoinsMarket | 🦎 |
| /coins/{id} | ✓ | CoinsId | 🦎 |
| /coins/{id}/tickers | ✓ | CoinsIdTickers | 🦎 |
| /coins/{id}/history | ✓ | CoinsIdHistory | 🦎 |
| /coins/{id}/market_chart | ✓ | CoinsIdMarketChart | 🦎 |
| /coins/{id}/market_chart/range | ✓ | CoinsIdMarketChartRange | 🦎 |
| /coins/{id}/ohlc | ✓ | CoinsOhlc | 🦎 |
| /coins/id/ohlc/range | ✗ | | 💼 |
| /coins/id/circulating_supply_chart | ✗ | | 👑 |
| /coins/id/circulating_supply_chart/range | ✗ | | 👑 |
| /coins/id/total_supply_chart | ✗ | | 👑 |
| /coins/id/total_supply_chart/range | ✗ | | 👑 |

### Contract Endpoints
| Endpoint | Status | Function | Plan |
|------------------------------------------------------------|--|---------------------------|------|
| /coins/{id}/contract/{contract_address} | ✓ | ContractInfo | 🦎 |
| /coins/{id}/contract/{contract_address}/market_chart/ | ✓ | ContractMarketChart | 🦎 |
| /coins/{id}/contract/{contract_address}/market_chart/range | ✓ | ContractMarketChartRange | 🦎 |

### Categories Endpoints
| Endpoint | Status | Function | Plan |
|------------------------------------------------------------|--|---------------------------|------|
| /coins/categories/list | ✓ | CategoriesList | 🦎 |
| /coins/categories/ | ✓ | Categories | 🦎 |

### Exchange Endpoints
| Endpoint | Status | Function |
|------------------------------------------------------------|--|---------------------------|
| /exchanges | ✓ | Exchanges |
| /exchanges/list | ✓ | ExchangesList |
| /exchanges/{id} | ✓ | ExchangesId |
| /exchanges/{id}/tickers | ✓ | ExchangesIdTickers |
| /exchanges/{id}/volume_chart | ✓ | ExchangesIdVolumeChart |
| Endpoint | Status | Function | Plan |
|----------------------------------------|--|------------------------|------|
| /exchanges | ✓ | Exchanges | 🦎 |
| /exchanges/list | ✓ | ExchangesList | 🦎 |
| /exchanges/{id} | ✓ | ExchangesId | 🦎 |
| /exchanges/{id}/tickers | ✓ | ExchangesIdTickers | 🦎 |
| /exchanges/{id}/volume_chart | ✓ | ExchangesIdVolumeChart | 🦎 |
| /exchanges/id/volume_chart/range | ✗ | | 💼 |

### Derivatives Endpoints
| Endpoint | Status | Function |
|------------------------------------------------------------|--|---------------------------|
| /derivaties | ✓ | Derivatives |
| /derivaties/exchanges | ✓ | DerivativesExchanges |
| /derivaties/exchanges/{id} | ✓ | DerivativesExchangesId |
| /derivaties/exchanges/list | ✓ | DerivativesExchangesList |
| Endpoint | Status | Function | Plan |
|------------------------------------------------------------|--|---------------------------|------|
| /derivaties | ✓ | Derivatives | 🦎 |
| /derivaties/exchanges | ✓ | DerivativesExchanges | 🦎 |
| /derivaties/exchanges/{id} | ✓ | DerivativesExchangesId | 🦎 |
| /derivaties/exchanges/list | ✓ | DerivativesExchangesList | 🦎 |

### NFT Endpoints
| Endpoint | Status | Function |
|------------------------------------------------------------|--|---------------------------|
| /nfts/list | ✓ | NftsList |
| /nfts/{id} | ✓ | NftsId |
| /nfts/{asset_platform_id}/contract/{contract_address} | ✓ | NftsContract |
| Endpoint | Status | Function | Plan |
|----------------------------------------------------------------|--|--------------|------|
| /nfts/list | ✓ | NftsList | 🦎 |
| /nfts/{id} | ✓ | NftsId | 🦎 |
| /nfts/{asset_platform_id}/contract/{contract_address} | ✓ | NftsContract | 🦎 |
| /nfts/markets | ✗ | | 💼 |
| /nfts/id/market_chart | ✗ | | 💼 |
| /nfts/asset_platform_id/contract/contract_address/market_chart | ✗ | | 💼 |
| /nfts/id/tickers | ✗ | | 💼 |

### Other Endpoints
| Endpoint | Status | Function |
|------------------------------------------------------------|--|---------------------------|
| /asset_platforms | ✓ | AssetPlatforms |
| /exchange_rates | ✓ | ExchangeRates |
| /search | ✓ | Search |
| /search/trending | ✓ | Trending |
| /global | ✓ | Global |
| /global/decentralized_finance_defi | ✓ | DecentrilizedFinanceDEFI |
| /companies/public_treasury/{coin_id} | ✓ | PublicTreasuryCoinId |
| Endpoint | Status | Function | Plan |
|-----------------------------------------|--|--------------------------|----|
| /asset_platforms | ✓ | AssetPlatforms | 🦎 |
| /token_lists/asset_platform_id/all.json | ✗ | | 👑 |
| /key | ✓ | AssetPlatforms | 🦎 |
| /exchange_rates | ✗ | | 💼 |
| /search | ✓ | Search | 🦎 |
| /search/trending | ✓ | Trending | 🦎 |
| /global | ✓ | Global | 🦎 |
| /global/decentralized_finance_defi | ✓ | DecentrilizedFinanceDEFI | 🦎 |
| /global/market_cap_chart | ✗ | | 💼 |
| /companies/public_treasury/{coin_id} | ✓ | PublicTreasuryCoinId | 🦎 |

#### Legend
* 🦎 - Free tier endpoints
* 💼 - Exclusive for Paid Plan subscribers (Analyst/Lite/Pro)
* 👑 - Exclusive for Enterprise Plan subscribers only

## Usage

Expand Down

0 comments on commit 8562122

Please sign in to comment.