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.
Files changed (82) hide show
  1. package/README.md +4 -13
  2. package/dist/cjs/index.d.ts +0 -10
  3. package/dist/cjs/index.js +0 -10
  4. package/dist/cjs/index.js.map +1 -1
  5. package/dist/cjs/rest-client-v2.d.ts +1 -1
  6. package/dist/cjs/rest-client-v3.d.ts +1 -1
  7. package/dist/cjs/types/request/v2/futures.d.ts +1 -1
  8. package/dist/cjs/types/shared.d.ts +6 -0
  9. package/dist/cjs/types/websockets/ws-general.d.ts +3 -1
  10. package/dist/cjs/util/BaseRestClient.js +5 -0
  11. package/dist/cjs/util/BaseRestClient.js.map +1 -1
  12. package/dist/mjs/index.d.ts +0 -10
  13. package/dist/mjs/index.js +0 -10
  14. package/dist/mjs/index.js.map +1 -1
  15. package/dist/mjs/rest-client-v2.d.ts +1 -1
  16. package/dist/mjs/rest-client-v3.d.ts +1 -1
  17. package/dist/mjs/types/request/v2/futures.d.ts +1 -1
  18. package/dist/mjs/types/shared.d.ts +6 -0
  19. package/dist/mjs/types/websockets/ws-general.d.ts +3 -1
  20. package/dist/mjs/util/BaseRestClient.js +5 -0
  21. package/dist/mjs/util/BaseRestClient.js.map +1 -1
  22. package/package.json +3 -2
  23. package/dist/cjs/broker-client.d.ts +0 -127
  24. package/dist/cjs/broker-client.js +0 -165
  25. package/dist/cjs/broker-client.js.map +0 -1
  26. package/dist/cjs/futures-client.d.ts +0 -184
  27. package/dist/cjs/futures-client.js +0 -480
  28. package/dist/cjs/futures-client.js.map +0 -1
  29. package/dist/cjs/spot-client.d.ts +0 -154
  30. package/dist/cjs/spot-client.js +0 -280
  31. package/dist/cjs/spot-client.js.map +0 -1
  32. package/dist/cjs/types/request/v1/brokerV1.d.ts +0 -23
  33. package/dist/cjs/types/request/v1/brokerV1.js +0 -3
  34. package/dist/cjs/types/request/v1/brokerV1.js.map +0 -1
  35. package/dist/cjs/types/request/v1/futuresV1.d.ts +0 -168
  36. package/dist/cjs/types/request/v1/futuresV1.js +0 -3
  37. package/dist/cjs/types/request/v1/futuresV1.js.map +0 -1
  38. package/dist/cjs/types/request/v1/spotV1.d.ts +0 -105
  39. package/dist/cjs/types/request/v1/spotV1.js +0 -3
  40. package/dist/cjs/types/request/v1/spotV1.js.map +0 -1
  41. package/dist/cjs/types/response/v1/futures.d.ts +0 -72
  42. package/dist/cjs/types/response/v1/futures.js +0 -3
  43. package/dist/cjs/types/response/v1/futures.js.map +0 -1
  44. package/dist/cjs/types/response/v1/shared.d.ts +0 -15
  45. package/dist/cjs/types/response/v1/shared.js +0 -3
  46. package/dist/cjs/types/response/v1/shared.js.map +0 -1
  47. package/dist/cjs/types/response/v1/spot.d.ts +0 -65
  48. package/dist/cjs/types/response/v1/spot.js +0 -3
  49. package/dist/cjs/types/response/v1/spot.js.map +0 -1
  50. package/dist/cjs/websocket-client-legacy-v1.d.ts +0 -127
  51. package/dist/cjs/websocket-client-legacy-v1.js +0 -509
  52. package/dist/cjs/websocket-client-legacy-v1.js.map +0 -1
  53. package/dist/mjs/broker-client.d.ts +0 -127
  54. package/dist/mjs/broker-client.js +0 -158
  55. package/dist/mjs/broker-client.js.map +0 -1
  56. package/dist/mjs/futures-client.d.ts +0 -184
  57. package/dist/mjs/futures-client.js +0 -473
  58. package/dist/mjs/futures-client.js.map +0 -1
  59. package/dist/mjs/spot-client.d.ts +0 -154
  60. package/dist/mjs/spot-client.js +0 -273
  61. package/dist/mjs/spot-client.js.map +0 -1
  62. package/dist/mjs/types/request/v1/brokerV1.d.ts +0 -23
  63. package/dist/mjs/types/request/v1/brokerV1.js +0 -2
  64. package/dist/mjs/types/request/v1/brokerV1.js.map +0 -1
  65. package/dist/mjs/types/request/v1/futuresV1.d.ts +0 -168
  66. package/dist/mjs/types/request/v1/futuresV1.js +0 -2
  67. package/dist/mjs/types/request/v1/futuresV1.js.map +0 -1
  68. package/dist/mjs/types/request/v1/spotV1.d.ts +0 -105
  69. package/dist/mjs/types/request/v1/spotV1.js +0 -2
  70. package/dist/mjs/types/request/v1/spotV1.js.map +0 -1
  71. package/dist/mjs/types/response/v1/futures.d.ts +0 -72
  72. package/dist/mjs/types/response/v1/futures.js +0 -2
  73. package/dist/mjs/types/response/v1/futures.js.map +0 -1
  74. package/dist/mjs/types/response/v1/shared.d.ts +0 -15
  75. package/dist/mjs/types/response/v1/shared.js +0 -2
  76. package/dist/mjs/types/response/v1/shared.js.map +0 -1
  77. package/dist/mjs/types/response/v1/spot.d.ts +0 -65
  78. package/dist/mjs/types/response/v1/spot.js +0 -2
  79. package/dist/mjs/types/response/v1/spot.js.map +0 -1
  80. package/dist/mjs/websocket-client-legacy-v1.d.ts +0 -127
  81. package/dist/mjs/websocket-client-legacy-v1.js +0 -502
  82. package/dist/mjs/websocket-client-legacy-v1.js.map +0 -1
