@coingecko/coingecko-typescript 1.13.0 → 1.15.0

package/src/client.ts

@@ -21,12 +21,18 @@ import {
   AssetPlatformGetResponse,
   AssetPlatforms,
 } from './resources/asset-platforms';
+import { Entities, EntityGetListParams, EntityGetListResponse } from './resources/entities';
 import { ExchangeRateGetResponse, ExchangeRates } from './resources/exchange-rates';
 import { Key, KeyGetResponse } from './resources/key';
 import { Ping, PingGetResponse } from './resources/ping';
+import {
+  PublicTreasury,
+  PublicTreasuryGetCoinIDParams,
+  PublicTreasuryGetCoinIDResponse,
+  PublicTreasuryGetEntityIDResponse,
+} from './resources/public-treasury';
 import { TokenListGetAllJsonResponse, TokenLists } from './resources/token-lists';
 import { CoinGetIDParams, CoinGetIDResponse, Coins } from './resources/coins/coins';
-import { Companies } from './resources/companies/companies';
 import { DerivativeGetResponse, Derivatives } from './resources/derivatives/derivatives';
 import {
   ExchangeGetIDParams,
@@ -807,8 +813,8 @@ export class Coingecko {
 
   assetPlatforms: API.AssetPlatforms = new API.AssetPlatforms(this);
   coins: API.Coins = new API.Coins(this);
-  companies: API.Companies = new API.Companies(this);
   derivatives: API.Derivatives = new API.Derivatives(this);
+  entities: API.Entities = new API.Entities(this);
   exchangeRates: API.ExchangeRates = new API.ExchangeRates(this);
   exchanges: API.Exchanges = new API.Exchanges(this);
   global: API.Global = new API.Global(this);
@@ -816,6 +822,7 @@ export class Coingecko {
   nfts: API.NFTs = new API.NFTs(this);
   onchain: API.Onchain = new API.Onchain(this);
   ping: API.Ping = new API.Ping(this);
+  publicTreasury: API.PublicTreasury = new API.PublicTreasury(this);
   search: API.Search = new API.Search(this);
   simple: API.Simple = new API.Simple(this);
   tokenLists: API.TokenLists = new API.TokenLists(this);
@@ -823,8 +830,8 @@ export class Coingecko {
 
 Coingecko.AssetPlatforms = AssetPlatforms;
 Coingecko.Coins = Coins;
-Coingecko.Companies = Companies;
 Coingecko.Derivatives = Derivatives;
+Coingecko.Entities = Entities;
 Coingecko.ExchangeRates = ExchangeRates;
 Coingecko.Exchanges = Exchanges;
 Coingecko.Global = Global;
@@ -832,6 +839,7 @@ Coingecko.Key = Key;
 Coingecko.NFTs = NFTs;
 Coingecko.Onchain = Onchain;
 Coingecko.Ping = Ping;
+Coingecko.PublicTreasury = PublicTreasury;
 Coingecko.Search = Search;
 Coingecko.Simple = Simple;
 Coingecko.TokenLists = TokenLists;
@@ -851,10 +859,14 @@ export declare namespace Coingecko {
     type CoinGetIDParams as CoinGetIDParams,
   };
 
-  export { Companies as Companies };
-
   export { Derivatives as Derivatives, type DerivativeGetResponse as DerivativeGetResponse };
 
+  export {
+    Entities as Entities,
+    type EntityGetListResponse as EntityGetListResponse,
+    type EntityGetListParams as EntityGetListParams,
+  };
+
   export { ExchangeRates as ExchangeRates, type ExchangeRateGetResponse as ExchangeRateGetResponse };
 
   export {
@@ -884,6 +896,13 @@ export declare namespace Coingecko {
 
   export { Ping as Ping, type PingGetResponse as PingGetResponse };
 
+  export {
+    PublicTreasury as PublicTreasury,
+    type PublicTreasuryGetCoinIDResponse as PublicTreasuryGetCoinIDResponse,
+    type PublicTreasuryGetEntityIDResponse as PublicTreasuryGetEntityIDResponse,
+    type PublicTreasuryGetCoinIDParams as PublicTreasuryGetCoinIDParams,
+  };
+
   export {
     Search as Search,
     type SearchGetResponse as SearchGetResponse,

package/src/internal/utils/values.ts

@@ -76,21 +76,21 @@ export const coerceBoolean = (value: unknown): boolean => {
 };
 
 export const maybeCoerceInteger = (value: unknown): number | undefined => {
-  if (value === undefined) {
+  if (value == null) {
     return undefined;
   }
   return coerceInteger(value);
 };
 
 export const maybeCoerceFloat = (value: unknown): number | undefined => {
-  if (value === undefined) {
+  if (value == null) {
     return undefined;
   }
   return coerceFloat(value);
 };
 
 export const maybeCoerceBoolean = (value: unknown): boolean | undefined => {
-  if (value === undefined) {
+  if (value == null) {
     return undefined;
   }
   return coerceBoolean(value);

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

@@ -35,7 +35,7 @@ export class CirculatingSupplyChart extends APIResource {
    * const response =
    *   await client.coins.circulatingSupplyChart.getRange(
    *     'bitcoin',
-   *     { from: 0, to: 0 },
+   *     { from: 'from', to: 'to' },
    *   );
    * ```
    */
@@ -70,14 +70,16 @@ export interface CirculatingSupplyChartGetParams {
 
 export interface CirculatingSupplyChartGetRangeParams {
   /**
-   * 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 CirculatingSupplyChart {

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

@@ -42,7 +42,12 @@ export class MarketChart extends APIResource {
    * const response =
    *   await client.coins.contract.marketChart.getRange(
    *     '0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48',
-   *     { id: 'ethereum', from: 0, to: 0, vs_currency: 'usd' },
+   *     {
+   *       id: 'ethereum',
+   *       from: 'from',
+   *       to: 'to',
+   *       vs_currency: 'usd',
+   *     },
    *   );
    * ```
    */
@@ -133,14 +138,17 @@ export interface MarketChartGetRangeParams {
   id: string;
 
   /**
-   * Query param: starting date in UNIX timestamp
+   * Query param: 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;
 
   /**
-   * Query param: ending date in UNIX timestamp
+   * Query param: 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;
 
   /**
    * Query param: target currency of market data \*refers to

package/src/resources/coins/history.ts

@@ -13,7 +13,7 @@ export class History extends APIResource {
    * @example
    * ```ts
    * const history = await client.coins.history.get('bitcoin', {
-   *   date: '30-12-2017',
+   *   date: 'date',
    * });
    * ```
    */
@@ -243,7 +243,7 @@ export namespace HistoryGetResponse {
 
 export interface HistoryGetParams {
   /**
-   * the date of data snapshot Format: `dd-mm-yyyy`
+   * date of data snapshot (`YYYY-MM-DD` or `YYYY-MM-DDTHH:MM`)
    */
   date: string;
 

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

@@ -31,7 +31,7 @@ export class MarketChart extends APIResource {
    * ```ts
    * const response = await client.coins.marketChart.getRange(
    *   'bitcoin',
-   *   { from: 0, to: 0, vs_currency: 'usd' },
+   *   { from: 'from', to: 'to', vs_currency: 'usd' },
    * );
    * ```
    */
@@ -106,14 +106,16 @@ export interface MarketChartGetParams {
 
 export interface MarketChartGetRangeParams {
   /**
-   * 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;
 
   /**
    * target currency of market data \*refers to

package/src/resources/coins/markets.ts

@@ -290,7 +290,7 @@ export interface MarketGetParams {
 
   /**
    * 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
+   * timeframe Valid values: 1h, 24h, 7d, 14d, 30d, 200d, 1y
    */
   price_change_percentage?: string;
 

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';