kucoin-api 1.0.15 → 1.0.17
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/cjs/FuturesClient.d.ts +2 -2
- package/dist/cjs/FuturesClient.js.map +1 -1
- package/dist/cjs/types/request/futures.types.d.ts +4 -0
- package/dist/cjs/types/request/spot-funding.d.ts +7 -7
- package/dist/cjs/types/response/futures.types.d.ts +2 -0
- package/dist/mjs/FuturesClient.d.ts +2 -2
- package/dist/mjs/FuturesClient.js.map +1 -1
- package/dist/mjs/types/request/futures.types.d.ts +4 -0
- package/dist/mjs/types/request/spot-funding.d.ts +7 -7
- package/dist/mjs/types/response/futures.types.d.ts +2 -0
- package/package.json +1 -1
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
import { AxiosRequestConfig } from 'axios';
|
|
2
2
|
import { BaseRestClient } from './lib/BaseRestClient.js';
|
|
3
3
|
import { RestClientOptions, RestClientType } from './lib/requestUtils.js';
|
|
4
|
-
import { AccountFillsRequest, BatchCancelOrdersRequest, CreateSubAPIRequest, DeleteSubAPIRequest, GetFundingHistoryRequest, GetFundingRatesRequest, GetInterestRatesRequest, GetKlinesRequest, GetOrdersRequest, GetStopOrdersRequest, GetSubAPIsRequest, GetTransactionsRequest, GetTransfersRequest, MaxOpenSizeRequest, Order, SubmitTransfer, UpdateSubAPIRequest } from './types/request/futures.types.js';
|
|
4
|
+
import { AccountFillsRequest, BatchCancelOrdersRequest, CreateSubAPIRequest, DeleteSubAPIRequest, GetFundingHistoryRequest, GetFundingRatesRequest, GetInterestRatesRequest, GetKlinesRequest, GetOrdersRequest, GetStopOrdersRequest, GetSubAPIsRequest, GetTransactionsRequest, GetTransfersRequest, MaxOpenSizeRequest, Order, SLTPOrder, SubmitTransfer, UpdateSubAPIRequest } from './types/request/futures.types.js';
|
|
5
5
|
import { AccountBalance, AccountSummary, AddMargin, BatchCancelOrderResult, CreateSubAccountAPI, FullOrderBookDetail, FuturesAccountFundingRateHistory, FuturesAccountTransaction, FuturesActiveOrder, FuturesClosedPositions, FuturesCurrentFundingRate, FuturesFill, FuturesFills, FuturesHistoricFundingRate, FuturesKline, FuturesMarkPrice, FuturesOrder, FuturesOrders, FuturesPosition, FuturesRiskLimit, FuturesSymbolInfo, FuturesTransferRecords, IndexListItem, InterestRateItem, MarketTradeDetail, MaxOpenSize, PremiumIndexItem, SubAccountAPI, SubBalance, SubmitMultipleOrdersFuturesResponse, TickerDetail, TransferDetail, UpdateSubAccountAPI } from './types/response/futures.types.js';
|
|
6
6
|
import { APISuccessResponse, ServiceStatus } from './types/response/shared.types.js';
|
|
7
7
|
import { WsConnectionInfo } from './types/response/ws.js';
|
|
@@ -135,7 +135,7 @@ export declare class FuturesClient extends BaseRestClient {
|
|
|
135
135
|
batchCancelOrders(params: BatchCancelOrdersRequest): Promise<APISuccessResponse<{
|
|
136
136
|
data: BatchCancelOrderResult[];
|
|
137
137
|
}>>;
|
|
138
|
-
submitSLTPOrder(params:
|
|
138
|
+
submitSLTPOrder(params: SLTPOrder): Promise<APISuccessResponse<{
|
|
139
139
|
orderId?: string;
|
|
140
140
|
clientOid?: string;
|
|
141
141
|
}>>;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"FuturesClient.js","sourceRoot":"","sources":["../../src/FuturesClient.ts"],"names":[],"mappings":";;;AACA,mCAAgC;AAEhC,+DAAyD;AACzD,2DAI+B;
|
|
1
|
+
{"version":3,"file":"FuturesClient.js","sourceRoot":"","sources":["../../src/FuturesClient.ts"],"names":[],"mappings":";;;AACA,mCAAgC;AAEhC,+DAAyD;AACzD,2DAI+B;AA8D/B;;GAEG;AACH,MAAa,aAAc,SAAQ,kCAAc;IAC/C,YACE,oBAAuC,EAAE,EACzC,iBAAqC,EAAE;QAEvC,KAAK,CAAC,iBAAiB,EAAE,cAAc,CAAC,CAAC;QACzC,OAAO,IAAI,CAAC;IACd,CAAC;IAED,aAAa;QACX,OAAO,uCAAqB,CAAC,OAAO,CAAC;IACvC,CAAC;IAED;;;;OAIG;IAEH,kBAAkB;QAChB,OAAO,IAAA,eAAM,EAAC,EAAE,CAAC,CAAC;IACpB,CAAC;IAED,aAAa;QACX,OAAO,IAAI,CAAC,GAAG,CAAC,kBAAkB,CAAC,CAAC;IACtC,CAAC;IAED,gBAAgB;QACd,OAAO,IAAI,CAAC,GAAG,CAAC,eAAe,CAAC,CAAC;IACnC,CAAC;IAED;;;OAGG;IAEH,eAAe,CAAC,MAA8B;QAM5C,OAAO,IAAI,CAAC,UAAU,CAAC,4BAA4B,EAAE,MAAM,CAAC,CAAC;IAC/D,CAAC;IAED;;OAEG;IAEH,UAAU,CACR,MAAyB;QAEzB,OAAO,IAAI,CAAC,UAAU,CAAC,oBAAoB,EAAE,MAAM,CAAC,CAAC;IACvD,CAAC;IAED,YAAY,CACV,MAA2B;QAE3B,OAAO,IAAI,CAAC,WAAW,CAAC,oBAAoB,EAAE,MAAM,CAAC,CAAC;IACxD,CAAC;IAED,YAAY,CACV,MAA2B;QAE3B,OAAO,IAAI,CAAC,WAAW,CAAC,2BAA2B,EAAE,MAAM,CAAC,CAAC;IAC/D,CAAC;IAED,YAAY,CAAC,MAA2B;QAMtC,OAAO,IAAI,CAAC,aAAa,CAAC,oBAAoB,EAAE,MAAM,CAAC,CAAC;IAC1D,CAAC;IAED;;OAEG;IAEH,UAAU,CAAC,MAEV;QACC,OAAO,IAAI,CAAC,UAAU,CAAC,yBAAyB,EAAE,MAAM,CAAC,CAAC;IAC5D,CAAC;IAED,cAAc,CAAC,MAA8B;QAM3C,OAAO,IAAI,CAAC,UAAU,CAAC,6BAA6B,EAAE,MAAM,CAAC,CAAC;IAChE,CAAC;IAED;;OAEG;IAEH,iBAAiB,CACf,MAAsB;QAEtB,OAAO,IAAI,CAAC,WAAW,CAAC,qBAAqB,EAAE,MAAM,CAAC,CAAC;IACzD,CAAC;IAED,gBAAgB,CAAC,MAAsB;QACrC,OAAO,IAAI,CAAC,WAAW,CAAC,oBAAoB,EAAE,MAAM,CAAC,CAAC;IACxD,CAAC;IAED,YAAY,CACV,MAA2B;QAE3B,OAAO,IAAI,CAAC,UAAU,CAAC,sBAAsB,EAAE,MAAM,CAAC,CAAC;IACzD,CAAC;IAED;;OAEG;IAEH,iBAAiB,CAAC,MAA0B;QAO1C,OAAO,IAAI,CAAC,UAAU,CAAC,mBAAmB,EAAE,MAAM,CAAC,CAAC;IACtD,CAAC;IAED;;;;OAIG;IAEH,UAAU;QACR,OAAO,IAAI,CAAC,GAAG,CAAC,yBAAyB,CAAC,CAAC;IAC7C,CAAC;IAED,SAAS,CAAC,MAET;QACC,OAAO,IAAI,CAAC,GAAG,CAAC,oBAAoB,MAAM,CAAC,MAAM,EAAE,CAAC,CAAC;IACvD,CAAC;IAED,SAAS,CAAC,MAET;QACC,OAAO,IAAI,CAAC,GAAG,CAAC,eAAe,EAAE,MAAM,CAAC,CAAC;IAC3C,CAAC;IAED,UAAU;QACR,OAAO,IAAI,CAAC,GAAG,CAAC,mBAAmB,CAAC,CAAC;IACvC,CAAC;IAED,sBAAsB,CAAC,MAEtB;QACC,OAAO,IAAI,CAAC,GAAG,CAAC,wBAAwB,EAAE,MAAM,CAAC,CAAC;IACpD,CAAC;IAED,6BAA6B,CAAC,MAE7B;QACC,OAAO,IAAI,CAAC,GAAG,CAAC,uBAAuB,EAAE,MAAM,CAAC,CAAC;IACnD,CAAC;IAED,8BAA8B,CAAC,MAE9B;QACC,OAAO,IAAI,CAAC,GAAG,CAAC,wBAAwB,EAAE,MAAM,CAAC,CAAC;IACpD,CAAC;IAED,eAAe,CAAC,MAEf;QACC,OAAO,IAAI,CAAC,GAAG,CAAC,sBAAsB,EAAE,MAAM,CAAC,CAAC;IAClD,CAAC;IAED,SAAS,CACP,MAAwB;QAExB,OAAO,IAAI,CAAC,GAAG,CAAC,oBAAoB,EAAE,MAAM,CAAC,CAAC;IAChD,CAAC;IAED,gBAAgB,CAAC,MAA+B;QAM9C,OAAO,IAAI,CAAC,GAAG,CAAC,uBAAuB,EAAE,MAAM,CAAC,CAAC;IACnD,CAAC;IAED,QAAQ,CAAC,MAA+B;QAMtC,OAAO,IAAI,CAAC,GAAG,CAAC,oBAAoB,EAAE,MAAM,CAAC,CAAC;IAChD,CAAC;IAED,YAAY,CAAC,MAEZ;QACC,OAAO,IAAI,CAAC,GAAG,CAAC,qBAAqB,MAAM,CAAC,MAAM,UAAU,CAAC,CAAC;IAChE,CAAC;IAED,eAAe,CAAC,MAA+B;QAM7C,OAAO,IAAI,CAAC,GAAG,CAAC,sBAAsB,EAAE,MAAM,CAAC,CAAC;IAClD,CAAC;IAED,0BAA0B;QAKxB,OAAO,IAAI,CAAC,GAAG,CAAC,yBAAyB,CAAC,CAAC;IAC7C,CAAC;IAED;;;;OAIG;IAEH,WAAW,CAAC,MAAa;QAMvB,OAAO,IAAI,CAAC,WAAW,CAAC,eAAe,EAAE,MAAM,CAAC,CAAC;IACnD,CAAC;IAED,kBAAkB;QAIhB,OAAO,IAAI,CAAC,WAAW,CAAC,oBAAoB,CAAC,CAAC;IAChD,CAAC;IAED,eAAe,CAAC,MAEf;QACC,OAAO,IAAI,CAAC,aAAa,CAAC,iBAAiB,MAAM,CAAC,OAAO,EAAE,CAAC,CAAC;IAC/D,CAAC;IAED,sBAAsB,CAAC,MAEtB;QACC,OAAO,IAAI,CAAC,aAAa,CAAC,8BAA8B,MAAM,CAAC,SAAS,EAAE,CAAC,CAAC;IAC9E,CAAC;IAED,iBAAiB,CAAC,MAAgC;QAKhD,OAAO,IAAI,CAAC,aAAa,CAAC,4BAA4B,EAAE,MAAM,CAAC,CAAC;IAClE,CAAC;IAED,eAAe,CAAC,MAAiB;QAM/B,OAAO,IAAI,CAAC,WAAW,CAAC,kBAAkB,EAAE,MAAM,CAAC,CAAC;IACtD,CAAC;IAED,oBAAoB,CAClB,MAAe;QAEf,OAAO,IAAI,CAAC,WAAW,CAAC,qBAAqB,EAAE,MAAM,CAAC,CAAC;IACzD,CAAC;IAED,eAAe,CAAC,MAEf;QACC,OAAO,IAAI,CAAC,aAAa,CAAC,eAAe,EAAE,MAAM,CAAC,CAAC;IACrD,CAAC;IAED,mBAAmB,CAAC,MAEnB;QACC,OAAO,IAAI,CAAC,aAAa,CAAC,mBAAmB,EAAE,MAAM,CAAC,CAAC;IACzD,CAAC;IAED,SAAS,CACP,MAAyB;QAEzB,OAAO,IAAI,CAAC,UAAU,CAAC,eAAe,EAAE,MAAM,CAAC,CAAC;IAClD,CAAC;IAED,aAAa,CACX,MAA6B;QAE7B,OAAO,IAAI,CAAC,UAAU,CAAC,mBAAmB,EAAE,MAAM,CAAC,CAAC;IACtD,CAAC;IAED,eAAe,CAAC,MAEf;QACC,OAAO,IAAI,CAAC,UAAU,CAAC,yBAAyB,EAAE,MAAM,CAAC,CAAC;IAC5D,CAAC;IAED,iBAAiB,CAAC,MAEjB;QACC,OAAO,IAAI,CAAC,UAAU,CAAC,iBAAiB,MAAM,CAAC,OAAO,EAAE,CAAC,CAAC;IAC5D,CAAC;IAED,uBAAuB,CAAC,MAEvB;QACC,OAAO,IAAI,CAAC,UAAU,CAAC,2BAA2B,EAAE,MAAM,CAAC,CAAC;IAC9D,CAAC;IAED;;;;OAIG;IAEH;;;;;OAKG;IACH,QAAQ,CACN,MAA4B;QAE5B,OAAO,IAAI,CAAC,UAAU,CAAC,cAAc,EAAE,MAAM,CAAC,CAAC;IACjD,CAAC;IAED;;;;OAIG;IACH,cAAc,CAAC,MAEd;QACC,OAAO,IAAI,CAAC,UAAU,CAAC,oBAAoB,EAAE,MAAM,CAAC,CAAC;IACvD,CAAC;IAED,sBAAsB,CAAC,MAEtB;QACC,OAAO,IAAI,CAAC,UAAU,CAAC,4BAA4B,EAAE,MAAM,CAAC,CAAC;IAC/D,CAAC;IAED;;;;OAIG;IAEH,cAAc,CACZ,MAA0B;QAE1B,OAAO,IAAI,CAAC,UAAU,CAAC,uBAAuB,EAAE,MAAM,CAAC,CAAC;IAC1D,CAAC;IAED,WAAW,CAAC,MAEX;QACC,OAAO,IAAI,CAAC,UAAU,CAAC,iBAAiB,EAAE,MAAM,CAAC,CAAC;IACpD,CAAC;IAED,YAAY,CAAC,MAEZ;QACC,OAAO,IAAI,CAAC,UAAU,CAAC,kBAAkB,EAAE,MAAM,CAAC,CAAC;IACrD,CAAC;IAED,mBAAmB,CAAC,MAMnB;QACC,OAAO,IAAI,CAAC,UAAU,CAAC,0BAA0B,EAAE,MAAM,CAAC,CAAC;IAC7D,CAAC;IAED,uBAAuB,CAAC,MAGvB;QACC,OAAO,IAAI,CAAC,WAAW,CACrB,4CAA4C,EAC5C,MAAM,CACP,CAAC;IACJ,CAAC;IAED,oBAAoB,CAAC,MAEpB;QACC,OAAO,IAAI,CAAC,UAAU,CAAC,iCAAiC,EAAE,MAAM,CAAC,CAAC;IACpE,CAAC;IAED,cAAc,CAAC,MAGd;QACC,OAAO,IAAI,CAAC,WAAW,CAAC,8BAA8B,EAAE,MAAM,CAAC,CAAC;IAClE,CAAC;IAED,aAAa,CAAC,MAIb;QACC,OAAO,IAAI,CAAC,WAAW,CAAC,uCAAuC,EAAE,MAAM,CAAC,CAAC;IAC3E,CAAC;IAED,aAAa,CAAC,MAA0B;QAMtC,OAAO,IAAI,CAAC,UAAU,CAAC,+BAA+B,EAAE,MAAM,CAAC,CAAC;IAClE,CAAC;IAED,gBAAgB,CAAC,MAGhB;QAMC,OAAO,IAAI,CAAC,WAAW,CAAC,kCAAkC,EAAE,MAAM,CAAC,CAAC;IACtE,CAAC;IAED,sBAAsB,CAAC,MAA0B;QAM/C,OAAO,IAAI,CAAC,UAAU,CAAC,6BAA6B,EAAE,MAAM,CAAC,CAAC;IAChE,CAAC;IAED,yBAAyB,CAAC,MAGzB;QAMC,OAAO,IAAI,CAAC,WAAW,CAAC,gCAAgC,EAAE,MAAM,CAAC,CAAC;IACpE,CAAC;IAED;;;;OAIG;IAEH,iBAAiB,CAAC,MAEjB;QACC,OAAO,IAAI,CAAC,UAAU,CAAC,+BAA+B,MAAM,CAAC,MAAM,EAAE,CAAC,CAAC;IACzE,CAAC;IAED,oBAAoB,CAAC,MAGpB;QACC,OAAO,IAAI,CAAC,WAAW,CAAC,yCAAyC,EAAE,MAAM,CAAC,CAAC;IAC7E,CAAC;IAED;;;;OAIG;IAEH,cAAc,CAAC,MAEd;QACC,OAAO,IAAI,CAAC,GAAG,CAAC,uBAAuB,MAAM,CAAC,MAAM,UAAU,CAAC,CAAC;IAClE,CAAC;IAED,eAAe,CACb,MAA8B;QAE9B,OAAO,IAAI,CAAC,GAAG,CAAC,+BAA+B,EAAE,MAAM,CAAC,CAAC;IAC3D,CAAC;IAED,iBAAiB,CAAC,MAAgC;QAMhD,OAAO,IAAI,CAAC,UAAU,CAAC,wBAAwB,EAAE,MAAM,CAAC,CAAC;IAC3D,CAAC;IAED;;;;OAIG;IACH,gCAAgC,CAAC,MAIhC;QACC,OAAO,IAAI,CAAC,UAAU,CAAC,mCAAmC,EAAE,MAAM,CAAC,CAAC;IACtE,CAAC;IAED;;;;OAIG;IAEH,0BAA0B;QACxB,OAAO,IAAI,CAAC,IAAI,CAAC,sBAAsB,CAAC,CAAC;IAC3C,CAAC;IAED,2BAA2B;QACzB,OAAO,IAAI,CAAC,WAAW,CAAC,uBAAuB,CAAC,CAAC;IACnD,CAAC;CACF;AA3hBD,sCA2hBC"}
|
|
@@ -114,6 +114,10 @@ export interface Order {
|
|
|
114
114
|
visibleSize?: number;
|
|
115
115
|
marginMode?: 'ISOLATED' | 'CROSS';
|
|
116
116
|
}
|
|
117
|
+
export interface SLTPOrder extends Order {
|
|
118
|
+
triggerStopDownPrice?: string;
|
|
119
|
+
triggerStopUpPrice?: string;
|
|
120
|
+
}
|
|
117
121
|
export interface GetOrdersRequest {
|
|
118
122
|
status?: 'active' | 'done';
|
|
119
123
|
symbol?: string;
|
|
@@ -76,7 +76,7 @@ export interface SubmitWithdrawV3Request {
|
|
|
76
76
|
*/
|
|
77
77
|
export interface GetTransferableRequest {
|
|
78
78
|
currency: string;
|
|
79
|
-
type: 'MAIN' | 'TRADE' | 'TRADE_HF' | 'MARGIN' | 'ISOLATED';
|
|
79
|
+
type: 'MAIN' | 'TRADE' | 'TRADE_HF' | 'MARGIN' | 'ISOLATED' | 'OPTION';
|
|
80
80
|
tag?: string;
|
|
81
81
|
}
|
|
82
82
|
export interface FlexTransferRequest {
|
|
@@ -84,11 +84,11 @@ export interface FlexTransferRequest {
|
|
|
84
84
|
currency?: string;
|
|
85
85
|
amount: string;
|
|
86
86
|
fromUserId?: string;
|
|
87
|
-
fromAccountType: 'MAIN' | 'TRADE' | 'CONTRACT' | 'MARGIN' | 'ISOLATED' | 'TRADE_HF' | 'MARGIN_V2' | 'ISOLATED_V2';
|
|
87
|
+
fromAccountType: 'MAIN' | 'TRADE' | 'CONTRACT' | 'MARGIN' | 'ISOLATED' | 'TRADE_HF' | 'MARGIN_V2' | 'ISOLATED_V2' | 'OPTION';
|
|
88
88
|
fromAccountTag?: string;
|
|
89
89
|
type: 'INTERNAL' | 'PARENT_TO_SUB' | 'SUB_TO_PARENT';
|
|
90
90
|
toUserId?: string;
|
|
91
|
-
toAccountType: 'MAIN' | 'TRADE' | 'CONTRACT' | 'MARGIN' | 'ISOLATED' | 'TRADE_HF' | 'MARGIN_V2' | 'ISOLATED_V2';
|
|
91
|
+
toAccountType: 'MAIN' | 'TRADE' | 'CONTRACT' | 'MARGIN' | 'ISOLATED' | 'TRADE_HF' | 'MARGIN_V2' | 'ISOLATED_V2' | 'OPTION';
|
|
92
92
|
toAccountTag?: string;
|
|
93
93
|
}
|
|
94
94
|
export interface submitTransferMasterSubRequest {
|
|
@@ -96,15 +96,15 @@ export interface submitTransferMasterSubRequest {
|
|
|
96
96
|
currency: string;
|
|
97
97
|
amount: string;
|
|
98
98
|
direction: 'OUT' | 'IN';
|
|
99
|
-
accountType?: 'MAIN' | 'TRADE' | 'TRADE_HF' | 'MARGIN' | 'CONTRACT';
|
|
100
|
-
subAccountType?: 'MAIN' | 'TRADE' | 'TRADE_HF' | 'MARGIN' | 'CONTRACT';
|
|
99
|
+
accountType?: 'MAIN' | 'TRADE' | 'TRADE_HF' | 'MARGIN' | 'CONTRACT' | 'OPTION';
|
|
100
|
+
subAccountType?: 'MAIN' | 'TRADE' | 'TRADE_HF' | 'MARGIN' | 'CONTRACT' | 'OPTION';
|
|
101
101
|
subUserId: string;
|
|
102
102
|
}
|
|
103
103
|
export interface InnerTransferRequest {
|
|
104
104
|
clientOid: string;
|
|
105
105
|
currency: string;
|
|
106
|
-
from: 'main' | 'trade' | 'trade_hf' | 'margin' | 'isolated' | 'margin_v2' | 'isolated_v2' | 'contract';
|
|
107
|
-
to: 'main' | 'trade' | 'trade_hf' | 'margin' | 'isolated' | 'margin_v2' | 'isolated_v2' | 'contract';
|
|
106
|
+
from: 'main' | 'trade' | 'trade_hf' | 'margin' | 'isolated' | 'margin_v2' | 'isolated_v2' | 'contract' | 'option';
|
|
107
|
+
to: 'main' | 'trade' | 'trade_hf' | 'margin' | 'isolated' | 'margin_v2' | 'isolated_v2' | 'contract' | 'option';
|
|
108
108
|
amount: string;
|
|
109
109
|
fromTag?: string;
|
|
110
110
|
toTag?: string;
|
|
@@ -46,6 +46,7 @@ export interface AccountBalance {
|
|
|
46
46
|
frozenFunds: number;
|
|
47
47
|
availableBalance: number;
|
|
48
48
|
currency: string;
|
|
49
|
+
riskRatio: number;
|
|
49
50
|
}
|
|
50
51
|
export interface AccountSummary {
|
|
51
52
|
accountEquityTotal: number;
|
|
@@ -162,6 +163,7 @@ export interface FuturesSymbolInfo {
|
|
|
162
163
|
highPrice: number;
|
|
163
164
|
priceChgPct: number;
|
|
164
165
|
priceChg: number;
|
|
166
|
+
supportCross: boolean;
|
|
165
167
|
}
|
|
166
168
|
export interface TickerDetail {
|
|
167
169
|
sequence: number;
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
import { AxiosRequestConfig } from 'axios';
|
|
2
2
|
import { BaseRestClient } from './lib/BaseRestClient.js';
|
|
3
3
|
import { RestClientOptions, RestClientType } from './lib/requestUtils.js';
|
|
4
|
-
import { AccountFillsRequest, BatchCancelOrdersRequest, CreateSubAPIRequest, DeleteSubAPIRequest, GetFundingHistoryRequest, GetFundingRatesRequest, GetInterestRatesRequest, GetKlinesRequest, GetOrdersRequest, GetStopOrdersRequest, GetSubAPIsRequest, GetTransactionsRequest, GetTransfersRequest, MaxOpenSizeRequest, Order, SubmitTransfer, UpdateSubAPIRequest } from './types/request/futures.types.js';
|
|
4
|
+
import { AccountFillsRequest, BatchCancelOrdersRequest, CreateSubAPIRequest, DeleteSubAPIRequest, GetFundingHistoryRequest, GetFundingRatesRequest, GetInterestRatesRequest, GetKlinesRequest, GetOrdersRequest, GetStopOrdersRequest, GetSubAPIsRequest, GetTransactionsRequest, GetTransfersRequest, MaxOpenSizeRequest, Order, SLTPOrder, SubmitTransfer, UpdateSubAPIRequest } from './types/request/futures.types.js';
|
|
5
5
|
import { AccountBalance, AccountSummary, AddMargin, BatchCancelOrderResult, CreateSubAccountAPI, FullOrderBookDetail, FuturesAccountFundingRateHistory, FuturesAccountTransaction, FuturesActiveOrder, FuturesClosedPositions, FuturesCurrentFundingRate, FuturesFill, FuturesFills, FuturesHistoricFundingRate, FuturesKline, FuturesMarkPrice, FuturesOrder, FuturesOrders, FuturesPosition, FuturesRiskLimit, FuturesSymbolInfo, FuturesTransferRecords, IndexListItem, InterestRateItem, MarketTradeDetail, MaxOpenSize, PremiumIndexItem, SubAccountAPI, SubBalance, SubmitMultipleOrdersFuturesResponse, TickerDetail, TransferDetail, UpdateSubAccountAPI } from './types/response/futures.types.js';
|
|
6
6
|
import { APISuccessResponse, ServiceStatus } from './types/response/shared.types.js';
|
|
7
7
|
import { WsConnectionInfo } from './types/response/ws.js';
|
|
@@ -135,7 +135,7 @@ export declare class FuturesClient extends BaseRestClient {
|
|
|
135
135
|
batchCancelOrders(params: BatchCancelOrdersRequest): Promise<APISuccessResponse<{
|
|
136
136
|
data: BatchCancelOrderResult[];
|
|
137
137
|
}>>;
|
|
138
|
-
submitSLTPOrder(params:
|
|
138
|
+
submitSLTPOrder(params: SLTPOrder): Promise<APISuccessResponse<{
|
|
139
139
|
orderId?: string;
|
|
140
140
|
clientOid?: string;
|
|
141
141
|
}>>;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"FuturesClient.js","sourceRoot":"","sources":["../../src/FuturesClient.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAC;AAEhC,OAAO,EAAE,cAAc,EAAE,MAAM,yBAAyB,CAAC;AACzD,OAAO,EACL,qBAAqB,GAGtB,MAAM,uBAAuB,CAAC;
|
|
1
|
+
{"version":3,"file":"FuturesClient.js","sourceRoot":"","sources":["../../src/FuturesClient.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAC;AAEhC,OAAO,EAAE,cAAc,EAAE,MAAM,yBAAyB,CAAC;AACzD,OAAO,EACL,qBAAqB,GAGtB,MAAM,uBAAuB,CAAC;AA8D/B;;GAEG;AACH,MAAM,OAAO,aAAc,SAAQ,cAAc;IAC/C,YACE,oBAAuC,EAAE,EACzC,iBAAqC,EAAE;QAEvC,KAAK,CAAC,iBAAiB,EAAE,cAAc,CAAC,CAAC;QACzC,OAAO,IAAI,CAAC;IACd,CAAC;IAED,aAAa;QACX,OAAO,qBAAqB,CAAC,OAAO,CAAC;IACvC,CAAC;IAED;;;;OAIG;IAEH,kBAAkB;QAChB,OAAO,MAAM,CAAC,EAAE,CAAC,CAAC;IACpB,CAAC;IAED,aAAa;QACX,OAAO,IAAI,CAAC,GAAG,CAAC,kBAAkB,CAAC,CAAC;IACtC,CAAC;IAED,gBAAgB;QACd,OAAO,IAAI,CAAC,GAAG,CAAC,eAAe,CAAC,CAAC;IACnC,CAAC;IAED;;;OAGG;IAEH,eAAe,CAAC,MAA8B;QAM5C,OAAO,IAAI,CAAC,UAAU,CAAC,4BAA4B,EAAE,MAAM,CAAC,CAAC;IAC/D,CAAC;IAED;;OAEG;IAEH,UAAU,CACR,MAAyB;QAEzB,OAAO,IAAI,CAAC,UAAU,CAAC,oBAAoB,EAAE,MAAM,CAAC,CAAC;IACvD,CAAC;IAED,YAAY,CACV,MAA2B;QAE3B,OAAO,IAAI,CAAC,WAAW,CAAC,oBAAoB,EAAE,MAAM,CAAC,CAAC;IACxD,CAAC;IAED,YAAY,CACV,MAA2B;QAE3B,OAAO,IAAI,CAAC,WAAW,CAAC,2BAA2B,EAAE,MAAM,CAAC,CAAC;IAC/D,CAAC;IAED,YAAY,CAAC,MAA2B;QAMtC,OAAO,IAAI,CAAC,aAAa,CAAC,oBAAoB,EAAE,MAAM,CAAC,CAAC;IAC1D,CAAC;IAED;;OAEG;IAEH,UAAU,CAAC,MAEV;QACC,OAAO,IAAI,CAAC,UAAU,CAAC,yBAAyB,EAAE,MAAM,CAAC,CAAC;IAC5D,CAAC;IAED,cAAc,CAAC,MAA8B;QAM3C,OAAO,IAAI,CAAC,UAAU,CAAC,6BAA6B,EAAE,MAAM,CAAC,CAAC;IAChE,CAAC;IAED;;OAEG;IAEH,iBAAiB,CACf,MAAsB;QAEtB,OAAO,IAAI,CAAC,WAAW,CAAC,qBAAqB,EAAE,MAAM,CAAC,CAAC;IACzD,CAAC;IAED,gBAAgB,CAAC,MAAsB;QACrC,OAAO,IAAI,CAAC,WAAW,CAAC,oBAAoB,EAAE,MAAM,CAAC,CAAC;IACxD,CAAC;IAED,YAAY,CACV,MAA2B;QAE3B,OAAO,IAAI,CAAC,UAAU,CAAC,sBAAsB,EAAE,MAAM,CAAC,CAAC;IACzD,CAAC;IAED;;OAEG;IAEH,iBAAiB,CAAC,MAA0B;QAO1C,OAAO,IAAI,CAAC,UAAU,CAAC,mBAAmB,EAAE,MAAM,CAAC,CAAC;IACtD,CAAC;IAED;;;;OAIG;IAEH,UAAU;QACR,OAAO,IAAI,CAAC,GAAG,CAAC,yBAAyB,CAAC,CAAC;IAC7C,CAAC;IAED,SAAS,CAAC,MAET;QACC,OAAO,IAAI,CAAC,GAAG,CAAC,oBAAoB,MAAM,CAAC,MAAM,EAAE,CAAC,CAAC;IACvD,CAAC;IAED,SAAS,CAAC,MAET;QACC,OAAO,IAAI,CAAC,GAAG,CAAC,eAAe,EAAE,MAAM,CAAC,CAAC;IAC3C,CAAC;IAED,UAAU;QACR,OAAO,IAAI,CAAC,GAAG,CAAC,mBAAmB,CAAC,CAAC;IACvC,CAAC;IAED,sBAAsB,CAAC,MAEtB;QACC,OAAO,IAAI,CAAC,GAAG,CAAC,wBAAwB,EAAE,MAAM,CAAC,CAAC;IACpD,CAAC;IAED,6BAA6B,CAAC,MAE7B;QACC,OAAO,IAAI,CAAC,GAAG,CAAC,uBAAuB,EAAE,MAAM,CAAC,CAAC;IACnD,CAAC;IAED,8BAA8B,CAAC,MAE9B;QACC,OAAO,IAAI,CAAC,GAAG,CAAC,wBAAwB,EAAE,MAAM,CAAC,CAAC;IACpD,CAAC;IAED,eAAe,CAAC,MAEf;QACC,OAAO,IAAI,CAAC,GAAG,CAAC,sBAAsB,EAAE,MAAM,CAAC,CAAC;IAClD,CAAC;IAED,SAAS,CACP,MAAwB;QAExB,OAAO,IAAI,CAAC,GAAG,CAAC,oBAAoB,EAAE,MAAM,CAAC,CAAC;IAChD,CAAC;IAED,gBAAgB,CAAC,MAA+B;QAM9C,OAAO,IAAI,CAAC,GAAG,CAAC,uBAAuB,EAAE,MAAM,CAAC,CAAC;IACnD,CAAC;IAED,QAAQ,CAAC,MAA+B;QAMtC,OAAO,IAAI,CAAC,GAAG,CAAC,oBAAoB,EAAE,MAAM,CAAC,CAAC;IAChD,CAAC;IAED,YAAY,CAAC,MAEZ;QACC,OAAO,IAAI,CAAC,GAAG,CAAC,qBAAqB,MAAM,CAAC,MAAM,UAAU,CAAC,CAAC;IAChE,CAAC;IAED,eAAe,CAAC,MAA+B;QAM7C,OAAO,IAAI,CAAC,GAAG,CAAC,sBAAsB,EAAE,MAAM,CAAC,CAAC;IAClD,CAAC;IAED,0BAA0B;QAKxB,OAAO,IAAI,CAAC,GAAG,CAAC,yBAAyB,CAAC,CAAC;IAC7C,CAAC;IAED;;;;OAIG;IAEH,WAAW,CAAC,MAAa;QAMvB,OAAO,IAAI,CAAC,WAAW,CAAC,eAAe,EAAE,MAAM,CAAC,CAAC;IACnD,CAAC;IAED,kBAAkB;QAIhB,OAAO,IAAI,CAAC,WAAW,CAAC,oBAAoB,CAAC,CAAC;IAChD,CAAC;IAED,eAAe,CAAC,MAEf;QACC,OAAO,IAAI,CAAC,aAAa,CAAC,iBAAiB,MAAM,CAAC,OAAO,EAAE,CAAC,CAAC;IAC/D,CAAC;IAED,sBAAsB,CAAC,MAEtB;QACC,OAAO,IAAI,CAAC,aAAa,CAAC,8BAA8B,MAAM,CAAC,SAAS,EAAE,CAAC,CAAC;IAC9E,CAAC;IAED,iBAAiB,CAAC,MAAgC;QAKhD,OAAO,IAAI,CAAC,aAAa,CAAC,4BAA4B,EAAE,MAAM,CAAC,CAAC;IAClE,CAAC;IAED,eAAe,CAAC,MAAiB;QAM/B,OAAO,IAAI,CAAC,WAAW,CAAC,kBAAkB,EAAE,MAAM,CAAC,CAAC;IACtD,CAAC;IAED,oBAAoB,CAClB,MAAe;QAEf,OAAO,IAAI,CAAC,WAAW,CAAC,qBAAqB,EAAE,MAAM,CAAC,CAAC;IACzD,CAAC;IAED,eAAe,CAAC,MAEf;QACC,OAAO,IAAI,CAAC,aAAa,CAAC,eAAe,EAAE,MAAM,CAAC,CAAC;IACrD,CAAC;IAED,mBAAmB,CAAC,MAEnB;QACC,OAAO,IAAI,CAAC,aAAa,CAAC,mBAAmB,EAAE,MAAM,CAAC,CAAC;IACzD,CAAC;IAED,SAAS,CACP,MAAyB;QAEzB,OAAO,IAAI,CAAC,UAAU,CAAC,eAAe,EAAE,MAAM,CAAC,CAAC;IAClD,CAAC;IAED,aAAa,CACX,MAA6B;QAE7B,OAAO,IAAI,CAAC,UAAU,CAAC,mBAAmB,EAAE,MAAM,CAAC,CAAC;IACtD,CAAC;IAED,eAAe,CAAC,MAEf;QACC,OAAO,IAAI,CAAC,UAAU,CAAC,yBAAyB,EAAE,MAAM,CAAC,CAAC;IAC5D,CAAC;IAED,iBAAiB,CAAC,MAEjB;QACC,OAAO,IAAI,CAAC,UAAU,CAAC,iBAAiB,MAAM,CAAC,OAAO,EAAE,CAAC,CAAC;IAC5D,CAAC;IAED,uBAAuB,CAAC,MAEvB;QACC,OAAO,IAAI,CAAC,UAAU,CAAC,2BAA2B,EAAE,MAAM,CAAC,CAAC;IAC9D,CAAC;IAED;;;;OAIG;IAEH;;;;;OAKG;IACH,QAAQ,CACN,MAA4B;QAE5B,OAAO,IAAI,CAAC,UAAU,CAAC,cAAc,EAAE,MAAM,CAAC,CAAC;IACjD,CAAC;IAED;;;;OAIG;IACH,cAAc,CAAC,MAEd;QACC,OAAO,IAAI,CAAC,UAAU,CAAC,oBAAoB,EAAE,MAAM,CAAC,CAAC;IACvD,CAAC;IAED,sBAAsB,CAAC,MAEtB;QACC,OAAO,IAAI,CAAC,UAAU,CAAC,4BAA4B,EAAE,MAAM,CAAC,CAAC;IAC/D,CAAC;IAED;;;;OAIG;IAEH,cAAc,CACZ,MAA0B;QAE1B,OAAO,IAAI,CAAC,UAAU,CAAC,uBAAuB,EAAE,MAAM,CAAC,CAAC;IAC1D,CAAC;IAED,WAAW,CAAC,MAEX;QACC,OAAO,IAAI,CAAC,UAAU,CAAC,iBAAiB,EAAE,MAAM,CAAC,CAAC;IACpD,CAAC;IAED,YAAY,CAAC,MAEZ;QACC,OAAO,IAAI,CAAC,UAAU,CAAC,kBAAkB,EAAE,MAAM,CAAC,CAAC;IACrD,CAAC;IAED,mBAAmB,CAAC,MAMnB;QACC,OAAO,IAAI,CAAC,UAAU,CAAC,0BAA0B,EAAE,MAAM,CAAC,CAAC;IAC7D,CAAC;IAED,uBAAuB,CAAC,MAGvB;QACC,OAAO,IAAI,CAAC,WAAW,CACrB,4CAA4C,EAC5C,MAAM,CACP,CAAC;IACJ,CAAC;IAED,oBAAoB,CAAC,MAEpB;QACC,OAAO,IAAI,CAAC,UAAU,CAAC,iCAAiC,EAAE,MAAM,CAAC,CAAC;IACpE,CAAC;IAED,cAAc,CAAC,MAGd;QACC,OAAO,IAAI,CAAC,WAAW,CAAC,8BAA8B,EAAE,MAAM,CAAC,CAAC;IAClE,CAAC;IAED,aAAa,CAAC,MAIb;QACC,OAAO,IAAI,CAAC,WAAW,CAAC,uCAAuC,EAAE,MAAM,CAAC,CAAC;IAC3E,CAAC;IAED,aAAa,CAAC,MAA0B;QAMtC,OAAO,IAAI,CAAC,UAAU,CAAC,+BAA+B,EAAE,MAAM,CAAC,CAAC;IAClE,CAAC;IAED,gBAAgB,CAAC,MAGhB;QAMC,OAAO,IAAI,CAAC,WAAW,CAAC,kCAAkC,EAAE,MAAM,CAAC,CAAC;IACtE,CAAC;IAED,sBAAsB,CAAC,MAA0B;QAM/C,OAAO,IAAI,CAAC,UAAU,CAAC,6BAA6B,EAAE,MAAM,CAAC,CAAC;IAChE,CAAC;IAED,yBAAyB,CAAC,MAGzB;QAMC,OAAO,IAAI,CAAC,WAAW,CAAC,gCAAgC,EAAE,MAAM,CAAC,CAAC;IACpE,CAAC;IAED;;;;OAIG;IAEH,iBAAiB,CAAC,MAEjB;QACC,OAAO,IAAI,CAAC,UAAU,CAAC,+BAA+B,MAAM,CAAC,MAAM,EAAE,CAAC,CAAC;IACzE,CAAC;IAED,oBAAoB,CAAC,MAGpB;QACC,OAAO,IAAI,CAAC,WAAW,CAAC,yCAAyC,EAAE,MAAM,CAAC,CAAC;IAC7E,CAAC;IAED;;;;OAIG;IAEH,cAAc,CAAC,MAEd;QACC,OAAO,IAAI,CAAC,GAAG,CAAC,uBAAuB,MAAM,CAAC,MAAM,UAAU,CAAC,CAAC;IAClE,CAAC;IAED,eAAe,CACb,MAA8B;QAE9B,OAAO,IAAI,CAAC,GAAG,CAAC,+BAA+B,EAAE,MAAM,CAAC,CAAC;IAC3D,CAAC;IAED,iBAAiB,CAAC,MAAgC;QAMhD,OAAO,IAAI,CAAC,UAAU,CAAC,wBAAwB,EAAE,MAAM,CAAC,CAAC;IAC3D,CAAC;IAED;;;;OAIG;IACH,gCAAgC,CAAC,MAIhC;QACC,OAAO,IAAI,CAAC,UAAU,CAAC,mCAAmC,EAAE,MAAM,CAAC,CAAC;IACtE,CAAC;IAED;;;;OAIG;IAEH,0BAA0B;QACxB,OAAO,IAAI,CAAC,IAAI,CAAC,sBAAsB,CAAC,CAAC;IAC3C,CAAC;IAED,2BAA2B;QACzB,OAAO,IAAI,CAAC,WAAW,CAAC,uBAAuB,CAAC,CAAC;IACnD,CAAC;CACF"}
|
|
@@ -114,6 +114,10 @@ export interface Order {
|
|
|
114
114
|
visibleSize?: number;
|
|
115
115
|
marginMode?: 'ISOLATED' | 'CROSS';
|
|
116
116
|
}
|
|
117
|
+
export interface SLTPOrder extends Order {
|
|
118
|
+
triggerStopDownPrice?: string;
|
|
119
|
+
triggerStopUpPrice?: string;
|
|
120
|
+
}
|
|
117
121
|
export interface GetOrdersRequest {
|
|
118
122
|
status?: 'active' | 'done';
|
|
119
123
|
symbol?: string;
|
|
@@ -76,7 +76,7 @@ export interface SubmitWithdrawV3Request {
|
|
|
76
76
|
*/
|
|
77
77
|
export interface GetTransferableRequest {
|
|
78
78
|
currency: string;
|
|
79
|
-
type: 'MAIN' | 'TRADE' | 'TRADE_HF' | 'MARGIN' | 'ISOLATED';
|
|
79
|
+
type: 'MAIN' | 'TRADE' | 'TRADE_HF' | 'MARGIN' | 'ISOLATED' | 'OPTION';
|
|
80
80
|
tag?: string;
|
|
81
81
|
}
|
|
82
82
|
export interface FlexTransferRequest {
|
|
@@ -84,11 +84,11 @@ export interface FlexTransferRequest {
|
|
|
84
84
|
currency?: string;
|
|
85
85
|
amount: string;
|
|
86
86
|
fromUserId?: string;
|
|
87
|
-
fromAccountType: 'MAIN' | 'TRADE' | 'CONTRACT' | 'MARGIN' | 'ISOLATED' | 'TRADE_HF' | 'MARGIN_V2' | 'ISOLATED_V2';
|
|
87
|
+
fromAccountType: 'MAIN' | 'TRADE' | 'CONTRACT' | 'MARGIN' | 'ISOLATED' | 'TRADE_HF' | 'MARGIN_V2' | 'ISOLATED_V2' | 'OPTION';
|
|
88
88
|
fromAccountTag?: string;
|
|
89
89
|
type: 'INTERNAL' | 'PARENT_TO_SUB' | 'SUB_TO_PARENT';
|
|
90
90
|
toUserId?: string;
|
|
91
|
-
toAccountType: 'MAIN' | 'TRADE' | 'CONTRACT' | 'MARGIN' | 'ISOLATED' | 'TRADE_HF' | 'MARGIN_V2' | 'ISOLATED_V2';
|
|
91
|
+
toAccountType: 'MAIN' | 'TRADE' | 'CONTRACT' | 'MARGIN' | 'ISOLATED' | 'TRADE_HF' | 'MARGIN_V2' | 'ISOLATED_V2' | 'OPTION';
|
|
92
92
|
toAccountTag?: string;
|
|
93
93
|
}
|
|
94
94
|
export interface submitTransferMasterSubRequest {
|
|
@@ -96,15 +96,15 @@ export interface submitTransferMasterSubRequest {
|
|
|
96
96
|
currency: string;
|
|
97
97
|
amount: string;
|
|
98
98
|
direction: 'OUT' | 'IN';
|
|
99
|
-
accountType?: 'MAIN' | 'TRADE' | 'TRADE_HF' | 'MARGIN' | 'CONTRACT';
|
|
100
|
-
subAccountType?: 'MAIN' | 'TRADE' | 'TRADE_HF' | 'MARGIN' | 'CONTRACT';
|
|
99
|
+
accountType?: 'MAIN' | 'TRADE' | 'TRADE_HF' | 'MARGIN' | 'CONTRACT' | 'OPTION';
|
|
100
|
+
subAccountType?: 'MAIN' | 'TRADE' | 'TRADE_HF' | 'MARGIN' | 'CONTRACT' | 'OPTION';
|
|
101
101
|
subUserId: string;
|
|
102
102
|
}
|
|
103
103
|
export interface InnerTransferRequest {
|
|
104
104
|
clientOid: string;
|
|
105
105
|
currency: string;
|
|
106
|
-
from: 'main' | 'trade' | 'trade_hf' | 'margin' | 'isolated' | 'margin_v2' | 'isolated_v2' | 'contract';
|
|
107
|
-
to: 'main' | 'trade' | 'trade_hf' | 'margin' | 'isolated' | 'margin_v2' | 'isolated_v2' | 'contract';
|
|
106
|
+
from: 'main' | 'trade' | 'trade_hf' | 'margin' | 'isolated' | 'margin_v2' | 'isolated_v2' | 'contract' | 'option';
|
|
107
|
+
to: 'main' | 'trade' | 'trade_hf' | 'margin' | 'isolated' | 'margin_v2' | 'isolated_v2' | 'contract' | 'option';
|
|
108
108
|
amount: string;
|
|
109
109
|
fromTag?: string;
|
|
110
110
|
toTag?: string;
|
|
@@ -46,6 +46,7 @@ export interface AccountBalance {
|
|
|
46
46
|
frozenFunds: number;
|
|
47
47
|
availableBalance: number;
|
|
48
48
|
currency: string;
|
|
49
|
+
riskRatio: number;
|
|
49
50
|
}
|
|
50
51
|
export interface AccountSummary {
|
|
51
52
|
accountEquityTotal: number;
|
|
@@ -162,6 +163,7 @@ export interface FuturesSymbolInfo {
|
|
|
162
163
|
highPrice: number;
|
|
163
164
|
priceChgPct: number;
|
|
164
165
|
priceChg: number;
|
|
166
|
+
supportCross: boolean;
|
|
165
167
|
}
|
|
166
168
|
export interface TickerDetail {
|
|
167
169
|
sequence: number;
|
package/package.json
CHANGED