bitget-api 2.3.4 → 2.3.5

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 (5) hide show
  1. package/README.md +2 -2
  2. package/lib/broker-client.d.ts +68 -0
  3. package/lib/broker-client.js +43 -0
  4. package/lib/broker-client.js.map +1 -1
  5. package/package.json +1 -1
package/README.md CHANGED
@@ -86,7 +86,7 @@ Each REST API group has a dedicated REST client. To avoid confusion, here are th
86
86
  | Class | Description |
87
87
  |:------------------------------------: |:---------------------------------------------------------------------------------------------: |
88
88
  | [RestClientV2](src/rest-client-v2.ts) | [V2 REST APIs](https://www.bitget.com/api-doc/common/intro) |
89
- | [WebsocketClient](src/websocket-client-v2.ts) | Universal client for all Bitget's V2 Websockets |
89
+ | [WebsocketClientV2](src/websocket-client-v2.ts) | Universal client for all Bitget's V2 Websockets |
90
90
  | [~~SpotClient~~ (deprecated, use RestClientV2)](src/spot-client.ts) | [~~Spot APIs~~](https://bitgetlimited.github.io/apidoc/en/spot/#introduction) |
91
91
  | [~~FuturesClient~~ (deprecated, use RestClientV2)](src/futures-client.ts) | [~~Futures APIs~~](https://bitgetlimited.github.io/apidoc/en/mix/#introduction) |
92
92
  | [~~BrokerClient~~ (deprecated, use RestClientV2)](src/broker-client.ts) | [~~Broker APIs~~](https://bitgetlimited.github.io/apidoc/en/broker/#introduction) |
@@ -164,7 +164,7 @@ For more examples, including how to use websockets with Bitget, check the [examp
164
164
  Pass a custom logger which supports the log methods `silly`, `debug`, `notice`, `info`, `warning` and `error`, or override methods from the default logger as desired.
165
165
 
166
166
  ```javascript
167
- const { WebsocketClient, DefaultLogger } = require('bitget-api');
167
+ const { WebsocketClientV2, DefaultLogger } = require('bitget-api');
168
168
 
169
169
  // Disable all logging on the silly level (less console logs)
170
170
  const customLogger = {
package/lib/broker-client.d.ts CHANGED
@@ -55,4 +55,72 @@ export declare class BrokerClient extends BaseRestClient {
55
55
  limit?: string;
56
56
  idLessThan?: string;
57
57
  }): Promise<APIResponse<any>>;
58
+ /** Get Agent Customer List */
59
+ getAgentCustomerList(params?: {
60
+ startTime?: string;
61
+ endTime?: string;
62
+ pageNo?: string;
63
+ pageSize?: string;
64
+ uid?: string;
65
+ referralCode?: string;
66
+ }): Promise<APIResponse<any>>;
67
+ /**
68
+ * Get Agent Customer Deposit List
69
+ * Includes both on-chain deposits and internal transfers
70
+ * Note: Can only query data within the last 90 days
71
+ */
72
+ getAgentCustomerDepositList(params?: {
73
+ startTime?: string;
74
+ endTime?: string;
75
+ pageNo?: string;
76
+ pageSize?: string;
77
+ uid?: string;
78
+ }): Promise<APIResponse<any>>;
79
+ /**
80
+ * Get Agent Customer Trade Volume List
81
+ * Includes trading volume for both spot and futures
82
+ * Note: Data updates every 10 minutes and can only query last 90 days
83
+ */
84
+ getAgentCustomerTradeVolumeList(params?: {
85
+ startTime?: string;
86
+ endTime?: string;
87
+ pageNo?: string;
88
+ pageSize?: string;
89
+ uid?: string;
90
+ }): Promise<APIResponse<any>>;
91
+ /**
92
+ * Get Agent Customer Assets List
93
+ * Returns account balances for customer accounts
94
+ * Note: Data updates every 10 minutes
95
+ */
96
+ getAgentCustomerAssetsList(params?: {
97
+ pageNo?: string;
98
+ pageSize?: string;
99
+ uid?: string;
100
+ }): Promise<APIResponse<any>>;
101
+ /**
102
+ * Get Agent Direct Commissions
103
+ * Returns commission data for direct customers
104
+ * Note: Data updates on T+1 (UTC+8) basis and can only query last 90 days
105
+ */
106
+ getAgentCustomerCommissions(params?: {
107
+ startTime?: string;
108
+ endTime?: string;
109
+ idLessThan?: string;
110
+ limit?: string;
111
+ uid?: string;
112
+ coin?: string;
113
+ symbol?: string;
114
+ }): Promise<APIResponse<any>>;
115
+ /**
116
+ * Get Agent Customer KYC Result
117
+ * Returns KYC verification status for customers
118
+ */
119
+ getAgentCustomerKycResult(params?: {
120
+ startTime?: string;
121
+ endTime?: string;
122
+ pageNo?: string;
123
+ pageSize?: string;
124
+ uid?: string;
125
+ }): Promise<APIResponse<any>>;
58
126
  }
package/lib/broker-client.js CHANGED
@@ -117,6 +117,49 @@ class BrokerClient extends BaseRestClient_1.default {
117
117
  getAgentCommissionDetail(params) {
118
118
  return this.getPrivate('/api/broker/v1/agent/commission-distribution', params);
119
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
+ }
120
163
  }
121
164
  exports.BrokerClient = BrokerClient;
122
165
  //# sourceMappingURL=broker-client.js.map
package/lib/broker-client.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"broker-client.js","sourceRoot":"","sources":["../src/broker-client.ts"],"names":[],"mappings":";;;;;;AAOA,iCAA+C;AAC/C,2EAAmD;AAEnD;;;;;GAKG;AACH,MAAa,YAAa,SAAQ,wBAAc;IAC9C,aAAa;QACX,OAAO,4BAAqB,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;CACF;AA7JD,oCA6JC"}
1
+ {"version":3,"file":"broker-client.js","sourceRoot":"","sources":["../src/broker-client.ts"],"names":[],"mappings":";;;;;;AAOA,iCAA+C;AAC/C,2EAAmD;AAEnD;;;;;GAKG;AACH,MAAa,YAAa,SAAQ,wBAAc;IAC9C,aAAa;QACX,OAAO,4BAAqB,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"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "bitget-api",
3
- "version": "2.3.4",
3
+ "version": "2.3.5",
4
4
  "description": "Node.js & JavaScript SDK for Bitget REST APIs & WebSockets, with TypeScript & end-to-end tests.",
5
5
  "main": "lib/index.js",
6
6
  "types": "lib/index.d.ts",