@coingecko/coingecko-typescript 2.5.0 → 3.1.0

package/src/resources/public-treasury.ts

@@ -23,8 +23,8 @@ export class PublicTreasury extends APIResource {
     params: PublicTreasuryGetCoinIDParams,
     options?: RequestOptions,
   ): APIPromise<PublicTreasuryGetCoinIDResponse> {
-    const { entity } = params;
-    return this._client.get(path`/${entity}/public_treasury/${coinID}`, options);
+    const { entity, ...query } = params;
+    return this._client.get(path`/${entity}/public_treasury/${coinID}`, { query, ...options });
   }
 
   /**
@@ -38,8 +38,12 @@ export class PublicTreasury extends APIResource {
    * );
    * ```
    */
-  getEntityID(entityID: string, options?: RequestOptions): APIPromise<PublicTreasuryGetEntityIDResponse> {
-    return this._client.get(path`/public_treasury/${entityID}`, options);
+  getEntityID(
+    entityID: string,
+    query: PublicTreasuryGetEntityIDParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<PublicTreasuryGetEntityIDResponse> {
+    return this._client.get(path`/public_treasury/${entityID}`, { query, ...options });
   }
 
   /**
@@ -88,61 +92,125 @@ export class PublicTreasury extends APIResource {
   }
 }
 
-export interface PublicTreasuryGetCoinIDResponse {
-  companies?: Array<PublicTreasuryGetCoinIDResponse.Company>;
-
-  /**
-   * market cap dominance
-   */
-  market_cap_dominance?: number;
-
-  /**
-   * total crypto holdings of companies or government
-   */
-  total_holdings?: number;
-
-  /**
-   * total crypto holdings value in usd
-   */
-  total_value_usd?: number;
-}
+export type PublicTreasuryGetCoinIDResponse =
+  | PublicTreasuryGetCoinIDResponse.CompaniesTreasury
+  | PublicTreasuryGetCoinIDResponse.GovernmentsTreasury;
 
 export namespace PublicTreasuryGetCoinIDResponse {
-  export interface Company {
-    /**
-     * company incorporated or government country
-     */
-    country?: string;
+  export interface CompaniesTreasury {
+    companies: Array<CompaniesTreasury.Company>;
 
     /**
-     * company or government name
+     * market cap dominance
      */
-    name?: string;
+    market_cap_dominance: number;
 
     /**
-     * percentage of total crypto supply
+     * total crypto holdings of companies
      */
-    percentage_of_total_supply?: number;
+    total_holdings: number;
 
     /**
-     * company symbol
+     * total crypto holdings value in usd
      */
-    symbol?: string;
+    total_value_usd: number;
+  }
+
+  export namespace CompaniesTreasury {
+    export interface Company {
+      /**
+       * company incorporated or government country
+       */
+      country?: string;
+
+      /**
+       * company or government name
+       */
+      name?: string;
+
+      /**
+       * percentage of total crypto supply
+       */
+      percentage_of_total_supply?: number;
+
+      /**
+       * company symbol
+       */
+      symbol?: string;
+
+      /**
+       * total current value of crypto holdings in usd
+       */
+      total_current_value_usd?: number;
+
+      /**
+       * total entry value in usd
+       */
+      total_entry_value_usd?: number;
+
+      /**
+       * total crypto holdings
+       */
+      total_holdings?: number;
+    }
+  }
+
+  export interface GovernmentsTreasury {
+    governments: Array<GovernmentsTreasury.Government>;
 
     /**
-     * total current value of crypto holdings in usd
+     * market cap dominance
      */
-    total_current_value_usd?: number;
+    market_cap_dominance: number;
 
     /**
-     * total entry value in usd
+     * total crypto holdings of governments
      */
-    total_entry_value_usd?: number;
+    total_holdings: number;
 
     /**
-     * total crypto holdings of company
+     * total crypto holdings value in usd
      */
-    total_holdings?: number;
+    total_value_usd: number;
+  }
+
+  export namespace GovernmentsTreasury {
+    export interface Government {
+      /**
+       * company incorporated or government country
+       */
+      country?: string;
+
+      /**
+       * company or government name
+       */
+      name?: string;
+
+      /**
+       * percentage of total crypto supply
+       */
+      percentage_of_total_supply?: number;
+
+      /**
+       * company symbol
+       */
+      symbol?: string;
+
+      /**
+       * total current value of crypto holdings in usd
+       */
+      total_current_value_usd?: number;
+
+      /**
+       * total entry value in usd
+       */
+      total_entry_value_usd?: number;
+
+      /**
+       * total crypto holdings
+       */
+      total_holdings?: number;
+    }
   }
 }
 
@@ -162,6 +230,11 @@ export interface PublicTreasuryGetEntityIDResponse {
    */
   holdings?: Array<PublicTreasuryGetEntityIDResponse.Holding>;
 
+  /**
+   * market to net asset value ratio
+   */
+  m_nav?: number;
+
   /**
    * entity name
    */
@@ -172,6 +245,16 @@ export interface PublicTreasuryGetEntityIDResponse {
    */
   symbol?: string;
 
+  /**
+   * total asset value per share in USD
+   */
+  total_asset_value_per_share_usd?: number;
+
+  /**
+   * total current value of all holdings in USD
+   */
+  total_treasury_value_usd?: number;
+
   /**
    * official Twitter handle of the entity
    */
@@ -182,6 +265,11 @@ export interface PublicTreasuryGetEntityIDResponse {
    */
   type?: string;
 
+  /**
+   * unrealized profit and loss (current value - total entry value)
+   */
+  unrealized_pnl?: number;
+
   /**
    * official website URL of the entity
    */
@@ -195,15 +283,95 @@ export namespace PublicTreasuryGetEntityIDResponse {
      */
     amount?: number;
 
+    /**
+     * amount of cryptocurrency per share
+     */
+    amount_per_share?: number;
+
+    /**
+     * average entry cost per unit in USD
+     */
+    average_entry_value_usd?: number;
+
     /**
      * coin ID
      */
     coin_id?: string;
 
+    /**
+     * current value of holdings in USD
+     */
+    current_value_usd?: number;
+
+    /**
+     * percentage of entity's total treasury value
+     */
+    entity_value_usd_percentage?: number;
+
+    /**
+     * holding amount changes over different timeframes (only present if
+     * holding_amount_change param is used)
+     */
+    holding_amount_change?: Holding.HoldingAmountChange;
+
+    /**
+     * holding change percentages over different timeframes (only present if
+     * holding_change_percentage param is used)
+     */
+    holding_change_percentage?: Holding.HoldingChangePercentage;
+
     /**
      * percentage of total crypto supply
      */
     percentage_of_total_supply?: number;
+
+    /**
+     * total entry cost/purchase value in USD
+     */
+    total_entry_value_usd?: number;
+
+    /**
+     * unrealized profit and loss for this holding
+     */
+    unrealized_pnl?: number;
+  }
+
+  export namespace Holding {
+    /**
+     * holding amount changes over different timeframes (only present if
+     * holding_amount_change param is used)
+     */
+    export interface HoldingAmountChange {
+      '14d'?: number;
+
+      '1y'?: number;
+
+      '30d'?: number;
+
+      '7d'?: number;
+
+      '90d'?: number;
+
+      ytd?: number;
+    }
+
+    /**
+     * holding change percentages over different timeframes (only present if
+     * holding_change_percentage param is used)
+     */
+    export interface HoldingChangePercentage {
+      '14d'?: number;
+
+      '1y'?: number;
+
+      '30d'?: number;
+
+      '7d'?: number;
+
+      '90d'?: number;
+
+      ytd?: number;
+    }
   }
 }
 
@@ -263,9 +431,38 @@ export namespace PublicTreasuryGetTransactionHistoryResponse {
 
 export interface PublicTreasuryGetCoinIDParams {
   /**
-   * public company or government entity
+   * Path param: public company or government entity
    */
   entity: 'companies' | 'governments';
+
+  /**
+   * Query param: Sort order for results
+   */
+  order?: 'total_holdings_usd_desc' | 'total_holdings_usd_asc';
+
+  /**
+   * Query param: Page number to return
+   */
+  page?: number;
+
+  /**
+   * Query param: Number of results to return per page
+   */
+  per_page?: number;
+}
+
+export interface PublicTreasuryGetEntityIDParams {
+  /**
+   * include holding amount change for specified timeframes, comma-separated if
+   * querying more than 1 timeframe Valid values: 7d, 14d, 30d, 90d, 1y, ytd
+   */
+  holding_amount_change?: string;
+
+  /**
+   * include holding change percentage for specified timeframes, comma-separated if
+   * querying more than 1 timeframe Valid values: 7d, 14d, 30d, 90d, 1y, ytd
+   */
+  holding_change_percentage?: string;
 }
 
 export interface PublicTreasuryGetHoldingChartParams {
@@ -325,6 +522,7 @@ export declare namespace PublicTreasury {
     type PublicTreasuryGetHoldingChartResponse as PublicTreasuryGetHoldingChartResponse,
     type PublicTreasuryGetTransactionHistoryResponse as PublicTreasuryGetTransactionHistoryResponse,
     type PublicTreasuryGetCoinIDParams as PublicTreasuryGetCoinIDParams,
+    type PublicTreasuryGetEntityIDParams as PublicTreasuryGetEntityIDParams,
     type PublicTreasuryGetHoldingChartParams as PublicTreasuryGetHoldingChartParams,
     type PublicTreasuryGetTransactionHistoryParams as PublicTreasuryGetTransactionHistoryParams,
   };

package/src/version.ts

@@ -1 +1 @@
-export const VERSION = '2.5.0'; // x-release-please-version
+export const VERSION = '3.1.0'; // x-release-please-version

package/version.d.mts

@@ -1,2 +1,2 @@
-export declare const VERSION = "2.5.0";
+export declare const VERSION = "3.1.0";
 //# sourceMappingURL=version.d.mts.map

package/version.d.ts

@@ -1,2 +1,2 @@
-export declare const VERSION = "2.5.0";
+export declare const VERSION = "3.1.0";
 //# sourceMappingURL=version.d.ts.map

package/version.js

@@ -1,5 +1,5 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.VERSION = void 0;
-exports.VERSION = '2.5.0'; // x-release-please-version
+exports.VERSION = '3.1.0'; // x-release-please-version
 //# sourceMappingURL=version.js.map

package/version.mjs

@@ -1,2 +1,2 @@
-export const VERSION = '2.5.0'; // x-release-please-version
+export const VERSION = '3.1.0'; // x-release-please-version
 //# sourceMappingURL=version.mjs.map