okx-api 1.4.0 → 1.4.2

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.
@@ -8,183 +8,9 @@ export declare class RestClient extends BaseRestClient {
8
8
  */
9
9
  constructor(credentials?: APICredentials | null, environment?: APIMarket, restClientOptions?: RestClientOptions, requestOptions?: AxiosRequestConfig);
10
10
  getServerTime(): Promise<number>;
11
- submitOrder(params: OrderRequest): Promise<OrderResult[]>;
12
- submitMultipleOrders(params: OrderRequest[]): Promise<OrderResult[]>;
13
- cancelOrder(params: OrderIdRequest): Promise<CancelledOrderResult[]>;
14
- cancelMultipleOrders(params: OrderIdRequest[]): Promise<CancelledOrderResult[]>;
15
- amendOrder(params: AmendOrderRequest): Promise<AmendedOrder[]>;
16
- amendMultipleOrders(params: AmendOrderRequest[]): Promise<AmendedOrder[]>;
17
- closePositions(params: ClosePositionRequest): Promise<ClosedPositions[]>;
18
- getOrderDetails(params: OrderIdRequest): Promise<OrderDetails[]>;
19
- getOrderList(params?: OrderHistoryRequest): Promise<OrderListItem[]>;
20
- /**
21
- * Get history for last 7 days
22
- */
23
- getOrderHistory(params: OrderHistoryRequest): Promise<HistoricOrder[]>;
24
- /**
25
- * Get history for last 3 months
26
- */
27
- getOrderHistoryArchive(params: OrderHistoryRequest): Promise<HistoricOrder[]>;
28
- /**
29
- * Get history for last 7 days
30
- */
31
- getFills(params?: FillsHistoryRequest): Promise<OrderFill[]>;
32
- /**
33
- * Get history for last 3 months
34
- */
35
- getFillsHistory(params: FillsHistoryRequest): Promise<OrderFill[]>;
36
- applyTransactionDetailsArchive(params: {
37
- year: string;
38
- quarter: 'Q1' | 'Q2' | 'Q3' | 'Q4';
39
- }): Promise<{
40
- result: string;
41
- ts: string;
42
- }[]>;
43
- getTransactionDetailsArchiveLink(params: {
44
- year: string;
45
- quarter: 'Q1' | 'Q2' | 'Q3' | 'Q4';
46
- }): Promise<any[]>;
47
- cancelMassOrder(params: {
48
- instType: string;
49
- instFamily: string;
50
- }): Promise<{
51
- result: boolean;
52
- }[]>;
53
- cancelAllAfter(params: {
54
- timeOut: string;
55
- tag?: string;
56
- }): Promise<CancelAllAfterResponse[]>;
57
- getAccountRateLimit(): Promise<any[]>;
58
- placeAlgoOrder(params: AlgoOrderRequest): Promise<AlgoOrderResult[]>;
59
- getAlgoOrderDetails(params: AlgoOrderDetailsRequest): Promise<AlgoOrderDetailsResult[]>;
60
- amendAlgoOrder(params: AmendAlgoOrderRequest): Promise<AmendAlgoOrderResult[]>;
61
- cancelAlgoOrder(params: CancelAlgoOrderRequest[]): Promise<AlgoOrderResult[]>;
62
- cancelAdvanceAlgoOrder(params: CancelAlgoOrderRequest[]): Promise<AlgoOrderResult[]>;
63
- getAlgoOrderList(params: AlgoRecentHistoryRequest): Promise<AlgoOrderListItem[]>;
64
- getAlgoOrderHistory(params: AlgoLongHistoryRequest): Promise<HistoricAlgoOrder[]>;
65
- /** Get easy convert currency list */
66
- getEasyConvertCurrencies(): Promise<any>;
67
- /**
68
- * Place easy convert : Convert small currencies to mainstream currencies.
69
- * Only applicable to the crypto balance less than $10.
70
- *
71
- * Maximum 5 currencies can be selected in one order.
72
- * If there are multiple currencies, separate them with commas in the "from" field.
73
- */
74
- submitEasyConvert(fromCcys: string[], toCcy: string): Promise<APIResponse<any>>;
75
- /** Get easy convert history : Get the history and status of easy convert trades. */
76
- getEasyConvertHistory(params?: Pagination): Promise<APIResponse<any>>;
77
- /**
78
- * Get one-click repay currency list : Get list of debt currency data and repay currencies.
79
- * Debt currencies include both cross and isolated debts.
80
- */
81
- getOneClickRepayCurrencyList(debtType?: 'cross' | 'isolated'): Promise<APIResponse<any>>;
82
- /**
83
- * Trade one-click repay to repay cross debts.
84
- * Isolated debts are not applicable.
85
- * The maximum repayment amount is based on the remaining available balance of funding and trading accounts.
86
- */
87
- submitOneClickRepay(debtCcys: string[], repayCcy: string): Promise<APIResponse<any>>;
88
- /** Get the history and status of one-click repay trades. */
89
- getOneClickRepayHistory(params?: Pagination): Promise<APIResponse<any>>;
90
- /**
91
- *
92
- * Block trading endpoints (private)
93
- *
94
- */
95
- getBlockCounterParties(): Promise<BlockCounterParty[]>;
96
- createBlockRFQ(params: CreateBlockRFQRequest): Promise<CreateRFQResult[]>;
97
- cancelBlockRFQ(params: CancelBlockRFQRequest): Promise<CancelBlockRFQResult[]>;
98
- cancelMultipleBlockRFQs(params: CancelMultipleBlockRFQRequest): Promise<CancelBlockRFQResult[]>;
99
- cancelAllRFQs(): Promise<TimestampObject[]>;
100
- executeBlockQuote(params: ExecuteBlockQuoteRequest): Promise<ExecuteBlockQuoteResult[]>;
101
- getQuoteProducts(): Promise<BlockMakerInstrumentSettings[]>;
102
- updateBlockQuoteProducts(params: SetQuoteProductsRequest): Promise<{
103
- result: boolean;
104
- }[]>;
105
- resetBlockMmp(): Promise<{
106
- ts: string;
107
- }[]>;
108
- updateBlockMmpConfig(params: SetMmpConfigRequest): Promise<SetMmpConfigResult[]>;
109
- getBlockMmpConfig(): Promise<BlockMMPConfig[]>;
110
- createBlockQuote(params: CreateBlockQuoteRequest): Promise<CreateBlockQuoteResult[]>;
111
- cancelBlockQuote(params: CancelBlockQuoteRequest): Promise<CancelBlockQuoteResult[]>;
112
- cancelMultipleBlockQuotes(params: CancelMultipleBlockQuoteRequest): Promise<CancelBlockQuoteResult[]>;
113
- cancelAllBlockQuotes(): Promise<TimestampObject[]>;
114
- cancelAllBlockAfter(params: {
115
- timeOut: string;
116
- }): Promise<{
117
- triggerTime: string;
118
- ts: string;
119
- }[]>;
120
- getBlockRFQs(params?: GetBlockRFQSParams): Promise<BlockRFQResult[]>;
121
- getBlockQuotes(params?: GetBlockQuoteParams): Promise<GetBlockQuoteResult[]>;
122
- getBlockTrades(params?: any): Promise<any[]>;
123
- getPublicRFQBlockTrades(params?: any): Promise<any[]>;
124
- getBlockPublicTrades(params: {
125
- instId: string;
126
- }): Promise<PublicBlockTrade[]>;
127
- /**
128
- *
129
- * Funding endpoints (private)
130
- *
131
- */
132
- getCurrencies(ccy?: string): Promise<FundingCurrency[]>;
133
- getBalances(ccy?: string): Promise<FundingBalance[]>;
134
- getNonTradableAssets(params?: {
135
- ccy?: string;
136
- }): Promise<NonTradableAsset[]>;
137
- getAccountAssetValuation(ccy?: string): Promise<AccountAssetValuation[]>;
138
- fundsTransfer(params: FundsTransferRequest): Promise<FundTransferResult[]>;
139
- /** Either parameter transId or clientId is required. */
140
- getFundsTransferState(params: {
141
- transId?: string;
142
- clientId?: string;
143
- type?: '0' | '1' | '2';
144
- }): Promise<FundTransferState[]>;
145
- getAssetBillsDetails(params?: {
146
- ccy?: string;
147
- type?: `${ASSET_BILL_TYPE}`;
148
- clientId?: string;
149
- after?: numberInString;
150
- before?: numberInString;
151
- limit?: numberInString;
152
- }): Promise<AssetBillDetails[]>;
153
- getLightningDeposits(ccy: string, amt: numberInString, to?: '6' | '18'): Promise<any[]>;
154
- getDepositAddress(ccy: string): Promise<any[]>;
155
- getDepositHistory(params?: any): Promise<any[]>;
156
- submitWithdraw(params: WithdrawRequest): Promise<WithdrawResponse[]>;
157
- submitWithdrawLightning(ccy: string, invoice: string, memo?: string): Promise<any[]>;
158
- cancelWithdrawal(wdId: string): Promise<any[]>;
159
- getWithdrawalHistory(params?: WithdrawalHistoryRequest): Promise<any[]>;
160
- getDepositWithdrawStatus(params: GetDepositWithdrawStatusRequest): Promise<any[]>;
161
- smallAssetsConvert(ccy: string[]): Promise<any[]>;
162
- getExchanges(): Promise<any[]>;
163
- applyForMonthlyStatement(params?: {
164
- month?: string;
165
- }): Promise<any[]>;
166
- getMonthlyStatement(params: {
167
- month: string;
168
- }): Promise<any[]>;
169
- getSavingBalance(ccy?: string): Promise<any[]>;
170
- savingsPurchaseRedemption(ccy: string, amt: numberInString, side: 'purchase' | 'redempt', rate: numberInString): Promise<any[]>;
171
- setLendingRate(ccy: string, rate: numberInString): Promise<any[]>;
172
- getLendingHistory(params?: PaginatedSymbolRequest): Promise<any[]>;
173
- getPublicBorrowInfo(ccy?: string): Promise<any[]>;
174
- getPublicBorrowHistory(params?: PaginatedSymbolRequest): Promise<any[]>;
175
- /**
176
- *
177
- * Convert endpoints (private)
178
- *
179
- */
180
- getConvertCurrencies(): Promise<any[]>;
181
- getConvertCurrencyPair(fromCcy: string, toCcy: string): Promise<any[]>;
182
- estimateConvertQuote(params: ConvertQuoteEstimateRequest): Promise<any[]>;
183
- convertTrade(params: ConvertTradeRequest): Promise<any[]>;
184
- getConvertHistory(params?: any): Promise<any[]>;
185
11
  /**
186
12
  *
187
- * Account endpoints (private)
13
+ * Trading account endpoints
188
14
  *
189
15
  */
190
16
  getAccountInstruments(params: GetInstrumentsRequest): Promise<AccountInstrument[]>;
@@ -198,12 +24,6 @@ export declare class RestClient extends BaseRestClient {
198
24
  getBillsArchive(params?: any): Promise<AccountBill[]>;
199
25
  getAccountConfiguration(): Promise<AccountConfiguration[]>;
200
26
  setPositionMode(posMode: PosMode): Promise<AccountPositionModeResult[]>;
201
- setAccountMode(params: {
202
- acctLv: AccountLevel;
203
- }): Promise<AccountModeResult[]>;
204
- setAutoLoan(params: {
205
- autoLoan: boolean;
206
- }): Promise<AutoLoanResult[]>;
207
27
  setLeverage(params: SetLeverageRequest): Promise<AccountLeverageResult[]>;
208
28
  /** Max buy/sell amount or open amount */
209
29
  getMaxBuySellAmount(params: {
@@ -301,6 +121,12 @@ export declare class RestClient extends BaseRestClient {
301
121
  activateOption(): Promise<{
302
122
  ts: string;
303
123
  }[]>;
124
+ setAutoLoan(params: {
125
+ autoLoan: boolean;
126
+ }): Promise<AutoLoanResult[]>;
127
+ setAccountMode(params: {
128
+ acctLv: AccountLevel;
129
+ }): Promise<AccountModeResult[]>;
304
130
  resetMMPStatus(params: {
305
131
  instType?: 'OPTION';
306
132
  instFamily: string;
@@ -313,49 +139,97 @@ export declare class RestClient extends BaseRestClient {
313
139
  }): Promise<MMPConfig[]>;
314
140
  /**
315
141
  *
316
- * SubAccount endpoints (private)
142
+ * Orderbook trading - trade endpoints
317
143
  *
318
144
  */
319
- /** View sub-account list */
320
- getSubAccountList(params?: any): Promise<SubAccount[]>;
321
- /** Reset the APIKey of a sub-account */
322
- resetSubAccountAPIKey(subAcct: string, apiKey: string, options?: {
323
- label?: string;
324
- perm?: string;
325
- ip?: string;
326
- }): Promise<SubAccountAPIReset[]>;
327
- /** Get sub-account trading balance */
328
- getSubAccountBalances(subAcct: string): Promise<SubAccountBalances[]>;
329
- /** Get sub-account funding balance */
330
- getSubAccountFundingBalances(subAcct: string, ccy?: string): Promise<FundingBalance[]>;
331
- getSubAccountMaxWithdrawal(params: GetSubAccountMaxWithdrawalsRequest): Promise<SubAccountMaxWithdrawal[]>;
332
- /** History of sub-account transfer */
333
- getSubAccountTransferHistory(params?: {
334
- ccy?: string;
335
- type?: '0' | '1';
336
- subAcct?: string;
337
- after?: string;
338
- before?: string;
339
- limit?: string;
340
- }): Promise<any[]>;
341
- getManagedSubAccountTransferHistory(params: GetManagedSubAccountTransferHistoryRequest): Promise<ManagedSubAccountTransfer[]>;
342
- /** Master accounts manage the transfers between sub-accounts */
343
- transferSubAccountBalance(params: SubAccountTransferRequest): Promise<SubAccountTransferResult[]>;
344
- /** Set Permission Of Transfer Out */
345
- setSubAccountTransferOutPermission(subAcct: string, canTransOut?: boolean): Promise<any[]>;
346
- /** Get custody trading sub-account list */
347
- getSubAccountCustodyTradingList(subAcct?: string): Promise<any[]>;
348
- setSubAccountLoanAllocation(params: SetSubAccountLoanAllocationRequest): Promise<{
349
- result: boolean;
145
+ submitOrder(params: OrderRequest): Promise<OrderResult[]>;
146
+ submitMultipleOrders(params: OrderRequest[]): Promise<OrderResult[]>;
147
+ cancelOrder(params: OrderIdRequest): Promise<CancelledOrderResult[]>;
148
+ cancelMultipleOrders(params: OrderIdRequest[]): Promise<CancelledOrderResult[]>;
149
+ amendOrder(params: AmendOrderRequest): Promise<AmendedOrder[]>;
150
+ amendMultipleOrders(params: AmendOrderRequest[]): Promise<AmendedOrder[]>;
151
+ closePositions(params: ClosePositionRequest): Promise<ClosedPositions[]>;
152
+ getOrderDetails(params: OrderIdRequest): Promise<OrderDetails[]>;
153
+ getOrderList(params?: OrderHistoryRequest): Promise<OrderListItem[]>;
154
+ /**
155
+ * Get history for last 7 days
156
+ */
157
+ getOrderHistory(params: OrderHistoryRequest): Promise<HistoricOrder[]>;
158
+ /**
159
+ * Get history for last 3 months
160
+ */
161
+ getOrderHistoryArchive(params: OrderHistoryRequest): Promise<HistoricOrder[]>;
162
+ /**
163
+ * Get history for last 7 days
164
+ */
165
+ getFills(params?: FillsHistoryRequest): Promise<OrderFill[]>;
166
+ /**
167
+ * Get history for last 3 months
168
+ */
169
+ getFillsHistory(params: FillsHistoryRequest): Promise<OrderFill[]>;
170
+ applyTransactionDetailsArchive(params: {
171
+ year: string;
172
+ quarter: 'Q1' | 'Q2' | 'Q3' | 'Q4';
173
+ }): Promise<{
174
+ result: string;
175
+ ts: string;
350
176
  }[]>;
351
- getSubAccountBorrowInterestAndLimit(params: {
352
- subAcct: string;
353
- ccy?: string;
177
+ getTransactionDetailsArchiveLink(params: {
178
+ year: string;
179
+ quarter: 'Q1' | 'Q2' | 'Q3' | 'Q4';
354
180
  }): Promise<any[]>;
181
+ /** Get easy convert currency list */
182
+ getEasyConvertCurrencies(): Promise<any>;
355
183
  /**
184
+ * Place easy convert : Convert small currencies to mainstream currencies.
185
+ * Only applicable to the crypto balance less than $10.
186
+ *
187
+ * Maximum 5 currencies can be selected in one order.
188
+ * If there are multiple currencies, separate them with commas in the "from" field.
189
+ */
190
+ submitEasyConvert(fromCcys: string[], toCcy: string): Promise<APIResponse<any>>;
191
+ /** Get easy convert history : Get the history and status of easy convert trades. */
192
+ getEasyConvertHistory(params?: Pagination): Promise<APIResponse<any>>;
193
+ /**
194
+ * Get one-click repay currency list : Get list of debt currency data and repay currencies.
195
+ * Debt currencies include both cross and isolated debts.
196
+ */
197
+ getOneClickRepayCurrencyList(debtType?: 'cross' | 'isolated'): Promise<APIResponse<any>>;
198
+ /**
199
+ * Trade one-click repay to repay cross debts.
200
+ * Isolated debts are not applicable.
201
+ * The maximum repayment amount is based on the remaining available balance of funding and trading accounts.
202
+ */
203
+ submitOneClickRepay(debtCcys: string[], repayCcy: string): Promise<APIResponse<any>>;
204
+ /** Get the history and status of one-click repay trades. */
205
+ getOneClickRepayHistory(params?: Pagination): Promise<APIResponse<any>>;
206
+ cancelMassOrder(params: {
207
+ instType: string;
208
+ instFamily: string;
209
+ }): Promise<{
210
+ result: boolean;
211
+ }[]>;
212
+ cancelAllAfter(params: {
213
+ timeOut: string;
214
+ tag?: string;
215
+ }): Promise<CancelAllAfterResponse[]>;
216
+ getAccountRateLimit(): Promise<any[]>;
217
+ /**
218
+ *
219
+ * Orderbook trading - Algo trading endpoints
220
+ *
221
+ */
222
+ placeAlgoOrder(params: AlgoOrderRequest): Promise<AlgoOrderResult[]>;
223
+ cancelAlgoOrder(params: CancelAlgoOrderRequest[]): Promise<AlgoOrderResult[]>;
224
+ amendAlgoOrder(params: AmendAlgoOrderRequest): Promise<AmendAlgoOrderResult[]>;
225
+ cancelAdvanceAlgoOrder(params: CancelAlgoOrderRequest[]): Promise<AlgoOrderResult[]>;
226
+ getAlgoOrderDetails(params: AlgoOrderDetailsRequest): Promise<AlgoOrderDetailsResult[]>;
227
+ getAlgoOrderList(params: AlgoRecentHistoryRequest): Promise<AlgoOrderListItem[]>;
228
+ getAlgoOrderHistory(params: AlgoLongHistoryRequest): Promise<HistoricAlgoOrder[]>;
229
+ /**
230
+ *
231
+ * Orderbook trading - Grid trading endpoints
356
232
  *
357
- * Grid trading endpoints (private)
358
- *
359
233
  */
360
234
  placeGridAlgoOrder(params: GridAlgoOrderRequest): Promise<any[]>;
361
235
  amendGridAlgoOrder(algoId: string, instId: string, triggerPx: {
@@ -406,15 +280,178 @@ export declare class RestClient extends BaseRestClient {
406
280
  }[]>;
407
281
  /**
408
282
  *
409
- * Market data endpoints (public)
283
+ * Orderbook trading - Signal bot trading endpoints
284
+ *
285
+ */
286
+ createSignal(params: CreateSignalRequest): Promise<CreateSignalResult[]>;
287
+ getSignals(params: GetSignalsRequest): Promise<GetSignalsResult[]>;
288
+ createSignalBot(params: CreateSignalBotRequest): Promise<CreateSignalBotResult[]>;
289
+ cancelSignalBots(params: {
290
+ algoId: string;
291
+ }): Promise<CancelSignalBotsResult[]>;
292
+ updateSignalMargin(params: AdjustMarginBalanceRequest): Promise<{
293
+ algoId: string;
294
+ }[]>;
295
+ updateSignalTPSL(params: AmendTPSLRequest): Promise<{
296
+ algoId: string;
297
+ }[]>;
298
+ setSignalInstruments(params: SetSignalInstrumentsRequest): Promise<{
299
+ algoId: string;
300
+ }[]>;
301
+ getSignalBotOrder(params: {
302
+ algoOrdType: string;
303
+ algoId: string;
304
+ }): Promise<any[]>;
305
+ getActiveSignalBot(params: GetSignalBotRequest): Promise<any[]>;
306
+ getSignalBotHistory(params: GetSignalBotRequest): Promise<any[]>;
307
+ getSignalBotPositions(params: {
308
+ algoOrdType: string;
309
+ algoId: string;
310
+ }): Promise<any[]>;
311
+ getSignalBotPositionHistory(params: GetSignalBotPositionHistoryRequest): Promise<any[]>;
312
+ closeSignalBotPosition(params: {
313
+ algoId: string;
314
+ instId: string;
315
+ }): Promise<{
316
+ algoId: string;
317
+ }[]>;
318
+ placeSignalBotSubOrder(params: PlaceSubOrderRequest): Promise<any[]>;
319
+ cancelSubOrder(params: CancelSubOrderRequest): Promise<any[]>;
320
+ getSignalBotSubOrders(params: GetSignalBotSubOrdersRequest): Promise<any[]>;
321
+ getSignalBotEventHistory(params: GetSignalBotEventHistoryRequest): Promise<any[]>;
322
+ /**
323
+ *
324
+ * Orderbook trading - Recurring buy endpoints
325
+ *
326
+ */
327
+ submitRecurringBuyOrder(params: PlaceRecurringBuyOrderRequest): Promise<RecurringBuyOrderResult[]>;
328
+ amendRecurringBuyOrder(params: AmendRecurringBuyOrderRequest): Promise<RecurringBuyOrderResult[]>;
329
+ stopRecurringBuyOrder(params: {
330
+ algoId: string;
331
+ }): Promise<RecurringBuyOrderResult[]>;
332
+ getRecurringBuyOrders(params: GetRecurringBuyOrderListRequest): Promise<RecurringBuyOrder[]>;
333
+ getRecurringBuyOrderHistory(params: GetRecurringBuyOrderListRequest): Promise<RecurringBuyOrder[]>;
334
+ getRecurringBuyOrderDetails(params: {
335
+ algoId: string;
336
+ }): Promise<RecurringBuyOrder[]>;
337
+ getRecurringBuySubOrders(params: GetRecurringBuyOrderListRequest): Promise<RecurringBuySubOrder[]>;
338
+ /**
339
+ *
340
+ * Orderbook trading - Copy trading endpoints
341
+ *
342
+ */
343
+ getCopytradingSubpositions(params?: GetCurrentSubpositionsRequest): Promise<CurrentSubposition[]>;
344
+ getCopytradingSubpositionsHistory(params?: GetSubpositionsHistoryRequest): Promise<SubpositionsHistory[]>;
345
+ submitCopytradingAlgoOrder(params: PlaceCTAlgoOrderRequest): Promise<PlaceCTAlgoOrderResult[]>;
346
+ closeCopytradingSubposition(params: CloseSubpositionRequest): Promise<{
347
+ subPosId: string;
348
+ tag: string;
349
+ }[]>;
350
+ getCopytradingInstruments(params?: {
351
+ instType?: 'SPOT' | 'SWAP';
352
+ }): Promise<{
353
+ instId: string;
354
+ enabled: boolean;
355
+ }[]>;
356
+ setCopytradingInstruments(params: {
357
+ instType?: 'SPOT' | 'SWAP';
358
+ instId: string;
359
+ }): Promise<{
360
+ instId: string;
361
+ enabled: boolean;
362
+ }[]>;
363
+ getCopytradingProfitDetails(params?: GetCTProfitDetailsRequest): Promise<GetCTProfitDetailsResult[]>;
364
+ getCopytradingTotalProfit(params?: {
365
+ instType?: 'SPOT' | 'SWAP';
366
+ }): Promise<GetCTTotalProfitResult[]>;
367
+ getCopytradingUnrealizedProfit(params?: {
368
+ instType?: 'SPOT' | 'SWAP';
369
+ }): Promise<GetCTUnrealizedProfitResult[]>;
370
+ getCopytradingTotalUnrealizedProfit(params?: {
371
+ instType?: 'SWAP';
372
+ }): Promise<{
373
+ instType?: 'SWAP';
374
+ instId: string;
375
+ }[]>;
376
+ applyCopytradingLeadTrading(params: {
377
+ profitSharingTs: string;
378
+ totalUnrealizedProfitSharingAmt: string;
379
+ }): Promise<{
380
+ result: boolean;
381
+ }[]>;
382
+ stopCopytradingLeadTrading(params: {
383
+ instType?: 'SWAP';
384
+ }): Promise<{
385
+ result: boolean;
386
+ }[]>;
387
+ updateCopytradingProfitSharing(params: {
388
+ instType?: 'SWAP';
389
+ profitSharingRatio: string;
390
+ }): Promise<{
391
+ result: boolean;
392
+ }[]>;
393
+ getCopytradingAccount(): Promise<GetAccountConfigurationResult[]>;
394
+ setCopytradingFirstCopy(params: CopySettingsRequest): Promise<{
395
+ result: boolean;
396
+ }[]>;
397
+ updateCopytradingCopySettings(params: CopySettingsRequest): Promise<{
398
+ result: boolean;
399
+ }[]>;
400
+ stopCopytradingCopy(params: {
401
+ instType?: 'SWAP';
402
+ uniqueCode: string;
403
+ subPosCloseType: 'market_close' | 'copy_close' | 'manual_close';
404
+ }): Promise<{
405
+ result: boolean;
406
+ }[]>;
407
+ getCopytradingCopySettings(params: {
408
+ instType?: 'SWAP';
409
+ uniqueCode: string;
410
+ }): Promise<GetCopySettingsResult[]>;
411
+ getCopytradingBatchLeverageInfo(params: GetCTBatchLeverageInfoRequest): Promise<GetCTBatchLeverageInfoResult[]>;
412
+ setCopytradingBatchLeverage(params: SetCTBatchLeverageRequest): Promise<SetCTBatchLeverageResult[]>;
413
+ getCopytradingMyLeadTraders(params?: {
414
+ instType?: 'SWAP';
415
+ }): Promise<GetCTMyLeadTradersResult[]>;
416
+ getCopytradingLeadTradersHistory(params?: GetCTHistoryLeadTradersRequest): Promise<GetCTHistoryLeadTradersResult[]>;
417
+ getCopytradingConfig(params?: {
418
+ instType?: 'SWAP';
419
+ }): Promise<GetCopyTradingConfigResult[]>;
420
+ getCopytradingLeadRanks(params?: GetLeadTraderRanksRequest): Promise<GetLeadTraderRanksResult[]>;
421
+ getCopytradingLeadWeeklyPnl(params: {
422
+ instType?: 'SWAP';
423
+ uniqueCode: string;
424
+ }): Promise<LeadTraderPnl[]>;
425
+ getCopytradingLeadDailyPnl(params: GetLeadTraderStatsRequest): Promise<LeadTraderPnl[]>;
426
+ getCopytradingLeadStats(params: GetLeadTraderStatsRequest): Promise<LeadTraderStats[]>;
427
+ getCopytradingLeadPreferences(params: {
428
+ instType?: 'SWAP';
429
+ uniqueCode: string;
430
+ }): Promise<LeadTraderPreference[]>;
431
+ getCopytradingLeadOpenPositions(params: GetLeadTraderPositionsRequest): Promise<LeadTraderCurrentPosition[]>;
432
+ getCopytradingLeadPositionHistory(params: GetLeadTraderPositionsRequest): Promise<LeadTraderPositionHistory[]>;
433
+ getCopyTraders(params: GetCopyTradersRequest): Promise<GetCopyTradersResult[]>;
434
+ getCopytradingLeadPrivateRanks(params?: GetPrivateLeadTraderRanksRequest): Promise<GetPrivateLeadTraderRanksResult[]>;
435
+ getCopytradingLeadPrivateWeeklyPnl(params: {
436
+ instType?: 'SWAP';
437
+ uniqueCode: string;
438
+ }): Promise<LeadTraderPnl[]>;
439
+ getCopytradingPLeadPrivateDailyPnl(params: GetLeadTraderStatsRequest): Promise<LeadTraderPnl[]>;
440
+ geCopytradingLeadPrivateStats(params: GetLeadTraderStatsRequest): Promise<LeadTraderStats[]>;
441
+ getCopytradingLeadPrivatePreferences(params: {
442
+ instType?: 'SWAP';
443
+ uniqueCode: string;
444
+ }): Promise<LeadTraderPreference[]>;
445
+ getCopytradingLeadPrivateOpenPositions(params: GetLeadTraderPositionsRequest): Promise<LeadTraderCurrentPosition[]>;
446
+ getCopytradingLeadPrivatePositionHistory(params: GetLeadTraderPositionsRequest): Promise<LeadTraderPositionHistory[]>;
447
+ getCopyTradersPrivate(params: GetCopyTradersRequest): Promise<GetCopyTradersResult[]>;
448
+ /**
449
+ *
450
+ * Orderbook trading - Market data endpoints
410
451
  *
411
452
  */
412
453
  getTickers(instrumentType: InstrumentType, uly?: string): Promise<Ticker[]>;
413
454
  getTicker(instId: string): Promise<Ticker[]>;
414
- getIndexTickers(params: {
415
- quoteCcy?: string;
416
- instId?: string;
417
- }): Promise<IndexTicker[]>;
418
455
  getOrderBook(instId: string, sz?: numberInString): Promise<OrderBook[]>;
419
456
  getFullOrderBook(params: {
420
457
  instId: string;
@@ -440,46 +477,6 @@ export declare class RestClient extends BaseRestClient {
440
477
  */
441
478
  getHistoricCandles(instId: string, bar?: string, pagination?: Pagination): Promise<Candle[]>;
442
479
  getHistoricCandlesV2(params: CandleRequest): Promise<Candle[]>;
443
- /**
444
- * @deprecated this method's parameters will change to an object in the next release. Use getIndexCandlesV2 instead.
445
- *
446
- * @param instId
447
- * @param bar
448
- * @param pagination
449
- * @returns
450
- */
451
- getIndexCandles(instId: string, bar?: string, pagination?: Pagination): Promise<CandleNoVolume[]>;
452
- getIndexCandlesV2(params: CandleRequest): Promise<CandleNoVolume[]>;
453
- /**
454
- * @deprecated this method's parameters will change to an object in the next release. Use getHistoricIndexCandlesV2 instead.
455
- *
456
- * @param instId
457
- * @param bar
458
- * @param pagination
459
- * @returns
460
- */
461
- getHistoricIndexCandles(instId: string, bar?: string, pagination?: Pagination): Promise<CandleNoVolume[]>;
462
- getHistoricIndexCandlesV2(params: CandleRequest): Promise<CandleNoVolume[]>;
463
- /**
464
- * @deprecated this method's parameters will change to an object in the next release. Use getMarkPriceCandlesV2 instead.
465
- *
466
- * @param instId
467
- * @param bar
468
- * @param pagination
469
- * @returns
470
- */
471
- getMarkPriceCandles(instId: string, bar?: string, pagination?: Pagination): Promise<CandleNoVolume[]>;
472
- getMarkPriceCandlesV2(params: CandleRequest): Promise<CandleNoVolume[]>;
473
- /**
474
- * @deprecated this method's parameters will change to an object in the next release. Use getHistoricMarkPriceCandlesV2 instead.
475
- *
476
- * @param instId
477
- * @param bar
478
- * @param pagination
479
- * @returns
480
- */
481
- getHistoricMarkPriceCandles(instId: string, bar?: string, pagination?: Pagination): Promise<CandleNoVolume[]>;
482
- getHistoricMarkPriceCandlesV2(params: CandleRequest): Promise<CandleNoVolume[]>;
483
480
  getTrades(instId: string, limit?: number): Promise<Trade[]>;
484
481
  getHistoricTrades(instId: string, pagination?: {
485
482
  after?: numberInString;
@@ -492,18 +489,91 @@ export declare class RestClient extends BaseRestClient {
492
489
  }): Promise<OptionTrade[]>;
493
490
  getOptionTrades(params: GetOptionTradesRequest): Promise<OptionTrades[]>;
494
491
  get24hrTotalVolume(): Promise<any[]>;
495
- getOracle(): Promise<any[]>;
496
- getExchangeRate(): Promise<any[]>;
497
- getIndexComponents(index: string): Promise<any[]>;
498
- getBlockTickers(instType: InstrumentType, uly?: string): Promise<any[]>;
492
+ /**
493
+ *
494
+ * Block trading - REST endpoints
495
+ *
496
+ */
497
+ getBlockCounterParties(): Promise<BlockCounterParty[]>;
498
+ createBlockRFQ(params: CreateBlockRFQRequest): Promise<CreateRFQResult[]>;
499
+ cancelBlockRFQ(params: CancelBlockRFQRequest): Promise<CancelBlockRFQResult[]>;
500
+ cancelMultipleBlockRFQs(params: CancelMultipleBlockRFQRequest): Promise<CancelBlockRFQResult[]>;
501
+ cancelAllRFQs(): Promise<TimestampObject[]>;
502
+ executeBlockQuote(params: ExecuteBlockQuoteRequest): Promise<ExecuteBlockQuoteResult[]>;
503
+ getQuoteProducts(): Promise<BlockMakerInstrumentSettings[]>;
504
+ updateBlockQuoteProducts(params: SetQuoteProductsRequest): Promise<{
505
+ result: boolean;
506
+ }[]>;
507
+ resetBlockMmp(): Promise<{
508
+ ts: string;
509
+ }[]>;
510
+ updateBlockMmpConfig(params: SetMmpConfigRequest): Promise<SetMmpConfigResult[]>;
511
+ getBlockMmpConfig(): Promise<BlockMMPConfig[]>;
512
+ createBlockQuote(params: CreateBlockQuoteRequest): Promise<CreateBlockQuoteResult[]>;
513
+ cancelBlockQuote(params: CancelBlockQuoteRequest): Promise<CancelBlockQuoteResult[]>;
514
+ cancelMultipleBlockQuotes(params: CancelMultipleBlockQuoteRequest): Promise<CancelBlockQuoteResult[]>;
515
+ cancelAllBlockQuotes(): Promise<TimestampObject[]>;
516
+ cancelAllBlockAfter(params: {
517
+ timeOut: string;
518
+ }): Promise<{
519
+ triggerTime: string;
520
+ ts: string;
521
+ }[]>;
522
+ getBlockRFQs(params?: GetBlockRFQSParams): Promise<BlockRFQResult[]>;
523
+ getBlockQuotes(params?: GetBlockQuoteParams): Promise<GetBlockQuoteResult[]>;
524
+ getBlockTrades(params?: any): Promise<any[]>;
525
+ getPublicRFQBlockTrades(params?: any): Promise<any[]>;
526
+ getBlockTickers(instType: InstrumentType, uly?: string): Promise<any[]>;
499
527
  getBlockTicker(instId: string): Promise<any[]>;
528
+ getBlockPublicTrades(params: {
529
+ instId: string;
530
+ }): Promise<PublicBlockTrade[]>;
500
531
  /**
501
- * @deprecated
532
+ *
533
+ * Spread trading - REST endpoints
534
+ *
502
535
  */
503
- getPublicBlockTrades(instId: string): Promise<any[]>;
536
+ submitSpreadOrder(params: PlaceSpreadOrderRequest): Promise<PlaceSpreadOrderResponse[]>;
537
+ cancelSpreadOrder(params?: {
538
+ ordId?: string;
539
+ clOrdId?: string;
540
+ }): Promise<CancelSpreadOrderResponse[]>;
541
+ cancelAllSpreadOrders(params: {
542
+ sprdId?: string;
543
+ }): Promise<{
544
+ result: boolean;
545
+ }[]>;
546
+ updateSpreadOrder(params: UpdateSpreadOrderRequest): Promise<UpdateSpreadOrderResponse[]>;
547
+ getSpreadOrder(params: {
548
+ ordId?: string;
549
+ clOrdId?: string;
550
+ }): Promise<SpreadOrder[]>;
551
+ getSpreadActiveOrders(params?: GetActiveSpreadOrdersRequest): Promise<SpreadOrder[]>;
552
+ getSpreadOrdersRecent(params?: GetSpreadOrderHistoryRequest): Promise<SpreadOrder[]>;
553
+ getSpreadOrdersArchive(params?: GetSpreadOrderHistoryArchiveRequest): Promise<SpreadOrder[]>;
554
+ getSpreadTrades(params?: GetSpreadTradesRequest): Promise<SpreadTrade[]>;
555
+ getSpreads(params?: GetSpreadsRequest): Promise<SpreadDetails[]>;
556
+ getSpreadOrderBook(params: {
557
+ sprdId: string;
558
+ sz?: string;
559
+ }): Promise<SpreadOrderBook[]>;
560
+ getSpreadTicker(params: {
561
+ sprdId: string;
562
+ }): Promise<SpreadTicker[]>;
563
+ getSpreadPublicTrades(params?: {
564
+ sprdId?: string;
565
+ }): Promise<PublicSpreadTrade[]>;
566
+ getSpreadCandles(params: GetSpreadCandlesRequest): Promise<SpreadCandle[]>;
567
+ getSpreadHistoryCandles(params: GetSpreadCandlesRequest): Promise<SpreadCandle[]>;
568
+ cancelSpreadAllAfter(params: {
569
+ timeOut: string;
570
+ }): Promise<{
571
+ triggerTime: string;
572
+ ts: string;
573
+ }[]>;
504
574
  /**
505
575
  *
506
- * Public data endpoints (public)
576
+ * Public data - rest endpoints
507
577
  *
508
578
  */
509
579
  getInstruments(instType: InstrumentType, uly?: string, instFamily?: string, instId?: string): Promise<Instrument[]>;
@@ -516,7 +586,6 @@ export declare class RestClient extends BaseRestClient {
516
586
  getEstimatedDeliveryExercisePrice(params: any): Promise<any[]>;
517
587
  getDiscountRateAndInterestFreeQuota(params: any): Promise<any[]>;
518
588
  getSystemTime(params: any): Promise<SystemTime[]>;
519
- getLiquidationOrders(params: any): Promise<any[]>;
520
589
  getMarkPrice(params: any): Promise<any[]>;
521
590
  getPositionTiers(params: any): Promise<any[]>;
522
591
  getInterestRateAndLoanQuota(params: any): Promise<any[]>;
@@ -529,10 +598,65 @@ export declare class RestClient extends BaseRestClient {
529
598
  instFamily?: string;
530
599
  }): Promise<any[]>;
531
600
  getPremiumHistory(params: GetPremiumHistoryRequest): Promise<any[]>;
601
+ getIndexTickers(params: {
602
+ quoteCcy?: string;
603
+ instId?: string;
604
+ }): Promise<IndexTicker[]>;
605
+ /**
606
+ * @deprecated this method's parameters will change to an object in the next release. Use getIndexCandlesV2 instead.
607
+ *
608
+ * @param instId
609
+ * @param bar
610
+ * @param pagination
611
+ * @returns
612
+ */
613
+ getIndexCandles(instId: string, bar?: string, pagination?: Pagination): Promise<CandleNoVolume[]>;
614
+ getIndexCandlesV2(params: CandleRequest): Promise<CandleNoVolume[]>;
615
+ /**
616
+ * @deprecated this method's parameters will change to an object in the next release. Use getHistoricIndexCandlesV2 instead.
617
+ *
618
+ * @param instId
619
+ * @param bar
620
+ * @param pagination
621
+ * @returns
622
+ */
623
+ getHistoricIndexCandles(instId: string, bar?: string, pagination?: Pagination): Promise<CandleNoVolume[]>;
624
+ getHistoricIndexCandlesV2(params: CandleRequest): Promise<CandleNoVolume[]>;
625
+ /**
626
+ * @deprecated this method's parameters will change to an object in the next release. Use getMarkPriceCandlesV2 instead.
627
+ *
628
+ * @param instId
629
+ * @param bar
630
+ * @param pagination
631
+ * @returns
632
+ */
633
+ getMarkPriceCandles(instId: string, bar?: string, pagination?: Pagination): Promise<CandleNoVolume[]>;
634
+ getMarkPriceCandlesV2(params: CandleRequest): Promise<CandleNoVolume[]>;
635
+ /**
636
+ * @deprecated this method's parameters will change to an object in the next release. Use getHistoricMarkPriceCandlesV2 instead.
637
+ *
638
+ * @param instId
639
+ * @param bar
640
+ * @param pagination
641
+ * @returns
642
+ */
643
+ getHistoricMarkPriceCandles(instId: string, bar?: string, pagination?: Pagination): Promise<CandleNoVolume[]>;
644
+ getHistoricMarkPriceCandlesV2(params: CandleRequest): Promise<CandleNoVolume[]>;
645
+ getOracle(): Promise<any[]>;
646
+ getExchangeRate(): Promise<any[]>;
647
+ getIndexComponents(index: string): Promise<any[]>;
532
648
  getEconomicCalendar(params: EconomicCalendarRequest): Promise<EconomicCalendarData[]>;
649
+ /**
650
+ * @deprecated
651
+ */
652
+ getPublicBlockTrades(instId: string): Promise<any[]>;
653
+ /**
654
+ * @deprecated
655
+ */
656
+ getLiquidationOrders(params: any): Promise<any[]>;
533
657
  /**
534
658
  *
535
- * Trading data endpoints (public)
659
+ * Trading statistics - REST endpoints
536
660
  *
537
661
  */
538
662
  getSupportCoin(): Promise<any[]>;
@@ -589,7 +713,95 @@ export declare class RestClient extends BaseRestClient {
589
713
  }): Promise<any[]>;
590
714
  /**
591
715
  *
592
- * FINANCIAL PRODUCT - On-chain earn endpoints
716
+ * Funding account - REST endpoints
717
+ *
718
+ */
719
+ getCurrencies(ccy?: string): Promise<FundingCurrency[]>;
720
+ getBalances(ccy?: string): Promise<FundingBalance[]>;
721
+ getNonTradableAssets(params?: {
722
+ ccy?: string;
723
+ }): Promise<NonTradableAsset[]>;
724
+ getAccountAssetValuation(ccy?: string): Promise<AccountAssetValuation[]>;
725
+ fundsTransfer(params: FundsTransferRequest): Promise<FundTransferResult[]>;
726
+ /** Either parameter transId or clientId is required. */
727
+ getFundsTransferState(params: {
728
+ transId?: string;
729
+ clientId?: string;
730
+ type?: '0' | '1' | '2';
731
+ }): Promise<FundTransferState[]>;
732
+ getAssetBillsDetails(params?: {
733
+ ccy?: string;
734
+ type?: `${ASSET_BILL_TYPE}`;
735
+ clientId?: string;
736
+ after?: numberInString;
737
+ before?: numberInString;
738
+ limit?: numberInString;
739
+ }): Promise<AssetBillDetails[]>;
740
+ getLightningDeposits(ccy: string, amt: numberInString, to?: '6' | '18'): Promise<any[]>;
741
+ getDepositAddress(ccy: string): Promise<any[]>;
742
+ getDepositHistory(params?: any): Promise<any[]>;
743
+ submitWithdraw(params: WithdrawRequest): Promise<WithdrawResponse[]>;
744
+ submitWithdrawLightning(ccy: string, invoice: string, memo?: string): Promise<any[]>;
745
+ cancelWithdrawal(wdId: string): Promise<any[]>;
746
+ getWithdrawalHistory(params?: WithdrawalHistoryRequest): Promise<any[]>;
747
+ getDepositWithdrawStatus(params: GetDepositWithdrawStatusRequest): Promise<any[]>;
748
+ smallAssetsConvert(ccy: string[]): Promise<any[]>;
749
+ getExchanges(): Promise<any[]>;
750
+ applyForMonthlyStatement(params?: {
751
+ month?: string;
752
+ }): Promise<any[]>;
753
+ getMonthlyStatement(params: {
754
+ month: string;
755
+ }): Promise<any[]>;
756
+ getConvertCurrencies(): Promise<any[]>;
757
+ getConvertCurrencyPair(fromCcy: string, toCcy: string): Promise<any[]>;
758
+ estimateConvertQuote(params: ConvertQuoteEstimateRequest): Promise<any[]>;
759
+ convertTrade(params: ConvertTradeRequest): Promise<any[]>;
760
+ getConvertHistory(params?: any): Promise<any[]>;
761
+ /**
762
+ *
763
+ * Subaccount - REST endpoints
764
+ *
765
+ */
766
+ /** View sub-account list */
767
+ getSubAccountList(params?: any): Promise<SubAccount[]>;
768
+ /** Reset the APIKey of a sub-account */
769
+ resetSubAccountAPIKey(subAcct: string, apiKey: string, options?: {
770
+ label?: string;
771
+ perm?: string;
772
+ ip?: string;
773
+ }): Promise<SubAccountAPIReset[]>;
774
+ /** Get sub-account trading balance */
775
+ getSubAccountBalances(subAcct: string): Promise<SubAccountBalances[]>;
776
+ /** Get sub-account funding balance */
777
+ getSubAccountFundingBalances(subAcct: string, ccy?: string): Promise<FundingBalance[]>;
778
+ getSubAccountMaxWithdrawal(params: GetSubAccountMaxWithdrawalsRequest): Promise<SubAccountMaxWithdrawal[]>;
779
+ /** History of sub-account transfer */
780
+ getSubAccountTransferHistory(params?: {
781
+ ccy?: string;
782
+ type?: '0' | '1';
783
+ subAcct?: string;
784
+ after?: string;
785
+ before?: string;
786
+ limit?: string;
787
+ }): Promise<any[]>;
788
+ getManagedSubAccountTransferHistory(params: GetManagedSubAccountTransferHistoryRequest): Promise<ManagedSubAccountTransfer[]>;
789
+ /** Master accounts manage the transfers between sub-accounts */
790
+ transferSubAccountBalance(params: SubAccountTransferRequest): Promise<SubAccountTransferResult[]>;
791
+ /** Set Permission Of Transfer Out */
792
+ setSubAccountTransferOutPermission(subAcct: string, canTransOut?: boolean): Promise<any[]>;
793
+ /** Get custody trading sub-account list */
794
+ getSubAccountCustodyTradingList(subAcct?: string): Promise<any[]>;
795
+ setSubAccountLoanAllocation(params: SetSubAccountLoanAllocationRequest): Promise<{
796
+ result: boolean;
797
+ }[]>;
798
+ getSubAccountBorrowInterestAndLimit(params: {
799
+ subAcct: string;
800
+ ccy?: string;
801
+ }): Promise<any[]>;
802
+ /**
803
+ *
804
+ * Financial product - on chain earn endpoints
593
805
  *
594
806
  */
595
807
  /** Get earn offers */
@@ -625,7 +837,7 @@ export declare class RestClient extends BaseRestClient {
625
837
  }): Promise<any[]>;
626
838
  /**
627
839
  *
628
- * FINANCIAL PRODUCT - ETH staking endpoints
840
+ * Financial product - ETH staking endpoints
629
841
  *
630
842
  */
631
843
  purchaseETHStaking(params: {
@@ -647,7 +859,18 @@ export declare class RestClient extends BaseRestClient {
647
859
  }): Promise<any[]>;
648
860
  /**
649
861
  *
650
- * Simple earn fixed endpoints
862
+ * Financial product - simple earn flexible endpoints
863
+ *
864
+ */
865
+ getSavingBalance(ccy?: string): Promise<any[]>;
866
+ savingsPurchaseRedemption(ccy: string, amt: numberInString, side: 'purchase' | 'redempt', rate: numberInString): Promise<any[]>;
867
+ setLendingRate(ccy: string, rate: numberInString): Promise<any[]>;
868
+ getLendingHistory(params?: PaginatedSymbolRequest): Promise<any[]>;
869
+ getPublicBorrowInfo(ccy?: string): Promise<any[]>;
870
+ getPublicBorrowHistory(params?: PaginatedSymbolRequest): Promise<any[]>;
871
+ /**
872
+ *
873
+ * Financial product - simple earn fixed endpoints
651
874
  *
652
875
  */
653
876
  getLendingOffers(params?: {
@@ -666,216 +889,6 @@ export declare class RestClient extends BaseRestClient {
666
889
  amendLendingOrder(params: LendingOrder): Promise<any[]>;
667
890
  getLendingOrders(params: GetLendingOrderListRequest): Promise<any[]>;
668
891
  getLendingSubOrders(params: GetLendingSubOrderListRequest): Promise<any[]>;
669
- /**
670
- *
671
- * Signal bot trading endpoints
672
- *
673
- */
674
- createSignal(params: CreateSignalRequest): Promise<CreateSignalResult[]>;
675
- getSignals(params: GetSignalsRequest): Promise<GetSignalsResult[]>;
676
- createSignalBot(params: CreateSignalBotRequest): Promise<CreateSignalBotResult[]>;
677
- cancelSignalBots(params: {
678
- algoId: string;
679
- }): Promise<CancelSignalBotsResult[]>;
680
- updateSignalMargin(params: AdjustMarginBalanceRequest): Promise<{
681
- algoId: string;
682
- }[]>;
683
- updateSignalTPSL(params: AmendTPSLRequest): Promise<{
684
- algoId: string;
685
- }[]>;
686
- setSignalInstruments(params: SetSignalInstrumentsRequest): Promise<{
687
- algoId: string;
688
- }[]>;
689
- getSignalBotOrder(params: {
690
- algoOrdType: string;
691
- algoId: string;
692
- }): Promise<any[]>;
693
- getActiveSignalBot(params: GetSignalBotRequest): Promise<any[]>;
694
- getSignalBotHistory(params: GetSignalBotRequest): Promise<any[]>;
695
- getSignalBotPositions(params: {
696
- algoOrdType: string;
697
- algoId: string;
698
- }): Promise<any[]>;
699
- getSignalBotPositionHistory(params: GetSignalBotPositionHistoryRequest): Promise<any[]>;
700
- closeSignalBotPosition(params: {
701
- algoId: string;
702
- instId: string;
703
- }): Promise<{
704
- algoId: string;
705
- }[]>;
706
- placeSignalBotSubOrder(params: PlaceSubOrderRequest): Promise<any[]>;
707
- cancelSubOrder(params: CancelSubOrderRequest): Promise<any[]>;
708
- getSignalBotSubOrders(params: GetSignalBotSubOrdersRequest): Promise<any[]>;
709
- getSignalBotEventHistory(params: GetSignalBotEventHistoryRequest): Promise<any[]>;
710
- /**
711
- *
712
- * Recurring buy endpoints
713
- *
714
- */
715
- submitRecurringBuyOrder(params: PlaceRecurringBuyOrderRequest): Promise<RecurringBuyOrderResult[]>;
716
- amendRecurringBuyOrder(params: AmendRecurringBuyOrderRequest): Promise<RecurringBuyOrderResult[]>;
717
- stopRecurringBuyOrder(params: {
718
- algoId: string;
719
- }): Promise<RecurringBuyOrderResult[]>;
720
- getRecurringBuyOrders(params: GetRecurringBuyOrderListRequest): Promise<RecurringBuyOrder[]>;
721
- getRecurringBuyOrderHistory(params: GetRecurringBuyOrderListRequest): Promise<RecurringBuyOrder[]>;
722
- getRecurringBuyOrderDetails(params: {
723
- algoId: string;
724
- }): Promise<RecurringBuyOrder[]>;
725
- getRecurringBuySubOrders(params: GetRecurringBuyOrderListRequest): Promise<RecurringBuySubOrder[]>;
726
- /**
727
- *
728
- * Copy Trading endpoints
729
- *
730
- */
731
- getCopytradingSubpositions(params?: GetCurrentSubpositionsRequest): Promise<CurrentSubposition[]>;
732
- getCopytradingSubpositionsHistory(params?: GetSubpositionsHistoryRequest): Promise<SubpositionsHistory[]>;
733
- submitCopytradingAlgoOrder(params: PlaceCTAlgoOrderRequest): Promise<PlaceCTAlgoOrderResult[]>;
734
- closeCopytradingSubposition(params: CloseSubpositionRequest): Promise<{
735
- subPosId: string;
736
- tag: string;
737
- }[]>;
738
- getCopytradingInstruments(params?: {
739
- instType?: 'SPOT' | 'SWAP';
740
- }): Promise<{
741
- instId: string;
742
- enabled: boolean;
743
- }[]>;
744
- setCopytradingInstruments(params: {
745
- instType?: 'SPOT' | 'SWAP';
746
- instId: string;
747
- }): Promise<{
748
- instId: string;
749
- enabled: boolean;
750
- }[]>;
751
- getCopytradingProfitDetails(params?: GetCTProfitDetailsRequest): Promise<GetCTProfitDetailsResult[]>;
752
- getCopytradingTotalProfit(params?: {
753
- instType?: 'SPOT' | 'SWAP';
754
- }): Promise<GetCTTotalProfitResult[]>;
755
- getCopytradingUnrealizedProfit(params?: {
756
- instType?: 'SPOT' | 'SWAP';
757
- }): Promise<GetCTUnrealizedProfitResult[]>;
758
- getCopytradingTotalUnrealizedProfit(params?: {
759
- instType?: 'SWAP';
760
- }): Promise<{
761
- instType?: 'SWAP';
762
- instId: string;
763
- }[]>;
764
- applyCopytradingLeadTrading(params: {
765
- profitSharingTs: string;
766
- totalUnrealizedProfitSharingAmt: string;
767
- }): Promise<{
768
- result: boolean;
769
- }[]>;
770
- stopCopytradingLeadTrading(params: {
771
- instType?: 'SWAP';
772
- }): Promise<{
773
- result: boolean;
774
- }[]>;
775
- updateCopytradingProfitSharing(params: {
776
- instType?: 'SWAP';
777
- profitSharingRatio: string;
778
- }): Promise<{
779
- result: boolean;
780
- }[]>;
781
- getCopytradingAccount(): Promise<GetAccountConfigurationResult[]>;
782
- setCopytradingFirstCopy(params: CopySettingsRequest): Promise<{
783
- result: boolean;
784
- }[]>;
785
- updateCopytradingCopySettings(params: CopySettingsRequest): Promise<{
786
- result: boolean;
787
- }[]>;
788
- stopCopytradingCopy(params: {
789
- instType?: 'SWAP';
790
- uniqueCode: string;
791
- subPosCloseType: 'market_close' | 'copy_close' | 'manual_close';
792
- }): Promise<{
793
- result: boolean;
794
- }[]>;
795
- getCopytradingCopySettings(params: {
796
- instType?: 'SWAP';
797
- uniqueCode: string;
798
- }): Promise<GetCopySettingsResult[]>;
799
- getCopytradingBatchLeverageInfo(params: GetCTBatchLeverageInfoRequest): Promise<GetCTBatchLeverageInfoResult[]>;
800
- setCopytradingBatchLeverage(params: SetCTBatchLeverageRequest): Promise<SetCTBatchLeverageResult[]>;
801
- getCopytradingMyLeadTraders(params?: {
802
- instType?: 'SWAP';
803
- }): Promise<GetCTMyLeadTradersResult[]>;
804
- getCopytradingLeadTradersHistory(params?: GetCTHistoryLeadTradersRequest): Promise<GetCTHistoryLeadTradersResult[]>;
805
- getCopytradingConfig(params?: {
806
- instType?: 'SWAP';
807
- }): Promise<GetCopyTradingConfigResult[]>;
808
- getCopytradingLeadRanks(params?: GetLeadTraderRanksRequest): Promise<GetLeadTraderRanksResult[]>;
809
- getCopytradingLeadWeeklyPnl(params: {
810
- instType?: 'SWAP';
811
- uniqueCode: string;
812
- }): Promise<LeadTraderPnl[]>;
813
- getCopytradingLeadDailyPnl(params: GetLeadTraderStatsRequest): Promise<LeadTraderPnl[]>;
814
- getCopytradingLeadStats(params: GetLeadTraderStatsRequest): Promise<LeadTraderStats[]>;
815
- getCopytradingLeadPreferences(params: {
816
- instType?: 'SWAP';
817
- uniqueCode: string;
818
- }): Promise<LeadTraderPreference[]>;
819
- getCopytradingLeadOpenPositions(params: GetLeadTraderPositionsRequest): Promise<LeadTraderCurrentPosition[]>;
820
- getCopytradingLeadPositionHistory(params: GetLeadTraderPositionsRequest): Promise<LeadTraderPositionHistory[]>;
821
- getCopyTraders(params: GetCopyTradersRequest): Promise<GetCopyTradersResult[]>;
822
- getCopytradingLeadPrivateRanks(params?: GetPrivateLeadTraderRanksRequest): Promise<GetPrivateLeadTraderRanksResult[]>;
823
- getCopytradingLeadPrivateWeeklyPnl(params: {
824
- instType?: 'SWAP';
825
- uniqueCode: string;
826
- }): Promise<LeadTraderPnl[]>;
827
- getCopytradingPLeadPrivateDailyPnl(params: GetLeadTraderStatsRequest): Promise<LeadTraderPnl[]>;
828
- geCopytradingLeadPrivateStats(params: GetLeadTraderStatsRequest): Promise<LeadTraderStats[]>;
829
- getCopytradingLeadPrivatePreferences(params: {
830
- instType?: 'SWAP';
831
- uniqueCode: string;
832
- }): Promise<LeadTraderPreference[]>;
833
- getCopytradingLeadPrivateOpenPositions(params: GetLeadTraderPositionsRequest): Promise<LeadTraderCurrentPosition[]>;
834
- getCopytradingLeadPrivatePositionHistory(params: GetLeadTraderPositionsRequest): Promise<LeadTraderPositionHistory[]>;
835
- getCopyTradersPrivate(params: GetCopyTradersRequest): Promise<GetCopyTradersResult[]>;
836
- /**
837
- *
838
- * Spread trading endpoints
839
- *
840
- */
841
- submitSpreadOrder(params: PlaceSpreadOrderRequest): Promise<PlaceSpreadOrderResponse[]>;
842
- cancelSpreadOrder(params?: {
843
- ordId?: string;
844
- clOrdId?: string;
845
- }): Promise<CancelSpreadOrderResponse[]>;
846
- cancelAllSpreadOrders(params: {
847
- sprdId?: string;
848
- }): Promise<{
849
- result: boolean;
850
- }[]>;
851
- updateSpreadOrder(params: UpdateSpreadOrderRequest): Promise<UpdateSpreadOrderResponse[]>;
852
- getSpreadOrder(params: {
853
- ordId?: string;
854
- clOrdId?: string;
855
- }): Promise<SpreadOrder[]>;
856
- getSpreadActiveOrders(params?: GetActiveSpreadOrdersRequest): Promise<SpreadOrder[]>;
857
- getSpreadOrdersRecent(params?: GetSpreadOrderHistoryRequest): Promise<SpreadOrder[]>;
858
- getSpreadOrdersArchive(params?: GetSpreadOrderHistoryArchiveRequest): Promise<SpreadOrder[]>;
859
- getSpreadTrades(params?: GetSpreadTradesRequest): Promise<SpreadTrade[]>;
860
- getSpreads(params?: GetSpreadsRequest): Promise<SpreadDetails[]>;
861
- getSpreadOrderBook(params: {
862
- sprdId: string;
863
- sz?: string;
864
- }): Promise<SpreadOrderBook[]>;
865
- getSpreadTicker(params: {
866
- sprdId: string;
867
- }): Promise<SpreadTicker[]>;
868
- getSpreadPublicTrades(params?: {
869
- sprdId?: string;
870
- }): Promise<PublicSpreadTrade[]>;
871
- getSpreadCandles(params: GetSpreadCandlesRequest): Promise<SpreadCandle[]>;
872
- getSpreadHistoryCandles(params: GetSpreadCandlesRequest): Promise<SpreadCandle[]>;
873
- cancelSpreadAllAfter(params: {
874
- timeOut: string;
875
- }): Promise<{
876
- triggerTime: string;
877
- ts: string;
878
- }[]>;
879
892
  /**
880
893
  *
881
894
  * Affiliate endpoints