feat(candlestick api): add public api

Author: imwh0im

src/index.ts

@@ -30,6 +30,9 @@ import {
   IPostWithDrawalKrw,
   IBalanceResponse,
   IBithumbErrorResponse,
+  Time,
+  IGetCandlestick,
+  IGetCandlestickData,
 } from './types';
 
 export default class ApiBithumb {
@@ -96,6 +99,31 @@ export default class ApiBithumb {
     return res;
   }
 
+  /**
+   * provides a Candlestick data.
+   * https://apidocs.bithumb.com/docs/candlestick
+   */
+  public async GetCandlestick(
+    orderCurrency: string,
+    paymentCurrency: string,
+    chartIntervals: Time,
+  ): Promise<IGetCandlestickData[]> {
+    const endpoint = `/candlestick/${orderCurrency}_${paymentCurrency}`;
+    const res = <IGetCandlestick> await this.requestPublic(endpoint, chartIntervals);
+
+    const candleData: IGetCandlestickData[] = res.data.map((candle) => ({
+      timestamp: candle[0],
+      opening_price: candle[1],
+      closing_price: candle[2],
+      max_price: candle[3],
+      min_price: candle[4],
+      volume: candle[5],
+    }));
+
+    return candleData;
+  }
+
+
   /**
    * Provide information on membership and coin transaction fees.
    * https://apidocs.bithumb.com/docs/account

src/types/get-candlestick-data.interface.ts

@@ -0,0 +1,8 @@
+export interface IGetCandlestickData {
+  timestamp: number;
+  opening_price: string;
+  closing_price: string;
+  max_price: string;
+  min_price: string;
+  volume: string;
+}

src/types/get-candlestick-time.interface.ts

@@ -0,0 +1,10 @@
+export type Time =
+| '1m'
+| '3m'
+| '5m'
+| '10m'
+| '30m'
+| '1h'
+| '6h'
+| '12h'
+| '24h';

src/types/get-candlestick.interface.ts

@@ -0,0 +1,7 @@
+import { IBithumbResponse } from './bithumb-response.interface';
+
+export interface IGetCandlestick extends IBithumbResponse {
+
+  /** [timestamp, opening amount, closing amount, max price, min price, volume] */
+  data: [number, string, string, string, string, string][];
+}

src/types/get-endpoint.interface.ts

@@ -1 +1,3 @@
-export type getEndpointType = 'ticker' | 'orderbook' | 'transaction_history' | 'assetsstatus' | 'btci';
+type Candlestick = string;
+
+export type getEndpointType = 'ticker' | 'orderbook' | 'transaction_history' | 'assetsstatus' | 'btci' | Candlestick;

src/types/index.ts

@@ -21,9 +21,12 @@ export * from './market-sell.interface';
 export * from './withdrawal-coin.interface';
 export * from './withdrawal-krw.interface';
 export * from './bithumb-error-response.interface';
+export * from './get-candlestick.interface';
+export * from './get-candlestick-data.interface';
 
 // type
 export * from './currency-i18n.interface';
 export * from './get-endpoint.interface';
 export * from './post-endpoint.interface';
 export * from './trade-type.interface';
+export * from './get-candlestick-time.interface';