gateio-api 1.4.2 → 1.5.0
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/README.md +3 -2
- package/dist/cjs/RestClient.d.ts +184 -117
- package/dist/cjs/RestClient.js +287 -105
- package/dist/cjs/RestClient.js.map +1 -1
- package/dist/cjs/index.d.ts +4 -0
- package/dist/cjs/index.js +4 -0
- package/dist/cjs/index.js.map +1 -1
- package/dist/cjs/types/request/earn.d.ts +10 -0
- package/dist/cjs/types/request/futures.d.ts +65 -0
- package/dist/cjs/types/request/p2pMerchant.d.ts +108 -0
- package/dist/cjs/types/request/p2pMerchant.js +4 -0
- package/dist/cjs/types/request/p2pMerchant.js.map +1 -0
- package/dist/cjs/types/request/tradfi.d.ts +56 -0
- package/dist/cjs/types/request/tradfi.js +4 -0
- package/dist/cjs/types/request/tradfi.js.map +1 -0
- package/dist/cjs/types/response/earn.d.ts +1 -0
- package/dist/cjs/types/response/futures.d.ts +80 -7
- package/dist/cjs/types/response/multicollateralLoan.d.ts +4 -0
- package/dist/cjs/types/response/p2pMerchant.d.ts +178 -0
- package/dist/cjs/types/response/p2pMerchant.js +4 -0
- package/dist/cjs/types/response/p2pMerchant.js.map +1 -0
- package/dist/cjs/types/response/spot.d.ts +1 -1
- package/dist/cjs/types/response/tradfi.d.ts +200 -0
- package/dist/cjs/types/response/tradfi.js +4 -0
- package/dist/cjs/types/response/tradfi.js.map +1 -0
- package/dist/mjs/RestClient.d.ts +184 -117
- package/dist/mjs/RestClient.js +287 -105
- package/dist/mjs/RestClient.js.map +1 -1
- package/dist/mjs/index.d.ts +4 -0
- package/dist/mjs/index.js +4 -0
- package/dist/mjs/index.js.map +1 -1
- package/dist/mjs/types/request/earn.d.ts +10 -0
- package/dist/mjs/types/request/futures.d.ts +65 -0
- package/dist/mjs/types/request/p2pMerchant.d.ts +108 -0
- package/dist/mjs/types/request/p2pMerchant.js +3 -0
- package/dist/mjs/types/request/p2pMerchant.js.map +1 -0
- package/dist/mjs/types/request/tradfi.d.ts +56 -0
- package/dist/mjs/types/request/tradfi.js +3 -0
- package/dist/mjs/types/request/tradfi.js.map +1 -0
- package/dist/mjs/types/response/earn.d.ts +1 -0
- package/dist/mjs/types/response/futures.d.ts +80 -7
- package/dist/mjs/types/response/multicollateralLoan.d.ts +4 -0
- package/dist/mjs/types/response/p2pMerchant.d.ts +178 -0
- package/dist/mjs/types/response/p2pMerchant.js +3 -0
- package/dist/mjs/types/response/p2pMerchant.js.map +1 -0
- package/dist/mjs/types/response/spot.d.ts +1 -1
- package/dist/mjs/types/response/tradfi.d.ts +200 -0
- package/dist/mjs/types/response/tradfi.js +3 -0
- package/dist/mjs/types/response/tradfi.js.map +1 -0
- package/llms.txt +13011 -11849
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -19,7 +19,7 @@
|
|
|
19
19
|
[1]: https://www.npmjs.com/package/gateio-api
|
|
20
20
|
|
|
21
21
|
> [!TIP]
|
|
22
|
-
> Upcoming change: As part of the [Siebly.io](https://siebly.io
|
|
22
|
+
> Upcoming change: As part of the [Siebly.io](https://siebly.io/) brand, this SDK will soon be hosted under the [Siebly.io GitHub organisation](https://github.com/sieblyio). The migration is seamless and requires no user changes.
|
|
23
23
|
|
|
24
24
|
Updated & performant JavaScript & Node.js SDK for the Gate.com (gate.io) REST APIs and WebSockets:
|
|
25
25
|
|
|
@@ -52,6 +52,7 @@ Updated & performant JavaScript & Node.js SDK for the Gate.com (gate.io) REST AP
|
|
|
52
52
|
- Heavy automated end-to-end testing with real API calls.
|
|
53
53
|
- Proxy support via axios integration.
|
|
54
54
|
- Active community support & collaboration in telegram: [Node.js Algo Traders](https://t.me/nodetraders).
|
|
55
|
+
- QuickStart Guide: https://siebly.io/sdk/gate/javascript
|
|
55
56
|
|
|
56
57
|
## Table of Contents
|
|
57
58
|
|
|
@@ -101,7 +102,7 @@ Refer to the [examples](./examples) folder for implementation demos, including:
|
|
|
101
102
|
|
|
102
103
|
Check out our JavaScript/TypeScript/Node.js SDKs & Projects:
|
|
103
104
|
|
|
104
|
-
- Visit our website: [https://Siebly.io](https://siebly.io
|
|
105
|
+
- Visit our website: [https://Siebly.io](https://siebly.io/)
|
|
105
106
|
- Try our REST API & WebSocket SDKs published on npmjs:
|
|
106
107
|
- [Bybit Node.js SDK: bybit-api](https://www.npmjs.com/package/bybit-api)
|
|
107
108
|
- [Kraken Node.js SDK: @siebly/kraken-api](https://www.npmjs.com/package/@siebly/kraken-api)
|
package/dist/cjs/RestClient.d.ts
CHANGED
|
@@ -3,41 +3,43 @@ import { BaseRestClient, RestClientType } from './lib/BaseRestClient.js';
|
|
|
3
3
|
import { RestClientOptions } from './lib/requestUtils.js';
|
|
4
4
|
import { CreateStpGroupReq } from './types/request/account.js';
|
|
5
5
|
import { CreateAlphaOrderReq, CreateAlphaQuoteReq, GetAlphaAccountBookReq, GetAlphaCurrenciesReq, GetAlphaOrderReq, GetAlphaOrdersReq, GetAlphaTickersReq } from './types/request/alpha.js';
|
|
6
|
-
import { GetLoanCollateralRecordsReq, GetLoanOrdersReq, GetLoanRepaymentHistoryReq, SubmitLoanOrderReq, UpdateLoanCollateralReq } from './types/request/collateralLoan.js';
|
|
7
6
|
import { CloseCrossExPositionReq, CreateCrossExConvertOrderReq, CreateCrossExConvertQuoteReq, CreateCrossExOrderReq, CreateCrossExTransferReq, GetCrossExAccountBookReq, GetCrossExAccountsReq, GetCrossExAdlRankReq, GetCrossExCoinDiscountRateReq, GetCrossExHistoryMarginInterestsReq, GetCrossExHistoryMarginPositionsReq, GetCrossExHistoryOrdersReq, GetCrossExHistoryPositionsReq, GetCrossExHistoryTradesReq, GetCrossExInterestRateReq, GetCrossExMarginPositionLeverageReq, GetCrossExMarginPositionsReq, GetCrossExOpenOrdersReq, GetCrossExPositionLeverageReq, GetCrossExPositionsReq, GetCrossExRiskLimitsReq, GetCrossExSymbolsReq, GetCrossExTransferCoinsReq, GetCrossExTransferHistoryReq, ModifyCrossExOrderReq, SetCrossExMarginPositionLeverageReq, SetCrossExPositionLeverageReq, UpdateCrossExAccountReq } from './types/request/crossex.js';
|
|
8
7
|
import { GetDeliveryAutoOrdersReq, GetDeliveryBookReq, GetDeliveryCandlesReq, GetDeliveryClosedPositionsReq, GetDeliveryLiquidationHistoryReq, GetDeliveryOrderBookReq, GetDeliveryOrdersReq, GetDeliverySettlementHistoryReq, GetDeliveryTradesReq, GetDeliveryTradingHistoryReq, SubmitDeliveryFuturesOrderReq } from './types/request/delivery.js';
|
|
9
|
-
import { GetStructuredProductListReq, GetStructuredProductOrdersReq } from './types/request/earn.js';
|
|
8
|
+
import { GetStructuredProductListReq, GetStructuredProductOrdersReq, PlaceDualInvestmentOrderParams } from './types/request/earn.js';
|
|
10
9
|
import { GetLendingInterestRecordsReq, GetLendingOrdersReq, GetLendingRecordsReq, SubmitLendOrRedeemReq } from './types/request/earnuni.js';
|
|
11
10
|
import { GetFlashSwapOrdersReq, SubmitFlashSwapOrderPreviewReq, SubmitFlashSwapOrderReq } from './types/request/flashswap.js';
|
|
12
|
-
import { BatchAmendOrderReq, DeleteAllFuturesOrdersReq, GetFundingRatesReq, GetFuturesAccountBookReq, GetFuturesAutoOrdersReq, GetFuturesCandlesReq, GetFuturesInsuranceReq, GetFuturesLiquidationHistoryReq, GetFuturesOrderBookReq, GetFuturesOrdersByTimeRangeReq, GetFuturesOrdersReq, GetFuturesPositionCloseHistoryReq, GetFuturesPositionHistoryReq, GetFuturesPositionsReq, GetFuturesStatsReq, GetFuturesTradesReq, GetFuturesTradingHistoryByTimeRangeReq, GetFuturesTradingHistoryReq, GetLiquidationHistoryReq, GetRiskLimitTableReq, GetRiskLimitTiersReq, SubmitFuturesOrderReq, SubmitFuturesTriggeredOrderReq, UpdateDualModePositionLeverageReq, UpdateDualModePositionMarginReq, UpdateFuturesOrderReq, UpdateFuturesPriceTriggeredOrderReq } from './types/request/futures.js';
|
|
11
|
+
import { BatchAmendOrderReq, BatchFundingRatesReq, BatchTerminateTrailOrdersReq, CreateTrailOrderReq, DeleteAllFuturesOrdersReq, GetFundingRatesReq, GetFuturesAccountBookReq, GetFuturesAutoOrdersReq, GetFuturesCandlesReq, GetFuturesInsuranceReq, GetFuturesLiquidationHistoryReq, GetFuturesOrderBookReq, GetFuturesOrdersByTimeRangeReq, GetFuturesOrdersReq, GetFuturesPositionCloseHistoryReq, GetFuturesPositionHistoryReq, GetFuturesPositionsReq, GetFuturesStatsReq, GetFuturesTradesReq, GetFuturesTradingHistoryByTimeRangeReq, GetFuturesTradingHistoryReq, GetLiquidationHistoryReq, GetRiskLimitTableReq, GetRiskLimitTiersReq, GetTrailOrderChangeLogReq, GetTrailOrderDetailReq, GetTrailOrderListReq, SubmitFuturesOrderReq, SubmitFuturesTriggeredOrderReq, TerminateTrailOrderReq, UpdateDualModePositionLeverageReq, UpdateDualModePositionMarginReq, UpdateFuturesOrderReq, UpdateFuturesPriceTriggeredOrderReq, UpdateTrailOrderReq } from './types/request/futures.js';
|
|
13
12
|
import { GetCrossMarginAccountHistoryReq, GetCrossMarginBorrowHistoryReq, GetCrossMarginInterestRecordsReq, GetCrossMarginRepaymentsReq, GetMarginBalanceHistoryReq, SubmitCrossMarginBorrowLoanReq } from './types/request/margin.js';
|
|
14
13
|
import { GetMarginUNIInterestRecordsReq, GetMarginUNILoanRecordsReq, GetMarginUNILoansReq, GetMarginUNIMaxBorrowReq } from './types/request/marginuni.js';
|
|
15
14
|
import { GetMultiLoanAdjustmentRecordsReq, GetMultiLoanOrdersReq, GetMultiLoanRepayRecordsReq, RepayMultiLoanReq, SubmitMultiLoanOrderReq, UpdateMultiLoanReq } from './types/request/multicollateralLoan.js';
|
|
16
15
|
import { GetOptionsAccountChangeReq, GetOptionsCandlesReq, GetOptionsMySettlementsReq, GetOptionsOrderBookReq, GetOptionsOrdersReq, GetOptionsPersonalHistoryReq, GetOptionsSettlementHistoryReq, GetOptionsTradesReq, GetOptionsUnderlyingCandlesReq, OptionsMMPSettingsReq, SubmitOptionsOrderReq } from './types/request/options.js';
|
|
17
16
|
import { CancelOTCOrderReq, CreateOTCFiatOrderReq, CreateOTCQuoteReq, CreateOTCStablecoinOrderReq, GetOTCFiatOrderDetailReq, GetOTCFiatOrderListReq, GetOTCStablecoinOrderListReq, MarkOTCOrderAsPaidReq } from './types/request/otc.js';
|
|
17
|
+
import { P2PMerchantAdsDetailReq, P2PMerchantAdsUpdateStatusReq, P2PMerchantCancelTransactionReq, P2PMerchantConfirmPaymentReq, P2PMerchantConfirmReceiptReq, P2PMerchantGetAdsListReq, P2PMerchantGetChatsListReq, P2PMerchantGetCompletedTransactionListReq, P2PMerchantGetCounterpartyUserInfoReq, P2PMerchantGetMyselfPaymentReq, P2PMerchantGetPendingTransactionListReq, P2PMerchantGetTransactionDetailsReq, P2PMerchantMyAdsListReq, P2PMerchantPlaceBizPushOrderReq, P2PMerchantSendChatMessageReq, P2PMerchantUploadChatFileReq } from './types/request/p2pMerchant.js';
|
|
18
18
|
import { GetAgencyCommissionHistoryReq, GetAgencyTransactionHistoryReq, GetBrokerCommissionHistoryReq, GetBrokerTransactionHistoryReq, GetPartnerSubordinateListReq, PartnerTransactionReq } from './types/request/rebate.js';
|
|
19
19
|
import { CancelSpotBatchOrdersReq, DeleteSpotOrderReq, GetSpotAccountBookReq, GetSpotAutoOrdersReq, GetSpotCandlesReq, GetSpotInsuranceHistoryReq, GetSpotOrderBookReq, GetSpotOrderReq, GetSpotOrdersReq, GetSpotTradesReq, GetSpotTradingHistoryReq, SubmitSpotClosePosCrossDisabledReq, SubmitSpotOrderReq, UpdateSpotBatchOrdersReq, UpdateSpotOrderReq } from './types/request/spot.js';
|
|
20
20
|
import { CreateSubAccountApiKeyReq, CreateSubAccountReq, UpdateSubAccountApiKeyReq } from './types/request/subaccount.js';
|
|
21
|
+
import { TradFiClosePositionReq, TradFiCreateOrderReq, TradFiCreateTransactionReq, TradFiGetKlinesParams, TradFiGetOrderHistoryParams, TradFiGetPositionHistoryParams, TradFiGetSymbolDetailParams, TradFiGetTransactionsParams, TradFiModifyOrderReq, TradFiModifyPositionReq } from './types/request/tradfi.js';
|
|
21
22
|
import { GetUnifiedHistoryLendingRateReq, GetUnifiedInterestRecordsReq, GetUnifiedLoanRecordsReq, GetUnifiedLoansReq, PortfolioMarginCalculatorReq, SetUnifiedAccountModeReq, SubmitUnifiedBorrowOrRepayReq, SubmitUnifiedLoanRepayReq } from './types/request/unified.js';
|
|
22
23
|
import { GetMainSubTransfersReq, GetSavedAddressReq, GetSmallBalanceHistoryReq, GetWithdrawalDepositRecordsReq, ListPushOrdersReq, SubmitMainSubTransferReq, SubmitSubToSubTransferReq, SubmitTransferReq } from './types/request/wallet.js';
|
|
23
24
|
import { SubmitWithdrawalReq } from './types/request/withdrawal.js';
|
|
24
25
|
import { AccountDetail, AccountMainKey, AccountRateLimit, StpGroup, StpGroupUser } from './types/response/account.js';
|
|
25
26
|
import { AlphaAccount, AlphaAccountBook, AlphaCurrency, AlphaOrder, AlphaTicker, CreateAlphaOrderResp, CreateAlphaQuoteResp } from './types/response/alpha.js';
|
|
26
|
-
import { LoanCollateralRatio, LoanCollateralRecord, LoanOrder, LoanRepaymentHistoryRecord } from './types/response/collateralloan.js';
|
|
27
27
|
import { CancelCrossExOrderResp, CloseCrossExPositionResp, CreateCrossExConvertQuoteResp, CreateCrossExOrderResp, CreateCrossExTransferResp, CrossExAccount, CrossExAccountBook, CrossExAdlRank, CrossExCoinDiscountRate, CrossExFeeRate, CrossExHistoryMarginInterest, CrossExHistoryMarginPosition, CrossExHistoryPosition, CrossExHistoryTrade, CrossExInterestRate, CrossExMarginPosition, CrossExMarginPositionLeverage, CrossExOrder, CrossExPosition, CrossExPositionLeverage, CrossExRiskLimit, CrossExSymbol, CrossExTransferCoin, CrossExTransferHistory, ModifyCrossExOrderResp, SetCrossExMarginPositionLeverageResp, SetCrossExPositionLeverageResp, UpdateCrossExAccountResp } from './types/response/crossex.js';
|
|
28
28
|
import { DeliveryAccount, DeliveryBook, DeliveryCandle, DeliveryClosedPosition, DeliveryLiquidationHistoryRecord, DeliveryOrderBook, DeliverySettlementHistoryRecord, DeliveryTicker, DeliveryTrade, DeliveryTradingHistoryRecord } from './types/response/delivery.js';
|
|
29
29
|
import { DualInvestmentOrder, DualInvestmentProduct, StructuredProduct, StructuredProductOrder } from './types/response/earn.js';
|
|
30
30
|
import { LendingCurrency, LendingInterestRecord, LendingOrder, LendingRecord } from './types/response/earnuni.js';
|
|
31
31
|
import { FlashSwapCurrencyPair, FlashSwapOrder, SubmitFlashSwapOrderPreviewResp } from './types/response/flashswap.js';
|
|
32
|
-
import { BatchAmendOrderResp, DeleteFuturesBatchOrdersResp, FuturesAccount, FuturesAccountBookRecord, FuturesAutoDeleveragingHistoryRecord, FuturesCandle, FuturesContract, FuturesDeliveryContract, FuturesInsuranceHistory, FuturesLiquidationHistoryRecord, FuturesOrder, FuturesOrderBook, FuturesPosition, FuturesPositionHistoryRecord, FuturesPriceTriggeredOrder, FuturesStats, FuturesTicker, FuturesTrade, FuturesTradingHistoryRecord, IndexConstituents, LiquidationHistoryRecord, PremiumIndexKLine, RiskLimitTableTier, RiskLimitTier } from './types/response/futures.js';
|
|
32
|
+
import { BatchAmendOrderResp, BatchFundingRatesResponse, DeleteFuturesBatchOrdersResp, FuturesAccount, FuturesAccountBookRecord, FuturesAutoDeleveragingHistoryRecord, FuturesCandle, FuturesContract, FuturesDeliveryContract, FuturesInsuranceHistory, FuturesLiquidationHistoryRecord, FuturesOrder, FuturesOrderBook, FuturesPosition, FuturesPositionHistoryRecord, FuturesPriceTriggeredOrder, FuturesStats, FuturesTicker, FuturesTrade, FuturesTradingHistoryRecord, IndexConstituents, LiquidationHistoryRecord, PremiumIndexKLine, RiskLimitTableTier, RiskLimitTier, TrailChangeLog, TrailOrder } from './types/response/futures.js';
|
|
33
33
|
import { CrossMarginAccount, CrossMarginAccountHistoryRecord, CrossMarginCurrency, CrossMarginMorrowLoanRecord, MarginAccount, MarginBalanceHistoryRecord, MarginUserAccount } from './types/response/margin.js';
|
|
34
34
|
import { LendingMarket, MarginUNIInterestRecord, MarginUNILoan, MarginUNILoanRecord, MarginUNIMaxBorrowable } from './types/response/marginuni.js';
|
|
35
35
|
import { MultiLoanAdjustmentRecord, MultiLoanCurrencyQuota, MultiLoanFixedRate, MultiLoanOrder, MultiLoanRatio, MultiLoanRepayRecord, MultiLoanSupportedCurrencies, RepayMultiLoanResp, UpdateMultiLoanResp } from './types/response/multicollateralLoan.js';
|
|
36
36
|
import { GetOptionsLiquidationResp, OptionsAccount, OptionsAccountChangeRecord, OptionsCandle, OptionsContract, OptionsMMPSettings, OptionsOrderBook, OptionsPositionsUnderlying, OptionsSettlementHistoryRecord, OptionsTicker, OptionsTrade, OptionsUnderlyingCandle, OptionsUserHistoryRecord, OptionsUserSettlement, SubmitOptionsOrderResp } from './types/response/options.js';
|
|
37
37
|
import { CancelOTCOrderResp, CreateOTCFiatOrderResp, CreateOTCQuoteResp, CreateOTCStablecoinOrderResp, GetOTCFiatOrderDetailResp, GetOTCFiatOrderListResp, GetOTCStablecoinOrderListResp, GetOTCUserDefaultBankResp, MarkOTCOrderAsPaidResp } from './types/response/otc.js';
|
|
38
|
+
import { P2PMerchantAdsDetail, P2PMerchantAdsListItem, P2PMerchantApiResp, P2PMerchantChatsListData, P2PMerchantCounterpartyUserInfo, P2PMerchantMyAdsListData, P2PMerchantPaymentMethod, P2PMerchantTransactionDetails, P2PMerchantTransactionListData, P2PMerchantUserInfo } from './types/response/p2pMerchant.js';
|
|
38
39
|
import { AgencyCommissionHistoryRecord, AgencyTransactionHistoryRecord, BrokerCommissionHistoryRecord, BrokerTransactionHistoryRecord, PartnerCommission, PartnerSubordinate, PartnerTransaction } from './types/response/rebate.js';
|
|
39
40
|
import { DeleteSpotBatchOrdersResp, GetSpotOpenOrdersResp, SpotAccount, SpotAccountBook, SpotCandle, SpotCurrency, SpotFeeRates, SpotHistoricTradeRecord, SpotInsuranceHistory, SpotOrder, SpotOrderBook, SpotPriceTriggeredOrder, SpotTicker, SpotTrade, SubmitSpotBatchOrdersResp } from './types/response/spot.js';
|
|
40
41
|
import { CreatedSubAccountAPIKey, SubAccount, SubAccountAPIKey, SubAccountMode } from './types/response/subaccount.js';
|
|
42
|
+
import { TradFiApiResp, TradFiAssets, TradFiCategoryItem, TradFiCreateOrderResult, TradFiCreateUserResult, TradFiKlineItem, TradFiListData, TradFiModifyOrderResult, TradFiMT5Account, TradFiOrderHistoryItem, TradFiOrderItem, TradFiPositionHistoryItem, TradFiPositionItem, TradFiSymbolDetailItem, TradFiSymbolItem, TradFiTicker, TradFiTransactionListData } from './types/response/tradfi.js';
|
|
41
43
|
import { MarginTier, PortfolioMarginCalculation, UnifiedAccountInfo, UnifiedCurrencyDiscountTiers, UnifiedHistoryLendingRate, UnifiedInterestRecord, UnifiedLoan, UnifiedLoanCurrency, UnifiedLoanRecord, UnifiedRiskUnitDetails, UserCurrencyLeverageConfig } from './types/response/unified.js';
|
|
42
44
|
import { CreateDepositAddressResp, CurrencyChain, DepositRecord, GetBalancesResp, PushOrder, SavedAddress, SmallBalanceHistoryRecord, SmallBalanceRecord, SubAccountCrossMarginBalancesResp, SubAccountFuturesBalancesResp, SubAccountMarginBalance, SubAccountTransferRecord, TradingFees, WithdrawalStatus } from './types/response/wallet.js';
|
|
43
45
|
import { WithdrawalRecord } from './types/response/withdrawal.js';
|
|
@@ -1494,6 +1496,13 @@ export declare class RestClient extends BaseRestClient {
|
|
|
1494
1496
|
t: number;
|
|
1495
1497
|
r: string;
|
|
1496
1498
|
}[]>;
|
|
1499
|
+
/**
|
|
1500
|
+
* Batch query historical funding rate data for perpetual contracts
|
|
1501
|
+
*
|
|
1502
|
+
* @param params settle and array of contract names
|
|
1503
|
+
* @returns Promise<BatchFundingRatesResponse[]>
|
|
1504
|
+
*/
|
|
1505
|
+
getBatchFundingRates(params: BatchFundingRatesReq): Promise<BatchFundingRatesResponse[]>;
|
|
1497
1506
|
/**
|
|
1498
1507
|
* Futures insurance balance history
|
|
1499
1508
|
*
|
|
@@ -1959,6 +1968,76 @@ export declare class RestClient extends BaseRestClient {
|
|
|
1959
1968
|
updateFuturesPriceTriggeredOrder(params: UpdateFuturesPriceTriggeredOrderReq): Promise<{
|
|
1960
1969
|
id: number;
|
|
1961
1970
|
}>;
|
|
1971
|
+
/**
|
|
1972
|
+
* Create trail order
|
|
1973
|
+
*
|
|
1974
|
+
* @param params settle and trail order parameters
|
|
1975
|
+
* @returns Promise with code, message, data containing id and timestamp
|
|
1976
|
+
*/
|
|
1977
|
+
createTrailOrder(params: CreateTrailOrderReq): Promise<{
|
|
1978
|
+
code?: number;
|
|
1979
|
+
message?: string;
|
|
1980
|
+
data?: {
|
|
1981
|
+
id?: string;
|
|
1982
|
+
timestamp?: number;
|
|
1983
|
+
};
|
|
1984
|
+
timestamp?: number;
|
|
1985
|
+
}>;
|
|
1986
|
+
/**
|
|
1987
|
+
* Terminate trail order
|
|
1988
|
+
*
|
|
1989
|
+
* @param params settle and id or text
|
|
1990
|
+
* @returns Promise<TrailOrder>
|
|
1991
|
+
*/
|
|
1992
|
+
terminateTrailOrder(params: TerminateTrailOrderReq): Promise<TrailOrder>;
|
|
1993
|
+
/**
|
|
1994
|
+
* Batch terminate trail orders
|
|
1995
|
+
*
|
|
1996
|
+
* @param params settle and optional contract, related_position
|
|
1997
|
+
* @returns Promise<{ orders: TrailOrder[] }>
|
|
1998
|
+
*/
|
|
1999
|
+
batchTerminateTrailOrders(params: BatchTerminateTrailOrdersReq): Promise<{
|
|
2000
|
+
orders?: TrailOrder[];
|
|
2001
|
+
}>;
|
|
2002
|
+
/**
|
|
2003
|
+
* Get trail order list
|
|
2004
|
+
*
|
|
2005
|
+
* @param params query parameters
|
|
2006
|
+
* @returns Promise<{ orders: TrailOrder[] }>
|
|
2007
|
+
*/
|
|
2008
|
+
getTrailOrderList(params: GetTrailOrderListReq): Promise<{
|
|
2009
|
+
orders?: TrailOrder[];
|
|
2010
|
+
}>;
|
|
2011
|
+
/**
|
|
2012
|
+
* Get trail order details
|
|
2013
|
+
*
|
|
2014
|
+
* @param params settle and order id
|
|
2015
|
+
* @returns Promise with code, message, data.order
|
|
2016
|
+
*/
|
|
2017
|
+
getTrailOrderDetail(params: GetTrailOrderDetailReq): Promise<{
|
|
2018
|
+
code?: number;
|
|
2019
|
+
message?: string;
|
|
2020
|
+
data?: {
|
|
2021
|
+
order?: TrailOrder;
|
|
2022
|
+
};
|
|
2023
|
+
timestamp?: number;
|
|
2024
|
+
}>;
|
|
2025
|
+
/**
|
|
2026
|
+
* Update trail order
|
|
2027
|
+
*
|
|
2028
|
+
* @param params settle, id and fields to update
|
|
2029
|
+
* @returns Promise<TrailOrder>
|
|
2030
|
+
*/
|
|
2031
|
+
updateTrailOrder(params: UpdateTrailOrderReq): Promise<TrailOrder>;
|
|
2032
|
+
/**
|
|
2033
|
+
* Get trail order user modification records
|
|
2034
|
+
*
|
|
2035
|
+
* @param params settle, id and optional pagination
|
|
2036
|
+
* @returns Promise<{ change_log: TrailChangeLog[] }>
|
|
2037
|
+
*/
|
|
2038
|
+
getTrailOrderChangeLog(params: GetTrailOrderChangeLogReq): Promise<{
|
|
2039
|
+
change_log?: TrailChangeLog[];
|
|
2040
|
+
}>;
|
|
1962
2041
|
getFuturesPositionCloseHistory(params: GetFuturesPositionCloseHistoryReq): Promise<FuturesPositionHistoryRecord[]>;
|
|
1963
2042
|
getFuturesInsuranceHistory(params: GetFuturesInsuranceReq): Promise<FuturesInsuranceHistory[]>;
|
|
1964
2043
|
/**==========================================================================================================================
|
|
@@ -2611,110 +2690,6 @@ export declare class RestClient extends BaseRestClient {
|
|
|
2611
2690
|
currency: string;
|
|
2612
2691
|
est_rate: string;
|
|
2613
2692
|
}[]>;
|
|
2614
|
-
/**==========================================================================================================================
|
|
2615
|
-
* COLLATERAL LOAN
|
|
2616
|
-
* ==========================================================================================================================
|
|
2617
|
-
*/
|
|
2618
|
-
/**
|
|
2619
|
-
* Place order
|
|
2620
|
-
*
|
|
2621
|
-
* @param params Parameters for placing an order
|
|
2622
|
-
* @returns Promise<{ order_id: number }>
|
|
2623
|
-
*/
|
|
2624
|
-
submitLoanOrder(params: SubmitLoanOrderReq): Promise<{
|
|
2625
|
-
order_id: number;
|
|
2626
|
-
}>;
|
|
2627
|
-
/**
|
|
2628
|
-
* List Orders
|
|
2629
|
-
*
|
|
2630
|
-
* @param params Parameters for listing orders
|
|
2631
|
-
* @returns Promise<GetLoanOrdersResp[]>
|
|
2632
|
-
*/
|
|
2633
|
-
getLoanOrders(params?: GetLoanOrdersReq): Promise<LoanOrder[]>;
|
|
2634
|
-
/**
|
|
2635
|
-
* Get a single order
|
|
2636
|
-
*
|
|
2637
|
-
* @param params Parameters for retrieving a single order
|
|
2638
|
-
* @returns Promise<GetLoanOrdersResp>
|
|
2639
|
-
*/
|
|
2640
|
-
getLoanOrder(params: {
|
|
2641
|
-
order_id: number;
|
|
2642
|
-
}): Promise<LoanOrder>;
|
|
2643
|
-
/**
|
|
2644
|
-
* Repayment
|
|
2645
|
-
*
|
|
2646
|
-
* @param params Parameters for repayment
|
|
2647
|
-
* @returns Promise<{
|
|
2648
|
-
* repaid_principal: string;
|
|
2649
|
-
* repaid_interest: string;
|
|
2650
|
-
* }>
|
|
2651
|
-
*/
|
|
2652
|
-
submitLoanRepay(params: {
|
|
2653
|
-
order_id: number;
|
|
2654
|
-
repay_amount: string;
|
|
2655
|
-
repaid_all: boolean;
|
|
2656
|
-
}): Promise<{
|
|
2657
|
-
repaid_principal: string;
|
|
2658
|
-
repaid_interest: string;
|
|
2659
|
-
}>;
|
|
2660
|
-
/**
|
|
2661
|
-
* Repayment history
|
|
2662
|
-
*
|
|
2663
|
-
* @param params Parameters for retrieving repayment history
|
|
2664
|
-
* @returns Promise<GetLoanRepaymentHistoryResp[]>
|
|
2665
|
-
*/
|
|
2666
|
-
getLoanRepaymentHistory(params: GetLoanRepaymentHistoryReq): Promise<LoanRepaymentHistoryRecord[]>;
|
|
2667
|
-
/**
|
|
2668
|
-
* Increase or redeem collateral
|
|
2669
|
-
*
|
|
2670
|
-
* @param params Parameters for increasing or redeeming collateral
|
|
2671
|
-
* @returns Promise<any>
|
|
2672
|
-
*/
|
|
2673
|
-
updateLoanCollateral(params: UpdateLoanCollateralReq): Promise<any>;
|
|
2674
|
-
/**
|
|
2675
|
-
* Query collateral adjustment records
|
|
2676
|
-
*
|
|
2677
|
-
* @param params Parameters for querying collateral adjustment records
|
|
2678
|
-
* @returns Promise<GetLoanCollateralRecordsResp[]>
|
|
2679
|
-
*/
|
|
2680
|
-
getLoanCollateralRecords(params?: GetLoanCollateralRecordsReq): Promise<LoanCollateralRecord[]>;
|
|
2681
|
-
/**
|
|
2682
|
-
* Query the total borrowing and collateral amount for the user
|
|
2683
|
-
*
|
|
2684
|
-
* @returns Promise<{
|
|
2685
|
-
* borrow_amount: string;
|
|
2686
|
-
* collateral_amount: string;
|
|
2687
|
-
* }>
|
|
2688
|
-
*/
|
|
2689
|
-
getLoanTotalAmount(): Promise<{
|
|
2690
|
-
borrow_amount: string;
|
|
2691
|
-
collateral_amount: string;
|
|
2692
|
-
}>;
|
|
2693
|
-
/**
|
|
2694
|
-
* Query user's collateralization ratio
|
|
2695
|
-
*
|
|
2696
|
-
* @param params Parameters for querying user's collateralization ratio
|
|
2697
|
-
* @returns Promise<GetLoanCollateralizationRatioResp>
|
|
2698
|
-
*/
|
|
2699
|
-
getLoanCollateralizationRatio(params: {
|
|
2700
|
-
collateral_currency: string;
|
|
2701
|
-
borrow_currency: string;
|
|
2702
|
-
}): Promise<LoanCollateralRatio>;
|
|
2703
|
-
/**
|
|
2704
|
-
* Query supported borrowing and collateral currencies
|
|
2705
|
-
*
|
|
2706
|
-
* @param params Parameters for querying supported borrowing and collateral currencies
|
|
2707
|
-
* @returns Promise<{
|
|
2708
|
-
* loan_currency: string;
|
|
2709
|
-
* collateral_currency: string[];
|
|
2710
|
-
* }[]>
|
|
2711
|
-
*/
|
|
2712
|
-
getLoanSupportedCurrencies(params?: {
|
|
2713
|
-
loan_currency?: string;
|
|
2714
|
-
}): Promise<{
|
|
2715
|
-
loan_currency: string;
|
|
2716
|
-
collateral_currency: string[];
|
|
2717
|
-
}[]>;
|
|
2718
2693
|
/**==========================================================================================================================
|
|
2719
2694
|
* MULTI COLLATERAL LOAN
|
|
2720
2695
|
* ==========================================================================================================================
|
|
@@ -2856,15 +2831,10 @@ export declare class RestClient extends BaseRestClient {
|
|
|
2856
2831
|
/**
|
|
2857
2832
|
* Place Dual Investment order
|
|
2858
2833
|
*
|
|
2859
|
-
* @param params
|
|
2860
|
-
* @returns Promise<
|
|
2834
|
+
* @param params plan_id, amount (or copies), optional text
|
|
2835
|
+
* @returns Promise<DualInvestmentOrder>
|
|
2861
2836
|
*/
|
|
2862
|
-
submitDualInvestmentOrder(params:
|
|
2863
|
-
plan_id: string;
|
|
2864
|
-
copies: string;
|
|
2865
|
-
is_max: number;
|
|
2866
|
-
amount: string;
|
|
2867
|
-
}): Promise<any>;
|
|
2837
|
+
submitDualInvestmentOrder(params: PlaceDualInvestmentOrderParams): Promise<DualInvestmentOrder>;
|
|
2868
2838
|
/**
|
|
2869
2839
|
* Structured Product List
|
|
2870
2840
|
*
|
|
@@ -3196,6 +3166,84 @@ export declare class RestClient extends BaseRestClient {
|
|
|
3196
3166
|
* @returns Promise with fiat order details
|
|
3197
3167
|
*/
|
|
3198
3168
|
getOTCFiatOrderDetail(params: GetOTCFiatOrderDetailReq): Promise<GetOTCFiatOrderDetailResp>;
|
|
3169
|
+
/**==========================================================================================================================
|
|
3170
|
+
* P2P MERCHANT
|
|
3171
|
+
* ==========================================================================================================================
|
|
3172
|
+
*/
|
|
3173
|
+
/**
|
|
3174
|
+
* Get account information
|
|
3175
|
+
*/
|
|
3176
|
+
getP2PMerchantUserInfo(): Promise<P2PMerchantApiResp<P2PMerchantUserInfo>>;
|
|
3177
|
+
/**
|
|
3178
|
+
* Get counterparty information
|
|
3179
|
+
*/
|
|
3180
|
+
getP2PMerchantCounterpartyUserInfo(params: P2PMerchantGetCounterpartyUserInfoReq): Promise<P2PMerchantApiResp<P2PMerchantCounterpartyUserInfo>>;
|
|
3181
|
+
/**
|
|
3182
|
+
* Get payment method list
|
|
3183
|
+
*/
|
|
3184
|
+
getP2PMerchantMyselfPayment(params?: P2PMerchantGetMyselfPaymentReq): Promise<P2PMerchantApiResp<P2PMerchantPaymentMethod[]>>;
|
|
3185
|
+
/**
|
|
3186
|
+
* Get pending orders
|
|
3187
|
+
*/
|
|
3188
|
+
getP2PMerchantPendingTransactionList(params: P2PMerchantGetPendingTransactionListReq): Promise<P2PMerchantApiResp<P2PMerchantTransactionListData>>;
|
|
3189
|
+
/**
|
|
3190
|
+
* Get completed/historical orders
|
|
3191
|
+
*/
|
|
3192
|
+
getP2PMerchantCompletedTransactionList(params: P2PMerchantGetCompletedTransactionListReq): Promise<P2PMerchantApiResp<P2PMerchantTransactionListData>>;
|
|
3193
|
+
/**
|
|
3194
|
+
* Get order details
|
|
3195
|
+
*/
|
|
3196
|
+
getP2PMerchantTransactionDetails(params: P2PMerchantGetTransactionDetailsReq): Promise<P2PMerchantApiResp<P2PMerchantTransactionDetails>>;
|
|
3197
|
+
/**
|
|
3198
|
+
* Confirm payment
|
|
3199
|
+
*/
|
|
3200
|
+
confirmP2PMerchantPayment(params: P2PMerchantConfirmPaymentReq): Promise<P2PMerchantApiResp<Record<string, unknown>>>;
|
|
3201
|
+
/**
|
|
3202
|
+
* Confirm receipt
|
|
3203
|
+
*/
|
|
3204
|
+
confirmP2PMerchantReceipt(params: P2PMerchantConfirmReceiptReq): Promise<P2PMerchantApiResp<Record<string, unknown>>>;
|
|
3205
|
+
/**
|
|
3206
|
+
* Cancel order
|
|
3207
|
+
*/
|
|
3208
|
+
cancelP2PMerchantTransaction(params: P2PMerchantCancelTransactionReq): Promise<P2PMerchantApiResp<Record<string, unknown>>>;
|
|
3209
|
+
/**
|
|
3210
|
+
* Place ad order
|
|
3211
|
+
*/
|
|
3212
|
+
placeP2PMerchantBizPushOrder(params: P2PMerchantPlaceBizPushOrderReq): Promise<P2PMerchantApiResp<Record<string, unknown>>>;
|
|
3213
|
+
/**
|
|
3214
|
+
* Update ad status
|
|
3215
|
+
*/
|
|
3216
|
+
updateP2PMerchantAdsStatus(params: P2PMerchantAdsUpdateStatusReq): Promise<P2PMerchantApiResp<{
|
|
3217
|
+
status: number;
|
|
3218
|
+
}>>;
|
|
3219
|
+
/**
|
|
3220
|
+
* Get ad details
|
|
3221
|
+
*/
|
|
3222
|
+
getP2PMerchantAdsDetail(params: P2PMerchantAdsDetailReq): Promise<P2PMerchantApiResp<P2PMerchantAdsDetail>>;
|
|
3223
|
+
/**
|
|
3224
|
+
* Get my ads list
|
|
3225
|
+
*/
|
|
3226
|
+
getP2PMerchantMyAdsList(params?: P2PMerchantMyAdsListReq): Promise<P2PMerchantApiResp<P2PMerchantMyAdsListData>>;
|
|
3227
|
+
/**
|
|
3228
|
+
* Get advertisement list
|
|
3229
|
+
*/
|
|
3230
|
+
getP2PMerchantAdsList(params: P2PMerchantGetAdsListReq): Promise<P2PMerchantApiResp<P2PMerchantAdsListItem[]>>;
|
|
3231
|
+
/**
|
|
3232
|
+
* Get chat history
|
|
3233
|
+
*/
|
|
3234
|
+
getP2PMerchantChatsList(params: P2PMerchantGetChatsListReq): Promise<P2PMerchantApiResp<P2PMerchantChatsListData>>;
|
|
3235
|
+
/**
|
|
3236
|
+
* Send chat message
|
|
3237
|
+
*/
|
|
3238
|
+
sendP2PMerchantChatMessage(params: P2PMerchantSendChatMessageReq): Promise<P2PMerchantApiResp<{
|
|
3239
|
+
SRVTM: number;
|
|
3240
|
+
}>>;
|
|
3241
|
+
/**
|
|
3242
|
+
* Upload chat file
|
|
3243
|
+
*/
|
|
3244
|
+
uploadP2PMerchantChatFile(params: P2PMerchantUploadChatFileReq): Promise<P2PMerchantApiResp<{
|
|
3245
|
+
file_key: string;
|
|
3246
|
+
}>>;
|
|
3199
3247
|
/**==========================================================================================================================
|
|
3200
3248
|
* CROSSEX
|
|
3201
3249
|
* ==========================================================================================================================
|
|
@@ -3554,4 +3602,23 @@ export declare class RestClient extends BaseRestClient {
|
|
|
3554
3602
|
* @returns Promise with array of ticker information
|
|
3555
3603
|
*/
|
|
3556
3604
|
getAlphaTickers(params?: GetAlphaTickersReq): Promise<AlphaTicker[]>;
|
|
3605
|
+
getTradFiMT5Account(): Promise<TradFiApiResp<TradFiMT5Account>>;
|
|
3606
|
+
getTradFiSymbolCategories(): Promise<TradFiApiResp<TradFiListData<TradFiCategoryItem>>>;
|
|
3607
|
+
getTradFiSymbols(): Promise<TradFiApiResp<TradFiListData<TradFiSymbolItem>>>;
|
|
3608
|
+
getTradFiSymbolDetail(params: TradFiGetSymbolDetailParams): Promise<TradFiApiResp<TradFiListData<TradFiSymbolDetailItem>>>;
|
|
3609
|
+
getTradFiKlines(symbol: string, params: TradFiGetKlinesParams): Promise<TradFiApiResp<TradFiListData<TradFiKlineItem>>>;
|
|
3610
|
+
getTradFiTicker(symbol: string): Promise<TradFiApiResp<TradFiTicker>>;
|
|
3611
|
+
createTradFiUser(): Promise<TradFiApiResp<TradFiCreateUserResult>>;
|
|
3612
|
+
getTradFiAssets(): Promise<TradFiApiResp<TradFiAssets>>;
|
|
3613
|
+
createTradFiTransaction(params: TradFiCreateTransactionReq): Promise<TradFiApiResp<Record<string, never>>>;
|
|
3614
|
+
getTradFiTransactions(params?: TradFiGetTransactionsParams): Promise<TradFiApiResp<TradFiTransactionListData>>;
|
|
3615
|
+
createTradFiOrder(params: TradFiCreateOrderReq): Promise<TradFiApiResp<TradFiCreateOrderResult>>;
|
|
3616
|
+
getTradFiOrders(): Promise<TradFiApiResp<TradFiListData<TradFiOrderItem>>>;
|
|
3617
|
+
modifyTradFiOrder(orderId: number, params: TradFiModifyOrderReq): Promise<TradFiApiResp<TradFiModifyOrderResult>>;
|
|
3618
|
+
cancelTradFiOrder(orderId: number): Promise<Record<string, never>>;
|
|
3619
|
+
getTradFiOrderHistory(params?: TradFiGetOrderHistoryParams): Promise<TradFiApiResp<TradFiListData<TradFiOrderHistoryItem>>>;
|
|
3620
|
+
getTradFiPositions(): Promise<TradFiApiResp<TradFiListData<TradFiPositionItem>>>;
|
|
3621
|
+
modifyTradFiPosition(positionId: number, params: TradFiModifyPositionReq): Promise<TradFiApiResp<Record<string, never>>>;
|
|
3622
|
+
closeTradFiPosition(positionId: number, params: TradFiClosePositionReq): Promise<TradFiApiResp<Record<string, never>>>;
|
|
3623
|
+
getTradFiPositionHistory(params?: TradFiGetPositionHistoryParams): Promise<TradFiApiResp<TradFiListData<TradFiPositionHistoryItem>>>;
|
|
3557
3624
|
}
|