@coingecko/coingecko-typescript 2.5.0 → 3.1.0

package/resources/public-treasury.mjs

@@ -15,8 +15,8 @@ export class PublicTreasury extends APIResource {
      * ```
      */
     getCoinID(coinID, params, options) {
-        const { entity } = params;
-        return this._client.get(path `/${entity}/public_treasury/${coinID}`, options);
+        const { entity, ...query } = params;
+        return this._client.get(path `/${entity}/public_treasury/${coinID}`, { query, ...options });
     }
     /**
      * This endpoint allows you **query public companies & governments' cryptocurrency
@@ -29,8 +29,8 @@ export class PublicTreasury extends APIResource {
      * );
      * ```
      */
-    getEntityID(entityID, options) {
-        return this._client.get(path `/public_treasury/${entityID}`, options);
+    getEntityID(entityID, query = {}, options) {
+        return this._client.get(path `/public_treasury/${entityID}`, { query, ...options });
     }
     /**
      * This endpoint allows you to **query historical cryptocurrency holdings chart of

package/resources/public-treasury.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"public-treasury.mjs","sourceRoot":"","sources":["../src/resources/public-treasury.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAGf,EAAE,IAAI,EAAE;AAEf,MAAM,OAAO,cAAe,SAAQ,WAAW;IAC7C;;;;;;;;;;;OAWG;IACH,SAAS,CACP,MAAc,EACd,MAAqC,EACrC,OAAwB;QAExB,MAAM,EAAE,MAAM,EAAE,GAAG,MAAM,CAAC;QAC1B,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,IAAI,MAAM,oBAAoB,MAAM,EAAE,EAAE,OAAO,CAAC,CAAC;IAC/E,CAAC;IAED;;;;;;;;;;OAUG;IACH,WAAW,CAAC,QAAgB,EAAE,OAAwB;QACpD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,oBAAoB,QAAQ,EAAE,EAAE,OAAO,CAAC,CAAC;IACvE,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,eAAe,CACb,MAAc,EACd,MAA2C,EAC3C,OAAwB;QAExB,MAAM,EAAE,SAAS,EAAE,GAAG,KAAK,EAAE,GAAG,MAAM,CAAC;QACvC,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,oBAAoB,SAAS,IAAI,MAAM,gBAAgB,EAAE;YACnF,KAAK;YACL,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;OAWG;IACH,qBAAqB,CACnB,QAAgB,EAChB,QAAsE,EAAE,EACxE,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,oBAAoB,QAAQ,sBAAsB,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACzG,CAAC;CACF"}
+{"version":3,"file":"public-treasury.mjs","sourceRoot":"","sources":["../src/resources/public-treasury.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAGf,EAAE,IAAI,EAAE;AAEf,MAAM,OAAO,cAAe,SAAQ,WAAW;IAC7C;;;;;;;;;;;OAWG;IACH,SAAS,CACP,MAAc,EACd,MAAqC,EACrC,OAAwB;QAExB,MAAM,EAAE,MAAM,EAAE,GAAG,KAAK,EAAE,GAAG,MAAM,CAAC;QACpC,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,IAAI,MAAM,oBAAoB,MAAM,EAAE,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC7F,CAAC;IAED;;;;;;;;;;OAUG;IACH,WAAW,CACT,QAAgB,EAChB,QAA4D,EAAE,EAC9D,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,oBAAoB,QAAQ,EAAE,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACrF,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,eAAe,CACb,MAAc,EACd,MAA2C,EAC3C,OAAwB;QAExB,MAAM,EAAE,SAAS,EAAE,GAAG,KAAK,EAAE,GAAG,MAAM,CAAC;QACvC,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,oBAAoB,SAAS,IAAI,MAAM,gBAAgB,EAAE;YACnF,KAAK;YACL,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;OAWG;IACH,qBAAqB,CACnB,QAAgB,EAChB,QAAsE,EAAE,EACxE,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,oBAAoB,QAAQ,sBAAsB,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACzG,CAAC;CACF"}

package/src/client.ts

@@ -11,6 +11,7 @@ import type { APIResponseProps } from './internal/parse';
 import { getPlatformHeaders } from './internal/detect-platform';
 import * as Shims from './internal/shims';
 import * as Opts from './internal/request-options';
+import { stringifyQuery } from './internal/utils/query';
 import { VERSION } from './version';
 import * as Errors from './core/error';
 import * as Uploads from './core/uploads';
@@ -29,6 +30,7 @@ import {
   PublicTreasury,
   PublicTreasuryGetCoinIDParams,
   PublicTreasuryGetCoinIDResponse,
+  PublicTreasuryGetEntityIDParams,
   PublicTreasuryGetEntityIDResponse,
   PublicTreasuryGetHoldingChartParams,
   PublicTreasuryGetHoldingChartResponse,
@@ -314,21 +316,8 @@ export class Coingecko {
   /**
    * Basic re-implementation of `qs.stringify` for primitive types.
    */
-  protected stringifyQuery(query: Record<string, unknown>): string {
-    return Object.entries(query)
-      .filter(([_, value]) => typeof value !== 'undefined')
-      .map(([key, value]) => {
-        if (typeof value === 'string' || typeof value === 'number' || typeof value === 'boolean') {
-          return `${encodeURIComponent(key)}=${encodeURIComponent(value)}`;
-        }
-        if (value === null) {
-          return `${encodeURIComponent(key)}=`;
-        }
-        throw new Errors.CoingeckoError(
-          `Cannot stringify type ${typeof value}; Expected string, number, boolean, or null. If you need to pass nested query parameters, you can manually encode them, e.g. { query: { 'foo[key1]': value1, 'foo[key2]': value2 } }, and please open a GitHub issue requesting better support for your use case.`,
-        );
-      })
-      .join('&');
+  protected stringifyQuery(query: object | Record<string, unknown>): string {
+    return stringifyQuery(query);
   }
 
   private getUserAgent(): string {
@@ -360,12 +349,13 @@ export class Coingecko {
       : new URL(baseURL + (baseURL.endsWith('/') && path.startsWith('/') ? path.slice(1) : path));
 
     const defaultQuery = this.defaultQuery();
-    if (!isEmptyObj(defaultQuery)) {
-      query = { ...defaultQuery, ...query };
+    const pathQuery = Object.fromEntries(url.searchParams);
+    if (!isEmptyObj(defaultQuery) || !isEmptyObj(pathQuery)) {
+      query = { ...pathQuery, ...defaultQuery, ...query };
     }
 
     if (typeof query === 'object' && query && !Array.isArray(query)) {
-      url.search = this.stringifyQuery(query as Record<string, unknown>);
+      url.search = this.stringifyQuery(query);
     }
 
     return url.toString();
@@ -549,7 +539,7 @@ export class Coingecko {
       loggerFor(this).info(`${responseInfo} - ${retryMessage}`);
 
       const errText = await response.text().catch((err: any) => castToError(err).message);
-      const errJSON = safeJSON(errText);
+      const errJSON = safeJSON(errText) as any;
       const errMessage = errJSON ? undefined : errText;
 
       loggerFor(this).debug(
@@ -590,9 +580,10 @@ export class Coingecko {
     controller: AbortController,
   ): Promise<Response> {
     const { signal, method, ...options } = init || {};
-    if (signal) signal.addEventListener('abort', () => controller.abort());
+    const abort = this._makeAbort(controller);
+    if (signal) signal.addEventListener('abort', abort, { once: true });
 
-    const timeout = setTimeout(() => controller.abort(), ms);
+    const timeout = setTimeout(abort, ms);
 
     const isReadableBody =
       ((globalThis as any).ReadableStream && options.body instanceof (globalThis as any).ReadableStream) ||
@@ -669,9 +660,9 @@ export class Coingecko {
       }
     }
 
-    // If the API asks us to wait a certain amount of time (and it's a reasonable amount),
-    // just do what it says, but otherwise calculate a default
-    if (!(timeoutMillis && 0 <= timeoutMillis && timeoutMillis < 60 * 1000)) {
+    // If the API asks us to wait a certain amount of time, just do what it
+    // says, but otherwise calculate a default
+    if (timeoutMillis === undefined) {
       const maxRetries = options.maxRetries ?? this.maxRetries;
       timeoutMillis = this.calculateDefaultRetryTimeoutMillis(retriesRemaining, maxRetries);
     }
@@ -759,6 +750,12 @@ export class Coingecko {
     return headers.values;
   }
 
+  private _makeAbort(controller: AbortController) {
+    // note: we can't just inline this method inside `fetchWithTimeout()` because then the closure
+    //       would capture all request options, and cause a memory leak.
+    return () => controller.abort();
+  }
+
   private buildBody({ options: { body, headers: rawHeaders } }: { options: FinalRequestOptions }): {
     bodyHeaders: HeadersLike;
     body: BodyInit | undefined;
@@ -791,6 +788,14 @@ export class Coingecko {
         (Symbol.iterator in body && 'next' in body && typeof body.next === 'function'))
     ) {
       return { bodyHeaders: undefined, body: Shims.ReadableStreamFrom(body as AsyncIterable<Uint8Array>) };
+    } else if (
+      typeof body === 'object' &&
+      headers.values.get('content-type') === 'application/x-www-form-urlencoded'
+    ) {
+      return {
+        bodyHeaders: { 'content-type': 'application/x-www-form-urlencoded' },
+        body: this.stringifyQuery(body),
+      };
     } else {
       return this.#encoder({ body, headers });
     }
@@ -907,6 +912,7 @@ export declare namespace Coingecko {
     type PublicTreasuryGetHoldingChartResponse as PublicTreasuryGetHoldingChartResponse,
     type PublicTreasuryGetTransactionHistoryResponse as PublicTreasuryGetTransactionHistoryResponse,
     type PublicTreasuryGetCoinIDParams as PublicTreasuryGetCoinIDParams,
+    type PublicTreasuryGetEntityIDParams as PublicTreasuryGetEntityIDParams,
     type PublicTreasuryGetHoldingChartParams as PublicTreasuryGetHoldingChartParams,
     type PublicTreasuryGetTransactionHistoryParams as PublicTreasuryGetTransactionHistoryParams,
   };

package/src/internal/parse.ts

@@ -29,6 +29,12 @@ export async function defaultParseResponse<T>(client: Coingecko, props: APIRespo
     const mediaType = contentType?.split(';')[0]?.trim();
     const isJSON = mediaType?.includes('application/json') || mediaType?.endsWith('+json');
     if (isJSON) {
+      const contentLength = response.headers.get('content-length');
+      if (contentLength === '0') {
+        // if there is no content we can't do anything
+        return undefined as T;
+      }
+
       const json = await response.json();
       return json as T;
     }

package/src/internal/utils/query.ts

@@ -0,0 +1,23 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { CoingeckoError } from '../../core/error';
+
+/**
+ * Basic re-implementation of `qs.stringify` for primitive types.
+ */
+export function stringifyQuery(query: object | Record<string, unknown>) {
+  return Object.entries(query)
+    .filter(([_, value]) => typeof value !== 'undefined')
+    .map(([key, value]) => {
+      if (typeof value === 'string' || typeof value === 'number' || typeof value === 'boolean') {
+        return `${encodeURIComponent(key)}=${encodeURIComponent(value)}`;
+      }
+      if (value === null) {
+        return `${encodeURIComponent(key)}=`;
+      }
+      throw new CoingeckoError(
+        `Cannot stringify type ${typeof value}; Expected string, number, boolean, or null. If you need to pass nested query parameters, you can manually encode them, e.g. { query: { 'foo[key1]': value1, 'foo[key2]': value2 } }, and please open a GitHub issue requesting better support for your use case.`,
+      );
+    })
+    .join('&');
+}

package/src/internal/utils.ts

@@ -6,3 +6,4 @@ export * from './utils/env';
 export * from './utils/log';
 export * from './utils/uuid';
 export * from './utils/sleep';
+export * from './utils/query';

package/src/resources/coins/coins.ts

@@ -179,6 +179,11 @@ export interface CoinGetIDResponse {
    */
   market_cap_rank?: number;
 
+  /**
+   * coin rank by market cap including rehypothecated tokens
+   */
+  market_cap_rank_with_rehypothecated?: number;
+
   /**
    * coin market data
    */
@@ -723,6 +728,11 @@ export namespace CoinGetIDResponse {
      */
     market_cap_rank?: number;
 
+    /**
+     * coin rank by market cap including rehypothecated tokens
+     */
+    market_cap_rank_with_rehypothecated?: number;
+
     /**
      * coin max supply
      */
@@ -1162,7 +1172,7 @@ export namespace CoinGetIDResponse {
     /**
      * coin ticker trust score
      */
-    trust_score?: string;
+    trust_score?: string | null;
 
     /**
      * coin ticker volume

package/src/resources/coins/contract/contract.ts

@@ -126,6 +126,11 @@ export interface ContractGetResponse {
    */
   market_cap_rank?: number;
 
+  /**
+   * coin rank by market cap including rehypothecated tokens
+   */
+  market_cap_rank_with_rehypothecated?: number;
+
   /**
    * coin market data
    */
@@ -503,6 +508,11 @@ export namespace ContractGetResponse {
      */
     market_cap_rank?: number;
 
+    /**
+     * coin rank by market cap including rehypothecated tokens
+     */
+    market_cap_rank_with_rehypothecated?: number;
+
     /**
      * coin max supply
      */
@@ -942,7 +952,7 @@ export namespace ContractGetResponse {
     /**
      * coin ticker trust score
      */
-    trust_score?: string;
+    trust_score?: string | null;
 
     /**
      * coin ticker volume

package/src/resources/coins/contract/market-chart.ts

@@ -16,7 +16,11 @@ export class MarketChart extends APIResource {
    * const marketChart =
    *   await client.coins.contract.marketChart.get(
    *     '0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48',
-   *     { id: 'ethereum', days: 'days', vs_currency: 'usd' },
+   *     {
+   *       id: 'ethereum',
+   *       days: 'days',
+   *       vs_currency: 'usd',
+   *     },
    *   );
    * ```
    */

package/src/resources/coins/market-chart.ts

@@ -31,7 +31,11 @@ export class MarketChart extends APIResource {
    * ```ts
    * const response = await client.coins.marketChart.getRange(
    *   'bitcoin',
-   *   { from: 'from', to: 'to', vs_currency: 'usd' },
+   *   {
+   *     from: 'from',
+   *     to: 'to',
+   *     vs_currency: 'usd',
+   *   },
    * );
    * ```
    */

package/src/resources/coins/markets.ts

@@ -115,6 +115,11 @@ export namespace MarketGetResponse {
      */
     market_cap_rank?: number | null;
 
+    /**
+     * coin rank by market cap including rehypothecated tokens
+     */
+    market_cap_rank_with_rehypothecated?: number | null;
+
     /**
      * coin max supply
      */
@@ -198,6 +203,12 @@ export interface MarketGetParams {
    */
   ids?: string;
 
+  /**
+   * include rehypothecated tokens in results, default: false When true, returns
+   * `market_cap_rank_with_rehypothecated` field
+   */
+  include_rehypothecated?: boolean;
+
   /**
    * for `symbols` lookups, specify `all` to include all matching tokens Default
    * `top` returns top-ranked tokens (by market cap or volume)

package/src/resources/coins/tickers.ts

@@ -131,7 +131,7 @@ export namespace TickerGetResponse {
     /**
      * coin ticker trust score
      */
-    trust_score?: string;
+    trust_score?: string | null;
 
     /**
      * coin ticker volume

package/src/resources/exchanges/exchanges.ts

@@ -91,7 +91,7 @@ export interface ExchangeGetResponse {
   has_trading_incentive?: boolean;
 
   /**
-   * exchange image url
+   * exchange image URL
    */
   image?: string;
 
@@ -116,7 +116,7 @@ export interface ExchangeGetResponse {
   trust_score_rank?: number;
 
   /**
-   * exchange website url
+   * exchange website URL
    */
   url?: string;
 
@@ -339,7 +339,7 @@ export namespace ExchangeGetIDResponse {
       /**
        * coin ticker trust score
        */
-      trust_score?: string;
+      trust_score?: string | null;
 
       /**
        * coin ticker volume

package/src/resources/exchanges/tickers.ts

@@ -132,7 +132,7 @@ export namespace TickerGetResponse {
     /**
      * coin ticker trust score
      */
-    trust_score?: string;
+    trust_score?: string | null;
 
     /**
      * coin ticker volume

package/src/resources/global/global.ts

@@ -79,6 +79,11 @@ export namespace GlobalGetResponse {
     upcoming_icos?: number;
 
     updated_at?: number;
+
+    /**
+     * cryptocurrencies volume change percentage in 24 hours in usd
+     */
+    volume_change_percentage_24h_usd?: number;
   }
 
   export namespace Data {

package/src/resources/index.ts

@@ -37,6 +37,7 @@ export {
   type PublicTreasuryGetHoldingChartResponse,
   type PublicTreasuryGetTransactionHistoryResponse,
   type PublicTreasuryGetCoinIDParams,
+  type PublicTreasuryGetEntityIDParams,
   type PublicTreasuryGetHoldingChartParams,
   type PublicTreasuryGetTransactionHistoryParams,
 } from './public-treasury';

package/src/resources/key.ts

@@ -20,6 +20,18 @@ export class Key extends APIResource {
 }
 
 export interface KeyGetResponse {
+  /**
+   * Specific monthly credit limit configured for the API key used to authenticate
+   * this request
+   */
+  api_key_monthly_call_credit?: number;
+
+  /**
+   * Specific request per minute configured for the API key used to authenticate this
+   * request
+   */
+  api_key_rate_limit_request_per_minute?: number;
+
   current_remaining_monthly_calls?: number;
 
   current_total_monthly_calls?: number;

package/src/resources/onchain/networks/tokens/pools.ts

@@ -54,6 +54,8 @@ export namespace PoolGetResponse {
 
       base_token_price_usd?: string;
 
+      community_sus_report?: number;
+
       fdv_usd?: string;
 
       last_trade_timestamp?: number;
@@ -74,6 +76,10 @@ export namespace PoolGetResponse {
 
       reserve_in_usd?: string;
 
+      sentiment_vote_negative_percentage?: number;
+
+      sentiment_vote_positive_percentage?: number;
+
       transactions?: Attributes.Transactions;
 
       volume_usd?: Attributes.VolumeUsd;
@@ -257,6 +263,12 @@ export interface PoolGetParams {
    */
   include?: string;
 
+  /**
+   * Query param: include GeckoTerminal community data (Sentiment votes, Suspicious
+   * reports) Default value: false
+   */
+  include_gt_community_data?: boolean;
+
   /**
    * Query param: include tokens from inactive pools using the most recent swap,
    * default: false

package/src/resources/onchain/networks/tokens/top-holders.ts

@@ -58,12 +58,28 @@ export namespace TopHolderGetResponse {
 
         amount?: string;
 
+        average_buy_price_usd?: string;
+
+        explorer_url?: string;
+
         label?: string;
 
         percentage?: string;
 
         rank?: number;
 
+        realized_pnl_percentage?: string;
+
+        realized_pnl_usd?: string;
+
+        total_buy_count?: number;
+
+        total_sell_count?: number;
+
+        unrealized_pnl_percentage?: string;
+
+        unrealized_pnl_usd?: string;
+
         value?: string;
       }
     }
@@ -81,6 +97,11 @@ export interface TopHolderGetParams {
    * `max` Default value: 10
    */
   holders?: string;
+
+  /**
+   * Query param: include PnL details for token holders, default: false
+   */
+  include_pnl_details?: boolean;
 }
 
 export declare namespace TopHolders {

package/src/resources/onchain/pools/megafilter.ts

@@ -330,6 +330,21 @@ export interface MegafilterGetParams {
    */
   pool_created_hour_min?: number;
 
+  /**
+   * duration for price change percentage metric
+   */
+  price_change_percentage_duration?: '5m' | '1h' | '6h' | '24h';
+
+  /**
+   * maximum price change percentage
+   */
+  price_change_percentage_max?: number;
+
+  /**
+   * minimum price change percentage
+   */
+  price_change_percentage_min?: number;
+
   /**
    * maximum reserve in USD
    */
@@ -374,7 +389,9 @@ export interface MegafilterGetParams {
     | 'h6_trending'
     | 'h24_trending'
     | 'h24_tx_count_desc'
+    | 'h24_tx_count_asc'
     | 'h24_volume_usd_desc'
+    | 'h24_volume_usd_asc'
     | 'm5_price_change_percentage_asc'
     | 'h1_price_change_percentage_asc'
     | 'h6_price_change_percentage_asc'
@@ -387,6 +404,8 @@ export interface MegafilterGetParams {
     | 'fdv_usd_desc'
     | 'reserve_in_usd_asc'
     | 'reserve_in_usd_desc'
+    | 'price_asc'
+    | 'price_desc'
     | 'pool_created_at_desc';
 
   /**