@coingecko/coingecko-typescript 2.3.0 → 3.0.0

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

@@ -13,6 +13,8 @@ import * as PoolsAPI from './pools';
 import { PoolGetParams, PoolGetResponse, Pools } from './pools';
 import * as TopHoldersAPI from './top-holders';
 import { TopHolderGetParams, TopHolderGetResponse, TopHolders } from './top-holders';
+import * as TopTradersAPI from './top-traders';
+import { TopTraderGetParams, TopTraderGetResponse, TopTraders } from './top-traders';
 import * as TradesAPI from './trades';
 import { TradeGetParams, TradeGetResponse, Trades } from './trades';
 import { APIPromise } from '../../../../core/api-promise';
@@ -27,6 +29,7 @@ export class Tokens extends APIResource {
   ohlcv: OhlcvAPI.Ohlcv = new OhlcvAPI.Ohlcv(this._client);
   pools: PoolsAPI.Pools = new PoolsAPI.Pools(this._client);
   trades: TradesAPI.Trades = new TradesAPI.Trades(this._client);
+  topTraders: TopTradersAPI.TopTraders = new TopTradersAPI.TopTraders(this._client);
 
   /**
    * This endpoint allows you to **query specific token data based on the provided
@@ -80,6 +83,8 @@ export namespace TokenGetAddressResponse {
 
       image_url?: string;
 
+      last_trade_timestamp?: number;
+
       market_cap_usd?: string;
 
       name?: string;
@@ -344,6 +349,12 @@ export interface TokenGetAddressParams {
    * Query param: include pool composition, default: false
    */
   include_composition?: boolean;
+
+  /**
+   * Query param: include token data from inactive pools using the most recent swap,
+   * default: false
+   */
+  include_inactive_source?: boolean;
 }
 
 Tokens.Multi = Multi;
@@ -353,6 +364,7 @@ Tokens.HoldersChart = HoldersChart;
 Tokens.Ohlcv = Ohlcv;
 Tokens.Pools = Pools;
 Tokens.Trades = Trades;
