bitget-api 1.0.5 → 1.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 +38 -13
- package/lib/constants/enum.d.ts +1 -0
- package/lib/constants/enum.js +1 -0
- package/lib/constants/enum.js.map +1 -1
- package/lib/futures-client.d.ts +8 -2
- package/lib/futures-client.js +21 -0
- package/lib/futures-client.js.map +1 -1
- package/lib/spot-client.d.ts +2 -2
- package/lib/spot-client.js.map +1 -1
- package/lib/types/request/futures.d.ts +1 -0
- package/lib/types/request/spot.d.ts +1 -0
- package/lib/types/shared.d.ts +3 -0
- package/lib/util/BaseRestClient.js +37 -3
- package/lib/util/BaseRestClient.js.map +1 -1
- package/lib/util/requestUtils.d.ts +7 -1
- package/lib/util/requestUtils.js +3 -2
- package/lib/util/requestUtils.js.map +1 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -4,12 +4,12 @@
|
|
|
4
4
|
[][1]
|
|
5
5
|
[](https://www.codefactor.io/repository/github/tiagosiebler/bitget-api) [](https://t.me/nodetraders)
|
|
6
6
|
|
|
7
|
-
|
|
8
7
|
[][1]
|
|
9
8
|
|
|
10
9
|
[1]: https://www.npmjs.com/package/bitget-api
|
|
11
10
|
|
|
12
11
|
Node.js connector for the Bitget APIs and WebSockets:
|
|
12
|
+
|
|
13
13
|
- Complete integration with all Bitget APIs.
|
|
14
14
|
- TypeScript support (with type declarations for most API requests & responses).
|
|
15
15
|
- Over 100 integration tests making real API calls & WebSocket connections, validating any changes before they reach npm.
|
|
@@ -18,14 +18,18 @@ Node.js connector for the Bitget APIs and WebSockets:
|
|
|
18
18
|
- Browser support (via webpack bundle - see "Browser Usage" below).
|
|
19
19
|
|
|
20
20
|
## Installation
|
|
21
|
+
|
|
21
22
|
`npm install --save bitget-api`
|
|
22
23
|
|
|
23
24
|
## Issues & Discussion
|
|
25
|
+
|
|
24
26
|
- Issues? Check the [issues tab](https://github.com/tiagosiebler/bitget-api/issues).
|
|
25
27
|
- Discuss & collaborate with other node devs? Join our [Node.js Algo Traders](https://t.me/nodetraders) engineering community on telegram.
|
|
26
28
|
|
|
27
29
|
## Related projects
|
|
30
|
+
|
|
28
31
|
Check out my related projects:
|
|
32
|
+
|
|
29
33
|
- Try my connectors:
|
|
30
34
|
- [binance](https://www.npmjs.com/package/binance)
|
|
31
35
|
- [bybit-api](https://www.npmjs.com/package/bybit-api)
|
|
@@ -38,13 +42,17 @@ Check out my related projects:
|
|
|
38
42
|
- [awesome-crypto-examples](https://github.com/tiagosiebler/awesome-crypto-examples)
|
|
39
43
|
|
|
40
44
|
## Documentation
|
|
45
|
+
|
|
41
46
|
Most methods pass values as-is into HTTP requests. These can be populated using parameters specified by Bitget's API documentation, or check the type definition in each class within this repository (see table below for convenient links to each class).
|
|
47
|
+
|
|
42
48
|
- [Bitget API Documentation](https://www.bitget.com/docs-v5/en/#rest-api).
|
|
43
49
|
|
|
44
50
|
## Structure
|
|
51
|
+
|
|
45
52
|
This connector is fully compatible with both TypeScript and pure JavaScript projects, while the connector is written in TypeScript. A pure JavaScript version can be built using `npm run build`, which is also the version published to [npm](https://www.npmjs.com/package/bitget-api).
|
|
46
53
|
|
|
47
54
|
The version on npm is the output from the `build` command and can be used in projects without TypeScript (although TypeScript is definitely recommended).
|
|
55
|
+
|
|
48
56
|
- [src](./src) - the whole connector written in TypeScript
|
|
49
57
|
- [lib](./lib) - the JavaScript version of the project (built from TypeScript). This should not be edited directly, as it will be overwritten with each release.
|
|
50
58
|
- [dist](./dist) - the webpack bundle of the project for use in browser environments (see guidance on webpack below).
|
|
@@ -53,22 +61,24 @@ The version on npm is the output from the `build` command and can be used in pro
|
|
|
53
61
|
---
|
|
54
62
|
|
|
55
63
|
## REST API Clients
|
|
64
|
+
|
|
56
65
|
Each REST API group has a dedicated REST client. To avoid confusion, here are the available REST clients and the corresponding API groups:
|
|
57
|
-
|
|
|
58
|
-
|:------------------------------------:
|
|
59
|
-
| [SpotClient](src/spot-client.ts)
|
|
60
|
-
| [FuturesClient](src/futures-client.ts)
|
|
61
|
-
| [BrokerClient](src/broker-client.ts)
|
|
62
|
-
| [WebsocketClient](src/websocket-client.ts)
|
|
66
|
+
| Class | Description |
|
|
67
|
+
|:------------------------------------: |:---------------------------------------------------------------------------------------------: |
|
|
68
|
+
| [SpotClient](src/spot-client.ts) | [Spot APIs](https://bitgetlimited.github.io/apidoc/en/spot/#introduction) |
|
|
69
|
+
| [FuturesClient](src/futures-client.ts) | [Futures APIs](https://bitgetlimited.github.io/apidoc/en/mix/#introduction) |
|
|
70
|
+
| [BrokerClient](src/broker-client.ts) | [Broker APIs](https://bitgetlimited.github.io/apidoc/en/broker/#introduction) |
|
|
71
|
+
| [WebsocketClient](src/websocket-client.ts) | Universal client for all Bitget's Websockets |
|
|
63
72
|
|
|
64
73
|
Examples for using each client can be found in:
|
|
74
|
+
|
|
65
75
|
- the [examples](./examples) folder.
|
|
66
76
|
- the [awesome-crypto-examples](https://github.com/tiagosiebler/awesome-crypto-examples) repository.
|
|
67
77
|
|
|
68
78
|
If you're missing an example, you're welcome to request one. Priority will be given to [github sponsors](https://github.com/sponsors/tiagosiebler).
|
|
69
79
|
|
|
70
|
-
|
|
71
80
|
### Usage
|
|
81
|
+
|
|
72
82
|
First, create API credentials on Bitget's website.
|
|
73
83
|
|
|
74
84
|
All REST clients have can be used in a similar way. However, method names, parameters and responses may vary depending on the API category you're using!
|
|
@@ -122,7 +132,10 @@ For more examples, including how to use websockets with bitget, check the [examp
|
|
|
122
132
|
|
|
123
133
|
---
|
|
124
134
|
|
|
125
|
-
##
|
|
135
|
+
## Logging
|
|
136
|
+
|
|
137
|
+
### Customise logging
|
|
138
|
+
|
|
126
139
|
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.
|
|
127
140
|
|
|
128
141
|
```javascript
|
|
@@ -133,16 +146,22 @@ DefaultLogger.silly = () => {};
|
|
|
133
146
|
|
|
134
147
|
const ws = new WebsocketClient(
|
|
135
148
|
{
|
|
136
|
-
|
|
137
|
-
|
|
138
|
-
|
|
149
|
+
apiKey: 'API_KEY',
|
|
150
|
+
apiSecret: 'API_SECRET',
|
|
151
|
+
apiPass: 'API_PASS',
|
|
139
152
|
},
|
|
140
|
-
DefaultLogger
|
|
153
|
+
DefaultLogger,
|
|
141
154
|
);
|
|
142
155
|
```
|
|
143
156
|
|
|
157
|
+
### Debug HTTP requests
|
|
158
|
+
|
|
159
|
+
In rare situations, you may want to see the raw HTTP requets being built as well as the API response. These can be enabled by setting the `BITGETTRACE` env var to `true`.
|
|
160
|
+
|
|
144
161
|
## Browser Usage
|
|
162
|
+
|
|
145
163
|
Build a bundle using webpack:
|
|
164
|
+
|
|
146
165
|
- `npm install`
|
|
147
166
|
- `npm build`
|
|
148
167
|
- `npm pack`
|
|
@@ -152,9 +171,13 @@ The bundle can be found in `dist/`. Altough usage should be largely consistent,
|
|
|
152
171
|
---
|
|
153
172
|
|
|
154
173
|
## Contributions & Thanks
|
|
174
|
+
|
|
155
175
|
### Donations
|
|
176
|
+
|
|
156
177
|
#### tiagosiebler
|
|
178
|
+
|
|
157
179
|
Support my efforts to make algo trading accessible to all - register with my referral links:
|
|
180
|
+
|
|
158
181
|
- [Bybit](https://www.bybit.com/en-US/register?affiliate_id=9410&language=en-US&group_id=0&group_type=1)
|
|
159
182
|
- [Binance](https://www.binance.com/en/register?ref=20983262)
|
|
160
183
|
- [Bitget](https://partner.bitget.com/bg/ZNM295)
|
|
@@ -162,10 +185,12 @@ Support my efforts to make algo trading accessible to all - register with my ref
|
|
|
162
185
|
- [FTX](https://ftx.com/referrals#a=ftxapigithub)
|
|
163
186
|
|
|
164
187
|
Or buy me a coffee using any of these:
|
|
188
|
+
|
|
165
189
|
- BTC: `1C6GWZL1XW3jrjpPTS863XtZiXL1aTK7Jk`
|
|
166
190
|
- ETH (ERC20): `0xd773d8e6a50758e1ada699bb6c4f98bb4abf82da`
|
|
167
191
|
|
|
168
192
|
### Contributions & Pull Requests
|
|
193
|
+
|
|
169
194
|
Contributions are encouraged, I will review any incoming pull requests. See the issues tab for todo items.
|
|
170
195
|
|
|
171
196
|
## Star History
|
package/lib/constants/enum.d.ts
CHANGED
|
@@ -13,6 +13,7 @@ export declare const API_ERROR_CODE: {
|
|
|
13
13
|
readonly QTY_LESS_THAN_MINIMUM: "43006";
|
|
14
14
|
/** Parameter verification exception margin mode == FIXED */
|
|
15
15
|
readonly PARAMETER_EXCEPTION: "40808";
|
|
16
|
+
readonly PLAN_ORDER_REACHED_UPPER_LIMIT: "40889";
|
|
16
17
|
readonly ORDER_NOT_FOUND: "43001";
|
|
17
18
|
readonly FUTURES_ORDER_TPSL_NOT_FOUND: "43020";
|
|
18
19
|
readonly PLAN_ORDER_NOT_FOUND: "43025";
|
package/lib/constants/enum.js
CHANGED
|
@@ -16,6 +16,7 @@ exports.API_ERROR_CODE = {
|
|
|
16
16
|
QTY_LESS_THAN_MINIMUM: '43006',
|
|
17
17
|
/** Parameter verification exception margin mode == FIXED */
|
|
18
18
|
PARAMETER_EXCEPTION: '40808',
|
|
19
|
+
PLAN_ORDER_REACHED_UPPER_LIMIT: '40889',
|
|
19
20
|
ORDER_NOT_FOUND: '43001',
|
|
20
21
|
FUTURES_ORDER_TPSL_NOT_FOUND: '43020',
|
|
21
22
|
PLAN_ORDER_NOT_FOUND: '43025',
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"enum.js","sourceRoot":"","sources":["../../src/constants/enum.ts"],"names":[],"mappings":";;;AAAa,QAAA,cAAc,GAAG;IAC5B,OAAO,EAAE,OAAO;IAChB,qBAAqB,EAAE,OAAO;IAC9B,uBAAuB,EAAE,OAAO;IAChC,gCAAgC,EAAE,OAAO;IACzC,kBAAkB,EAAE,OAAO;IAC3B,2BAA2B,EAAE,OAAO;IACpC,sBAAsB,EAAE,OAAO;IAC/B,oBAAoB,EAAE,OAAO;IAC7B,yBAAyB,EAAE,OAAO;IAClC,8BAA8B,EAAE,OAAO;IACvC,qCAAqC,EAAE,OAAO;IAC9C,qBAAqB,EAAE,OAAO;IAC9B,4DAA4D;IAC5D,mBAAmB,EAAE,OAAO;IAC5B,eAAe,EAAE,OAAO;IACxB,4BAA4B,EAAE,OAAO;IACrC,oBAAoB,EAAE,OAAO;CACrB,CAAC"}
|
|
1
|
+
{"version":3,"file":"enum.js","sourceRoot":"","sources":["../../src/constants/enum.ts"],"names":[],"mappings":";;;AAAa,QAAA,cAAc,GAAG;IAC5B,OAAO,EAAE,OAAO;IAChB,qBAAqB,EAAE,OAAO;IAC9B,uBAAuB,EAAE,OAAO;IAChC,gCAAgC,EAAE,OAAO;IACzC,kBAAkB,EAAE,OAAO;IAC3B,2BAA2B,EAAE,OAAO;IACpC,sBAAsB,EAAE,OAAO;IAC/B,oBAAoB,EAAE,OAAO;IAC7B,yBAAyB,EAAE,OAAO;IAClC,8BAA8B,EAAE,OAAO;IACvC,qCAAqC,EAAE,OAAO;IAC9C,qBAAqB,EAAE,OAAO;IAC9B,4DAA4D;IAC5D,mBAAmB,EAAE,OAAO;IAC5B,8BAA8B,EAAE,OAAO;IACvC,eAAe,EAAE,OAAO;IACxB,4BAA4B,EAAE,OAAO;IACrC,oBAAoB,EAAE,OAAO;CACrB,CAAC"}
|
package/lib/futures-client.d.ts
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { APIResponse,
|
|
1
|
+
import { APIResponse, FuturesProductType, FuturesAccountBillRequest, FuturesBusinessBillRequest, NewFuturesOrder, NewBatchFuturesOrder, FuturesPagination, NewFuturesPlanOrder, ModifyFuturesPlanOrder, ModifyFuturesPlanOrderTPSL, NewFuturesPlanPositionTPSL, ModifyFuturesPlanStopOrder, CancelFuturesPlanTPSL, HistoricPlanOrderTPSLRequest, NewFuturesPlanStopOrder, FuturesAccount, FuturesSymbolRule, FuturesMarginMode, FuturesPosition, NewFuturesPlanTrailingStopOrder, VIPFeeRate, GetHistoricTradesParams, FuturesMarketTrade, FuturesPlanType, FuturesKlineInterval } from './types';
|
|
2
2
|
import BaseRestClient from './util/BaseRestClient';
|
|
3
3
|
/**
|
|
4
4
|
* REST API client
|
|
@@ -29,7 +29,7 @@ export declare class FuturesClient extends BaseRestClient {
|
|
|
29
29
|
*/
|
|
30
30
|
getMarketTrades(symbol: string, limit?: string): Promise<APIResponse<FuturesMarketTrade[]>>;
|
|
31
31
|
/** Get Candle Data */
|
|
32
|
-
getCandles(symbol: string, granularity:
|
|
32
|
+
getCandles(symbol: string, granularity: FuturesKlineInterval, startTime: string, endTime: string, limit?: string): Promise<any>;
|
|
33
33
|
/** Get symbol index price */
|
|
34
34
|
getIndexPrice(symbol: string): Promise<APIResponse<any>>;
|
|
35
35
|
/** Get symbol next funding time */
|
|
@@ -44,6 +44,8 @@ export declare class FuturesClient extends BaseRestClient {
|
|
|
44
44
|
getMarkPrice(symbol: string): Promise<APIResponse<any>>;
|
|
45
45
|
/** Get symbol min/max leverage rules */
|
|
46
46
|
getLeverageMinMax(symbol: string): Promise<APIResponse<any>>;
|
|
47
|
+
/** Get Position Tier */
|
|
48
|
+
getPositionTier(symbol: string, productType: FuturesProductType): Promise<APIResponse<any>>;
|
|
47
49
|
/**
|
|
48
50
|
*
|
|
49
51
|
* Account Endpoints
|
|
@@ -70,8 +72,12 @@ export declare class FuturesClient extends BaseRestClient {
|
|
|
70
72
|
setHoldMode(productType: FuturesProductType, holdMode: 'single_hold' | 'double_hold'): Promise<APIResponse<any>>;
|
|
71
73
|
/** Get Symbol Position */
|
|
72
74
|
getPosition(symbol: string, marginCoin?: string): Promise<APIResponse<FuturesPosition[]>>;
|
|
75
|
+
/** Get Symbol Position V2 */
|
|
76
|
+
getPositionV2(symbol: string, marginCoin: string): Promise<APIResponse<FuturesPosition[]>>;
|
|
73
77
|
/** Get All Position */
|
|
74
78
|
getPositions(productType: FuturesProductType, marginCoin?: string): Promise<APIResponse<FuturesPosition[]>>;
|
|
79
|
+
/** Get All Position V2 */
|
|
80
|
+
getPositionsV2(productType: FuturesProductType, marginCoin?: string): Promise<APIResponse<FuturesPosition[]>>;
|
|
75
81
|
/** Get Account Bill */
|
|
76
82
|
getAccountBill(params: FuturesAccountBillRequest): Promise<APIResponse<any>>;
|
|
77
83
|
/** Get Business Account Bill */
|
package/lib/futures-client.js
CHANGED
|
@@ -95,6 +95,13 @@ class FuturesClient extends BaseRestClient_1.default {
|
|
|
95
95
|
getLeverageMinMax(symbol) {
|
|
96
96
|
return this.get('/api/mix/v1/market/symbol-leverage', { symbol });
|
|
97
97
|
}
|
|
98
|
+
/** Get Position Tier */
|
|
99
|
+
getPositionTier(symbol, productType) {
|
|
100
|
+
return this.get('/api/mix/v1/market/queryPositionLever', {
|
|
101
|
+
symbol,
|
|
102
|
+
productType,
|
|
103
|
+
});
|
|
104
|
+
}
|
|
98
105
|
/**
|
|
99
106
|
*
|
|
100
107
|
* Account Endpoints
|
|
@@ -170,6 +177,13 @@ class FuturesClient extends BaseRestClient_1.default {
|
|
|
170
177
|
marginCoin,
|
|
171
178
|
});
|
|
172
179
|
}
|
|
180
|
+
/** Get Symbol Position V2 */
|
|
181
|
+
getPositionV2(symbol, marginCoin) {
|
|
182
|
+
return this.getPrivate('/api/mix/v1/position/singlePosition-v2', {
|
|
183
|
+
symbol,
|
|
184
|
+
marginCoin,
|
|
185
|
+
});
|
|
186
|
+
}
|
|
173
187
|
/** Get All Position */
|
|
174
188
|
getPositions(productType, marginCoin) {
|
|
175
189
|
return this.getPrivate('/api/mix/v1/position/allPosition', {
|
|
@@ -177,6 +191,13 @@ class FuturesClient extends BaseRestClient_1.default {
|
|
|
177
191
|
marginCoin,
|
|
178
192
|
});
|
|
179
193
|
}
|
|
194
|
+
/** Get All Position V2 */
|
|
195
|
+
getPositionsV2(productType, marginCoin) {
|
|
196
|
+
return this.getPrivate('/api/mix/v1/position/allPosition-v2', {
|
|
197
|
+
productType,
|
|
198
|
+
marginCoin,
|
|
199
|
+
});
|
|
200
|
+
}
|
|
180
201
|
/** Get Account Bill */
|
|
181
202
|
getAccountBill(params) {
|
|
182
203
|
return this.getPrivate('/api/mix/v1/account/accountBill', params);
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"futures-client.js","sourceRoot":"","sources":["../src/futures-client.ts"],"names":[],"mappings":";;;;;;AA2BA,iCAA+C;AAC/C,2EAAmD;AAEnD;;GAEG;AACH,MAAa,aAAc,SAAQ,wBAAc;IAC/C,aAAa;QACX,OAAO,4BAAqB,CAAC,OAAO,CAAC;IACvC,CAAC;IAED;;;;OAIG;IAEH,+FAA+F;IAC/F,UAAU,CACR,WAA+B;QAE/B,OAAO,IAAI,CAAC,GAAG,CAAC,8BAA8B,EAAE,EAAE,WAAW,EAAE,CAAC,CAAC;IACnE,CAAC;IAED,gBAAgB;IAChB,QAAQ,CAAC,MAAc,EAAE,KAAc;QACrC,OAAO,IAAI,CAAC,GAAG,CAAC,0BAA0B,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC,CAAC;IACjE,CAAC;IAED,+BAA+B;IAC/B,SAAS,CAAC,MAAc;QACtB,OAAO,IAAI,CAAC,GAAG,CAAC,2BAA2B,EAAE,EAAE,MAAM,EAAE,CAAC,CAAC;IAC3D,CAAC;IAED,sBAAsB;IACtB,aAAa,CAAC,WAA+B;QAC3C,OAAO,IAAI,CAAC,GAAG,CAAC,4BAA4B,EAAE,EAAE,WAAW,EAAE,CAAC,CAAC;IACjE,CAAC;IAED,wBAAwB;IACxB,cAAc;QACZ,OAAO,IAAI,CAAC,GAAG,CAAC,uCAAuC,CAAC,CAAC;IAC3D,CAAC;IAED,yDAAyD;IACzD,eAAe,CACb,MAAc,EACd,KAAc;QAEd,OAAO,IAAI,CAAC,GAAG,CAAC,0BAA0B,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC,CAAC;IACjE,CAAC;IAED,wGAAwG;IACxG,iBAAiB,CACf,MAA+B;QAE/B,OAAO,IAAI,CAAC,GAAG,CAAC,kCAAkC,EAAE,MAAM,CAAC,CAAC;IAC9D,CAAC;IAED;;OAEG;IACH,eAAe,CACb,MAAc,EACd,KAAc;QAEd,OAAO,IAAI,CAAC,GAAG,CAAC,0BAA0B,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC,CAAC;IACjE,CAAC;IAED,sBAAsB;IACtB,UAAU,CACR,MAAc,EACd,
|
|
1
|
+
{"version":3,"file":"futures-client.js","sourceRoot":"","sources":["../src/futures-client.ts"],"names":[],"mappings":";;;;;;AA2BA,iCAA+C;AAC/C,2EAAmD;AAEnD;;GAEG;AACH,MAAa,aAAc,SAAQ,wBAAc;IAC/C,aAAa;QACX,OAAO,4BAAqB,CAAC,OAAO,CAAC;IACvC,CAAC;IAED;;;;OAIG;IAEH,+FAA+F;IAC/F,UAAU,CACR,WAA+B;QAE/B,OAAO,IAAI,CAAC,GAAG,CAAC,8BAA8B,EAAE,EAAE,WAAW,EAAE,CAAC,CAAC;IACnE,CAAC;IAED,gBAAgB;IAChB,QAAQ,CAAC,MAAc,EAAE,KAAc;QACrC,OAAO,IAAI,CAAC,GAAG,CAAC,0BAA0B,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC,CAAC;IACjE,CAAC;IAED,+BAA+B;IAC/B,SAAS,CAAC,MAAc;QACtB,OAAO,IAAI,CAAC,GAAG,CAAC,2BAA2B,EAAE,EAAE,MAAM,EAAE,CAAC,CAAC;IAC3D,CAAC;IAED,sBAAsB;IACtB,aAAa,CAAC,WAA+B;QAC3C,OAAO,IAAI,CAAC,GAAG,CAAC,4BAA4B,EAAE,EAAE,WAAW,EAAE,CAAC,CAAC;IACjE,CAAC;IAED,wBAAwB;IACxB,cAAc;QACZ,OAAO,IAAI,CAAC,GAAG,CAAC,uCAAuC,CAAC,CAAC;IAC3D,CAAC;IAED,yDAAyD;IACzD,eAAe,CACb,MAAc,EACd,KAAc;QAEd,OAAO,IAAI,CAAC,GAAG,CAAC,0BAA0B,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC,CAAC;IACjE,CAAC;IAED,wGAAwG;IACxG,iBAAiB,CACf,MAA+B;QAE/B,OAAO,IAAI,CAAC,GAAG,CAAC,kCAAkC,EAAE,MAAM,CAAC,CAAC;IAC9D,CAAC;IAED;;OAEG;IACH,eAAe,CACb,MAAc,EACd,KAAc;QAEd,OAAO,IAAI,CAAC,GAAG,CAAC,0BAA0B,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC,CAAC;IACjE,CAAC;IAED,sBAAsB;IACtB,UAAU,CACR,MAAc,EACd,WAAiC,EACjC,SAAiB,EACjB,OAAe,EACf,KAAc;QAEd,OAAO,IAAI,CAAC,GAAG,CAAC,4BAA4B,EAAE;YAC5C,MAAM;YACN,WAAW;YACX,SAAS;YACT,OAAO;YACP,KAAK;SACN,CAAC,CAAC;IACL,CAAC;IAED,6BAA6B;IAC7B,aAAa,CAAC,MAAc;QAC1B,OAAO,IAAI,CAAC,GAAG,CAAC,0BAA0B,EAAE,EAAE,MAAM,EAAE,CAAC,CAAC;IAC1D,CAAC;IAED,mCAAmC;IACnC,kBAAkB,CAAC,MAAc;QAC/B,OAAO,IAAI,CAAC,GAAG,CAAC,iCAAiC,EAAE,EAAE,MAAM,EAAE,CAAC,CAAC;IACjE,CAAC;IAED,wBAAwB;IACxB,sBAAsB,CACpB,MAAc,EACd,QAAiB,EACjB,MAAe,EACf,QAAkB;QAElB,OAAO,IAAI,CAAC,GAAG,CAAC,qCAAqC,EAAE;YACrD,MAAM;YACN,QAAQ;YACR,QAAQ;YACR,MAAM;SACP,CAAC,CAAC;IACL,CAAC;IAED,sCAAsC;IACtC,qBAAqB,CAAC,MAAc;QAClC,OAAO,IAAI,CAAC,GAAG,CAAC,qCAAqC,EAAE,EAAE,MAAM,EAAE,CAAC,CAAC;IACrE,CAAC;IAED,+BAA+B;IAC/B,eAAe,CAAC,MAAc;QAC5B,OAAO,IAAI,CAAC,GAAG,CAAC,kCAAkC,EAAE,EAAE,MAAM,EAAE,CAAC,CAAC;IAClE,CAAC;IAED,4BAA4B;IAC5B,YAAY,CAAC,MAAc;QACzB,OAAO,IAAI,CAAC,GAAG,CAAC,+BAA+B,EAAE,EAAE,MAAM,EAAE,CAAC,CAAC;IAC/D,CAAC;IAED,wCAAwC;IACxC,iBAAiB,CAAC,MAAc;QAC9B,OAAO,IAAI,CAAC,GAAG,CAAC,oCAAoC,EAAE,EAAE,MAAM,EAAE,CAAC,CAAC;IACpE,CAAC;IAED,wBAAwB;IACxB,eAAe,CACb,MAAc,EACd,WAA+B;QAE/B,OAAO,IAAI,CAAC,GAAG,CAAC,uCAAuC,EAAE;YACvD,MAAM;YACN,WAAW;SACZ,CAAC,CAAC;IACL,CAAC;IAED;;;;OAIG;IAEH,yBAAyB;IACzB,UAAU,CACR,MAAc,EACd,UAAkB;QAElB,OAAO,IAAI,CAAC,UAAU,CAAC,6BAA6B,EAAE;YACpD,MAAM;YACN,UAAU;SACX,CAAC,CAAC;IACL,CAAC;IAED,uBAAuB;IACvB,WAAW,CAAC,WAA+B;QACzC,OAAO,IAAI,CAAC,UAAU,CAAC,8BAA8B,EAAE,EAAE,WAAW,EAAE,CAAC,CAAC;IAC1E,CAAC;IAED,sCAAsC;IACtC,2BAA2B,CACzB,WAA+B;QAE/B,OAAO,IAAI,CAAC,WAAW,CAAC,iDAAiD,EAAE;YACzE,WAAW;SACZ,CAAC,CAAC;IACL,CAAC;IAED;;;OAGG;IACH,YAAY,CACV,MAAc,EACd,UAAkB,EAClB,SAAiB,EACjB,UAAkB,EAClB,QAAiB;QAEjB,OAAO,IAAI,CAAC,WAAW,CAAC,gCAAgC,EAAE;YACxD,MAAM;YACN,UAAU;YACV,SAAS;YACT,UAAU;YACV,QAAQ;SACT,CAAC,CAAC;IACL,CAAC;IAED,sBAAsB;IACtB,WAAW,CACT,MAAc,EACd,UAAkB,EAClB,QAAgB,EAChB,QAAiB;QAEjB,OAAO,IAAI,CAAC,WAAW,CAAC,iCAAiC,EAAE;YACzD,MAAM;YACN,UAAU;YACV,QAAQ;YACR,QAAQ;SACT,CAAC,CAAC;IACL,CAAC;IAED,oBAAoB;IACpB,SAAS,CACP,MAAc,EACd,UAAkB,EAClB,MAAc,EACd,QAAiB;QAEjB,OAAO,IAAI,CAAC,WAAW,CAAC,+BAA+B,EAAE;YACvD,MAAM;YACN,UAAU;YACV,MAAM;YACN,QAAQ;SACT,CAAC,CAAC;IACL,CAAC;IAED,yBAAyB;IACzB,aAAa,CACX,MAAc,EACd,UAAkB,EAClB,UAA6B;QAE7B,OAAO,IAAI,CAAC,WAAW,CAAC,mCAAmC,EAAE;YAC3D,MAAM;YACN,UAAU;YACV,UAAU;SACX,CAAC,CAAC;IACL,CAAC;IAED,uBAAuB;IACvB,WAAW,CACT,WAA+B,EAC/B,QAAuC;QAEvC,OAAO,IAAI,CAAC,WAAW,CAAC,qCAAqC,EAAE;YAC7D,WAAW;YACX,QAAQ;SACT,CAAC,CAAC;IACL,CAAC;IAED,0BAA0B;IAC1B,WAAW,CACT,MAAc,EACd,UAAmB;QAEnB,OAAO,IAAI,CAAC,UAAU,CAAC,qCAAqC,EAAE;YAC5D,MAAM;YACN,UAAU;SACX,CAAC,CAAC;IACL,CAAC;IAED,6BAA6B;IAC7B,aAAa,CACX,MAAc,EACd,UAAkB;QAElB,OAAO,IAAI,CAAC,UAAU,CAAC,wCAAwC,EAAE;YAC/D,MAAM;YACN,UAAU;SACX,CAAC,CAAC;IACL,CAAC;IAED,uBAAuB;IACvB,YAAY,CACV,WAA+B,EAC/B,UAAmB;QAEnB,OAAO,IAAI,CAAC,UAAU,CAAC,kCAAkC,EAAE;YACzD,WAAW;YACX,UAAU;SACX,CAAC,CAAC;IACL,CAAC;IAED,0BAA0B;IAC1B,cAAc,CACZ,WAA+B,EAC/B,UAAmB;QAEnB,OAAO,IAAI,CAAC,UAAU,CAAC,qCAAqC,EAAE;YAC5D,WAAW;YACX,UAAU;SACX,CAAC,CAAC;IACL,CAAC;IAED,uBAAuB;IACvB,cAAc,CAAC,MAAiC;QAC9C,OAAO,IAAI,CAAC,UAAU,CAAC,iCAAiC,EAAE,MAAM,CAAC,CAAC;IACpE,CAAC;IAED,gCAAgC;IAChC,eAAe,CACb,MAAkC;QAElC,OAAO,IAAI,CAAC,UAAU,CAAC,yCAAyC,EAAE,MAAM,CAAC,CAAC;IAC5E,CAAC;IAED;;;;OAIG;IAEH,kBAAkB;IAClB,WAAW,CAAC,MAAuB;QACjC,OAAO,IAAI,CAAC,WAAW,CAAC,8BAA8B,EAAE,MAAM,CAAC,CAAC;IAClE,CAAC;IAED,kBAAkB;IAClB,gBAAgB,CACd,MAAc,EACd,UAAkB,EAClB,MAA8B;QAE9B,OAAO,IAAI,CAAC,WAAW,CAAC,gCAAgC,EAAE;YACxD,MAAM;YACN,UAAU;YACV,aAAa,EAAE,MAAM;SACtB,CAAC,CAAC;IACL,CAAC;IAED,mBAAmB;IACnB,WAAW,CACT,MAAc,EACd,UAAkB,EAClB,OAAgB,EAChB,SAAkB;QAElB,OAAO,IAAI,CAAC,WAAW,CAAC,gCAAgC,EAAE;YACxD,MAAM;YACN,UAAU;YACV,OAAO;YACP,SAAS;SACV,CAAC,CAAC;IACL,CAAC;IAED,yBAAyB;IACzB,gBAAgB,CACd,MAAc,EACd,UAAkB,EAClB,QAAkB;QAElB,OAAO,IAAI,CAAC,WAAW,CAAC,uCAAuC,EAAE;YAC/D,MAAM;YACN,UAAU;YACV,QAAQ;SACT,CAAC,CAAC;IACL,CAAC;IAED;;OAEG;IACH,kBAAkB,CAChB,MAAc,EACd,UAAkB;QAElB,OAAO,IAAI,CAAC,WAAW,CAAC,wCAAwC,EAAE;YAChE,MAAM;YACN,UAAU;SACX,CAAC,CAAC;IACL,CAAC;IAED,uBAAuB;IACvB,eAAe,CACb,WAA+B,EAC/B,UAAkB;QAElB,OAAO,IAAI,CAAC,WAAW,CAAC,qCAAqC,EAAE;YAC7D,WAAW;YACX,UAAU;SACX,CAAC,CAAC;IACL,CAAC;IAED,qBAAqB;IACrB,mBAAmB,CAAC,MAAc;QAChC,OAAO,IAAI,CAAC,UAAU,CAAC,2BAA2B,EAAE,EAAE,MAAM,EAAE,CAAC,CAAC;IAClE,CAAC;IAED,yBAAyB;IACzB,aAAa,CACX,WAA+B,EAC/B,UAAkB;QAElB,OAAO,IAAI,CAAC,UAAU,CAAC,qCAAqC,EAAE;YAC5D,WAAW;YACX,UAAU;SACX,CAAC,CAAC;IACL,CAAC;IAED,yBAAyB;IACzB,eAAe,CACb,MAAc,EACd,SAAiB,EACjB,OAAe,EACf,QAAgB,EAChB,SAAkB,EAClB,KAAe,EACf,SAAkB;QAElB,OAAO,IAAI,CAAC,UAAU,CAAC,2BAA2B,EAAE;YAClD,MAAM;YACN,SAAS;YACT,OAAO;YACP,QAAQ;YACR,SAAS;YACT,KAAK;YACL,SAAS;SACV,CAAC,CAAC;IACL,CAAC;IAED,qCAAqC;IACrC,0BAA0B,CACxB,WAA+B,EAC/B,SAAiB,EACjB,OAAe,EACf,QAAgB,EAChB,SAAkB,EAClB,KAAe,EACf,SAAkB;QAElB,OAAO,IAAI,CAAC,UAAU,CAAC,sCAAsC,EAAE;YAC7D,WAAW;YACX,SAAS;YACT,OAAO;YACP,QAAQ;YACR,SAAS;YACT,KAAK;YACL,SAAS;SACV,CAAC,CAAC;IACL,CAAC;IAED,wBAAwB;IACxB,QAAQ,CACN,MAAc,EACd,OAAgB,EAChB,SAAkB;QAElB,OAAO,IAAI,CAAC,UAAU,CAAC,0BAA0B,EAAE;YACjD,MAAM;YACN,OAAO;YACP,SAAS;SACV,CAAC,CAAC;IACL,CAAC;IAED,iDAAiD;IACjD,aAAa,CACX,MAAc,EACd,OAAgB,EAChB,UAA8B;QAE9B,OAAO,IAAI,CAAC,UAAU,CAAC,yBAAyB,kBAC9C,MAAM;YACN,OAAO,IACJ,UAAU,EACb,CAAC;IACL,CAAC;IAED,wCAAwC;IACxC,wBAAwB,CACtB,WAA+B,EAC/B,UAA8B;QAE9B,OAAO,IAAI,CAAC,UAAU,CAAC,4BAA4B,kBACjD,WAAW,EAAE,WAAW,CAAC,WAAW,EAAE,IACnC,UAAU,EACb,CAAC;IACL,CAAC;IAED,uBAAuB;IACvB,eAAe,CAAC,MAA2B;QACzC,OAAO,IAAI,CAAC,WAAW,CAAC,4BAA4B,EAAE,MAAM,CAAC,CAAC;IAChE,CAAC;IAED,wBAAwB;IACxB,eAAe,CAAC,MAA8B;QAC5C,OAAO,IAAI,CAAC,WAAW,CAAC,6BAA6B,EAAE,MAAM,CAAC,CAAC;IACjE,CAAC;IAED,6BAA6B;IAC7B,mBAAmB,CACjB,MAAkC;QAElC,OAAO,IAAI,CAAC,WAAW,CAAC,mCAAmC,EAAE,MAAM,CAAC,CAAC;IACvE,CAAC;IAED,uBAAuB;IACvB,eAAe,CAAC,MAA+B;QAC7C,OAAO,IAAI,CAAC,WAAW,CAAC,4BAA4B,EAAE,MAAM,CAAC,CAAC;IAChE,CAAC;IAED,gCAAgC;IAChC,uBAAuB,CACrB,MAAuC;QAEvC,OAAO,IAAI,CAAC,WAAW,CAAC,iCAAiC,EAAE,MAAM,CAAC,CAAC;IACrE,CAAC;IAED,0BAA0B;IAC1B,kBAAkB,CAChB,MAAkC;QAElC,OAAO,IAAI,CAAC,WAAW,CAAC,qCAAqC,EAAE,MAAM,CAAC,CAAC;IACzE,CAAC;IAED,wBAAwB;IACxB,eAAe,CACb,MAAkC;QAElC,OAAO,IAAI,CAAC,WAAW,CAAC,iCAAiC,EAAE,MAAM,CAAC,CAAC;IACrE,CAAC;IAED,6BAA6B;IAC7B,mBAAmB,CACjB,MAA6B;QAE7B,OAAO,IAAI,CAAC,WAAW,CAAC,6BAA6B,EAAE,MAAM,CAAC,CAAC;IACjE,CAAC;IAED,sCAAsC;IACtC,mBAAmB,CACjB,WAA+B,EAC/B,QAAyB;QAEzB,OAAO,IAAI,CAAC,WAAW,CAAC,gCAAgC,EAAE;YACxD,WAAW;YACX,QAAQ;SACT,CAAC,CAAC;IACL,CAAC;IAED,iCAAiC;IACjC,iBAAiB,CACf,MAAc,EACd,MAAe,EACf,WAAgC;QAEhC,OAAO,IAAI,CAAC,UAAU,CAAC,8BAA8B,EAAE;YACrD,MAAM;YACN,MAAM;YACN,WAAW;SACZ,CAAC,CAAC;IACL,CAAC;IAED,qCAAqC;IACrC,yBAAyB,CACvB,MAAoC;QAEpC,OAAO,IAAI,CAAC,UAAU,CAAC,8BAA8B,EAAE,MAAM,CAAC,CAAC;IACjE,CAAC;IAED;;;;OAIG;IAEH,4BAA4B;IAC5B,sBAAsB,CACpB,MAAc,EACd,WAA+B,EAC/B,QAAgB,EAChB,MAAc;QAEd,OAAO,IAAI,CAAC,UAAU,CAAC,gCAAgC,EAAE;YACvD,MAAM;YACN,WAAW;YACX,QAAQ;YACR,MAAM;SACP,CAAC,CAAC;IACL,CAAC;IAED,+BAA+B;IAC/B,yBAAyB,CACvB,MAAc,EACd,WAA+B,EAC/B,QAAgB,EAChB,MAAc;QAEd,OAAO,IAAI,CAAC,UAAU,CAAC,iCAAiC,EAAE;YACxD,MAAM;YACN,WAAW;YACX,QAAQ;YACR,MAAM;SACP,CAAC,CAAC;IACL,CAAC;IAED,4BAA4B;IAC5B,uBAAuB,CACrB,MAAc,EACd,UAAkB;QAElB,OAAO,IAAI,CAAC,WAAW,CAAC,mCAAmC,EAAE;YAC3D,MAAM;YACN,UAAU;SACX,CAAC,CAAC;IACL,CAAC;IAED,yBAAyB;IACzB,oBAAoB,CAClB,MAAc,EACd,UAAkB,EAClB,OAGC;QAED,OAAO,IAAI,CAAC,WAAW,CAAC,8BAA8B,kBACpD,MAAM;YACN,UAAU,IACP,OAAO,EACV,CAAC;IACL,CAAC;IAED,iCAAiC;IACjC,yBAAyB,CACvB,SAAiB,EACjB,OAAe,EACf,QAAgB,EAChB,MAAc;QAEd,OAAO,IAAI,CAAC,UAAU,CAAC,gCAAgC,EAAE;YACvD,SAAS;YACT,OAAO;YACP,QAAQ;YACR,MAAM;SACP,CAAC,CAAC;IACL,CAAC;IAED,gCAAgC;IAChC,0BAA0B;QACxB,OAAO,IAAI,CAAC,UAAU,CAAC,2BAA2B,CAAC,CAAC;IACtD,CAAC;IAED,2EAA2E;IAC3E,kCAAkC;QAChC,OAAO,IAAI,CAAC,UAAU,CAAC,4CAA4C,CAAC,CAAC;IACvE,CAAC;IAED,oFAAoF;IACpF,wCAAwC,CACtC,UAAkB,EAClB,MAAc,EACd,QAAgB,EAChB,MAAc;QAEd,OAAO,IAAI,CAAC,UAAU,CAAC,uCAAuC,EAAE;YAC9D,UAAU;YACV,IAAI,EAAE,MAAM;YACZ,QAAQ;YACR,MAAM;SACP,CAAC,CAAC;IACL,CAAC;IAED,uCAAuC;IACvC,iCAAiC,CAC/B,UAAkB,EAClB,MAAc,EACd,QAAgB,EAChB,MAAc;QAEd,OAAO,IAAI,CAAC,UAAU,CAAC,kCAAkC,EAAE;YACzD,UAAU;YACV,IAAI,EAAE,MAAM;YACZ,QAAQ;YACR,MAAM;SACP,CAAC,CAAC;IACL,CAAC;IAED,iCAAiC;IACjC,0BAA0B,CACxB,QAAgB,EAChB,MAAc;QAEd,OAAO,IAAI,CAAC,UAAU,CAAC,sCAAsC,EAAE;YAC7D,QAAQ;YACR,MAAM;SACP,CAAC,CAAC;IACL,CAAC;IAED,4BAA4B;IAC5B,oBAAoB;QAClB,OAAO,IAAI,CAAC,UAAU,CAAC,iCAAiC,CAAC,CAAC;IAC5D,CAAC;IAED,qCAAqC;IACrC,oBAAoB,CAClB,MAAc,EACd,SAA2B;QAE3B,OAAO,IAAI,CAAC,WAAW,CAAC,oCAAoC,EAAE;YAC5D,MAAM;YACN,SAAS;SACV,CAAC,CAAC;IACL,CAAC;CACF;AArrBD,sCAqrBC"}
|
package/lib/spot-client.d.ts
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { NewBatchSpotOrder, NewSpotOrder, NewWalletTransfer, Pagination, APIResponse,
|
|
1
|
+
import { NewBatchSpotOrder, NewSpotOrder, NewWalletTransfer, Pagination, APIResponse, CoinBalance, SymbolRules, NewSpotSubTransfer, NewSpotWithdraw, CancelSpotOrderV2, BatchCancelSpotOrderV2, SpotOrderResult, NewSpotPlanOrder, ModifySpotPlanOrder, CancelSpotPlanOrderParams, GetSpotPlanOrdersParams, SpotPlanOrder, GetHistoricPlanOrdersParams, SpotMarketTrade, GetHistoricTradesParams, VIPFeeRate, SpotKlineInterval } from './types';
|
|
2
2
|
import BaseRestClient from './util/BaseRestClient';
|
|
3
3
|
/**
|
|
4
4
|
* REST API client
|
|
@@ -37,7 +37,7 @@ export declare class SpotClient extends BaseRestClient {
|
|
|
37
37
|
*/
|
|
38
38
|
getMarketTrades(symbol: string, limit?: string): Promise<APIResponse<SpotMarketTrade[]>>;
|
|
39
39
|
/** Get Candle Data */
|
|
40
|
-
getCandles(symbol: string, period:
|
|
40
|
+
getCandles(symbol: string, period: SpotKlineInterval, pagination?: Pagination): Promise<APIResponse<any>>;
|
|
41
41
|
/** Get Depth */
|
|
42
42
|
getDepth(symbol: string, type: 'step0' | 'step1' | 'step2' | 'step3' | 'step4' | 'step5', limit?: string): Promise<APIResponse<any>>;
|
|
43
43
|
/** Get VIP fee rates */
|
package/lib/spot-client.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"spot-client.js","sourceRoot":"","sources":["../src/spot-client.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAwBA,iCAA+C;AAC/C,2EAAmD;AAEnD;;GAEG;AACH,MAAa,UAAW,SAAQ,wBAAc;IAC5C,aAAa;QACX,OAAO,4BAAqB,CAAC,IAAI,CAAC;IACpC,CAAC;IAEK,eAAe;;YACnB,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,aAAa,EAAE,CAAC;YACvC,OAAO,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;QAC1B,CAAC;KAAA;IAED;;;;OAIG;IAEH,sBAAsB;IACtB,aAAa;QACX,OAAO,IAAI,CAAC,GAAG,CAAC,0BAA0B,CAAC,CAAC;IAC9C,CAAC;IAED,gEAAgE;IAChE,QAAQ;QACN,OAAO,IAAI,CAAC,GAAG,CAAC,gCAAgC,CAAC,CAAC;IACpD,CAAC;IAED,+FAA+F;IAC/F,UAAU;QACR,OAAO,IAAI,CAAC,GAAG,CAAC,8BAA8B,CAAC,CAAC;IAClD,CAAC;IAED,6EAA6E;IAC7E,SAAS,CAAC,MAAc;QACtB,OAAO,IAAI,CAAC,GAAG,CAAC,6BAA6B,EAAE,EAAE,MAAM,EAAE,CAAC,CAAC;IAC7D,CAAC;IAED;;;;OAIG;IAEH,wBAAwB;IACxB,SAAS,CAAC,MAAc;QACtB,OAAO,IAAI,CAAC,GAAG,CAAC,4BAA4B,EAAE,EAAE,MAAM,EAAE,CAAC,CAAC;IAC5D,CAAC;IAED,sBAAsB;IACtB,aAAa;QACX,OAAO,IAAI,CAAC,GAAG,CAAC,6BAA6B,CAAC,CAAC;IACjD,CAAC;IAED,yDAAyD;IACzD,eAAe,CACb,MAAc,EACd,KAAc;QAEd,OAAO,IAAI,CAAC,GAAG,CAAC,2BAA2B,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC,CAAC;IAClE,CAAC;IAED,wGAAwG;IACxG,iBAAiB,CACf,MAA+B;QAE/B,OAAO,IAAI,CAAC,GAAG,CAAC,mCAAmC,EAAE,MAAM,CAAC,CAAC;IAC/D,CAAC;IAED;;OAEG;IACH,eAAe,CACb,MAAc,EACd,KAAc;QAEd,OAAO,IAAI,CAAC,GAAG,CAAC,2BAA2B,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC,CAAC;IAClE,CAAC;IAED,sBAAsB;IACtB,UAAU,CACR,MAAc,EACd,
|
|
1
|
+
{"version":3,"file":"spot-client.js","sourceRoot":"","sources":["../src/spot-client.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAwBA,iCAA+C;AAC/C,2EAAmD;AAEnD;;GAEG;AACH,MAAa,UAAW,SAAQ,wBAAc;IAC5C,aAAa;QACX,OAAO,4BAAqB,CAAC,IAAI,CAAC;IACpC,CAAC;IAEK,eAAe;;YACnB,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,aAAa,EAAE,CAAC;YACvC,OAAO,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;QAC1B,CAAC;KAAA;IAED;;;;OAIG;IAEH,sBAAsB;IACtB,aAAa;QACX,OAAO,IAAI,CAAC,GAAG,CAAC,0BAA0B,CAAC,CAAC;IAC9C,CAAC;IAED,gEAAgE;IAChE,QAAQ;QACN,OAAO,IAAI,CAAC,GAAG,CAAC,gCAAgC,CAAC,CAAC;IACpD,CAAC;IAED,+FAA+F;IAC/F,UAAU;QACR,OAAO,IAAI,CAAC,GAAG,CAAC,8BAA8B,CAAC,CAAC;IAClD,CAAC;IAED,6EAA6E;IAC7E,SAAS,CAAC,MAAc;QACtB,OAAO,IAAI,CAAC,GAAG,CAAC,6BAA6B,EAAE,EAAE,MAAM,EAAE,CAAC,CAAC;IAC7D,CAAC;IAED;;;;OAIG;IAEH,wBAAwB;IACxB,SAAS,CAAC,MAAc;QACtB,OAAO,IAAI,CAAC,GAAG,CAAC,4BAA4B,EAAE,EAAE,MAAM,EAAE,CAAC,CAAC;IAC5D,CAAC;IAED,sBAAsB;IACtB,aAAa;QACX,OAAO,IAAI,CAAC,GAAG,CAAC,6BAA6B,CAAC,CAAC;IACjD,CAAC;IAED,yDAAyD;IACzD,eAAe,CACb,MAAc,EACd,KAAc;QAEd,OAAO,IAAI,CAAC,GAAG,CAAC,2BAA2B,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC,CAAC;IAClE,CAAC;IAED,wGAAwG;IACxG,iBAAiB,CACf,MAA+B;QAE/B,OAAO,IAAI,CAAC,GAAG,CAAC,mCAAmC,EAAE,MAAM,CAAC,CAAC;IAC/D,CAAC;IAED;;OAEG;IACH,eAAe,CACb,MAAc,EACd,KAAc;QAEd,OAAO,IAAI,CAAC,GAAG,CAAC,2BAA2B,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC,CAAC;IAClE,CAAC;IAED,sBAAsB;IACtB,UAAU,CACR,MAAc,EACd,MAAyB,EACzB,UAAuB;QAEvB,OAAO,IAAI,CAAC,GAAG,CAAC,6BAA6B,kBAC3C,MAAM;YACN,MAAM,IACH,UAAU,EACb,CAAC;IACL,CAAC;IAED,gBAAgB;IAChB,QAAQ,CACN,MAAc,EACd,IAA+D,EAC/D,KAAc;QAEd,OAAO,IAAI,CAAC,GAAG,CAAC,2BAA2B,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC,CAAC;IACxE,CAAC;IAED,wBAAwB;IACxB,cAAc;QACZ,OAAO,IAAI,CAAC,GAAG,CAAC,oCAAoC,CAAC,CAAC;IACxD,CAAC;IAED;;;;OAIG;IAEH,+BAA+B;IAC/B,QAAQ,CAAC,MAAyB;QAChC,OAAO,IAAI,CAAC,WAAW,CAAC,8BAA8B,EAAE,MAAM,CAAC,CAAC;IAClE,CAAC;IAED,6CAA6C;IAC7C,UAAU,CAAC,MAAyB;QAClC,OAAO,IAAI,CAAC,WAAW,CAAC,iCAAiC,EAAE,MAAM,CAAC,CAAC;IACrE,CAAC;IAED;;OAEG;IACH,WAAW,CAAC,MAA0B;QACpC,OAAO,IAAI,CAAC,WAAW,CAAC,iCAAiC,EAAE,MAAM,CAAC,CAAC;IACrE,CAAC;IAED,uBAAuB;IACvB,iBAAiB,CAAC,IAAY,EAAE,KAAc;QAC5C,OAAO,IAAI,CAAC,UAAU,CAAC,qCAAqC,EAAE;YAC5D,IAAI;YACJ,KAAK;SACN,CAAC,CAAC;IACL,CAAC;IAED,8BAA8B;IAC9B,QAAQ,CAAC,MAAuB;QAC9B,OAAO,IAAI,CAAC,WAAW,CAAC,gCAAgC,EAAE,MAAM,CAAC,CAAC;IACpE,CAAC;IAED,4CAA4C;IAC5C,UAAU,CAAC,MAAuB;QAChC,OAAO,IAAI,CAAC,WAAW,CAAC,mCAAmC,EAAE,MAAM,CAAC,CAAC;IACvE,CAAC;IAED,4FAA4F;IAC5F,aAAa,CACX,IAAY,EACZ,KAAa,EACb,MAAc,EACd,SAAkB;QAElB,OAAO,IAAI,CAAC,WAAW,CAAC,sCAAsC,EAAE;YAC9D,IAAI;YACJ,KAAK;YACL,MAAM;YACN,SAAS;SACV,CAAC,CAAC;IACL,CAAC;IAED,0GAA0G;IAC1G,eAAe,CACb,IAAY,EACZ,KAAa,EACb,MAAc,EACd,SAAkB;QAElB,OAAO,IAAI,CAAC,WAAW,CAAC,yCAAyC,EAAE;YACjE,IAAI;YACJ,KAAK;YACL,MAAM;YACN,SAAS;SACV,CAAC,CAAC;IACL,CAAC;IAED,wBAAwB;IACxB,cAAc,CACZ,IAAY,EACZ,SAAiB,EACjB,OAAe,EACf,QAAiB,EACjB,MAAe,EACf,SAAkB;QAElB,OAAO,IAAI,CAAC,UAAU,CAAC,qCAAqC,EAAE;YAC5D,IAAI;YACJ,SAAS;YACT,OAAO;YACP,QAAQ;YACR,MAAM;YACN,SAAS;SACV,CAAC,CAAC;IACL,CAAC;IAED,uBAAuB;IACvB,WAAW,CACT,IAAY,EACZ,SAAiB,EACjB,OAAe,EACf,QAAiB,EACjB,MAAe;QAEf,OAAO,IAAI,CAAC,UAAU,CAAC,kCAAkC,EAAE;YACzD,IAAI;YACJ,SAAS;YACT,OAAO;YACP,QAAQ;YACR,MAAM;SACP,CAAC,CAAC;IACL,CAAC;IAED;;;;OAIG;IAEH,sBAAsB;IACtB,aAAa;QACX,OAAO,IAAI,CAAC,UAAU,CAAC,8BAA8B,CAAC,CAAC;IACzD,CAAC;IAED,uCAAuC;IACvC,UAAU,CAAC,IAAa;QACtB,OAAO,IAAI,CAAC,UAAU,CAAC,6BAA6B,EAAE,EAAE,IAAI,EAAE,CAAC,CAAC;IAClE,CAAC;IAED,iCAAiC;IACjC,uBAAuB;QACrB,OAAO,IAAI,CAAC,WAAW,CAAC,8CAA8C,CAAC,CAAC;IAC1E,CAAC;IAED,8CAA8C;IAC9C,qBAAqB,CAAC,MAOrB;QACC,OAAO,IAAI,CAAC,WAAW,CAAC,4BAA4B,EAAE,MAAM,CAAC,CAAC;IAChE,CAAC;IAED,wBAAwB;IACxB,kBAAkB,CAAC,MAOlB;QACC,OAAO,IAAI,CAAC,UAAU,CAAC,sCAAsC,EAAE,MAAM,CAAC,CAAC;IACzE,CAAC;IAED;;;;OAIG;IAEH,kBAAkB;IAClB,WAAW,CAAC,MAAoB;QAC9B,OAAO,IAAI,CAAC,WAAW,CAAC,2BAA2B,EAAE,MAAM,CAAC,CAAC;IAC/D,CAAC;IAED,kDAAkD;IAClD,gBAAgB,CACd,MAAc,EACd,SAA8B;QAE9B,OAAO,IAAI,CAAC,WAAW,CAAC,iCAAiC,EAAE;YACzD,MAAM;YACN,SAAS;SACV,CAAC,CAAC;IACL,CAAC;IAED,mBAAmB;IACnB,WAAW,CAAC,MAAc,EAAE,OAAe;QACzC,OAAO,IAAI,CAAC,WAAW,CAAC,iCAAiC,EAAE;YACzD,MAAM;YACN,OAAO;SACR,CAAC,CAAC;IACL,CAAC;IAED,iEAAiE;IACjE,aAAa,CAAC,MAA0B;QACtC,OAAO,IAAI,CAAC,WAAW,CAAC,oCAAoC,EAAE,MAAM,CAAC,CAAC;IACxE,CAAC;IAED;;OAEG;IACH,kBAAkB,CAAC,MAAc;QAC/B,OAAO,IAAI,CAAC,WAAW,CAAC,wCAAwC,EAAE;YAChE,MAAM;SACP,CAAC,CAAC;IACL,CAAC;IAED,yCAAyC;IACzC,gBAAgB,CACd,MAAc,EACd,QAAkB;QAElB,OAAO,IAAI,CAAC,WAAW,CAAC,wCAAwC,EAAE;YAChE,MAAM;YACN,QAAQ;SACT,CAAC,CAAC;IACL,CAAC;IAED,wFAAwF;IACxF,kBAAkB,CAChB,MAA8B;QAE9B,OAAO,IAAI,CAAC,WAAW,CACrB,2CAA2C,EAC3C,MAAM,CACP,CAAC;IACJ,CAAC;IAED,wBAAwB;IACxB,QAAQ,CACN,MAAc,EACd,OAAe,EACf,aAAsB;QAEtB,OAAO,IAAI,CAAC,WAAW,CAAC,8BAA8B,EAAE;YACtD,MAAM;YACN,OAAO;YACP,aAAa;SACd,CAAC,CAAC;IACL,CAAC;IAED,mCAAmC;IACnC,aAAa,CAAC,MAAe;QAC3B,OAAO,IAAI,CAAC,WAAW,CAAC,gCAAgC,EAAE,EAAE,MAAM,EAAE,CAAC,CAAC;IACxE,CAAC;IAED,qCAAqC;IACrC,eAAe,CACb,MAAc,EACd,UAAuB;QAEvB,OAAO,IAAI,CAAC,WAAW,CAAC,4BAA4B,kBAClD,MAAM,IACH,UAAU,EACb,CAAC;IACL,CAAC;IAED,6DAA6D;IAC7D,aAAa,CACX,MAAc,EACd,OAAe,EACf,UAAuB;QAEvB,OAAO,IAAI,CAAC,WAAW,CAAC,0BAA0B,kBAChD,MAAM;YACN,OAAO,IACJ,UAAU,EACb,CAAC;IACL,CAAC;IAED,uBAAuB;IACvB,eAAe,CACb,MAAwB;QAExB,OAAO,IAAI,CAAC,WAAW,CAAC,6BAA6B,EAAE,MAAM,CAAC,CAAC;IACjE,CAAC;IAED,wBAAwB;IACxB,eAAe,CACb,MAA2B;QAE3B,OAAO,IAAI,CAAC,WAAW,CAAC,8BAA8B,EAAE,MAAM,CAAC,CAAC;IAClE,CAAC;IAED,wBAAwB;IACxB,eAAe,CACb,MAAiC;QAEjC,OAAO,IAAI,CAAC,WAAW,CAAC,8BAA8B,EAAE,MAAM,CAAC,CAAC;IAClE,CAAC;IAED,8BAA8B;IAC9B,oBAAoB,CAAC,MAA+B;QAOlD,OAAO,IAAI,CAAC,WAAW,CAAC,+BAA+B,EAAE,MAAM,CAAC,CAAC;IACnE,CAAC;IAED,8BAA8B;IAC9B,qBAAqB,CAAC,MAAmC;QAOvD,OAAO,IAAI,CAAC,WAAW,CAAC,+BAA+B,EAAE,MAAM,CAAC,CAAC;IACnE,CAAC;CACF;AArZD,gCAqZC"}
|
|
@@ -1,5 +1,6 @@
|
|
|
1
1
|
import { OrderTimeInForce } from './shared';
|
|
2
2
|
export declare type FuturesProductType = 'umcbl' | 'dmcbl' | 'cmcbl' | 'sumcbl' | 'sdmcbl' | 'scmcbl';
|
|
3
|
+
export declare type FuturesKlineInterval = '1m' | '3m' | '5m' | '15m' | '30m' | '1H' | '2H' | '4H' | '6H' | '12H' | '1D' | '3D' | '1W' | '1M' | '6Hutc' | '12Hutc' | '1Dutc' | '3Dutc' | '1Wutc' | '1Mutc';
|
|
3
4
|
export declare type FuturesHoldSide = 'long' | 'short';
|
|
4
5
|
export declare type FuturesMarginMode = 'fixed' | 'crossed';
|
|
5
6
|
export declare type FuturesHoldMode = 'double_hold' | 'single_hold';
|
|
@@ -1,5 +1,6 @@
|
|
|
1
1
|
import { OrderTimeInForce } from './shared';
|
|
2
2
|
export declare type WalletType = 'spot' | 'mix_usdt' | 'mix_usd';
|
|
3
|
+
export declare type SpotKlineInterval = '1min' | '5min' | '15min' | '30min' | '1h' | '4h' | '6h' | '12h' | '1M' | '1W' | '1week' | '6Hutc' | '12Hutc' | '1Dutc' | '3Dutc' | '1Wutc' | '1Mutc';
|
|
3
4
|
export interface NewWalletTransfer {
|
|
4
5
|
fromType: WalletType;
|
|
5
6
|
toType: WalletType;
|
package/lib/types/shared.d.ts
CHANGED
|
@@ -1,5 +1,8 @@
|
|
|
1
1
|
import { REST_CLIENT_TYPE_ENUM } from '../util';
|
|
2
2
|
export declare type numberInString = string;
|
|
3
3
|
export declare type OrderSide = 'Buy' | 'Sell';
|
|
4
|
+
/**
|
|
5
|
+
* @deprecated use SpotKlineInterval or FuturesKlineInterval, depending on which API group you're using
|
|
6
|
+
*/
|
|
4
7
|
export declare type KlineInterval = '1min' | '5min' | '15min' | '30min' | '1h' | '4h' | '6h' | '12h' | '1M' | '1W' | '1week' | '6Hutc' | '12Hutc' | '1Dutc' | '3Dutc' | '1Wutc' | '1Mutc';
|
|
5
8
|
export declare type RestClientType = typeof REST_CLIENT_TYPE_ENUM[keyof typeof REST_CLIENT_TYPE_ENUM];
|
|
@@ -16,6 +16,37 @@ const axios_1 = __importDefault(require("axios"));
|
|
|
16
16
|
const node_support_1 = require("./node-support");
|
|
17
17
|
const requestUtils_1 = require("./requestUtils");
|
|
18
18
|
const websocket_util_1 = require("./websocket-util");
|
|
19
|
+
const ENABLE_HTTP_TRACE = typeof process === 'object' &&
|
|
20
|
+
typeof process.env === 'object' &&
|
|
21
|
+
process.env.BITGETTRACE;
|
|
22
|
+
if (ENABLE_HTTP_TRACE) {
|
|
23
|
+
axios_1.default.interceptors.request.use((request) => {
|
|
24
|
+
console.log(new Date(), 'Starting Request', JSON.stringify({
|
|
25
|
+
url: request.url,
|
|
26
|
+
method: request.method,
|
|
27
|
+
params: request.params,
|
|
28
|
+
data: request.data,
|
|
29
|
+
}, null, 2));
|
|
30
|
+
return request;
|
|
31
|
+
});
|
|
32
|
+
axios_1.default.interceptors.response.use((response) => {
|
|
33
|
+
console.log(new Date(), 'Response:', {
|
|
34
|
+
// request: {
|
|
35
|
+
// url: response.config.url,
|
|
36
|
+
// method: response.config.method,
|
|
37
|
+
// data: response.config.data,
|
|
38
|
+
// headers: response.config.headers,
|
|
39
|
+
// },
|
|
40
|
+
response: {
|
|
41
|
+
status: response.status,
|
|
42
|
+
statusText: response.statusText,
|
|
43
|
+
headers: response.headers,
|
|
44
|
+
data: response.data,
|
|
45
|
+
},
|
|
46
|
+
});
|
|
47
|
+
return response;
|
|
48
|
+
});
|
|
49
|
+
}
|
|
19
50
|
class BaseRestClient {
|
|
20
51
|
/**
|
|
21
52
|
* Create an instance of the REST client. Pass API credentials in the object in the first parameter.
|
|
@@ -25,7 +56,7 @@ class BaseRestClient {
|
|
|
25
56
|
constructor(restOptions = {}, networkOptions = {}) {
|
|
26
57
|
this.options = Object.assign({ recvWindow: 5000,
|
|
27
58
|
/** Throw errors if any request params are empty */
|
|
28
|
-
strictParamValidation: false }, restOptions);
|
|
59
|
+
strictParamValidation: false, encodeQueryStringValues: true }, restOptions);
|
|
29
60
|
this.globalRequestOptions = Object.assign(Object.assign({
|
|
30
61
|
/** in ms == 5 minutes by default */
|
|
31
62
|
timeout: 1000 * 60 * 5 }, networkOptions), { headers: {
|
|
@@ -68,7 +99,9 @@ class BaseRestClient {
|
|
|
68
99
|
const requestUrl = [this.baseUrl, endpoint].join(endpoint.startsWith('/') ? '' : '/');
|
|
69
100
|
// Build a request and handle signature process
|
|
70
101
|
const options = yield this.buildRequest(method, endpoint, requestUrl, params, isPublicApi);
|
|
71
|
-
|
|
102
|
+
if (ENABLE_HTTP_TRACE) {
|
|
103
|
+
console.log('full request: ', options);
|
|
104
|
+
}
|
|
72
105
|
// Dispatch request
|
|
73
106
|
return (0, axios_1.default)(options)
|
|
74
107
|
.then((response) => {
|
|
@@ -133,9 +166,10 @@ class BaseRestClient {
|
|
|
133
166
|
}
|
|
134
167
|
// It's possible to override the recv window on a per rquest level
|
|
135
168
|
const strictParamValidation = this.options.strictParamValidation;
|
|
169
|
+
const encodeQueryStringValues = this.options.encodeQueryStringValues;
|
|
136
170
|
if (signMethod === 'bitget') {
|
|
137
171
|
const signRequestParams = method === 'GET'
|
|
138
|
-
? (0, requestUtils_1.serializeParams)(data, strictParamValidation, '?')
|
|
172
|
+
? (0, requestUtils_1.serializeParams)(data, strictParamValidation, encodeQueryStringValues, '?')
|
|
139
173
|
: JSON.stringify(data) || '';
|
|
140
174
|
const paramsStr = timestamp + method.toUpperCase() + endpoint + signRequestParams;
|
|
141
175
|
// console.log('sign params: ', paramsStr);
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"BaseRestClient.js","sourceRoot":"","sources":["../../src/util/BaseRestClient.ts"],"names":[],"mappings":";;;;;;;;;;;;;;AAAA,kDAAyE;AAGzE,iDAA6C;AAC7C,iDAIwB;AACxB,qDAA8C;AAmB9C,MAA8B,cAAc;IAW1C;;;;OAIG;IACH,YACE,cAAiC,EAAE,EACnC,iBAAqC,EAAE;QAEvC,IAAI,CAAC,OAAO,mBACV,UAAU,EAAE,IAAI;YAChB,mDAAmD;YACnD,qBAAqB,EAAE,KAAK,
|
|
1
|
+
{"version":3,"file":"BaseRestClient.js","sourceRoot":"","sources":["../../src/util/BaseRestClient.ts"],"names":[],"mappings":";;;;;;;;;;;;;;AAAA,kDAAyE;AAGzE,iDAA6C;AAC7C,iDAIwB;AACxB,qDAA8C;AAmB9C,MAAM,iBAAiB,GACrB,OAAO,OAAO,KAAK,QAAQ;IAC3B,OAAO,OAAO,CAAC,GAAG,KAAK,QAAQ;IAC/B,OAAO,CAAC,GAAG,CAAC,WAAW,CAAC;AAE1B,IAAI,iBAAiB,EAAE;IACrB,eAAK,CAAC,YAAY,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE;QACzC,OAAO,CAAC,GAAG,CACT,IAAI,IAAI,EAAE,EACV,kBAAkB,EAClB,IAAI,CAAC,SAAS,CACZ;YACE,GAAG,EAAE,OAAO,CAAC,GAAG;YAChB,MAAM,EAAE,OAAO,CAAC,MAAM;YACtB,MAAM,EAAE,OAAO,CAAC,MAAM;YACtB,IAAI,EAAE,OAAO,CAAC,IAAI;SACnB,EACD,IAAI,EACJ,CAAC,CACF,CACF,CAAC;QACF,OAAO,OAAO,CAAC;IACjB,CAAC,CAAC,CAAC;IACH,eAAK,CAAC,YAAY,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,QAAQ,EAAE,EAAE;QAC3C,OAAO,CAAC,GAAG,CAAC,IAAI,IAAI,EAAE,EAAE,WAAW,EAAE;YACnC,aAAa;YACb,8BAA8B;YAC9B,oCAAoC;YACpC,gCAAgC;YAChC,sCAAsC;YACtC,KAAK;YACL,QAAQ,EAAE;gBACR,MAAM,EAAE,QAAQ,CAAC,MAAM;gBACvB,UAAU,EAAE,QAAQ,CAAC,UAAU;gBAC/B,OAAO,EAAE,QAAQ,CAAC,OAAO;gBACzB,IAAI,EAAE,QAAQ,CAAC,IAAI;aACpB;SACF,CAAC,CAAC;QACH,OAAO,QAAQ,CAAC;IAClB,CAAC,CAAC,CAAC;CACJ;AAED,MAA8B,cAAc;IAW1C;;;;OAIG;IACH,YACE,cAAiC,EAAE,EACnC,iBAAqC,EAAE;QAEvC,IAAI,CAAC,OAAO,mBACV,UAAU,EAAE,IAAI;YAChB,mDAAmD;YACnD,qBAAqB,EAAE,KAAK,EAC5B,uBAAuB,EAAE,IAAI,IAC1B,WAAW,CACf,CAAC;QAEF,IAAI,CAAC,oBAAoB;YACvB,oCAAoC;YACpC,OAAO,EAAE,IAAI,GAAG,EAAE,GAAG,CAAC,IAEnB,cAAc,KACjB,OAAO,EAAE;gBACP,oBAAoB,EAAE,OAAO;gBAC7B,cAAc,EAAE,kBAAkB;gBAClC,MAAM,EAAE,OAAO;aAChB,GACF,CAAC;QAEF,IAAI,CAAC,OAAO,GAAG,IAAA,6BAAc,EAAC,KAAK,EAAE,WAAW,CAAC,CAAC;QAClD,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC;QAClC,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC;QACxC,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC;QAEpC,2EAA2E;QAC3E,MAAM,WAAW,GAAG,CAAC,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,SAAS,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC;QAChE,IACE,WAAW,CAAC,QAAQ,CAAC,SAAS,CAAC;YAC/B,WAAW,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,OAAO,CAAC,KAAK,QAAQ,CAAC,EAC9C;YACA,MAAM,IAAI,KAAK,CACb,oFAAoF,CACrF,CAAC;SACH;IACH,CAAC;IAED,GAAG,CAAC,QAAgB,EAAE,MAAY;QAChC,OAAO,IAAI,CAAC,KAAK,CAAC,KAAK,EAAE,QAAQ,EAAE,MAAM,EAAE,IAAI,CAAC,CAAC;IACnD,CAAC;IAED,UAAU,CAAC,QAAgB,EAAE,MAAY;QACvC,OAAO,IAAI,CAAC,KAAK,CAAC,KAAK,EAAE,QAAQ,EAAE,MAAM,EAAE,KAAK,CAAC,CAAC;IACpD,CAAC;IAED,IAAI,CAAC,QAAgB,EAAE,MAAY;QACjC,OAAO,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,IAAI,CAAC,CAAC;IACpD,CAAC;IAED,WAAW,CAAC,QAAgB,EAAE,MAAY;QACxC,OAAO,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,KAAK,CAAC,CAAC;IACrD,CAAC;IAED,aAAa,CAAC,QAAgB,EAAE,MAAY;QAC1C,OAAO,IAAI,CAAC,KAAK,CAAC,QAAQ,EAAE,QAAQ,EAAE,MAAM,EAAE,KAAK,CAAC,CAAC;IACvD,CAAC;IAED;;OAEG;IACW,KAAK,CACjB,MAAc,EACd,QAAgB,EAChB,MAAY,EACZ,WAAqB;;YAErB,yEAAyE;YACzE,MAAM,UAAU,GAAG,CAAC,IAAI,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC,IAAI,CAC9C,QAAQ,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,GAAG,CACpC,CAAC;YAEF,+CAA+C;YAC/C,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,YAAY,CACrC,MAAM,EACN,QAAQ,EACR,UAAU,EACV,MAAM,EACN,WAAW,CACZ,CAAC;YAEF,IAAI,iBAAiB,EAAE;gBACrB,OAAO,CAAC,GAAG,CAAC,gBAAgB,EAAE,OAAO,CAAC,CAAC;aACxC;YAED,mBAAmB;YACnB,OAAO,IAAA,eAAK,EAAC,OAAO,CAAC;iBAClB,IAAI,CAAC,CAAC,QAAQ,EAAE,EAAE;;gBACjB,IAAI,QAAQ,CAAC,MAAM,IAAI,GAAG,EAAE;oBAC1B,IACE,OAAO,CAAA,MAAA,QAAQ,CAAC,IAAI,0CAAE,IAAI,CAAA,KAAK,QAAQ;wBACvC,CAAA,MAAA,QAAQ,CAAC,IAAI,0CAAE,IAAI,MAAK,OAAO,EAC/B;wBACA,MAAM,EAAE,QAAQ,EAAE,CAAC;qBACpB;oBACD,OAAO,QAAQ,CAAC,IAAI,CAAC;iBACtB;gBACD,MAAM,EAAE,QAAQ,EAAE,CAAC;YACrB,CAAC,CAAC;iBACD,KAAK,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC,CAAC;QAC1C,CAAC;KAAA;IAED;;OAEG;IACH,cAAc,CAAC,CAAM;QACnB,IAAI,IAAI,CAAC,OAAO,CAAC,eAAe,KAAK,KAAK,EAAE;YAC1C,MAAM,CAAC,CAAC;SACT;QAED,uEAAuE;QACvE,IAAI,CAAC,CAAC,CAAC,QAAQ,EAAE;YACf,IAAI,CAAC,CAAC,CAAC,OAAO,EAAE;gBACd,MAAM,CAAC,CAAC,OAAO,CAAC;aACjB;YAED,wCAAwC;YACxC,MAAM,CAAC,CAAC;SACT;QAED,mEAAmE;QACnE,qCAAqC;QACrC,MAAM,QAAQ,GAAkB,CAAC,CAAC,QAAQ,CAAC;QAC3C,0CAA0C;QAE1C,MAAM;YACJ,IAAI,EAAE,QAAQ,CAAC,MAAM;YACrB,OAAO,EAAE,QAAQ,CAAC,UAAU;YAC5B,IAAI,EAAE,QAAQ,CAAC,IAAI;YACnB,OAAO,EAAE,QAAQ,CAAC,OAAO;YACzB,cAAc,kCACT,IAAI,CAAC,OAAO;gBACf,uDAAuD;gBACvD,OAAO,EAAE,kBAAkB,EAC3B,SAAS,EAAE,kBAAkB,GAC9B;SACF,CAAC;IACJ,CAAC;IAED;;OAEG;IACW,WAAW,CACvB,IAAO,EACP,QAAgB,EAChB,MAAc,EACd,UAAsB;;YAEtB,MAAM,SAAS,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;YAE7B,MAAM,GAAG,GAAqB;gBAC5B,cAAc,oBACT,IAAI,CACR;gBACD,IAAI,EAAE,EAAE;gBACR,SAAS;gBACT,UAAU,EAAE,CAAC;gBACb,gBAAgB,EAAE,EAAE;gBACpB,mBAAmB,EAAE,EAAE;aACxB,CAAC;YAEF,IAAI,CAAC,IAAI,CAAC,MAAM,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE;gBACnC,OAAO,GAAG,CAAC;aACZ;YAED,kEAAkE;YAClE,MAAM,qBAAqB,GAAG,IAAI,CAAC,OAAO,CAAC,qBAAqB,CAAC;YACjE,MAAM,uBAAuB,GAAG,IAAI,CAAC,OAAO,CAAC,uBAAuB,CAAC;YAErE,IAAI,UAAU,KAAK,QAAQ,EAAE;gBAC3B,MAAM,iBAAiB,GACrB,MAAM,KAAK,KAAK;oBACd,CAAC,CAAC,IAAA,8BAAe,EACb,IAAI,EACJ,qBAAqB,EACrB,uBAAuB,EACvB,GAAG,CACJ;oBACH,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC;gBAEjC,MAAM,SAAS,GACb,SAAS,GAAG,MAAM,CAAC,WAAW,EAAE,GAAG,QAAQ,GAAG,iBAAiB,CAAC;gBAElE,2CAA2C;gBAE3C,GAAG,CAAC,IAAI,GAAG,MAAM,IAAA,0BAAW,EAAC,SAAS,EAAE,IAAI,CAAC,SAAS,EAAE,QAAQ,CAAC,CAAC;gBAClE,GAAG,CAAC,mBAAmB,GAAG,iBAAiB,CAAC;gBAC5C,OAAO,GAAG,CAAC;aACZ;YAED,OAAO,CAAC,KAAK,CACX,IAAI,IAAI,EAAE,EACV,IAAA,2BAAU,EAAC,UAAU,EAAE,2BAA2B,0BAAW,GAAG,CAAC,CAClE,CAAC;YAEF,OAAO,GAAG,CAAC;QACb,CAAC;KAAA;IAgBa,iBAAiB,CAC7B,MAAc,EACd,QAAgB,EAChB,UAAsB,EACtB,MAAgB,EAChB,WAAqB;;YAErB,IAAI,WAAW,EAAE;gBACf,OAAO;oBACL,cAAc,EAAE,MAAM;oBACtB,cAAc,EAAE,MAAM;iBACvB,CAAC;aACH;YAED,IAAI,CAAC,IAAI,CAAC,MAAM,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE;gBACnC,MAAM,IAAI,KAAK,CAAC,oDAAoD,CAAC,CAAC;aACvE;YAED,OAAO,IAAI,CAAC,WAAW,CAAC,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,UAAU,CAAC,CAAC;QAChE,CAAC;KAAA;IAED,2GAA2G;IAC7F,YAAY,CACxB,MAAc,EACd,QAAgB,EAChB,GAAW,EACX,MAAY,EACZ,WAAqB;;YAErB,MAAM,OAAO,mCACR,IAAI,CAAC,oBAAoB,KAC5B,GAAG,EAAE,GAAG,EACR,MAAM,EAAE,MAAM,GACf,CAAC;YAEF,KAAK,MAAM,GAAG,IAAI,MAAM,EAAE;gBACxB,IAAI,OAAO,MAAM,CAAC,GAAG,CAAC,KAAK,WAAW,EAAE;oBACtC,OAAO,MAAM,CAAC,GAAG,CAAC,CAAC;iBACpB;aACF;YAED,IAAI,WAAW,IAAI,CAAC,IAAI,CAAC,MAAM,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE;gBAChD,uCACK,OAAO,KACV,MAAM,EAAE,MAAM,IACd;aACH;YAED,MAAM,UAAU,GAAG,MAAM,IAAI,CAAC,iBAAiB,CAC7C,MAAM,EACN,QAAQ,EACR,QAAQ,EACR,MAAM,EACN,WAAW,CACZ,CAAC;YAEF,MAAM,WAAW,GAAG;gBAClB,YAAY,EAAE,IAAI,CAAC,MAAM;gBACzB,mBAAmB,EAAE,IAAI,CAAC,OAAO;gBACjC,kBAAkB,EAAE,UAAU,CAAC,SAAS;gBACxC,aAAa,EAAE,UAAU,CAAC,IAAI;aAC/B,CAAC;YAEF,IAAI,MAAM,KAAK,KAAK,EAAE;gBACpB,uCACK,OAAO,KACV,OAAO,kCACF,WAAW,GACX,OAAO,CAAC,OAAO,GAEpB,GAAG,EAAE,OAAO,CAAC,GAAG,GAAG,UAAU,CAAC,mBAAmB,IACjD;aACH;YAED,uCACK,OAAO,KACV,OAAO,kCACF,WAAW,GACX,OAAO,CAAC,OAAO,GAEpB,IAAI,EAAE,MAAM,IACZ;QACJ,CAAC;KAAA;CACF;AA1TD,iCA0TC"}
|
|
@@ -10,6 +10,12 @@ export interface RestClientOptions {
|
|
|
10
10
|
recvWindow?: number;
|
|
11
11
|
/** Default: false. If true, we'll throw errors if any params are undefined */
|
|
12
12
|
strictParamValidation?: boolean;
|
|
13
|
+
/**
|
|
14
|
+
* Default: true.
|
|
15
|
+
* If true, query string values will be URI Encoded (encodeURIComponent).
|
|
16
|
+
* This prevents sign errors with GET requests containing unusual parameters (spaces, symbols, etc).
|
|
17
|
+
*/
|
|
18
|
+
encodeQueryStringValues?: boolean;
|
|
13
19
|
/**
|
|
14
20
|
* Optionally override API protocol + domain
|
|
15
21
|
* e.g baseUrl: 'https://api.bitget.com'
|
|
@@ -18,7 +24,7 @@ export interface RestClientOptions {
|
|
|
18
24
|
/** Default: true. whether to try and post-process request exceptions (and throw them). */
|
|
19
25
|
parseExceptions?: boolean;
|
|
20
26
|
}
|
|
21
|
-
export declare function serializeParams<T extends object | undefined = {}>(params: T, strict_validation?: boolean, prefixWith?: string): string;
|
|
27
|
+
export declare function serializeParams<T extends object | undefined = {}>(params: T, strict_validation?: boolean, encodeValues?: boolean, prefixWith?: string): string;
|
|
22
28
|
export declare function getRestBaseUrl(useTestnet: boolean, restInverseOptions: RestClientOptions): string;
|
|
23
29
|
export declare function isWsPong(msg: any): boolean;
|
|
24
30
|
/**
|
package/lib/util/requestUtils.js
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
"use strict";
|
|
2
2
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
3
|
exports.REST_CLIENT_TYPE_ENUM = exports.isWsPong = exports.getRestBaseUrl = exports.serializeParams = void 0;
|
|
4
|
-
function serializeParams(params, strict_validation = false, prefixWith = '') {
|
|
4
|
+
function serializeParams(params, strict_validation = false, encodeValues = true, prefixWith = '') {
|
|
5
5
|
if (!params) {
|
|
6
6
|
return '';
|
|
7
7
|
}
|
|
@@ -12,7 +12,8 @@ function serializeParams(params, strict_validation = false, prefixWith = '') {
|
|
|
12
12
|
if (strict_validation === true && typeof value === 'undefined') {
|
|
13
13
|
throw new Error('Failed to sign API request due to undefined parameter');
|
|
14
14
|
}
|
|
15
|
-
|
|
15
|
+
const encodedValue = encodeValues ? encodeURIComponent(value) : value;
|
|
16
|
+
return `${key}=${encodedValue}`;
|
|
16
17
|
})
|
|
17
18
|
.join('&');
|
|
18
19
|
// Only prefix if there's a value
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"requestUtils.js","sourceRoot":"","sources":["../../src/util/requestUtils.ts"],"names":[],"mappings":";;;
|
|
1
|
+
{"version":3,"file":"requestUtils.js","sourceRoot":"","sources":["../../src/util/requestUtils.ts"],"names":[],"mappings":";;;AAoCA,SAAgB,eAAe,CAC7B,MAAS,EACT,iBAAiB,GAAG,KAAK,EACzB,eAAwB,IAAI,EAC5B,aAAqB,EAAE;IAEvB,IAAI,CAAC,MAAM,EAAE;QACX,OAAO,EAAE,CAAC;KACX;IAED,MAAM,WAAW,GAAG,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC;SACpC,IAAI,EAAE;SACN,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE;QACX,MAAM,KAAK,GAAG,MAAM,CAAC,GAAG,CAAC,CAAC;QAC1B,IAAI,iBAAiB,KAAK,IAAI,IAAI,OAAO,KAAK,KAAK,WAAW,EAAE;YAC9D,MAAM,IAAI,KAAK,CACb,uDAAuD,CACxD,CAAC;SACH;QACD,MAAM,YAAY,GAAG,YAAY,CAAC,CAAC,CAAC,kBAAkB,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC;QACtE,OAAO,GAAG,GAAG,IAAI,YAAY,EAAE,CAAC;IAClC,CAAC,CAAC;SACD,IAAI,CAAC,GAAG,CAAC,CAAC;IAEb,iCAAiC;IACjC,OAAO,WAAW,CAAC,CAAC,CAAC,UAAU,GAAG,WAAW,CAAC,CAAC,CAAC,WAAW,CAAC;AAC9D,CAAC;AA1BD,0CA0BC;AAED,SAAgB,cAAc,CAC5B,UAAmB,EACnB,kBAAqC;IAErC,MAAM,gBAAgB,GAAG;QACvB,OAAO,EAAE,wBAAwB;QACjC,QAAQ,EAAE,yBAAyB;QACnC,OAAO,EAAE,mBAAmB;KAC7B,CAAC;IAEF,IAAI,kBAAkB,CAAC,OAAO,EAAE;QAC9B,OAAO,kBAAkB,CAAC,OAAO,CAAC;KACnC;IAED,IAAI,UAAU,EAAE;QACd,OAAO,gBAAgB,CAAC,OAAO,CAAC;KACjC;IAED,OAAO,gBAAgB,CAAC,OAAO,CAAC;AAClC,CAAC;AAnBD,wCAmBC;AAED,SAAgB,QAAQ,CAAC,GAAQ;IAC/B,SAAS;IACT,IAAI,CAAA,GAAG,aAAH,GAAG,uBAAH,GAAG,CAAE,IAAI,MAAK,MAAM,EAAE;QACxB,OAAO,IAAI,CAAC;KACb;IACD,OAAO,KAAK,CAAC;AACf,CAAC;AAND,4BAMC;AAED;;GAEG;AACU,QAAA,qBAAqB,GAAG;IACnC,IAAI,EAAE,MAAM;IACZ,OAAO,EAAE,SAAS;IAClB,MAAM,EAAE,QAAQ;CACR,CAAC"}
|