@coingecko/coingecko-typescript 2.3.0 → 2.5.0

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

@@ -65,7 +65,7 @@ export interface CirculatingSupplyChartGetParams {
   /**
    * data interval
    */
-  interval?: 'daily';
+  interval?: '5m' | 'hourly' | 'daily';
 }
 
 export interface CirculatingSupplyChartGetRangeParams {

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
    */
@@ -231,6 +241,18 @@ export interface CoinGetIDResponse {
 }
 
 export namespace CoinGetIDResponse {
+  export interface CategoriesDetail {
+    /**
+     * category ID
+     */
+    id?: string;
+
+    /**
+     * category name
+     */
+    name?: string;
+  }
+
   /**
    * coin community data
    */
@@ -344,6 +366,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
    */
@@ -1055,6 +1232,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/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/index.ts

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

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

@@ -56,6 +56,8 @@ export namespace PoolGetResponse {
 
       fdv_usd?: string;
 
+      last_trade_timestamp?: number;
+
       market_cap_usd?: string;
 
       name?: string;
@@ -255,6 +257,12 @@ export interface PoolGetParams {
    */
   include?: string;
 
+  /**
+   * 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
    */

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-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 };
+}