coingecko-api-v3 - npm Package Compare versions

Comparing version 0.0.7 to 0.0.8

dist/CoinGeckoClient.d.ts

@@ -64,3 +64,3 @@ import { PLATFORMS } from './Enum';
      */
-    coin(input: {
+    coinId(input: {
         id: string;
@@ -90,3 +90,3 @@ localization?: boolean;
      */
-    coinTickers(input: {
+    coinIdTickers(input: {
         id: string;
@@ -108,3 +108,3 @@ exchange_ids?: string;
      */
-    coinHistory(input: {
+    coinIdHistory(input: {
         id: string;
@@ -125,3 +125,3 @@ date: string;
      */
-    coinMarketChart(input: {
+    coinIdMarketChart(input: {
         id: string;
@@ -143,3 +143,3 @@ vs_currency: string;
      */
-    coinMarketChartRange(input: {
+    coinIdMarketChartRange(input: {
         id: string;
@@ -160,3 +160,3 @@ vs_currency: string;
      */
-    coinStatusUpdates(input: {
+    coinIdStatusUpdates(input: {
         id: string;
@@ -194,3 +194,3 @@ per_page?: number;
      */
-    coinOHLC(input: {
+    coinIdOHLC(input: {
         id: string;
@@ -197,0 +197,0 @@ vs_currency: string;

dist/CoinGeckoClient.js

@@ -130,3 +130,3 @@ "use strict";
      */
-    coin(input) {
+    coinId(input) {
         return __awaiter(this, void 0, void 0, function* () {
@@ -152,3 +152,3 @@ return this.makeRequest(Enum_1.API_ROUTES.COIN, input);
      */
-    coinTickers(input) {
+    coinIdTickers(input) {
         return __awaiter(this, void 0, void 0, function* () {
@@ -167,3 +167,3 @@ return this.makeRequest(Enum_1.API_ROUTES.COIN_TICKERS, input);
      */
-    coinHistory(input) {
+    coinIdHistory(input) {
         return __awaiter(this, void 0, void 0, function* () {
@@ -184,3 +184,3 @@ return this.makeRequest(Enum_1.API_ROUTES.COIN_HISTORY, input);
      */
-    coinMarketChart(input) {
+    coinIdMarketChart(input) {
         return __awaiter(this, void 0, void 0, function* () {
@@ -201,3 +201,3 @@ return this.makeRequest(Enum_1.API_ROUTES.COIN_MARKET_CHART, input);
      */
-    coinMarketChartRange(input) {
+    coinIdMarketChartRange(input) {
         return __awaiter(this, void 0, void 0, function* () {
@@ -217,3 +217,3 @@ return this.makeRequest(Enum_1.API_ROUTES.COIN_MARKET_CHART_RANGE, input);
      */
-    coinStatusUpdates(input) {
+    coinIdStatusUpdates(input) {
         return __awaiter(this, void 0, void 0, function* () {
@@ -251,3 +251,3 @@ return this.makeRequest(Enum_1.API_ROUTES.COIN_STATUS_UPDATES, input);
      */
-    coinOHLC(input) {
+    coinIdOHLC(input) {
         return __awaiter(this, void 0, void 0, function* () {
@@ -254,0 +254,0 @@ return this.makeRequest(Enum_1.API_ROUTES.COIN_OHLC, input);

dist/CoinGeckoClient.test.js

@@ -44,3 +44,3 @@ "use strict";
         it('/coins/{id}/tickers should successful', () => __awaiter(void 0, void 0, void 0, function* () {
-            const ticker = yield client.coinTickers({ id: 'origin-protocol' });
+            const ticker = yield client.coinIdTickers({ id: 'origin-protocol' });
             expect(ticker.name).toEqual('Origin Protocol');
@@ -50,3 +50,3 @@ expect(ticker.tickers.length).toBeGreaterThan(0);
         it('/coins/{id}/history should successful', () => __awaiter(void 0, void 0, void 0, function* () {
-            const coin = yield client.coinHistory({ id: 'bitcoin', date: '01-04-2021' });
+            const coin = yield client.coinIdHistory({ id: 'bitcoin', date: '01-04-2021' });
             expect(coin.name).toEqual('Bitcoin');
@@ -56,3 +56,3 @@ expect(coin.localization).not.toBeNull();
         it('/coins/{id}/history should successful with no localization', () => __awaiter(void 0, void 0, void 0, function* () {
-            const coin = yield client.coinHistory({ id: 'bitcoin', date: '01-04-2021', localization: false });
+            const coin = yield client.coinIdHistory({ id: 'bitcoin', date: '01-04-2021', localization: false });
             expect(coin.name).toEqual('Bitcoin');
@@ -62,3 +62,3 @@ expect(coin.localization).toEqual(undefined);
         it('/coins/{id}/market_chart should successful', () => __awaiter(void 0, void 0, void 0, function* () {
-            const marketChart = yield client.coinMarketChart({
+            const marketChart = yield client.coinIdMarketChart({
                 id: 'bitcoin', vs_currency: 'aud', interval: 'hourly', days: 1,
@@ -72,3 +72,3 @@ });
         it('/coins/{id}/market_chart/range should successful', () => __awaiter(void 0, void 0, void 0, function* () {
-            const marketChart = yield client.coinMarketChartRange({
+            const marketChart = yield client.coinIdMarketChartRange({
                 id: 'bitcoin', vs_currency: 'aud', from: 1392577232, to: 1618716149,
@@ -82,7 +82,7 @@ });
         it('/coins/{id}/status_updates should successful', () => __awaiter(void 0, void 0, void 0, function* () {
-            const statusUpdate = yield client.coinStatusUpdates({ id: 'litecoin' });
+            const statusUpdate = yield client.coinIdStatusUpdates({ id: 'litecoin' });
             expect(statusUpdate.status_updates.length).toBeGreaterThan(0);
         }));
         it('/coins/{id}/ohlc should successful', () => __awaiter(void 0, void 0, void 0, function* () {
-            const ohlc = yield client.coinOHLC({ id: 'litecoin', vs_currency: 'aud', days: 30 });
+            const ohlc = yield client.coinIdOHLC({ id: 'litecoin', vs_currency: 'aud', days: 30 });
             expect(ohlc.length).toBeGreaterThan(0);
@@ -89,0 +89,0 @@ expect(ohlc[0].length).toBe(5);

package.json

 {
   "name": "coingecko-api-v3",
-  "version": "0.0.7",
+  "version": "0.0.8",
   "description": "The nodejs api library for accessing coingecko api v3 , develop with typescript",
@@ -31,3 +31,3 @@ "main": "dist/index.js",
   },
-  "homepage": "https://github.com/samuraitruong/coingecko-api-v3#readme",
+  "homepage": "https://samuraitruong.github.io/coingecko-api-v3",
   "devDependencies": {
@@ -34,0 +34,0 @@ "@types/jest": "^26.0.22",

README.md

 # coingecko-api-v3
 
-The nodejs api library for accessing coingecko api v3 , develop with typescript
+[![CI](https://github.com/samuraitruong/coingecko-api-v3/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/samuraitruong/coingecko-api-v3/actions/workflows/ci.yml)
 
-Official document here - https://www.coingecko.com/api/documentations/v3
-API document generated - https://samuraitruong.github.io/coingecko-api-v3/classes/coingeckoclient.coingeckoclient-1.html
+The nodejs api library for accessing coingecko api v3 , develop with typescript with zero dependencies
 
+Official document here - https:/www.coingecko.com/api/documentations/v3
+
+API document generated - https:/samuraitruong.github.io/coingecko-api-v3/classes/coingeckoclient.coingeckoclient-1.html
+
 ## Get started
@@ -20,3 +23,45 @@
 
-## Methods
+## Supported API method
 
+| Endpoint                                                   |                           function | tested? |
+| ---------------------------------------------------------- | ---------------------------------: | :-----: |
+| /ping                                                      |                      client.ping() |   ✅    |
+| /simple/price                                              |                client.simpePrice() |   ✅    |
+| /simple/token_price/:id                                    |             client.simplePriceId() |   ✅    |
+| /simple/supported_vs_currencies                            | client.simpleSupportedCurrencies() |   ✅    |
+| /coins/list                                                |                  client.coinList() |   ✅    |
+| /coins/markets                                             |               client.coinMarkets() |   ✅    |
+| /coins/:id                                                 |                    client.coinId() |   ✅    |
+| /coins/:id/tickers                                         |             client.coinIdTickers() |   ✅    |
+| /coins/:id/history                                         |             client.coinIdHistory() |   ✅    |
+| /coins/:id/market_history                                  |       client.coinIdMarketHistory() |   ✅    |
+| /coins/id/market_chart                                     |         client.coinIdMarketChart() |   ✅    |
+| /coins/{id}/market_chart/range                             |    client.coinIdMarketChartRange() |   ✅    |
+| /coins/{id}/status_updates                                 |       client.coinIdStatusUpdates() |   ✅    |
+| /coins/{id}/ohlc                                           |                client.coinIdOHLC() |   ✅    |
+| /coins/{id}/contract/{contract_address}                    |                  client.contract() |   ✅    |
+| /coins/{id}/contract/{contract_address}/market_chart/      |       client.contractMarketChart() |   ✅    |
+| /coins/{id}/contract/{contract_address}/market_chart/range |  client.contractMarketChartRange() |   ✅    |
+| /exchanges                                                 |                 client.exchanges() |   ✅    |
+| /exchanges/list                                            |              client.exchangeList() |   ✅    |
+| /exchanges/{id}/tickers                                    |         client.exchangeIdTickers() |   ✅    |
+| /exchanges/{id}/status_update                              |   client.exchangeIdStatusUpdates() |   ✅    |
+| /exchanges/{id}/volume_chart                               |     client.exchangeIdVolumeChart() |   ✅    |
+| /finance_platforms                                         |          client.financePlatforms() |   ✅    |
+| /finance_products                                          |           client.financeProducts() |   ✅    |
+| /indexes                                                   |                   client.indexes() |   ✅    |
+| /indexes/{market_id}/{id}                                  |           client.indexesMarketId() |   ✅    |
+| /indexes/list                                              |               client.indexesList() |   ✅    |
+| /indexes/list_by_market_and_id/{market_id}/{id}            |           client.financeProducts() |   ✅    |
+| /derivatives                                               |              client./derivatives() |   ✅    |
+| /derivatives/exchanges                                     |     client./derivativesExchanges() |   ✅    |
+| /derivatives/exchanges/{id}                                |   client./derivativesExchangesId() |   ✅    |
+| /status_updates                                            |             client.statusUpdates() |   ✅    |
+| /event                                                     |                    client.events() |   ✅    |
+| //events/countries                                         |            client.eventCountries() |   ✅    |
+| /events/types                                              |               client.eventsTypes() |   ✅    |
+| /exchange_rates                                            |             client.exhangesRates() |   ✅    |
+| /search/trending                                           |            client.searchTrending() |   ✅    |
+| /global                                                    |                    client.global() |   ✅    |
+| /status_updates                                            |             client.statusUpdates() |   ✅    |
+| //global/decentralized_finance_defi                        |                client.globalDefi() |   ✅    |

New alerts

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

Improved metrics

Number of lines in readme file

67

increased by204.55%

Worsened metrics

Total package byte prevSize

98737

decreased by-85.85%

Number of package files

17

decreased by-32%

Lines of code

2167

decreased by-94.21%

Number of medium supply chain risk alerts

2

increased by100%

No dependency changes