Merge pull request #38 from Apexrsq/feature/supply-interface

GannicusZhou · web-flow · commit c8bf9af911d1 · 2024-10-08T12:04:35.000+08:00
feat: add rest interface(/api/v1/st-orders)
diff --git a/README.md b/README.md
@@ -22,6 +22,7 @@
       - [Orders](#orders)
         - [Place Order Test](#place-order-test)
         - [Place Multiple Orders](#place-multiple-orders)
+        - [Place take profit and stop loss order](#place-take-profit-and-stop-loss-order)
       - [Fills](#fills)
       - [Positions](#positions)
       - [Risk Limit Level](#risk-limit-level)
@@ -390,6 +391,43 @@ futuresSDK.futuresOrderMulti([...], console.log);
 ```
 
 
+##### Place take profit and stop loss order
+```js
+//request
+{
+  "clientOid": "5c52e11203aa677f33e493fb",
+  "reduceOnly": false,
+  "closeOrder": false,
+  "forceHold": false,
+  "hidden": false,
+  "iceberg": false,
+  "leverage": 20,
+  "postOnly": false,
+  "price": 8000,
+  "remark": "remark",
+  "side": "buy",
+  "size": 20,"stopPriceType": "",
+  "symbol": "XBTUSDM",
+  "timeInForce": "",
+  "type": "limit",
+  "visibleSize": 0,
+  "marginMode": "ISOLATED"
+  "triggerStopUpPrice": 9000, 	//take profit price
+  "triggerStopDownPrice": 7000  //stop loss price
+}
+
+//Response
+{
+	"code": "200000",
+	"data": {
+		"orderId": "5bd6e9286d99522a52e458de",
+		"clientOid": "5c52e11203aa677f33e493fb"
+	}
+}
+
+futuresSDK.futuresOrderStp(params, console.log);
+```
+
 
 #### Fills
 
@@ -478,7 +516,7 @@ futuresSDK.futuresChangeRiskLimit(
 
 ```js
 // Get Current Funding Rate
-futuresSDK.futuresFundingRate('XBTUSDM', console.log);
+futuresSDK.futuresFundingRate('XBTUSDTM', console.log);
 
 // Get Public Funding History
 futuresSDK.futuresFundingRates({ 
@@ -558,10 +596,10 @@ futuresSDK.futuresInterests({ symbol: '.XBTINT' }, console.log);
 futuresSDK.futuresIndexList({ symbol: '.KXBT' }, console.log);
 
 // Get Current Mark Price
-futuresSDK.futuresMarkPrice('XBTUSDM', console.log);
+futuresSDK.futuresMarkPrice('XBTUSDTM', console.log);
 
 // Get Premium Index
-futuresSDK.futuresPremiums({ symbol: '.XBTUSDMPI' }, console.log);
+futuresSDK.futuresPremiums({ symbol: '.XBTUSDTMPI' }, console.log);
 ```
 
 #### Server Time
diff --git a/example/index.js b/example/index.js
@@ -239,11 +239,11 @@ futuresSDK.futuresStatus(console.log);
 
 // futuresSDK.futuresIndexList({ symbol: '.KXBT' }, console.log);
 
-// futuresSDK.futuresMarkPrice('XBTUSDM', console.log);
+// futuresSDK.futuresMarkPrice('XBTUSDTM', console.log);
 
-// futuresSDK.futuresPremiums({ symbol: '.XBTUSDMPI' }, console.log);
+// futuresSDK.futuresPremiums({ symbol: '.XBTUSDTMPI' }, console.log);
 
-// futuresSDK.futuresFundingRate('XBTUSDM', console.log);
+// futuresSDK.futuresFundingRate('XBTUSDTM', console.log);
 
 // futuresSDK.futuresTradeFees('XBTUSDTM', console.log);
 
diff --git a/lib/dataType/order.d.ts b/lib/dataType/order.d.ts
@@ -1,6 +1,9 @@
 import { PageSizeParams } from './common';
 export type BaseOrderType = 'limit' | 'market';
 export type OrderType = 'limit' | 'market' | 'limit_stop' | 'market_stop';
+export type TriggerType = 'TP' | 'IP' | 'MP';
+export type STPType = 'CN' | 'CO' | 'CB';
+export type TimeInForceType = 'GTC' | 'IOC';
 export type OrderOptionalParamsType = 'type' | 'remark' | 'stop' | 'stopPriceType' | 'stopPrice' | 'reduceOnly' | 'closeOrder' | 'forceHold' | 'timeInForce' | 'postOnly' | 'hidden' | 'iceberg' | 'visibleSize';
 export type OptionalParamsObject<T extends keyof any> = {
     [P in T]?: any;
@@ -55,3 +58,25 @@ export interface FillsParams extends PageSizeParams {
     side?: string;
     type?: OrderType;
 }
+export interface StpOrderParams {
+    clientOid: string;
+    side: string;
+    symbol: string;
+    leverage: string;
+    type?: string;
+    remark?: string;
+    triggerStopUpPrice?: string;
+    stopPriceType?: TriggerType;
+    triggerStopDownPrice?: string;
+    reduceOnly?: boolean;
+    closeOrder?: boolean;
+    forceHold?: boolean;
+    stp?: STPType;
+    price?: number | string;
+    size?: number;
+    timeInForce?: TimeInForceType;
+    postOnly?: boolean;
+    hidden?: boolean;
+    iceberg?: boolean;
+    visibleSize?: number | string;
+}
diff --git a/lib/index.d.ts b/lib/index.d.ts
@@ -1,5 +1,5 @@
 import { WebSocketClient } from './websocket';
-import { CreateSubApiParams, FillsParams, FundingHistoryParams, OpenOrderListParams, StopOrderListParams, TransactionHistoryParams, TransferListParams, UpdateSubApiParams, IndexListParams, klineParams, Callback, FundingRatesParams, MultiOrderBody, HistoryPositionsParams } from './dataType';
+import { CreateSubApiParams, FillsParams, FundingHistoryParams, OpenOrderListParams, StopOrderListParams, TransactionHistoryParams, TransferListParams, UpdateSubApiParams, IndexListParams, klineParams, Callback, FundingRatesParams, MultiOrderBody, HistoryPositionsParams, StpOrderParams } from './dataType';
 export default class KuCoinFutures {
     private request;
     private socketInstanceCache;
@@ -93,6 +93,7 @@ export default class KuCoinFutures {
         optional?: object | undefined;
     }, callback?: Function) => Promise<any>;
     futuresOrderMulti: (params: Array<MultiOrderBody>, callback?: Function) => Promise<any>;
+    futuresOrderStp: (params: StpOrderParams, callback?: Function) => Promise<any>;
     futuresCancel: (orderId: string, callback?: Function) => Promise<any>;
     futuresCancelAllOpenOrders: (symbol?: string, callback?: Function) => Promise<any>;
     futuresCancelAllStopOrders: (symbol?: string, callback?: Function) => Promise<any>;
@@ -255,19 +256,29 @@ export default class KuCoinFutures {
     futuresSocketSubscribe: (topic: string, callback?: Callback, isPrivate?: boolean, strict?: boolean) => Promise<false | undefined>;
     get websocket(): {
         klineCandle: (symbol: string, callback?: (d: any) => void) => Promise<false | (false | undefined)[] | undefined>;
-        tickerV2: (symbols: string | [], callback?: (d: any) => void) => Promise<false | (false | undefined)[] | undefined>;
-        ticker: (symbols: string | [], callback?: (d: any) => void) => Promise<false | (false | undefined)[] | undefined>;
-        level2: (symbols: string | [], callback?: (d: any) => void) => Promise<false | (false | undefined)[] | undefined>;
-        execution: (symbols: string | [], callback?: (d: any) => void) => Promise<false | (false | undefined)[] | undefined>;
-        level2Depth5: (symbols: string | [], callback?: (d: any) => void) => Promise<false | (false | undefined)[] | undefined>;
-        level2Depth50: (symbols: string | [], callback?: (d: any) => void) => Promise<false | (false | undefined)[] | undefined>;
-        instrument: (symbols: string | [], callback?: (d: any) => void) => Promise<false | (false | undefined)[] | undefined>;
+        tickerV2: (symbols: string | [
+        ], callback?: (d: any) => void) => Promise<false | (false | undefined)[] | undefined>;
+        ticker: (symbols: string | [
+        ], callback?: (d: any) => void) => Promise<false | (false | undefined)[] | undefined>;
+        level2: (symbols: string | [
+        ], callback?: (d: any) => void) => Promise<false | (false | undefined)[] | undefined>;
+        execution: (symbols: string | [
+        ], callback?: (d: any) => void) => Promise<false | (false | undefined)[] | undefined>;
+        level2Depth5: (symbols: string | [
+        ], callback?: (d: any) => void) => Promise<false | (false | undefined)[] | undefined>;
+        level2Depth50: (symbols: string | [
+        ], callback?: (d: any) => void) => Promise<false | (false | undefined)[] | undefined>;
+        instrument: (symbols: string | [
+        ], callback?: (d: any) => void) => Promise<false | (false | undefined)[] | undefined>;
         announcement: (callback?: (d: any) => void) => Promise<false | undefined>;
-        snapshot: (symbols: string | [], callback?: (d: any) => void) => Promise<false | (false | undefined)[] | undefined>;
-        tradeOrders: (symbols: string | [], callback?: (d: any) => void) => Promise<false | (false | undefined)[] | undefined>;
+        snapshot: (symbols: string | [
+        ], callback?: (d: any) => void) => Promise<false | (false | undefined)[] | undefined>;
+        tradeOrders: (symbols: string | [
+        ], callback?: (d: any) => void) => Promise<false | (false | undefined)[] | undefined>;
         advancedOrders: (callback?: (d: any) => void) => Promise<false | undefined>;
         wallet: (callback?: (d: any) => void) => Promise<false | undefined>;
-        position: (symbols: string | [], callback?: (d: any) => void) => Promise<false | (false | undefined)[] | undefined>;
+        position: (symbols: string | [
+        ], callback?: (d: any) => void) => Promise<false | (false | undefined)[] | undefined>;
         positionAll: (callback?: (d: any) => void) => Promise<false | undefined>;
     };
 }
diff --git a/lib/index.js b/lib/index.js
@@ -312,6 +312,16 @@ var KuCoinFutures = /** @class */ (function () {
                     })];
             });
         }); };
+        this.futuresOrderStp = function (params, callback) { return __awaiter(_this_1, void 0, void 0, function () {
+            return __generator(this, function (_a) {
+                return [2 /*return*/, this.makeRequest({
+                        body: params,
+                        method: constants_1.POST,
+                        endpoint: resetAPI_1.FUTURES_ORDER_STP_EP,
+                        callback: callback
+                    })];
+            });
+        }); };
         this.futuresCancel = function (orderId, callback) { return __awaiter(_this_1, void 0, void 0, function () {
             return __generator(this, function (_a) {
                 return [2 /*return*/, this.order(orderId, constants_1.DELETE, callback)];
diff --git a/lib/resetAPI/constants.d.ts b/lib/resetAPI/constants.d.ts
@@ -12,6 +12,7 @@ export declare const FUTURES_RECENT_DONE_ORDERS_EP = "/api/v1/recentDoneOrders";
 export declare const FUTURES_ORDER_CLIENT_ORDER_EP = "/api/v1/orders/client-order";
 export declare const FUTURES_ORDER_TEST_EP = "/api/v1/orders/test";
 export declare const FUTURES_ORDER_MULTI_EP = "/api/v1/orders/multi";
+export declare const FUTURES_ORDER_STP_EP = "/api/v1/st-orders";
 export declare const FUTURES_FILLS_EP = "/api/v1/fills";
 export declare const FUTURES_RECENT_FILLS_EP = "/api/v1/recentFills";
 export declare const FUTURES_TOTAL_OPEN_ORDERS_MARGIN_EP = "/api/v1/openOrderStatistics";
diff --git a/lib/resetAPI/constants.js b/lib/resetAPI/constants.js
@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.FUTURES_ALL_TICKER_TP = exports.FUTURES_TRADE_STATISTICS_EP = exports.FUTURES_KLINE_EP = exports.FUTURES_SERVICE_STATUS_EP = exports.FUTURES_TIMESTAMP_EP = exports.FUTURES_PREMIUM_EP = exports.FUTURES_MARK_PRICE_EP = exports.FUTURES_INDEX_EP = exports.FUTURES_INTEREST_EP = exports.FUTURES_TRADE_HISTORY_EP = exports.FUTURES_LEVEL2_100_EP = exports.FUTURES_LEVEL2_20_EP = exports.FUTURES_LEVEL2_EP = exports.FUTURES_TICKER_EP = exports.FUTURES_CONTRACTS_DETAIL_EP = exports.FUTURES_CONTRACTS_ACTIVE_EP = exports.FUTURES_TRADE_FEE_EP = exports.FUTURES_FUNDING_RATES_EP = exports.FUTURES_FUNDING_HISTORY_EP = exports.FUTURES_FUNDING_RATE_EP = exports.FUTURES_CHANGE_RISK_LIMIT_EP = exports.FUTURES_RISK_LIMIT_EP = exports.FUTURES_MAX_OPEN_POSITIONS_EP = exports.FUTURES_HISTORY_POSITIONS_EP = exports.FUTURES_WITHDRAW_MARGIN_EP = exports.FUTURES_MAX_WITHDRAW_MARGIN_EP = exports.FUTURES_POSITION_MARGIN_EP = exports.FUTURES_POSITION_AUTO_DEPOSIT_STATUS_EP = exports.FUTURES_POSITIONS_EP = exports.FUTURES_POSITION_EP = exports.FUTURES_TOTAL_OPEN_ORDERS_MARGIN_EP = exports.FUTURES_RECENT_FILLS_EP = exports.FUTURES_FILLS_EP = exports.FUTURES_ORDER_MULTI_EP = exports.FUTURES_ORDER_TEST_EP = exports.FUTURES_ORDER_CLIENT_ORDER_EP = exports.FUTURES_RECENT_DONE_ORDERS_EP = exports.FUTURES_STOP_ORDER_EP = exports.FUTURES_ORDER_EP = exports.FUTURES_TRANSFER_LIST_EP = exports.FUTURES_TRANSFER_IN_EP = exports.FUTURES_TRANSFER_OUT_EP = exports.FUTURES_UPDATE_SUB_API_EP = exports.FUTURES_SUB_API_EP = exports.FUTURES_TRANSACTION_HISTORY_EP = exports.FUTURES_ACCOUNT_OVERVIEW_ALL_EP = exports.FUTURES_ACCOUNT_OVERVIEW_EP = void 0;
+exports.FUTURES_ALL_TICKER_TP = exports.FUTURES_TRADE_STATISTICS_EP = exports.FUTURES_KLINE_EP = exports.FUTURES_SERVICE_STATUS_EP = exports.FUTURES_TIMESTAMP_EP = exports.FUTURES_PREMIUM_EP = exports.FUTURES_MARK_PRICE_EP = exports.FUTURES_INDEX_EP = exports.FUTURES_INTEREST_EP = exports.FUTURES_TRADE_HISTORY_EP = exports.FUTURES_LEVEL2_100_EP = exports.FUTURES_LEVEL2_20_EP = exports.FUTURES_LEVEL2_EP = exports.FUTURES_TICKER_EP = exports.FUTURES_CONTRACTS_DETAIL_EP = exports.FUTURES_CONTRACTS_ACTIVE_EP = exports.FUTURES_TRADE_FEE_EP = exports.FUTURES_FUNDING_RATES_EP = exports.FUTURES_FUNDING_HISTORY_EP = exports.FUTURES_FUNDING_RATE_EP = exports.FUTURES_CHANGE_RISK_LIMIT_EP = exports.FUTURES_RISK_LIMIT_EP = exports.FUTURES_MAX_OPEN_POSITIONS_EP = exports.FUTURES_HISTORY_POSITIONS_EP = exports.FUTURES_WITHDRAW_MARGIN_EP = exports.FUTURES_MAX_WITHDRAW_MARGIN_EP = exports.FUTURES_POSITION_MARGIN_EP = exports.FUTURES_POSITION_AUTO_DEPOSIT_STATUS_EP = exports.FUTURES_POSITIONS_EP = exports.FUTURES_POSITION_EP = exports.FUTURES_TOTAL_OPEN_ORDERS_MARGIN_EP = exports.FUTURES_RECENT_FILLS_EP = exports.FUTURES_FILLS_EP = exports.FUTURES_ORDER_STP_EP = exports.FUTURES_ORDER_MULTI_EP = exports.FUTURES_ORDER_TEST_EP = exports.FUTURES_ORDER_CLIENT_ORDER_EP = exports.FUTURES_RECENT_DONE_ORDERS_EP = exports.FUTURES_STOP_ORDER_EP = exports.FUTURES_ORDER_EP = exports.FUTURES_TRANSFER_LIST_EP = exports.FUTURES_TRANSFER_IN_EP = exports.FUTURES_TRANSFER_OUT_EP = exports.FUTURES_UPDATE_SUB_API_EP = exports.FUTURES_SUB_API_EP = exports.FUTURES_TRANSACTION_HISTORY_EP = exports.FUTURES_ACCOUNT_OVERVIEW_ALL_EP = exports.FUTURES_ACCOUNT_OVERVIEW_EP = void 0;
 // account endpoint
 exports.FUTURES_ACCOUNT_OVERVIEW_EP = '/api/v1/account-overview';
 exports.FUTURES_ACCOUNT_OVERVIEW_ALL_EP = '/api/v1/account-overview-all';
@@ -18,6 +18,7 @@ exports.FUTURES_RECENT_DONE_ORDERS_EP = '/api/v1/recentDoneOrders';
 exports.FUTURES_ORDER_CLIENT_ORDER_EP = '/api/v1/orders/client-order';
 exports.FUTURES_ORDER_TEST_EP = '/api/v1/orders/test';
 exports.FUTURES_ORDER_MULTI_EP = '/api/v1/orders/multi';
+exports.FUTURES_ORDER_STP_EP = '/api/v1/st-orders';
 // fills endpoint
 exports.FUTURES_FILLS_EP = '/api/v1/fills';
 exports.FUTURES_RECENT_FILLS_EP = '/api/v1/recentFills';
diff --git a/src/dataType/order.ts b/src/dataType/order.ts
@@ -2,6 +2,9 @@ import { PageSizeParams } from './common';
 
 export type BaseOrderType = 'limit' | 'market';
 export type OrderType = 'limit' | 'market' | 'limit_stop' | 'market_stop';
+export type TriggerType = 'TP' | 'IP' | 'MP';
+export type STPType = 'CN' | 'CO' | 'CB';
+export type TimeInForceType = 'GTC' | 'IOC';
 
 export type OrderOptionalParamsType =
   | 'type'
@@ -77,3 +80,26 @@ export interface FillsParams extends PageSizeParams {
   side?: string;
   type?: OrderType;
 }
+
+export interface StpOrderParams {
+  clientOid: string;
+  side: string;
+  symbol: string;
+  leverage: string;
+  type?: string;
+  remark?: string;
+  triggerStopUpPrice?: string;
+  stopPriceType?: TriggerType;
+  triggerStopDownPrice?: string;
+  reduceOnly?: boolean;
+  closeOrder?: boolean;
+  forceHold?: boolean;
+  stp?: STPType;
+  price?: number | string;
+  size?: number;
+  timeInForce?: TimeInForceType;
+  postOnly?: boolean;
+  hidden?: boolean;
+  iceberg?: boolean;
+  visibleSize?: number | string;
+}
diff --git a/src/index.ts b/src/index.ts
@@ -51,7 +51,8 @@ import {
   FUTURES_TRADE_FEE_EP,
   FUTURES_HISTORY_POSITIONS_EP,
   FUTURES_MAX_OPEN_POSITIONS_EP,
-  FUTURES_ALL_TICKER_TP
+  FUTURES_ALL_TICKER_TP,
+  FUTURES_ORDER_STP_EP
 } from './resetAPI';
 import {
   WebSocketClient,
@@ -92,7 +93,8 @@ import {
   Callback,
   FundingRatesParams,
   MultiOrderBody,
-  HistoryPositionsParams
+  HistoryPositionsParams,
+  StpOrderParams
 } from './dataType';
 
 export default class KuCoinFutures {
@@ -447,6 +449,18 @@ export default class KuCoinFutures {
     });
   };
 
+  futuresOrderStp = async (
+    params: StpOrderParams,
+    callback?: Function
+  ) => {
+    return this.makeRequest({
+      body: params,
+      method: POST,
+      endpoint: FUTURES_ORDER_STP_EP,
+      callback
+    });
+  };
+
   futuresCancel = async (orderId: string, callback?: Function) => {
     return this.order(orderId, DELETE, callback);
   };
diff --git a/src/resetAPI/constants.ts b/src/resetAPI/constants.ts
@@ -18,6 +18,7 @@ export const FUTURES_RECENT_DONE_ORDERS_EP = '/api/v1/recentDoneOrders';
 export const FUTURES_ORDER_CLIENT_ORDER_EP = '/api/v1/orders/client-order';
 export const FUTURES_ORDER_TEST_EP  = '/api/v1/orders/test';
 export const FUTURES_ORDER_MULTI_EP = '/api/v1/orders/multi';
+export const FUTURES_ORDER_STP_EP = '/api/v1/st-orders';
 
 // fills endpoint
 export const FUTURES_FILLS_EP = '/api/v1/fills';
