Merge pull request #59 from JJ-Cro/Update181124

v1.0.5 feat(): added 4 new INTX Index endpoints

examples/apidoc/CBInternationalClient/getIndexCandles.js

@@ -0,0 +1,20 @@
+const { CBInternationalClient } = require('coinbase-api');
+
+  // This example shows how to call this coinbase API endpoint with either node.js, javascript (js) or typescript (ts) with the npm module "coinbase-api" for coinbase exchange
+  // This coinbase API SDK is available on npm via "npm install coinbase-api"
+  // ENDPOINT: /api/v1/index/{index}/candles
+  // METHOD: GET
+  // PUBLIC: YES
+
+const client = new CBInternationalClient({
+  apiKey: 'insert_api_key_here',
+  apiSecret: 'insert_api_secret_here',
+});
+
+client.getIndexCandles(params)
+  .then((response) => {
+    console.log(response);
+  })
+  .catch((error) => {
+    console.error(error);
+  });

examples/apidoc/CBInternationalClient/getIndexComposition.js

@@ -0,0 +1,20 @@
+const { CBInternationalClient } = require('coinbase-api');
+
+  // This example shows how to call this coinbase API endpoint with either node.js, javascript (js) or typescript (ts) with the npm module "coinbase-api" for coinbase exchange
+  // This coinbase API SDK is available on npm via "npm install coinbase-api"
+  // ENDPOINT: /api/v1/index/{index}/composition
+  // METHOD: GET
+  // PUBLIC: YES
+
+const client = new CBInternationalClient({
+  apiKey: 'insert_api_key_here',
+  apiSecret: 'insert_api_secret_here',
+});
+
+client.getIndexComposition(params)
+  .then((response) => {
+    console.log(response);
+  })
+  .catch((error) => {
+    console.error(error);
+  });

examples/apidoc/CBInternationalClient/getIndexCompositionHistory.js

@@ -0,0 +1,20 @@
+const { CBInternationalClient } = require('coinbase-api');
+
+  // This example shows how to call this coinbase API endpoint with either node.js, javascript (js) or typescript (ts) with the npm module "coinbase-api" for coinbase exchange
+  // This coinbase API SDK is available on npm via "npm install coinbase-api"
+  // ENDPOINT: /api/v1/index/{index}/composition-history
+  // METHOD: GET
+  // PUBLIC: YES
+
+const client = new CBInternationalClient({
+  apiKey: 'insert_api_key_here',
+  apiSecret: 'insert_api_secret_here',
+});
+
+client.getIndexCompositionHistory(params)
+  .then((response) => {
+    console.log(response);
+  })
+  .catch((error) => {
+    console.error(error);
+  });

examples/apidoc/CBInternationalClient/getIndexPrice.js

@@ -0,0 +1,20 @@
+const { CBInternationalClient } = require('coinbase-api');
+
+  // This example shows how to call this coinbase API endpoint with either node.js, javascript (js) or typescript (ts) with the npm module "coinbase-api" for coinbase exchange
+  // This coinbase API SDK is available on npm via "npm install coinbase-api"
+  // ENDPOINT: /api/v1/index/{index}/price
+  // METHOD: GET
+  // PUBLIC: YES
+
+const client = new CBInternationalClient({
+  apiKey: 'insert_api_key_here',
+  apiSecret: 'insert_api_secret_here',
+});
+
+client.getIndexPrice(params)
+  .then((response) => {
+    console.log(response);
+  })
+  .catch((error) => {
+    console.error(error);
+  });

package.json

@@ -1,6 +1,6 @@
 {
   "name": "coinbase-api",
-  "version": "1.0.4",
+  "version": "1.0.5",
   "description": "Node.js SDK for Coinbase's REST APIs and WebSockets, with TypeScript & strong end to end tests.",
   "scripts": {
     "clean": "rm -rf dist",

src/CBInternationalClient.ts

@@ -11,6 +11,8 @@ import {
   GetINTXAggregatedCandlesData,
   GetINTXDailyTradingVolumes,
   GetINTXFillsByPortfoliosRequest,
+  GetINTXIndexCandlesRequest,
+  GetINTXIndexCompositionHistory,
   GetINTXMatchingTransfersRequest,
   GetINTXOpenOrdersRequest,
   GetINTXPortfolioFillsRequest,
@@ -73,6 +75,54 @@ export class CBInternationalClient extends BaseRestClient {
     return this.get(`/api/v1/assets/${params.asset}/networks`);
   }
 
+  /**
+   *
+   * Index Endpoints
+   *
+   */
+
+  /**
+   * Get index composition
+   *
+   * Retrieves the latest index composition (metadata) with an ordered set of constituents.
+   */
+  getIndexComposition(params: { index: string }): Promise<any> {
+    return this.get(`/api/v1/index/${params.index}/composition`);
+  }
+
+  /**
+   * Get index composition history
+   *
+   * Retrieves a history of index composition records in a descending time order.
+   * The results are an array of index composition data recorded at different "timestamps".
+   */
+  getIndexCompositionHistory(
+    params: GetINTXIndexCompositionHistory,
+  ): Promise<any> {
+    const { index, ...query } = params;
+    return this.get(`/api/v1/index/${index}/composition-history`, query);
+  }
+
+  /**
+   * Get index price
+   *
+   * Retrieves the latest index price.
+   */
+  getIndexPrice(params: { index: string }): Promise<any> {
+    return this.get(`/api/v1/index/${params.index}/price`);
+  }
+
+  /**
+   * Get index candles
+   *
+   * Retrieves the historical daily index prices in time descending order.
+   * The daily values are represented as aggregated entries for the day in typical OHLC format.
+   */
+  getIndexCandles(params: GetINTXIndexCandlesRequest): Promise<any> {
+    const { index, ...query } = params;
+    return this.get(`/api/v1/index/${index}/candles`, query);
+  }
+
   /**
    *
    * Instruments Endpoints

src/types/request/coinbase-international.ts

@@ -4,6 +4,26 @@
  *
  */
 
+/**
+ *
+ * Index Endpoints
+ *
+ */
+
+export interface GetINTXIndexCompositionHistory {
+  index: string;
+  time_from?: string;
+  result_limit?: number;
+  result_offset?: number;
+}
+
+export interface GetINTXIndexCandlesRequest {
+  index: string;
+  granularity: string;
+  start: string;
+  end?: string;
+}
+
 /**
  *
  * Instruments Endpoints