@@ -1,127 +0,0 @@
1
- import { BrokerProductType, BrokerSubAPIKeyModifyRequest, BrokerSubListRequest, BrokerSubWithdrawalRequest } from './types/request/v1/brokerV1.js';
2
- import { APIResponse } from './types/response/v1/shared.js';
3
- import BaseRestClient from './util/BaseRestClient.js';
4
- /**
5
- * REST API client for the V1 bitget Broker APIs. These are the previous generation of Bitget's APIs and should be considered deprecated.
6
- * These will be removed in a future release, once Bitget formally deprecates them.
7
- *
8
- * @deprecated use RestClientV2 instead
9
- */
10
- export declare class BrokerClient extends BaseRestClient {
11
- getClientType(): "broker";
12
- /**
13
- *
14
- * Sub Account Interface
15
- *
16
- */
17
- /** Get Broker Info */
18
- getBrokerInfo(): Promise<APIResponse<any>>;
19
- /** Create Sub Account */
20
- createSubAccount(subName: string, remark?: string): Promise<APIResponse<any>>;
21
- /** Get Sub List */
22
- getSubAccounts(params?: BrokerSubListRequest): Promise<APIResponse<any>>;
23
- /** Modify Sub Account */
24
- modifySubAccount(subUid: string, perm: string, status: 'normal' | 'freeze' | 'del'): Promise<APIResponse<any>>;
25
- /** Modify Sub Email */
26
- modifySubEmail(subUid: string, subEmail: string): Promise<APIResponse<any>>;
27
- /** Get Sub Email */
28
- getSubEmail(subUid: string): Promise<APIResponse<any>>;
29
- /** Get Sub Spot Assets */
30
- getSubSpotAssets(subUid: string): Promise<APIResponse<any>>;
31
- /** Get Sub Future Assets */
32
- getSubFutureAssets(subUid: string, productType: BrokerProductType): Promise<APIResponse<any>>;
33
- /** Get Sub Deposit Address (Only Broker) */
34
- getSubDepositAddress(subUid: string, coin: string, chain?: string): Promise<APIResponse<any>>;
35
- /** Sub Withdrawal (Only Broker) */
36
- subWithdrawal(params: BrokerSubWithdrawalRequest): Promise<APIResponse<any>>;
37
- /** Sub Deposit Auto Transfer (Only Broker) */
38
- setSubDepositAutoTransfer(subUid: string, coin: string, toAccountType: 'spot' | 'mix_usdt' | 'mix_usd' | 'mix_usdc'): Promise<APIResponse<any>>;
39
- /**
40
- *
41
- * Sub API Interface
42
- *
43
- */
44
- /** Create Sub ApiKey (Only Broker) */
45
- createSubAPIKey(subUid: string, passphrase: string, remark: string, ip: string, perm?: string): Promise<APIResponse<any>>;
46
- /** Get Sub ApiKey List */
47
- getSubAPIKeys(subUid: string): Promise<APIResponse<any>>;
48
- /** Modify Sub ApiKey (Only Broker) */
49
- modifySubAPIKey(params: BrokerSubAPIKeyModifyRequest): Promise<APIResponse<any>>;
50
- /**
51
- * Undocumented endpoints
52
- */
53
- getAgentCommissionDetail(params?: {
54
- startTime?: string;
55
- endTime?: string;
56
- limit?: string;
57
- idLessThan?: string;
58
- }): Promise<APIResponse<any>>;
59
- /** Get Agent Customer List */
60
- getAgentCustomerList(params?: {
61
- startTime?: string;
62
- endTime?: string;
63
- pageNo?: string;
64
- pageSize?: string;
65
- uid?: string;
66
- referralCode?: string;
67
- }): Promise<APIResponse<any>>;
68
- /**
69
- * Get Agent Customer Deposit List
70
- * Includes both on-chain deposits and internal transfers
71
- * Note: Can only query data within the last 90 days
72
- */
73
- getAgentCustomerDepositList(params?: {
74
- startTime?: string;
75
- endTime?: string;
76
- pageNo?: string;
77
- pageSize?: string;
78
- uid?: string;
79
- }): Promise<APIResponse<any>>;
80
- /**
81
- * Get Agent Customer Trade Volume List
82
- * Includes trading volume for both spot and futures
83
- * Note: Data updates every 10 minutes and can only query last 90 days
84
- */
85
- getAgentCustomerTradeVolumeList(params?: {
86
- startTime?: string;
87
- endTime?: string;
88
- pageNo?: string;
89
- pageSize?: string;
90
- uid?: string;
91
- }): Promise<APIResponse<any>>;
92
- /**
93
- * Get Agent Customer Assets List
94
- * Returns account balances for customer accounts
95
- * Note: Data updates every 10 minutes
96
- */
97
- getAgentCustomerAssetsList(params?: {
98
- pageNo?: string;
99
- pageSize?: string;
100
- uid?: string;
101
- }): Promise<APIResponse<any>>;
102
- /**
103
- * Get Agent Direct Commissions
104
- * Returns commission data for direct customers
105
- * Note: Data updates on T+1 (UTC+8) basis and can only query last 90 days
106
- */
107
- getAgentCustomerCommissions(params?: {
108
- startTime?: string;
109
- endTime?: string;
110
- idLessThan?: string;
111
- limit?: string;
112
- uid?: string;
113
- coin?: string;
114
- symbol?: string;
115
- }): Promise<APIResponse<any>>;
116
- /**
117
- * Get Agent Customer KYC Result
118
- * Returns KYC verification status for customers
119
- */
120
- getAgentCustomerKycResult(params?: {
121
- startTime?: string;
122
- endTime?: string;
123
- pageNo?: string;
124
- pageSize?: string;
125
- uid?: string;
126
- }): Promise<APIResponse<any>>;
127
- }
@@ -1,165 +0,0 @@
1
- "use strict";
2
- var __importDefault = (this && this.__importDefault) || function (mod) {
3
- return (mod && mod.__esModule) ? mod : { "default": mod };
4
- };
5
- Object.defineProperty(exports, "__esModule", { value: true });
6
- exports.BrokerClient = void 0;
7
- const BaseRestClient_js_1 = __importDefault(require("./util/BaseRestClient.js"));
8
- const requestUtils_js_1 = require("./util/requestUtils.js");
9
- /**
10
- * REST API client for the V1 bitget Broker APIs. These are the previous generation of Bitget's APIs and should be considered deprecated.
11
- * These will be removed in a future release, once Bitget formally deprecates them.
12
- *
13
- * @deprecated use RestClientV2 instead
14
- */
15
- class BrokerClient extends BaseRestClient_js_1.default {
16
- getClientType() {
17
- return requestUtils_js_1.REST_CLIENT_TYPE_ENUM.broker;
18
- }
19
- /**
20
- *
21
- * Sub Account Interface
22
- *
23
- */
24
- /** Get Broker Info */
25
- getBrokerInfo() {
26
- return this.getPrivate('/api/broker/v1/account/info');
27
- }
28
- /** Create Sub Account */
29
- createSubAccount(subName, remark) {
30
- return this.postPrivate('/api/broker/v1/account/sub-create', {
31
- subName,
32
- remark,
33
- });
34
- }
35
- /** Get Sub List */
36
- getSubAccounts(params) {
37
- return this.getPrivate('/api/broker/v1/account/sub-list', params);
38
- }
39
- /** Modify Sub Account */
40
- modifySubAccount(subUid, perm, status) {
41
- return this.postPrivate('/api/broker/v1/account/sub-modify', {
42
- subUid,
43
- perm,
44
- status,
45
- });
46
- }
47
- /** Modify Sub Email */
48
- modifySubEmail(subUid, subEmail) {
49
- return this.postPrivate('/api/broker/v1/account/sub-modify-email', {
50
- subUid,
51
- subEmail,
52
- });
53
- }
54
- /** Get Sub Email */
55
- getSubEmail(subUid) {
56
- return this.getPrivate('/api/broker/v1/account/sub-email', { subUid });
57
- }
58
- /** Get Sub Spot Assets */
59
- getSubSpotAssets(subUid) {
60
- return this.getPrivate('/api/broker/v1/account/sub-spot-assets', {
61
- subUid,
62
- });
63
- }
64
- /** Get Sub Future Assets */
65
- getSubFutureAssets(subUid, productType) {
66
- return this.getPrivate('/api/broker/v1/account/sub-future-assets', {
67
- subUid,
68
- productType,
69
- });
70
- }
71
- /** Get Sub Deposit Address (Only Broker) */
72
- getSubDepositAddress(subUid, coin, chain) {
73
- return this.postPrivate('/api/broker/v1/account/sub-address', {
74
- subUid,
75
- coin,
76
- chain,
77
- });
78
- }
79
- /** Sub Withdrawal (Only Broker) */
80
- subWithdrawal(params) {
81
- return this.postPrivate('/api/broker/v1/account/sub-withdrawal', params);
82
- }
83
- /** Sub Deposit Auto Transfer (Only Broker) */
84
- setSubDepositAutoTransfer(subUid, coin, toAccountType) {
85
- return this.postPrivate('/api/broker/v1/account/sub-auto-transfer', {
86
- subUid,
87
- coin,
88
- toAccountType,
89
- });
90
- }
91
- /**
92
- *
93
- * Sub API Interface
94
- *
95
- */
96
- /** Create Sub ApiKey (Only Broker) */
97
- createSubAPIKey(subUid, passphrase, remark, ip, perm) {
98
- return this.postPrivate('/api/broker/v1/manage/sub-api-create', {
99
- subUid,
100
- passphrase,
101
- remark,
102
- ip,
103
- perm,
104
- });
105
- }
106
- /** Get Sub ApiKey List */
107
- getSubAPIKeys(subUid) {
108
- return this.getPrivate('/api/broker/v1/manage/sub-api-list', { subUid });
109
- }
110
- /** Modify Sub ApiKey (Only Broker) */
111
- modifySubAPIKey(params) {
112
- return this.postPrivate('/api/broker/v1/manage/sub-api-modify', params);
113
- }
114
- /**
115
- * Undocumented endpoints
116
- */
117
- getAgentCommissionDetail(params) {
118
- return this.getPrivate('/api/broker/v1/agent/commission-distribution', params);
119
- }
120
- /** Get Agent Customer List */
121
- getAgentCustomerList(params) {
122
- return this.postPrivate('/api/broker/v1/agent/customerList', params);
123
- }
124
- /**
125
- * Get Agent Customer Deposit List
126
- * Includes both on-chain deposits and internal transfers
127
- * Note: Can only query data within the last 90 days
128
- */
129
- getAgentCustomerDepositList(params) {
130
- return this.postPrivate('/api/broker/v1/agent/customerDepositList', params);
131
- }
132
- /**
133
- * Get Agent Customer Trade Volume List
134
- * Includes trading volume for both spot and futures
135
- * Note: Data updates every 10 minutes and can only query last 90 days
136
- */
137
- getAgentCustomerTradeVolumeList(params) {
138
- return this.postPrivate('/api/broker/v1/agent/customerTradeVolumnList', params);
139
- }
140
- /**
141
- * Get Agent Customer Assets List
142
- * Returns account balances for customer accounts
143
- * Note: Data updates every 10 minutes
144
- */
145
- getAgentCustomerAssetsList(params) {
146
- return this.postPrivate('/api/broker/v1/agent/customerAccountAssetsList', params);
147
- }
148
- /**
149
- * Get Agent Direct Commissions
150
- * Returns commission data for direct customers
151
- * Note: Data updates on T+1 (UTC+8) basis and can only query last 90 days
152
- */
153
- getAgentCustomerCommissions(params) {
154
- return this.getPrivate('/api/broker/v1/agent/customer-commissions', params);
155
- }
156
- /**
157
- * Get Agent Customer KYC Result
158
- * Returns KYC verification status for customers
159
- */
160
- getAgentCustomerKycResult(params) {
161
- return this.getPrivate('/api/broker/v1/agent/customer-kyc-result', params);
162
- }
163
- }
164
- exports.BrokerClient = BrokerClient;
165
- //# sourceMappingURL=broker-client.js.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"broker-client.js","sourceRoot":"","sources":["../../src/broker-client.ts"],"names":[],"mappings":";;;;;;AAOA,iFAAsD;AACtD,4DAA+D;AAE/D;;;;;GAKG;AACH,MAAa,YAAa,SAAQ,2BAAc;IAC9C,aAAa;QACX,OAAO,uCAAqB,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;AAzPD,oCAyPC"}
@@ -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
- }