bitget-api 3.0.12 → 3.1.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 +4 -13
- package/dist/cjs/index.d.ts +0 -10
- package/dist/cjs/index.js +0 -10
- package/dist/cjs/index.js.map +1 -1
- package/dist/cjs/rest-client-v2.d.ts +1 -1
- package/dist/cjs/rest-client-v3.d.ts +1 -1
- package/dist/cjs/types/request/v2/futures.d.ts +1 -1
- package/dist/cjs/types/shared.d.ts +6 -0
- package/dist/cjs/types/websockets/ws-general.d.ts +3 -1
- package/dist/cjs/util/BaseRestClient.js +5 -0
- package/dist/cjs/util/BaseRestClient.js.map +1 -1
- package/dist/mjs/index.d.ts +0 -10
- package/dist/mjs/index.js +0 -10
- package/dist/mjs/index.js.map +1 -1
- package/dist/mjs/rest-client-v2.d.ts +1 -1
- package/dist/mjs/rest-client-v3.d.ts +1 -1
- package/dist/mjs/types/request/v2/futures.d.ts +1 -1
- package/dist/mjs/types/shared.d.ts +6 -0
- package/dist/mjs/types/websockets/ws-general.d.ts +3 -1
- package/dist/mjs/util/BaseRestClient.js +5 -0
- package/dist/mjs/util/BaseRestClient.js.map +1 -1
- package/package.json +3 -2
- package/dist/cjs/broker-client.d.ts +0 -127
- package/dist/cjs/broker-client.js +0 -165
- package/dist/cjs/broker-client.js.map +0 -1
- package/dist/cjs/futures-client.d.ts +0 -184
- package/dist/cjs/futures-client.js +0 -480
- package/dist/cjs/futures-client.js.map +0 -1
- package/dist/cjs/spot-client.d.ts +0 -154
- package/dist/cjs/spot-client.js +0 -280
- package/dist/cjs/spot-client.js.map +0 -1
- package/dist/cjs/types/request/v1/brokerV1.d.ts +0 -23
- package/dist/cjs/types/request/v1/brokerV1.js +0 -3
- package/dist/cjs/types/request/v1/brokerV1.js.map +0 -1
- package/dist/cjs/types/request/v1/futuresV1.d.ts +0 -168
- package/dist/cjs/types/request/v1/futuresV1.js +0 -3
- package/dist/cjs/types/request/v1/futuresV1.js.map +0 -1
- package/dist/cjs/types/request/v1/spotV1.d.ts +0 -105
- package/dist/cjs/types/request/v1/spotV1.js +0 -3
- package/dist/cjs/types/request/v1/spotV1.js.map +0 -1
- package/dist/cjs/types/response/v1/futures.d.ts +0 -72
- package/dist/cjs/types/response/v1/futures.js +0 -3
- package/dist/cjs/types/response/v1/futures.js.map +0 -1
- package/dist/cjs/types/response/v1/shared.d.ts +0 -15
- package/dist/cjs/types/response/v1/shared.js +0 -3
- package/dist/cjs/types/response/v1/shared.js.map +0 -1
- package/dist/cjs/types/response/v1/spot.d.ts +0 -65
- package/dist/cjs/types/response/v1/spot.js +0 -3
- package/dist/cjs/types/response/v1/spot.js.map +0 -1
- package/dist/cjs/websocket-client-legacy-v1.d.ts +0 -127
- package/dist/cjs/websocket-client-legacy-v1.js +0 -509
- package/dist/cjs/websocket-client-legacy-v1.js.map +0 -1
- package/dist/mjs/broker-client.d.ts +0 -127
- package/dist/mjs/broker-client.js +0 -158
- package/dist/mjs/broker-client.js.map +0 -1
- package/dist/mjs/futures-client.d.ts +0 -184
- package/dist/mjs/futures-client.js +0 -473
- package/dist/mjs/futures-client.js.map +0 -1
- package/dist/mjs/spot-client.d.ts +0 -154
- package/dist/mjs/spot-client.js +0 -273
- package/dist/mjs/spot-client.js.map +0 -1
- package/dist/mjs/types/request/v1/brokerV1.d.ts +0 -23
- package/dist/mjs/types/request/v1/brokerV1.js +0 -2
- package/dist/mjs/types/request/v1/brokerV1.js.map +0 -1
- package/dist/mjs/types/request/v1/futuresV1.d.ts +0 -168
- package/dist/mjs/types/request/v1/futuresV1.js +0 -2
- package/dist/mjs/types/request/v1/futuresV1.js.map +0 -1
- package/dist/mjs/types/request/v1/spotV1.d.ts +0 -105
- package/dist/mjs/types/request/v1/spotV1.js +0 -2
- package/dist/mjs/types/request/v1/spotV1.js.map +0 -1
- package/dist/mjs/types/response/v1/futures.d.ts +0 -72
- package/dist/mjs/types/response/v1/futures.js +0 -2
- package/dist/mjs/types/response/v1/futures.js.map +0 -1
- package/dist/mjs/types/response/v1/shared.d.ts +0 -15
- package/dist/mjs/types/response/v1/shared.js +0 -2
- package/dist/mjs/types/response/v1/shared.js.map +0 -1
- package/dist/mjs/types/response/v1/spot.d.ts +0 -65
- package/dist/mjs/types/response/v1/spot.js +0 -2
- package/dist/mjs/types/response/v1/spot.js.map +0 -1
- package/dist/mjs/websocket-client-legacy-v1.d.ts +0 -127
- package/dist/mjs/websocket-client-legacy-v1.js +0 -502
- package/dist/mjs/websocket-client-legacy-v1.js.map +0 -1
|
@@ -1,158 +0,0 @@
|
|
|
1
|
-
import BaseRestClient from './util/BaseRestClient.js';
|
|
2
|
-
import { REST_CLIENT_TYPE_ENUM } from './util/requestUtils.js';
|
|
3
|
-
/**
|
|
4
|
-
* REST API client for the V1 bitget Broker APIs. These are the previous generation of Bitget's APIs and should be considered deprecated.
|
|
5
|
-
* These will be removed in a future release, once Bitget formally deprecates them.
|
|
6
|
-
*
|
|
7
|
-
* @deprecated use RestClientV2 instead
|
|
8
|
-
*/
|
|
9
|
-
export class BrokerClient extends BaseRestClient {
|
|
10
|
-
getClientType() {
|
|
11
|
-
return REST_CLIENT_TYPE_ENUM.broker;
|
|
12
|
-
}
|
|
13
|
-
/**
|
|
14
|
-
*
|
|
15
|
-
* Sub Account Interface
|
|
16
|
-
*
|
|
17
|
-
*/
|
|
18
|
-
/** Get Broker Info */
|
|
19
|
-
getBrokerInfo() {
|
|
20
|
-
return this.getPrivate('/api/broker/v1/account/info');
|
|
21
|
-
}
|
|
22
|
-
/** Create Sub Account */
|
|
23
|
-
createSubAccount(subName, remark) {
|
|
24
|
-
return this.postPrivate('/api/broker/v1/account/sub-create', {
|
|
25
|
-
subName,
|
|
26
|
-
remark,
|
|
27
|
-
});
|
|
28
|
-
}
|
|
29
|
-
/** Get Sub List */
|
|
30
|
-
getSubAccounts(params) {
|
|
31
|
-
return this.getPrivate('/api/broker/v1/account/sub-list', params);
|
|
32
|
-
}
|
|
33
|
-
/** Modify Sub Account */
|
|
34
|
-
modifySubAccount(subUid, perm, status) {
|
|
35
|
-
return this.postPrivate('/api/broker/v1/account/sub-modify', {
|
|
36
|
-
subUid,
|
|
37
|
-
perm,
|
|
38
|
-
status,
|
|
39
|
-
});
|
|
40
|
-
}
|
|
41
|
-
/** Modify Sub Email */
|
|
42
|
-
modifySubEmail(subUid, subEmail) {
|
|
43
|
-
return this.postPrivate('/api/broker/v1/account/sub-modify-email', {
|
|
44
|
-
subUid,
|
|
45
|
-
subEmail,
|
|
46
|
-
});
|
|
47
|
-
}
|
|
48
|
-
/** Get Sub Email */
|
|
49
|
-
getSubEmail(subUid) {
|
|
50
|
-
return this.getPrivate('/api/broker/v1/account/sub-email', { subUid });
|
|
51
|
-
}
|
|
52
|
-
/** Get Sub Spot Assets */
|
|
53
|
-
getSubSpotAssets(subUid) {
|
|
54
|
-
return this.getPrivate('/api/broker/v1/account/sub-spot-assets', {
|
|
55
|
-
subUid,
|
|
56
|
-
});
|
|
57
|
-
}
|
|
58
|
-
/** Get Sub Future Assets */
|
|
59
|
-
getSubFutureAssets(subUid, productType) {
|
|
60
|
-
return this.getPrivate('/api/broker/v1/account/sub-future-assets', {
|
|
61
|
-
subUid,
|
|
62
|
-
productType,
|
|
63
|
-
});
|
|
64
|
-
}
|
|
65
|
-
/** Get Sub Deposit Address (Only Broker) */
|
|
66
|
-
getSubDepositAddress(subUid, coin, chain) {
|
|
67
|
-
return this.postPrivate('/api/broker/v1/account/sub-address', {
|
|
68
|
-
subUid,
|
|
69
|
-
coin,
|
|
70
|
-
chain,
|
|
71
|
-
});
|
|
72
|
-
}
|
|
73
|
-
/** Sub Withdrawal (Only Broker) */
|
|
74
|
-
subWithdrawal(params) {
|
|
75
|
-
return this.postPrivate('/api/broker/v1/account/sub-withdrawal', params);
|
|
76
|
-
}
|
|
77
|
-
/** Sub Deposit Auto Transfer (Only Broker) */
|
|
78
|
-
setSubDepositAutoTransfer(subUid, coin, toAccountType) {
|
|
79
|
-
return this.postPrivate('/api/broker/v1/account/sub-auto-transfer', {
|
|
80
|
-
subUid,
|
|
81
|
-
coin,
|
|
82
|
-
toAccountType,
|
|
83
|
-
});
|
|
84
|
-
}
|
|
85
|
-
/**
|
|
86
|
-
*
|
|
87
|
-
* Sub API Interface
|
|
88
|
-
*
|
|
89
|
-
*/
|
|
90
|
-
/** Create Sub ApiKey (Only Broker) */
|
|
91
|
-
createSubAPIKey(subUid, passphrase, remark, ip, perm) {
|
|
92
|
-
return this.postPrivate('/api/broker/v1/manage/sub-api-create', {
|
|
93
|
-
subUid,
|
|
94
|
-
passphrase,
|
|
95
|
-
remark,
|
|
96
|
-
ip,
|
|
97
|
-
perm,
|
|
98
|
-
});
|
|
99
|
-
}
|
|
100
|
-
/** Get Sub ApiKey List */
|
|
101
|
-
getSubAPIKeys(subUid) {
|
|
102
|
-
return this.getPrivate('/api/broker/v1/manage/sub-api-list', { subUid });
|
|
103
|
-
}
|
|
104
|
-
/** Modify Sub ApiKey (Only Broker) */
|
|
105
|
-
modifySubAPIKey(params) {
|
|
106
|
-
return this.postPrivate('/api/broker/v1/manage/sub-api-modify', params);
|
|
107
|
-
}
|
|
108
|
-
/**
|
|
109
|
-
* Undocumented endpoints
|
|
110
|
-
*/
|
|
111
|
-
getAgentCommissionDetail(params) {
|
|
112
|
-
return this.getPrivate('/api/broker/v1/agent/commission-distribution', params);
|
|
113
|
-
}
|
|
114
|
-
/** Get Agent Customer List */
|
|
115
|
-
getAgentCustomerList(params) {
|
|
116
|
-
return this.postPrivate('/api/broker/v1/agent/customerList', params);
|
|
117
|
-
}
|
|
118
|
-
/**
|
|
119
|
-
* Get Agent Customer Deposit List
|
|
120
|
-
* Includes both on-chain deposits and internal transfers
|
|
121
|
-
* Note: Can only query data within the last 90 days
|
|
122
|
-
*/
|
|
123
|
-
getAgentCustomerDepositList(params) {
|
|
124
|
-
return this.postPrivate('/api/broker/v1/agent/customerDepositList', params);
|
|
125
|
-
}
|
|
126
|
-
/**
|
|
127
|
-
* Get Agent Customer Trade Volume List
|
|
128
|
-
* Includes trading volume for both spot and futures
|
|
129
|
-
* Note: Data updates every 10 minutes and can only query last 90 days
|
|
130
|
-
*/
|
|
131
|
-
getAgentCustomerTradeVolumeList(params) {
|
|
132
|
-
return this.postPrivate('/api/broker/v1/agent/customerTradeVolumnList', params);
|
|
133
|
-
}
|
|
134
|
-
/**
|
|
135
|
-
* Get Agent Customer Assets List
|
|
136
|
-
* Returns account balances for customer accounts
|
|
137
|
-
* Note: Data updates every 10 minutes
|
|
138
|
-
*/
|
|
139
|
-
getAgentCustomerAssetsList(params) {
|
|
140
|
-
return this.postPrivate('/api/broker/v1/agent/customerAccountAssetsList', params);
|
|
141
|
-
}
|
|
142
|
-
/**
|
|
143
|
-
* Get Agent Direct Commissions
|
|
144
|
-
* Returns commission data for direct customers
|
|
145
|
-
* Note: Data updates on T+1 (UTC+8) basis and can only query last 90 days
|
|
146
|
-
*/
|
|
147
|
-
getAgentCustomerCommissions(params) {
|
|
148
|
-
return this.getPrivate('/api/broker/v1/agent/customer-commissions', params);
|
|
149
|
-
}
|
|
150
|
-
/**
|
|
151
|
-
* Get Agent Customer KYC Result
|
|
152
|
-
* Returns KYC verification status for customers
|
|
153
|
-
*/
|
|
154
|
-
getAgentCustomerKycResult(params) {
|
|
155
|
-
return this.getPrivate('/api/broker/v1/agent/customer-kyc-result', params);
|
|
156
|
-
}
|
|
157
|
-
}
|
|
158
|
-
//# sourceMappingURL=broker-client.js.map
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"broker-client.js","sourceRoot":"","sources":["../../src/broker-client.ts"],"names":[],"mappings":"AAOA,OAAO,cAAc,MAAM,0BAA0B,CAAC;AACtD,OAAO,EAAE,qBAAqB,EAAE,MAAM,wBAAwB,CAAC;AAE/D;;;;;GAKG;AACH,MAAM,OAAO,YAAa,SAAQ,cAAc;IAC9C,aAAa;QACX,OAAO,qBAAqB,CAAC,MAAM,CAAC;IACtC,CAAC;IAED;;;;OAIG;IAEH,sBAAsB;IACtB,aAAa;QACX,OAAO,IAAI,CAAC,UAAU,CAAC,6BAA6B,CAAC,CAAC;IACxD,CAAC;IAED,yBAAyB;IACzB,gBAAgB,CACd,OAAe,EACf,MAAe;QAEf,OAAO,IAAI,CAAC,WAAW,CAAC,mCAAmC,EAAE;YAC3D,OAAO;YACP,MAAM;SACP,CAAC,CAAC;IACL,CAAC;IAED,mBAAmB;IACnB,cAAc,CAAC,MAA6B;QAC1C,OAAO,IAAI,CAAC,UAAU,CAAC,iCAAiC,EAAE,MAAM,CAAC,CAAC;IACpE,CAAC;IAED,yBAAyB;IACzB,gBAAgB,CACd,MAAc,EACd,IAAY,EACZ,MAAmC;QAEnC,OAAO,IAAI,CAAC,WAAW,CAAC,mCAAmC,EAAE;YAC3D,MAAM;YACN,IAAI;YACJ,MAAM;SACP,CAAC,CAAC;IACL,CAAC;IAED,uBAAuB;IACvB,cAAc,CAAC,MAAc,EAAE,QAAgB;QAC7C,OAAO,IAAI,CAAC,WAAW,CAAC,yCAAyC,EAAE;YACjE,MAAM;YACN,QAAQ;SACT,CAAC,CAAC;IACL,CAAC;IAED,oBAAoB;IACpB,WAAW,CAAC,MAAc;QACxB,OAAO,IAAI,CAAC,UAAU,CAAC,kCAAkC,EAAE,EAAE,MAAM,EAAE,CAAC,CAAC;IACzE,CAAC;IAED,0BAA0B;IAC1B,gBAAgB,CAAC,MAAc;QAC7B,OAAO,IAAI,CAAC,UAAU,CAAC,wCAAwC,EAAE;YAC/D,MAAM;SACP,CAAC,CAAC;IACL,CAAC;IAED,4BAA4B;IAC5B,kBAAkB,CAChB,MAAc,EACd,WAA8B;QAE9B,OAAO,IAAI,CAAC,UAAU,CAAC,0CAA0C,EAAE;YACjE,MAAM;YACN,WAAW;SACZ,CAAC,CAAC;IACL,CAAC;IAED,4CAA4C;IAC5C,oBAAoB,CAClB,MAAc,EACd,IAAY,EACZ,KAAc;QAEd,OAAO,IAAI,CAAC,WAAW,CAAC,oCAAoC,EAAE;YAC5D,MAAM;YACN,IAAI;YACJ,KAAK;SACN,CAAC,CAAC;IACL,CAAC;IAED,mCAAmC;IACnC,aAAa,CAAC,MAAkC;QAC9C,OAAO,IAAI,CAAC,WAAW,CAAC,uCAAuC,EAAE,MAAM,CAAC,CAAC;IAC3E,CAAC;IAED,8CAA8C;IAC9C,yBAAyB,CACvB,MAAc,EACd,IAAY,EACZ,aAA2D;QAE3D,OAAO,IAAI,CAAC,WAAW,CAAC,0CAA0C,EAAE;YAClE,MAAM;YACN,IAAI;YACJ,aAAa;SACd,CAAC,CAAC;IACL,CAAC;IAED;;;;OAIG;IAEH,sCAAsC;IACtC,eAAe,CACb,MAAc,EACd,UAAkB,EAClB,MAAc,EACd,EAAU,EACV,IAAa;QAEb,OAAO,IAAI,CAAC,WAAW,CAAC,sCAAsC,EAAE;YAC9D,MAAM;YACN,UAAU;YACV,MAAM;YACN,EAAE;YACF,IAAI;SACL,CAAC,CAAC;IACL,CAAC;IAED,0BAA0B;IAC1B,aAAa,CAAC,MAAc;QAC1B,OAAO,IAAI,CAAC,UAAU,CAAC,oCAAoC,EAAE,EAAE,MAAM,EAAE,CAAC,CAAC;IAC3E,CAAC;IAED,sCAAsC;IACtC,eAAe,CACb,MAAoC;QAEpC,OAAO,IAAI,CAAC,WAAW,CAAC,sCAAsC,EAAE,MAAM,CAAC,CAAC;IAC1E,CAAC;IAED;;OAEG;IAEH,wBAAwB,CAAC,MAKxB;QACC,OAAO,IAAI,CAAC,UAAU,CACpB,8CAA8C,EAC9C,MAAM,CACP,CAAC;IACJ,CAAC;IAED,8BAA8B;IAC9B,oBAAoB,CAAC,MAOpB;QACC,OAAO,IAAI,CAAC,WAAW,CAAC,mCAAmC,EAAE,MAAM,CAAC,CAAC;IACvE,CAAC;IAED;;;;OAIG;IACH,2BAA2B,CAAC,MAM3B;QACC,OAAO,IAAI,CAAC,WAAW,CAAC,0CAA0C,EAAE,MAAM,CAAC,CAAC;IAC9E,CAAC;IAED;;;;OAIG;IACH,+BAA+B,CAAC,MAM/B;QACC,OAAO,IAAI,CAAC,WAAW,CACrB,8CAA8C,EAC9C,MAAM,CACP,CAAC;IACJ,CAAC;IAED;;;;OAIG;IACH,0BAA0B,CAAC,MAI1B;QACC,OAAO,IAAI,CAAC,WAAW,CACrB,gDAAgD,EAChD,MAAM,CACP,CAAC;IACJ,CAAC;IAED;;;;OAIG;IACH,2BAA2B,CAAC,MAQ3B;QACC,OAAO,IAAI,CAAC,UAAU,CAAC,2CAA2C,EAAE,MAAM,CAAC,CAAC;IAC9E,CAAC;IAED;;;OAGG;IACH,yBAAyB,CAAC,MAMzB;QACC,OAAO,IAAI,CAAC,UAAU,CAAC,0CAA0C,EAAE,MAAM,CAAC,CAAC;IAC7E,CAAC;CACF"}
|
|
@@ -1,184 +0,0 @@
|
|
|
1
|
-
import { GetHistoricTradesParams } from './types/request/shared.js';
|
|
2
|
-
import { CancelFuturesPlanTPSL, FuturesAccountBillRequest, FuturesBusinessBillRequest, FuturesCandleData, FuturesHistoricPositions, FuturesKlineInterval, FuturesMarginMode, FuturesPagination, FuturesPlanType, FuturesProductType, HistoricPlanOrderTPSLRequest, ModifyFuturesOrder, ModifyFuturesPlanOrder, ModifyFuturesPlanOrderTPSL, ModifyFuturesPlanStopOrder, NewBatchFuturesOrder, NewFuturesOrder, NewFuturesPlanOrder, NewFuturesPlanPositionTPSL, NewFuturesPlanStopOrder, NewFuturesPlanTrailingStopOrder } from './types/request/v1/futuresV1.js';
|
|
3
|
-
import { FuturesAccount, FuturesMarketTrade, FuturesPosition, FuturesSymbolRule } from './types/response/v1/futures.js';
|
|
4
|
-
import { APIResponse, VIPFeeRate } from './types/response/v1/shared.js';
|
|
5
|
-
import BaseRestClient from './util/BaseRestClient.js';
|
|
6
|
-
/**
|
|
7
|
-
* REST API client for the V1 bitget Futures APIs. These are the previous generation of Bitget's APIs and should be considered deprecated.
|
|
8
|
-
* These will be removed in a future release, once Bitget formally deprecates them.
|
|
9
|
-
*
|
|
10
|
-
* @deprecated use RestClientV2 instead
|
|
11
|
-
*/
|
|
12
|
-
export declare class FuturesClient extends BaseRestClient {
|
|
13
|
-
getClientType(): "futures";
|
|
14
|
-
/**
|
|
15
|
-
*
|
|
16
|
-
* Market
|
|
17
|
-
*
|
|
18
|
-
*/
|
|
19
|
-
/** Get Symbols : Get basic configuration information of all trading pairs (including rules) */
|
|
20
|
-
getSymbols(productType: FuturesProductType): Promise<APIResponse<FuturesSymbolRule[]>>;
|
|
21
|
-
/** Get Depth */
|
|
22
|
-
getDepth(symbol: string, limit?: string): Promise<APIResponse<any>>;
|
|
23
|
-
/** Get Single Symbol Ticker */
|
|
24
|
-
getTicker(symbol: string): Promise<APIResponse<any>>;
|
|
25
|
-
/** Get All Tickers */
|
|
26
|
-
getAllTickers(productType: FuturesProductType): Promise<APIResponse<any>>;
|
|
27
|
-
/** Get VIP fee rates */
|
|
28
|
-
getVIPFeeRates(): Promise<APIResponse<VIPFeeRate[]>>;
|
|
29
|
-
/** Get most recent trades (up to 500, 100 by default) */
|
|
30
|
-
getRecentTrades(symbol: string, limit?: string): Promise<APIResponse<FuturesMarketTrade[]>>;
|
|
31
|
-
/** Get historic trades, up to 30 days at a time. Same-parameter responses are cached for 10 minutes. */
|
|
32
|
-
getHistoricTrades(params: GetHistoricTradesParams): Promise<APIResponse<FuturesMarketTrade[]>>;
|
|
33
|
-
/**
|
|
34
|
-
* @deprecated use getRecentTrades() instead. This method will be removed soon.
|
|
35
|
-
*/
|
|
36
|
-
getMarketTrades(symbol: string, limit?: string): Promise<APIResponse<FuturesMarketTrade[]>>;
|
|
37
|
-
/** Get Candle Data */
|
|
38
|
-
getCandles(symbol: string, granularity: FuturesKlineInterval, startTime: string, endTime: string, limit?: string, kLineType?: 'market' | 'mark' | 'index'): Promise<APIResponse<FuturesCandleData[]>>;
|
|
39
|
-
/** Get symbol index price */
|
|
40
|
-
getIndexPrice(symbol: string): Promise<APIResponse<any>>;
|
|
41
|
-
/** Get symbol next funding time */
|
|
42
|
-
getNextFundingTime(symbol: string): Promise<APIResponse<any>>;
|
|
43
|
-
/** Get Withdraw List */
|
|
44
|
-
getHistoricFundingRate(symbol: string, pageSize?: string, pageNo?: string, nextPage?: boolean): Promise<APIResponse<any>>;
|
|
45
|
-
/** Get symbol current funding time */
|
|
46
|
-
getCurrentFundingRate(symbol: string): Promise<APIResponse<any>>;
|
|
47
|
-
/** Get symbol open interest */
|
|
48
|
-
getOpenInterest(symbol: string): Promise<APIResponse<any>>;
|
|
49
|
-
/** Get symbol mark price */
|
|
50
|
-
getMarkPrice(symbol: string): Promise<APIResponse<any>>;
|
|
51
|
-
/** Get symbol min/max leverage rules */
|
|
52
|
-
getLeverageMinMax(symbol: string): Promise<APIResponse<any>>;
|
|
53
|
-
/** Get Position Tier */
|
|
54
|
-
getPositionTier(symbol: string, productType: FuturesProductType): Promise<APIResponse<any>>;
|
|
55
|
-
/**
|
|
56
|
-
*
|
|
57
|
-
* Account Endpoints
|
|
58
|
-
*
|
|
59
|
-
*/
|
|
60
|
-
/** Get Single Account */
|
|
61
|
-
getAccount(symbol: string, marginCoin: string): Promise<APIResponse<FuturesAccount>>;
|
|
62
|
-
/** Get Account List */
|
|
63
|
-
getAccounts(productType: FuturesProductType): Promise<APIResponse<any>>;
|
|
64
|
-
/** Get Sub Account Contract Assets */
|
|
65
|
-
getSubAccountContractAssets(productType: FuturesProductType): Promise<APIResponse<any>>;
|
|
66
|
-
/**
|
|
67
|
-
* This interface is only used to calculate the maximum number of positions that can be opened when the user does not hold a position by default.
|
|
68
|
-
* The result does not represent the actual number of positions opened.
|
|
69
|
-
*/
|
|
70
|
-
getOpenCount(symbol: string, marginCoin: string, openPrice: number, openAmount: number, leverage?: number): Promise<APIResponse<any>>;
|
|
71
|
-
/** Change Leverage */
|
|
72
|
-
setLeverage(symbol: string, marginCoin: string, leverage: string, holdSide?: string): Promise<APIResponse<any>>;
|
|
73
|
-
/** Change Margin */
|
|
74
|
-
setMargin(symbol: string, marginCoin: string, amount: string, holdSide?: string): Promise<APIResponse<any>>;
|
|
75
|
-
/** Change Margin Mode */
|
|
76
|
-
setMarginMode(symbol: string, marginCoin: string, marginMode: FuturesMarginMode): Promise<APIResponse<any>>;
|
|
77
|
-
/** Change Hold Mode */
|
|
78
|
-
setHoldMode(productType: FuturesProductType, holdMode: 'single_hold' | 'double_hold'): Promise<APIResponse<any>>;
|
|
79
|
-
/** Get Symbol Position */
|
|
80
|
-
getPosition(symbol: string, marginCoin?: string): Promise<APIResponse<FuturesPosition[]>>;
|
|
81
|
-
/** Get Symbol Position V2 */
|
|
82
|
-
getPositionV2(symbol: string, marginCoin: string): Promise<APIResponse<FuturesPosition[]>>;
|
|
83
|
-
/** Get All Position */
|
|
84
|
-
getPositions(productType: FuturesProductType, marginCoin?: string): Promise<APIResponse<FuturesPosition[]>>;
|
|
85
|
-
/** Get All Position V2 */
|
|
86
|
-
getPositionsV2(productType: FuturesProductType, marginCoin?: string): Promise<APIResponse<FuturesPosition[]>>;
|
|
87
|
-
/** Get All historic positions, only supports Query within 3 months */
|
|
88
|
-
getHistoryPositions(params: FuturesHistoricPositions): Promise<APIResponse<FuturesPosition[]>>;
|
|
89
|
-
/** Get Account Bill */
|
|
90
|
-
getAccountBill(params: FuturesAccountBillRequest): Promise<APIResponse<any>>;
|
|
91
|
-
/** Get Business Account Bill */
|
|
92
|
-
getBusinessBill(params: FuturesBusinessBillRequest): Promise<APIResponse<any>>;
|
|
93
|
-
/**
|
|
94
|
-
*
|
|
95
|
-
* Trade Endpoints
|
|
96
|
-
*
|
|
97
|
-
*/
|
|
98
|
-
/** Place Order */
|
|
99
|
-
submitOrder(params: NewFuturesOrder): Promise<APIResponse<any>>;
|
|
100
|
-
/** Batch Order */
|
|
101
|
-
batchSubmitOrder(symbol: string, marginCoin: string, orders: NewBatchFuturesOrder[]): Promise<APIResponse<any>>;
|
|
102
|
-
/** Cancel Order */
|
|
103
|
-
cancelOrder(symbol: string, marginCoin: string, orderId?: string, clientOid?: string): Promise<APIResponse<any>>;
|
|
104
|
-
/** Batch Cancel Order */
|
|
105
|
-
batchCancelOrder(symbol: string, marginCoin: string, orderIds: string[]): Promise<APIResponse<any>>;
|
|
106
|
-
/** Modify Order */
|
|
107
|
-
modifyOrder(params: ModifyFuturesOrder): Promise<APIResponse<any>>;
|
|
108
|
-
/**
|
|
109
|
-
* Cancel all futures orders for a symbol
|
|
110
|
-
*/
|
|
111
|
-
cancelSymbolOrders(symbol: string, marginCoin: string): Promise<APIResponse<any>>;
|
|
112
|
-
/** Cancel All Order */
|
|
113
|
-
cancelAllOrders(productType: FuturesProductType, marginCoin: string): Promise<APIResponse<any>>;
|
|
114
|
-
/** Get Open Order */
|
|
115
|
-
getOpenSymbolOrders(symbol: string): Promise<APIResponse<any>>;
|
|
116
|
-
/** Get All Open Order */
|
|
117
|
-
getOpenOrders(productType: FuturesProductType, marginCoin: string): Promise<APIResponse<any>>;
|
|
118
|
-
/** Get History Orders */
|
|
119
|
-
getOrderHistory(symbol: string, startTime: string, endTime: string, pageSize: string, lastEndId?: string, isPre?: boolean, clientOid?: string): Promise<APIResponse<any>>;
|
|
120
|
-
/** Get ProductType History Orders */
|
|
121
|
-
getProductTypeOrderHistory(productType: FuturesProductType, startTime: string, endTime: string, pageSize: string, lastEndId?: string, isPre?: boolean, clientOid?: string): Promise<APIResponse<any>>;
|
|
122
|
-
/** Get order details */
|
|
123
|
-
getOrder(symbol: string, orderId?: string, clientOid?: string): Promise<APIResponse<any>>;
|
|
124
|
-
/** Get transaction details / history (fills) */
|
|
125
|
-
getOrderFills(symbol: string, orderId?: string, pagination?: FuturesPagination): Promise<APIResponse<any>>;
|
|
126
|
-
/** Get ProductType Order fill detail */
|
|
127
|
-
getProductTypeOrderFills(productType: FuturesProductType, pagination?: FuturesPagination): Promise<APIResponse<any>>;
|
|
128
|
-
/** Place Plan order */
|
|
129
|
-
submitPlanOrder(params: NewFuturesPlanOrder): Promise<APIResponse<any>>;
|
|
130
|
-
/** Modify Plan Order */
|
|
131
|
-
modifyPlanOrder(params: ModifyFuturesPlanOrder): Promise<APIResponse<any>>;
|
|
132
|
-
/** Modify Plan Order TPSL */
|
|
133
|
-
modifyPlanOrderTPSL(params: ModifyFuturesPlanOrderTPSL): Promise<APIResponse<any>>;
|
|
134
|
-
/** Place Stop order */
|
|
135
|
-
submitStopOrder(params: NewFuturesPlanStopOrder): Promise<APIResponse<any>>;
|
|
136
|
-
/** Place Trailing Stop order */
|
|
137
|
-
submitTrailingStopOrder(params: NewFuturesPlanTrailingStopOrder): Promise<APIResponse<any>>;
|
|
138
|
-
/** Place Position TPSL */
|
|
139
|
-
submitPositionTPSL(params: NewFuturesPlanPositionTPSL): Promise<APIResponse<any>>;
|
|
140
|
-
/** Modify Stop Order */
|
|
141
|
-
modifyStopOrder(params: ModifyFuturesPlanStopOrder): Promise<APIResponse<any>>;
|
|
142
|
-
/** Cancel Plan Order (TPSL) */
|
|
143
|
-
cancelPlanOrderTPSL(params: CancelFuturesPlanTPSL): Promise<APIResponse<any>>;
|
|
144
|
-
/** Cancel Symbol Plan Order (TPSL) */
|
|
145
|
-
cancelSymbolPlanOrders(symbol: string, planType: FuturesPlanType): Promise<APIResponse<any>>;
|
|
146
|
-
/** Cancel All Trigger Order (TPSL) */
|
|
147
|
-
cancelAllPlanOrders(productType: FuturesProductType, planType: FuturesPlanType): Promise<APIResponse<any>>;
|
|
148
|
-
/** Get Plan Order (TPSL) List */
|
|
149
|
-
getPlanOrderTPSLs(symbol: string, isPlan?: string, productType?: FuturesProductType): Promise<APIResponse<any>>;
|
|
150
|
-
/** Get History Plan Orders (TPSL) */
|
|
151
|
-
getHistoricPlanOrdersTPSL(params: HistoricPlanOrderTPSLRequest): Promise<APIResponse<any>>;
|
|
152
|
-
/**
|
|
153
|
-
*
|
|
154
|
-
* Copy Trade Endpoints
|
|
155
|
-
*
|
|
156
|
-
*/
|
|
157
|
-
/** Get Trader Open order */
|
|
158
|
-
getCopyTraderOpenOrder(symbol: string, productType: FuturesProductType, pageSize: number, pageNo: number): Promise<APIResponse<any>>;
|
|
159
|
-
/** Get Followers Open Order */
|
|
160
|
-
getCopyFollowersOpenOrder(symbol: string, productType: FuturesProductType, pageSize: number, pageNo: number): Promise<APIResponse<any>>;
|
|
161
|
-
/** Trader Close Position */
|
|
162
|
-
closeCopyTraderPosition(symbol: string, trackingNo: string): Promise<APIResponse<any>>;
|
|
163
|
-
/** Trader Modify TPSL */
|
|
164
|
-
modifyCopyTraderTPSL(symbol: string, trackingNo: string, changes?: {
|
|
165
|
-
stopProfitPrice?: number;
|
|
166
|
-
stopLossPrice?: number;
|
|
167
|
-
}): Promise<APIResponse<any>>;
|
|
168
|
-
/** Get Traders History Orders */
|
|
169
|
-
getCopyTraderOrderHistory(startTime: string, endTime: string, pageSize: number, pageNo: number): Promise<APIResponse<any>>;
|
|
170
|
-
/** Get Trader Profit Summary */
|
|
171
|
-
getCopyTraderProfitSummary(): Promise<APIResponse<any>>;
|
|
172
|
-
/** Get Trader History Profit Summary (according to settlement currency) */
|
|
173
|
-
getCopyTraderHistoricProfitSummary(): Promise<APIResponse<any>>;
|
|
174
|
-
/** Get Trader History Profit Summary (according to settlement currency and date) */
|
|
175
|
-
getCopyTraderHistoricProfitSummaryByDate(marginCoin: string, dateMs: string, pageSize: number, pageNo: number): Promise<APIResponse<any>>;
|
|
176
|
-
/** Get Trader Histroy Profit Detail */
|
|
177
|
-
getCopyTraderHistoricProfitDetail(marginCoin: string, dateMs: string, pageSize: number, pageNo: number): Promise<APIResponse<any>>;
|
|
178
|
-
/** Get Trader Profits Details */
|
|
179
|
-
getCopyTraderProfitDetails(pageSize: number, pageNo: number): Promise<APIResponse<any>>;
|
|
180
|
-
/** Get CopyTrade Symbols */
|
|
181
|
-
getCopyTraderSymbols(): Promise<APIResponse<any>>;
|
|
182
|
-
/** Trader Change CopyTrade symbol */
|
|
183
|
-
setCopyTraderSymbols(symbol: string, operation: 'add' | 'delete'): Promise<APIResponse<any>>;
|
|
184
|
-
}
|