README

JulianToledano · Jan 23, 2025 · 7e5f293 · 7e5f293
1 parent 2ef474d
commit 7e5f293
Show file tree

Hide file tree

Showing 2 changed files with 25 additions and 3 deletions.
diff --git a/README.md b/README.md
@@ -9,12 +9,18 @@ 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 |
+
+### Coins Endpoints
+| Endpoint                                                   |  Status | Function                  |
+|------------------------------------------------------------|--|---------------------------|
 | /coins/list                                                | ✓ | CoinsList                 |
 | /coins/markets                                             | ✓ | CoinsMarket               |
 | /coins/{id}                                                | ✓ | CoinsId                   |
@@ -26,21 +32,37 @@ Coingecko API client for golang.
 | /coins/{id}/contract/{contract_address}                    | ✓ | ContractInfo              |
 | /coins/{id}/contract/{contract_address}/market_chart/      | ✓ | ContractMarketChart       |
 | /coins/{id}/contract/{contract_address}/market_chart/range | ✓ | ContractMarketChartRange  |
-| /asset_platforms                                           | ✓ | AssetPlatforms            |
 | /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    |
+
+### Derivatives Endpoints
+| Endpoint                                                   |  Status | Function                  |
+|------------------------------------------------------------|--|---------------------------|
 | /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              |
+
+### Other Endpoints
+| Endpoint                                                   |  Status | Function                  |
+|------------------------------------------------------------|--|---------------------------|
+| /asset_platforms                                           | ✓ | AssetPlatforms            |
 | /exchange_rates                                            | ✓ | ExchangeRates             |
 | /search                                                    | ✓ | Search                    |
 | /search/trending                                           | ✓ | Trending                  |

diff --git a/api/client.go b/api/client.go
@@ -21,14 +21,14 @@ import (
 )
 
 // proApiHeader returns a function that sets the Pro API key header on requests
-func proApiHeader(apiKey string) func(r *http.Request) {
+func proApiHeader(apiKey string) geckohttp.ApiHeaderFn {
 	return func(r *http.Request) {
 		r.Header.Set("x-cg-pro-api-key", apiKey)
 	}
 }
 
 // demoApiHeader returns a function that sets the Demo API key header on requests
-func demoApiHeader(apiKey string) func(r *http.Request) {
+func demoApiHeader(apiKey string) geckohttp.ApiHeaderFn {
 	return func(r *http.Request) {
 		r.Header.Set("x-cg-demo-api-key", apiKey)
 	}