+Tokens.TopTraders = TopTraders;
 
 export declare namespace Tokens {
   export {
@@ -393,4 +405,10 @@ export declare namespace Tokens {
     type TradeGetResponse as TradeGetResponse,
     type TradeGetParams as TradeGetParams,
   };
+
+  export {
+    TopTraders as TopTraders,
+    type TopTraderGetResponse as TopTraderGetResponse,
+    type TopTraderGetParams as TopTraderGetParams,
+  };
 }

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/networks/tokens/top-traders.ts

@@ -0,0 +1,116 @@
+// 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';
+import { path } from '../../../../internal/utils/path';
+
+export class TopTraders extends APIResource {
+  /**
+   * This endpoint allows you to **query top token traders based on the provided
+   * token contract address on a network**
+   *
+   * @example
+   * ```ts
+   * const topTrader =
+   *   await client.onchain.networks.tokens.topTraders.get(
+   *     '0x6921b130d297cc43754afba22e5eac0fbf8db75b',
+   *     { network_id: 'base' },
+   *   );
+   * ```
+   */
+  get(
+    tokenAddress: string,
+    params: TopTraderGetParams,
+    options?: RequestOptions,
+  ): APIPromise<TopTraderGetResponse> {
+    const { network_id, ...query } = params;
+    return this._client.get(path`/onchain/networks/${network_id}/tokens/${tokenAddress}/top_traders`, {
+      query,
+      ...options,
+    });
+  }
+}
+
+export interface TopTraderGetResponse {
+  data?: TopTraderGetResponse.Data;
+}
+
+export namespace TopTraderGetResponse {
+  export interface Data {
+    id?: string;
+
+    attributes?: Data.Attributes;
+
+    type?: string;
+  }
+
+  export namespace Data {
+    export interface Attributes {
+      traders?: Array<Attributes.Trader>;
+    }
+
+    export namespace Attributes {
+      export interface Trader {
+        address?: string;
+
+        average_buy_price_usd?: string;
+
+        average_sell_price_usd?: string;
+
+        explorer_url?: string;
+
+        label?: string;
+
+        name?: string;
+
+        realized_pnl_usd?: string;
+
+        token_balance?: string;
+
+        total_buy_count?: number;
+
+        total_buy_token_amount?: string;
+
+        total_buy_usd?: string;
+
+        total_sell_count?: number;
+
+        total_sell_token_amount?: string;
+
+        total_sell_usd?: string;
+
+        type?: string;
+
+        unrealized_pnl_usd?: string;
+      }
+    }
+  }
+}
+
+export interface TopTraderGetParams {
+  /**
+   * Path param: network ID \*refers to [/networks](/reference/networks-list)
+   */
+  network_id: string;
+
+  /**
+   * Query param: include address label data, default: false
+   */
+  include_address_label?: boolean;
+
+  /**
+   * Query param: sort the traders by field Default value: realized_pnl_usd_desc
+   */
+  sort?: 'realized_pnl_usd_desc' | 'unrealized_pnl_usd_desc' | 'total_buy_usd_desc' | 'total_sell_usd_desc';
+
+  /**
+   * Query param: number of top token traders to return, you may use any integer or
+   * `max` Default value: 10
+   */
+  traders?: string;
+}
+
+export declare namespace TopTraders {
+  export { type TopTraderGetResponse as TopTraderGetResponse, type TopTraderGetParams as TopTraderGetParams };
+}

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

@@ -71,6 +71,8 @@ export namespace TrendingPoolGetResponse {
 
       base_token_price_usd?: string;
 
+      community_sus_report?: number;
+
       fdv_usd?: string;
 
       market_cap_usd?: string;
@@ -89,6 +91,10 @@ export namespace TrendingPoolGetResponse {
 
       reserve_in_usd?: string;
 
+      sentiment_vote_negative_percentage?: number;
+
+      sentiment_vote_positive_percentage?: number;
+
       transactions?: Attributes.Transactions;
 
       volume_usd?: Attributes.VolumeUsd;
@@ -287,6 +293,8 @@ export namespace TrendingPoolGetNetworkResponse {
 
       base_token_price_usd?: string;
 
+      community_sus_report?: number;
+
       fdv_usd?: string;
 
       market_cap_usd?: string;
@@ -305,6 +313,10 @@ export namespace TrendingPoolGetNetworkResponse {
 
       reserve_in_usd?: string;
 
+      sentiment_vote_negative_percentage?: number;
+
+      sentiment_vote_positive_percentage?: number;
+
       transactions?: Attributes.Transactions;
 
       volume_usd?: Attributes.VolumeUsd;
@@ -489,6 +501,12 @@ export interface TrendingPoolGetParams {
    */
   include?: string;
 
+  /**
+   * include GeckoTerminal community data (Sentiment votes, Suspicious reports)
+   * Default value: false
+   */
+  include_gt_community_data?: boolean;
+
   /**
    * page through results Default value: 1
    */
@@ -507,6 +525,12 @@ export interface TrendingPoolGetNetworkParams {
    */
   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/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';
 
   /**

package/src/resources/onchain/simple/networks/token-price.ts

@@ -47,7 +47,17 @@ export namespace TokenPriceGetAddressesResponse {
 
   export namespace Data {
     export interface Attributes {
+      h24_price_change_percentage?: { [key: string]: string };
+
+      h24_volume_usd?: { [key: string]: string };
+
+      last_trade_timestamp?: { [key: string]: number };
+
+      market_cap_usd?: { [key: string]: string };
+
       token_prices?: { [key: string]: string };
+
+      total_reserve_in_usd?: { [key: string]: string };
     }
   }
 }
@@ -68,6 +78,12 @@ export interface TokenPriceGetAddressesParams {
    */
   include_24hr_vol?: boolean;
 
+  /**
+   * Query param: include token price data from inactive pools using the most recent
+   * swap, default: false
+   */
+  include_inactive_source?: boolean;
+
   /**
    * Query param: include market capitalization, default: false
    */