@coingecko/coingecko-typescript 1.14.0 → 1.15.0

package/src/resources/coins/ohlc.ts

@@ -30,7 +30,12 @@ export class Ohlc extends APIResource {
    * ```ts
    * const response = await client.coins.ohlc.getRange(
    *   'bitcoin',
-   *   { from: 0, interval: 'daily', to: 0, vs_currency: 'usd' },
+   *   {
+   *     from: 'from',
+   *     interval: 'daily',
+   *     to: 'to',
+   *     vs_currency: 'usd',
+   *   },
    * );
    * ```
    */
@@ -92,9 +97,10 @@ export interface OhlcGetParams {
 
 export interface OhlcGetRangeParams {
   /**
-   * starting date in UNIX timestamp
+   * starting date in ISO date string (`YYYY-MM-DD` or `YYYY-MM-DDTHH:MM`) or UNIX
+   * timestamp. **use ISO date string for best compatibility**
    */
-  from: number;
+  from: string;
 
   /**
    * data interval
@@ -102,9 +108,10 @@ export interface OhlcGetRangeParams {
   interval: 'daily' | 'hourly';
 
   /**
-   * ending date in UNIX timestamp
+   * ending date in ISO date string (`YYYY-MM-DD` or `YYYY-MM-DDTHH:MM`) or UNIX
+   * timestamp. **use ISO date string for best compatibility**
    */
-  to: number;
+  to: string;
 
   /**
    * target currency of price data \*refers to

package/src/resources/coins/top-gainers-losers.ts

@@ -11,7 +11,7 @@ export class TopGainersLosers extends APIResource {
    *
    * @example
    * ```ts
-   * const topGainersLosers =
+   * const topGainersLoser =
    *   await client.coins.topGainersLosers.get({
    *     vs_currency: 'usd',
    *   });
@@ -22,10 +22,86 @@ export class TopGainersLosers extends APIResource {
   }
 }
 
-export type TopGainersLoserGetResponse = Array<TopGainersLoserGetResponse.TopGainersLoserGetResponseItem>;
+export interface TopGainersLoserGetResponse {
+  top_gainers?: Array<TopGainersLoserGetResponse.TopGainer>;
+
+  top_losers?: Array<TopGainersLoserGetResponse.TopLoser>;
+}
 
 export namespace TopGainersLoserGetResponse {
-  export interface TopGainersLoserGetResponseItem {
+  export interface TopGainer {
+    /**
+     * coin ID
+     */
+    id?: string;
+
+    /**
+     * coin image url
+     */
+    image?: string;
+
+    /**
+     * coin rank by market cap
+     */
+    market_cap_rank?: number;
+
+    /**
+     * coin name
+     */
+    name?: string;
+
+    /**
+     * coin symbol
+     */
+    symbol?: string;
+
+    /**
+     * coin price in USD
+     */
+    usd?: number;
+
+    /**
+     * coin 14 day change percentage in USD
+     */
+    usd_14d_change?: number | null;
+
+    /**
+     * coin 1hr change percentage in USD
+     */
+    usd_1h_change?: number | null;
+
+    /**
+     * coin 1 year change percentage in USD
+     */
+    usd_1y_change?: number | null;
+
+    /**
+     * coin 200 day change percentage in USD
+     */
+    usd_200d_change?: number | null;
+
+    /**
+     * coin 24hr change percentage in USD
+     */
+    usd_24h_change?: number | null;
+
+    /**
+     * coin 24hr volume in USD
+     */
+    usd_24h_vol?: number;
+
+    /**
+     * coin 30 day change percentage in USD
+     */
+    usd_30d_change?: number | null;
+
+    /**
+     * coin 7 day change percentage in USD
+     */
+    usd_7d_change?: number | null;
+  }
+
+  export interface TopLoser {
     /**
      * coin ID
      */
@@ -57,14 +133,44 @@ export namespace TopGainersLoserGetResponse {
     usd?: number;
 
     /**
-     * coin 1 year change in USD
+     * coin 14 day change percentage in USD
+     */
+    usd_14d_change?: number | null;
+
+    /**
+     * coin 1hr change percentage in USD
+     */
+    usd_1h_change?: number | null;
+
+    /**
+     * coin 1 year change percentage in USD
+     */
+    usd_1y_change?: number | null;
+
+    /**
+     * coin 200 day change percentage in USD
+     */
+    usd_200d_change?: number | null;
+
+    /**
+     * coin 24hr change percentage in USD
      */
-    usd_1y_change?: number;
+    usd_24h_change?: number | null;
 
     /**
      * coin 24hr volume in USD
      */
     usd_24h_vol?: number;
+
+    /**
+     * coin 30 day change percentage in USD
+     */
+    usd_30d_change?: number | null;
+
+    /**
+     * coin 7 day change percentage in USD
+     */
+    usd_7d_change?: number | null;
   }
 }
 
@@ -80,6 +186,12 @@ export interface TopGainersLoserGetParams {
    */
   duration?: '1h' | '24h' | '7d' | '14d' | '30d' | '60d' | '1y';
 
+  /**
+   * include price change percentage timeframe, comma-separated if query more than 1
+   * price change percentage timeframe Valid values: 1h, 24h, 7d, 14d, 30d, 200d, 1y
+   */
+  price_change_percentage?: string;
+
   /**
    * filter result by market cap ranking (top 300 to 1000) or all coins (including
    * coins that do not have market cap) Default value: `1000`

package/src/resources/coins/total-supply-chart.ts

@@ -34,8 +34,8 @@ export class TotalSupplyChart extends APIResource {
    * ```ts
    * const response =
    *   await client.coins.totalSupplyChart.getRange('bitcoin', {
-   *     from: 0,
-   *     to: 0,
+   *     from: 'from',
+   *     to: 'to',
    *   });
    * ```
    */
@@ -70,14 +70,16 @@ export interface TotalSupplyChartGetParams {
 
 export interface TotalSupplyChartGetRangeParams {
   /**
-   * starting date in UNIX timestamp
+   * starting date in ISO date string (`YYYY-MM-DD` or `YYYY-MM-DDTHH:MM`) or UNIX
+   * timestamp. **use ISO date string for best compatibility**
    */
-  from: number;
+  from: string;
 
   /**
-   * ending date in UNIX timestamp
+   * ending date in ISO date string (`YYYY-MM-DD` or `YYYY-MM-DDTHH:MM`) or UNIX
+   * timestamp. **use ISO date string for best compatibility**
    */
-  to: number;
+  to: string;
 }
 
 export declare namespace TotalSupplyChart {

package/src/resources/derivatives/exchanges.ts

@@ -23,8 +23,8 @@ export class Exchanges extends APIResource {
   }
 
   /**
-   * This endpoint allows you to **query the derivatives exchange’s related data (ID,
-   * name, open interest, ...) based on the exchanges’ ID**
+   * This endpoint allows you to **query the derivatives exchange's related data (ID,
+   * name, open interest, ...) based on the exchanges' ID**
    *
    * @example
    * ```ts

package/src/resources/entities.ts

@@ -0,0 +1,73 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../core/resource';
+import { APIPromise } from '../core/api-promise';
+import { RequestOptions } from '../internal/request-options';
+
+export class Entities extends APIResource {
+  /**
+   * This endpoint allows you to **query all the supported entities on CoinGecko with
+   * entities ID, name, symbol, and country**
+   *
+   * @example
+   * ```ts
+   * const response = await client.entities.getList();
+   * ```
+   */
+  getList(
+    query: EntityGetListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<EntityGetListResponse> {
+    return this._client.get('/entities/list', { query, ...options });
+  }
+}
+
+export type EntityGetListResponse = Array<EntityGetListResponse.EntityGetListResponseItem>;
+
+export namespace EntityGetListResponse {
+  export interface EntityGetListResponseItem {
+    /**
+     * entity ID
+     */
+    id?: string;
+
+    /**
+     * country code
+     */
+    country?: string;
+
+    /**
+     * entity name
+     */
+    name?: string;
+
+    /**
+     * ticker symbol of public company
+     */
+    symbol?: string;
+  }
+}
+
+export interface EntityGetListParams {
+  /**
+   * filter by entity type, default: false
+   */
+  entity_type?: 'company' | 'government';
+
+  /**
+   * page through results, default: 1
+   */
+  page?: number;
+
+  /**
+   * total results per page, default: 100 Valid values: 1...250
+   */
+  per_page?: number;
+}
+
+export declare namespace Entities {
+  export {
+    type EntityGetListResponse as EntityGetListResponse,
+    type EntityGetListParams as EntityGetListParams,
+  };
+}

package/src/resources/exchanges/exchanges.ts

@@ -20,7 +20,7 @@ export class Exchanges extends APIResource {
   volumeChart: VolumeChartAPI.VolumeChart = new VolumeChartAPI.VolumeChart(this._client);
 
   /**
-   * This endpoint allows you to **query all the supported exchanges with exchanges’
+   * This endpoint allows you to **query all the supported exchanges with exchanges'
    * data (ID, name, country, ...) that have active trading volumes on CoinGecko**
    *
    * @example
@@ -36,8 +36,8 @@ export class Exchanges extends APIResource {
   }
 
   /**
-   * This endpoint allows you to **query exchange’s data (name, year established,
-   * country, ...), exchange volume in BTC and top 100 tickers based on exchange’s
+   * This endpoint allows you to **query exchange's data (name, year established,
+   * country, ...), exchange volume in BTC and top 100 tickers based on exchange's
    * ID**
    *
    * @example

package/src/resources/exchanges/tickers.ts

@@ -7,7 +7,7 @@ import { path } from '../../internal/utils/path';
 
 export class Tickers extends APIResource {
   /**
-   * This endpoint allows you to **query exchange's tickers based on exchange’s ID**
+   * This endpoint allows you to **query exchange's tickers based on exchange's ID**
    *
    * @example
    * ```ts
@@ -217,7 +217,14 @@ export interface TickerGetParams {
   /**
    * use this to sort the order of responses, default: trust_score_desc
    */
-  order?: 'trust_score_desc' | 'trust_score_asc' | 'volume_desc' | 'volume_asc' | 'base_target';
+  order?:
+    | 'market_cap_asc'
+    | 'market_cap_desc'
+    | 'trust_score_desc'
+    | 'trust_score_asc'
+    | 'volume_desc'
+    | 'volume_asc'
+    | 'base_target';
 
   /**
    * page through results

package/src/resources/exchanges/volume-chart.ts

@@ -8,7 +8,7 @@ import { path } from '../../internal/utils/path';
 export class VolumeChart extends APIResource {
   /**
    * This endpoint allows you to **query the historical volume chart data with time
-   * in UNIX and trading volume data in BTC based on exchange’s ID**
+   * in UNIX and trading volume data in BTC based on exchange's ID**
    *
    * @example
    * ```ts
@@ -24,7 +24,7 @@ export class VolumeChart extends APIResource {
 
   /**
    * This endpoint allows you to **query the historical volume chart data in BTC by
-   * specifying date range in UNIX based on exchange’s ID**
+   * specifying date range in UNIX based on exchange's ID**
    *
    * @example
    * ```ts

package/src/resources/index.ts

@@ -6,8 +6,8 @@ export {
   type AssetPlatformGetParams,
 } from './asset-platforms';
 export { Coins, type CoinGetIDResponse, type CoinGetIDParams } from './coins/coins';
-export { Companies } from './companies/companies';
 export { Derivatives, type DerivativeGetResponse } from './derivatives/derivatives';
+export { Entities, type EntityGetListResponse, type EntityGetListParams } from './entities';
 export { ExchangeRates, type ExchangeRateGetResponse } from './exchange-rates';
 export {
   Exchanges,
@@ -30,6 +30,12 @@ export {
 } from './nfts/nfts';
 export { Onchain } from './onchain/onchain';
 export { Ping, type PingGetResponse } from './ping';
+export {
+  PublicTreasury,
+  type PublicTreasuryGetCoinIDResponse,
+  type PublicTreasuryGetEntityIDResponse,
+  type PublicTreasuryGetCoinIDParams,
+} from './public-treasury';
 export { Search, type SearchGetResponse, type SearchGetParams } from './search/search';
 export { Simple } from './simple/simple';
 export { TokenLists, type TokenListGetAllJsonResponse } from './token-lists';

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

@@ -20,114 +20,152 @@ export class Info extends APIResource {
    * ```
    */
   get(poolAddress: string, params: InfoGetParams, options?: RequestOptions): APIPromise<InfoGetResponse> {
-    const { network } = params;
-    return this._client.get(path`/onchain/networks/${network}/pools/${poolAddress}/info`, options);
+    const { network, ...query } = params;
+    return this._client.get(path`/onchain/networks/${network}/pools/${poolAddress}/info`, {
+      query,
+      ...options,
+    });
   }
 }
 
 export interface InfoGetResponse {
-  data?: InfoGetResponse.Data;
+  data?: Array<InfoGetResponse.Data>;
+
+  included?: Array<InfoGetResponse.Included>;
 }
 
 export namespace InfoGetResponse {
   export interface Data {
-    id?: string;
-
-    attributes?: Data.Attributes;
-
-    type?: string;
+    data?: Data.Data;
   }
 
   export namespace Data {
-    export interface Attributes {
-      address?: string;
+    export interface Data {
+      id?: string;
+
+      attributes?: Data.Attributes;
 
-      categories?: Array<string>;
+      type?: string;
+    }
 
-      coingecko_coin_id?: string;
+    export namespace Data {
+      export interface Attributes {
+        address?: string;
 
-      description?: string;
+        categories?: Array<string>;
 
-      discord_url?: string;
+        coingecko_coin_id?: string;
 
-      freeze_authority?: string;
+        description?: string;
 
-      gt_categories_id?: Array<string>;
+        discord_url?: string;
 
-      gt_score?: number;
+        freeze_authority?: string;
 
-      gt_score_details?: Attributes.GtScoreDetails;
+        gt_categories_id?: Array<string>;
 
-      holders?: Attributes.Holders;
+        gt_score?: number;
 
-      image?: Attributes.Image;
+        gt_score_details?: Attributes.GtScoreDetails;
 
-      image_url?: string;
+        holders?: Attributes.Holders;
 
-      is_honeypot?: boolean;
+        image?: Attributes.Image;
 
-      mint_authority?: string;
+        image_url?: string;
 
-      name?: string;
+        is_honeypot?: boolean | string;
 
-      symbol?: string;
+        mint_authority?: string;
 
-      telegram_handle?: string;
+        name?: string;
 
-      twitter_handle?: string;
+        symbol?: string;
 
-      websites?: Array<string>;
-    }
+        telegram_handle?: string;
 
-    export namespace Attributes {
-      export interface GtScoreDetails {
-        creation?: number;
+        twitter_handle?: string;
 
-        holders?: number;
+        websites?: Array<string>;
+      }
 
-        info?: number;
+      export namespace Attributes {
+        export interface GtScoreDetails {
+          creation?: number;
 
-        pool?: number;
+          holders?: number;
 
-        transaction?: number;
-      }
+          info?: number;
 
-      export interface Holders {
-        count?: number;
+          pool?: number;
 
-        distribution_percentage?: Holders.DistributionPercentage;
+          transaction?: number;
+        }
 
-        last_updated?: string;
-      }
+        export interface Holders {
+          count?: number;
 
-      export namespace Holders {
-        export interface DistributionPercentage {
-          '11_30'?: number;
+          distribution_percentage?: Holders.DistributionPercentage;
 
-          '31_50'?: number;
+          last_updated?: string;
+        }
 
-          rest?: number;
+        export namespace Holders {
+          export interface DistributionPercentage {
+            '11_30'?: number;
 
-          top_10?: number;
+            '31_50'?: number;
+
+            rest?: number;
+
+            top_10?: number;
+          }
         }
-      }
 
-      export interface Image {
-        large?: string;
+        export interface Image {
+          large?: string;
 
-        small?: string;
+          small?: string;
 
-        thumb?: string;
+          thumb?: string;
+        }
       }
     }
   }
+
+  export interface Included {
+    id?: string;
+
+    attributes?: Included.Attributes;
+
+    type?: string;
+  }
+
+  export namespace Included {
+    export interface Attributes {
+      base_token_address?: string;
+
+      community_sus_report?: number;
+
+      quote_token_address?: string;
+
+      sentiment_vote_negative_percentage?: number;
+
+      sentiment_vote_positive_percentage?: number;
+    }
+  }
 }
 
 export interface InfoGetParams {
   /**
-   * network ID \*refers to [/networks](/reference/networks-list)
+   * Path param: network ID \*refers to [/networks](/reference/networks-list)
    */
   network: string;
+
+  /**
+   * Query param: attributes to include
+   */
+  include?: 'pool';
 }
 
 export declare namespace Info {