@coingecko/coingecko-typescript 2.3.0 → 3.0.0

package/src/resources/coins/coins.ts

@@ -109,6 +109,11 @@ export interface CoinGetIDResponse {
    */
   categories?: Array<string>;
 
+  /**
+   * detailed coin categories
+   */
+  categories_details?: Array<CoinGetIDResponse.CategoriesDetail>;
+
   /**
    * coin community data
    */
@@ -144,6 +149,11 @@ export interface CoinGetIDResponse {
    */
   hashing_algorithm?: string;
 
+  /**
+   * coin ICO data
+   */
+  ico_data?: CoinGetIDResponse.IcoData;
+
   /**
    * coin image url
    */
@@ -169,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
    */
@@ -231,6 +246,18 @@ export interface CoinGetIDResponse {
 }
 
 export namespace CoinGetIDResponse {
+  export interface CategoriesDetail {
+    /**
+     * category ID
+     */
+    id?: string;
+
+    /**
+     * category name
+     */
+    name?: string;
+  }
+
   /**
    * coin community data
    */
@@ -344,6 +371,161 @@ export namespace CoinGetIDResponse {
     }
   }
 
+  /**
+   * coin ICO data
+   */
+  export interface IcoData {
+    /**
+     * accepting currencies
+     */
+    accepting_currencies?: string;
+
+    /**
+     * amount for sale
+     */
+    amount_for_sale?: number;
+
+    /**
+     * base pre-sale amount
+     */
+    base_pre_sale_amount?: number;
+
+    /**
+     * base public sale amount
+     */
+    base_public_sale_amount?: number;
+
+    /**
+     * bounty detail url
+     */
+    bounty_detail_url?: string;
+
+    /**
+     * country of origin
+     */
+    country_origin?: string;
+
+    /**
+     * detailed description
+     */
+    description?: string;
+
+    /**
+     * hardcap amount
+     */
+    hardcap_amount?: number;
+
+    /**
+     * hardcap currency
+     */
+    hardcap_currency?: string;
+
+    /**
+     * ICO end date
+     */
+    ico_end_date?: string;
+
+    /**
+     * ICO start date
+     */
+    ico_start_date?: string;
+
+    /**
+     * KYC required
+     */
+    kyc_required?: boolean;
+
+    /**
+     * ICO related links
+     */
+    links?: { [key: string]: string };
+
+    /**
+     * pre-sale available
+     */
+    pre_sale_available?: boolean;
+
+    /**
+     * pre-sale end date
+     */
+    pre_sale_end_date?: string;
+
+    /**
+     * pre-sale ended
+     */
+    pre_sale_ended?: boolean;
+
+    /**
+     * pre-sale start date
+     */
+    pre_sale_start_date?: string;
+
+    /**
+     * quote pre-sale amount
+     */
+    quote_pre_sale_amount?: number;
+
+    /**
+     * quote pre-sale currency
+     */
+    quote_pre_sale_currency?: string;
+
+    /**
+     * quote public sale amount
+     */
+    quote_public_sale_amount?: number;
+
+    /**
+     * quote public sale currency
+     */
+    quote_public_sale_currency?: string;
+
+    /**
+     * short description
+     */
+    short_desc?: string;
+
+    /**
+     * softcap amount
+     */
+    softcap_amount?: number;
+
+    /**
+     * softcap currency
+     */
+    softcap_currency?: string;
+
+    /**
+     * total raised amount
+     */
+    total_raised?: number;
+
+    /**
+     * total raised currency
+     */
+    total_raised_currency?: string;
+
+    /**
+     * whitelist available
+     */
+    whitelist_available?: boolean;
+
+    /**
+     * whitelist end date
+     */
+    whitelist_end_date?: string;
+
+    /**
+     * whitelist start date
+     */
+    whitelist_start_date?: string;
+
+    /**
+     * whitelist url
+     */
+    whitelist_url?: string;
+  }
+
   /**
    * coin image url
    */
@@ -546,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
      */
@@ -985,7 +1172,7 @@ export namespace CoinGetIDResponse {
     /**
      * coin ticker trust score
      */
-    trust_score?: string;
+    trust_score?: string | null;
 
     /**
      * coin ticker volume
@@ -1055,6 +1242,11 @@ export interface CoinGetIDParams {
    */
   dex_pair_format?: 'contract_address' | 'symbol';
 
+  /**
+   * include categories details, default: false
+   */
+  include_categories_details?: boolean;
+
   /**
    * include all the localized languages in the response, default: true
    */

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/history.ts

@@ -243,7 +243,7 @@ export namespace HistoryGetResponse {
 
 export interface HistoryGetParams {
   /**
-   * date of data snapshot (`YYYY-MM-DD` or `YYYY-MM-DDTHH:MM`)
+   * date of data snapshot (`YYYY-MM-DD`)
    */
   date: string;
 

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

@@ -34,7 +34,12 @@ export {
   PublicTreasury,
   type PublicTreasuryGetCoinIDResponse,
   type PublicTreasuryGetEntityIDResponse,
+  type PublicTreasuryGetHoldingChartResponse,
+  type PublicTreasuryGetTransactionHistoryResponse,
   type PublicTreasuryGetCoinIDParams,
+  type PublicTreasuryGetEntityIDParams,
+  type PublicTreasuryGetHoldingChartParams,
+  type PublicTreasuryGetTransactionHistoryParams,
 } from './public-treasury';
 export { Search, type SearchGetResponse, type SearchGetParams } from './search/search';
 export { Simple } from './simple/simple';

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/dexes.ts

@@ -93,6 +93,8 @@ export namespace DexGetPoolsResponse {
 
       base_token_price_usd?: string;
 
+      community_sus_report?: number;
+
       fdv_usd?: string;
 
       market_cap_usd?: string;
@@ -111,6 +113,10 @@ export namespace DexGetPoolsResponse {
 
       reserve_in_usd?: string;
 
+      sentiment_vote_negative_percentage?: number;
+
+      sentiment_vote_positive_percentage?: number;
+
       transactions?: Attributes.Transactions;
 
       volume_usd?: Attributes.VolumeUsd;
@@ -301,6 +307,12 @@ export interface DexGetPoolsParams {
    */
   include?: string;
 
+  /**
+   * Query param: include GeckoTerminal community data (Sentiment votes, Suspicious
+   * reports) Default value: false
+   */
+  include_gt_community_data?: boolean;
+
   /**
    * Query param: page through results Default value: 1
    */

package/src/resources/onchain/networks/new-pools.ts

@@ -69,6 +69,8 @@ export namespace NewPoolGetResponse {
 
       base_token_price_usd?: string;
 
+      community_sus_report?: number;
+
       fdv_usd?: string;
 
       market_cap_usd?: string;
@@ -87,6 +89,10 @@ export namespace NewPoolGetResponse {
 
       reserve_in_usd?: string;
 
+      sentiment_vote_negative_percentage?: number;
+
+      sentiment_vote_positive_percentage?: number;
+
       transactions?: Attributes.Transactions;
 
       volume_usd?: Attributes.VolumeUsd;
@@ -285,6 +291,8 @@ export namespace NewPoolGetNetworkResponse {
 
       base_token_price_usd?: string;
 
+      community_sus_report?: number;
+
       fdv_usd?: string;
 
       market_cap_usd?: string;
@@ -303,6 +311,10 @@ export namespace NewPoolGetNetworkResponse {
 
       reserve_in_usd?: string;
 
+      sentiment_vote_negative_percentage?: number;
+
+      sentiment_vote_positive_percentage?: number;
+
       transactions?: Attributes.Transactions;
 
       volume_usd?: Attributes.VolumeUsd;
@@ -481,6 +493,12 @@ export interface NewPoolGetParams {
    */
   include?: string;
 
+  /**
+   * include GeckoTerminal community data (Sentiment votes, Suspicious reports)
+   * Default value: false
+   */
+  include_gt_community_data?: boolean;
+
   /**
    * page through results Default value: 1
    */
@@ -494,6 +512,12 @@ export interface NewPoolGetNetworkParams {
    */
   include?: string;
 
+  /**
+   * include GeckoTerminal community data (Sentiment votes, Suspicious reports)
+   * Default value: false
+   */
+  include_gt_community_data?: boolean;
+
   /**
    * page through results Default value: 1
    */

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

@@ -60,6 +60,8 @@ export namespace InfoGetResponse {
 
         discord_url?: string;
 
+        farcaster_url?: string;
+
         freeze_authority?: string;
 
         gt_categories_id?: Array<string>;
@@ -87,6 +89,8 @@ export namespace InfoGetResponse {
         twitter_handle?: string;
 
         websites?: Array<string>;
+
+        zora_url?: string;
       }
 
       export namespace Attributes {

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

@@ -86,6 +86,8 @@ export namespace PoolGetResponse {
 
       base_token_price_usd?: string;
 
+      community_sus_report?: number;
+
       fdv_usd?: string;
 
       market_cap_usd?: string;
@@ -104,6 +106,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;
@@ -572,6 +578,12 @@ export interface PoolGetParams {
    */
   include?: string;
 
+  /**
+   * include GeckoTerminal community data (Sentiment votes, Suspicious reports)
+   * Default value: false
+   */
+  include_gt_community_data?: boolean;
+
   /**
    * page through results Default value: 1
    */

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

@@ -7,4 +7,5 @@ export { Ohlcv, type OhlcvGetTimeframeResponse, type OhlcvGetTimeframeParams } f
 export { Pools, type PoolGetResponse, type PoolGetParams } from './pools';
 export { Tokens, type TokenGetAddressResponse, type TokenGetAddressParams } from './tokens';
 export { TopHolders, type TopHolderGetResponse, type TopHolderGetParams } from './top-holders';
+export { TopTraders, type TopTraderGetResponse, type TopTraderGetParams } from './top-traders';
 export { Trades, type TradeGetResponse, type TradeGetParams } from './trades';

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

@@ -50,6 +50,8 @@ export namespace InfoGetResponse {
 
       discord_url?: string;
 
+      farcaster_url?: string;
+
       freeze_authority?: string;
 
       gt_categories_id?: Array<string>;
@@ -77,6 +79,8 @@ export namespace InfoGetResponse {
       twitter_handle?: string;
 
       websites?: Array<string>;
+
+      zora_url?: string;
     }
 
     export namespace Attributes {

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

@@ -61,6 +61,8 @@ export namespace MultiGetAddressesResponse {
 
       image_url?: string;
 
+      last_trade_timestamp?: number;
+
       launchpad_details?: Attributes.LaunchpadDetails;
 
       market_cap_usd?: string;
@@ -335,6 +337,12 @@ export interface MultiGetAddressesParams {
    * Query param: include pool composition, default: false
    */
   include_composition?: boolean;
+
+  /**
+   * Query param: include tokens from inactive pools using the most recent swap,
+   * default: false
+   */
+  include_inactive_source?: boolean;
 }
 
 export declare namespace Multi {

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

@@ -120,6 +120,12 @@ export interface OhlcvGetTimeframeParams {
    */
   include_empty_intervals?: boolean;
 
+  /**
+   * Query param: include token data from inactive pools using the most recent swap,
+   * default: false
+   */
+  include_inactive_source?: boolean;
+
   /**
    * Query param: number of OHLCV results to return, maximum 1000 Default value: 100
    */

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

@@ -54,8 +54,12 @@ export namespace PoolGetResponse {
 
       base_token_price_usd?: string;
 
+      community_sus_report?: number;
+
       fdv_usd?: string;
 
+      last_trade_timestamp?: number;
+
       market_cap_usd?: string;
 
       name?: string;
@@ -72,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;
@@ -255,6 +263,18 @@ 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
+   */
+  include_inactive_source?: boolean;
+
   /**
    * Query param: page through results Default value: 1
    */