bitget-api 1.0.1 → 1.0.3
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
CHANGED
|
@@ -9,12 +9,12 @@
|
|
|
9
9
|
|
|
10
10
|
[1]: https://www.npmjs.com/package/bitget-api
|
|
11
11
|
|
|
12
|
-
|
|
13
12
|
Node.js connector for the Bitget APIs and WebSockets:
|
|
14
13
|
- Complete integration with all Bitget APIs.
|
|
15
14
|
- TypeScript support (with type declarations for most API requests & responses).
|
|
16
15
|
- Over 100 integration tests making real API calls & WebSocket connections, validating any changes before they reach npm.
|
|
17
16
|
- Robust WebSocket integration with configurable connection heartbeats & automatic reconnect then resubscribe workflows.
|
|
17
|
+
- Officially listed Node.js SDK in [Bitget API docs](https://bitgetlimited.github.io/apidoc/en/spot/#sdk-code-example).
|
|
18
18
|
- Browser support (via webpack bundle - see "Browser Usage" below).
|
|
19
19
|
|
|
20
20
|
## Installation
|
|
@@ -157,7 +157,8 @@ The bundle can be found in `dist/`. Altough usage should be largely consistent,
|
|
|
157
157
|
Support my efforts to make algo trading accessible to all - register with my referral links:
|
|
158
158
|
- [Bybit](https://www.bybit.com/en-US/register?affiliate_id=9410&language=en-US&group_id=0&group_type=1)
|
|
159
159
|
- [Binance](https://www.binance.com/en/register?ref=20983262)
|
|
160
|
-
- [Bitget](https://
|
|
160
|
+
- [Bitget](https://partner.bitget.com/bg/ZNM295)
|
|
161
|
+
- [OKX](https://www.okx.com/join/18504944)
|
|
161
162
|
- [FTX](https://ftx.com/referrals#a=ftxapigithub)
|
|
162
163
|
|
|
163
164
|
Or buy me a coffee using any of these:
|
|
@@ -7,7 +7,6 @@ export default abstract class BaseRestClient {
|
|
|
7
7
|
private globalRequestOptions;
|
|
8
8
|
private apiKey;
|
|
9
9
|
private apiSecret;
|
|
10
|
-
private clientType;
|
|
11
10
|
private apiPass;
|
|
12
11
|
/** Defines the client type (affecting how requests & signatures behave) */
|
|
13
12
|
abstract getClientType(): RestClientType;
|
|
@@ -23,7 +22,7 @@ export default abstract class BaseRestClient {
|
|
|
23
22
|
postPrivate(endpoint: string, params?: any): Promise<any>;
|
|
24
23
|
deletePrivate(endpoint: string, params?: any): Promise<any>;
|
|
25
24
|
/**
|
|
26
|
-
* @private Make a HTTP request to a specific endpoint. Private
|
|
25
|
+
* @private Make a HTTP request to a specific endpoint. Private endpoint API calls are automatically signed.
|
|
27
26
|
*/
|
|
28
27
|
private _call;
|
|
29
28
|
/**
|
|
@@ -15,6 +15,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
|
|
|
15
15
|
const axios_1 = __importDefault(require("axios"));
|
|
16
16
|
const node_support_1 = require("./node-support");
|
|
17
17
|
const requestUtils_1 = require("./requestUtils");
|
|
18
|
+
const websocket_util_1 = require("./websocket-util");
|
|
18
19
|
class BaseRestClient {
|
|
19
20
|
/**
|
|
20
21
|
* Create an instance of the REST client. Pass API credentials in the object in the first parameter.
|
|
@@ -22,14 +23,13 @@ class BaseRestClient {
|
|
|
22
23
|
* @param {AxiosRequestConfig} [networkOptions={}] HTTP networking options for axios
|
|
23
24
|
*/
|
|
24
25
|
constructor(restOptions = {}, networkOptions = {}) {
|
|
25
|
-
this.clientType = this.getClientType();
|
|
26
26
|
this.options = Object.assign({ recvWindow: 5000,
|
|
27
27
|
/** Throw errors if any request params are empty */
|
|
28
28
|
strictParamValidation: false }, restOptions);
|
|
29
29
|
this.globalRequestOptions = Object.assign(Object.assign({
|
|
30
|
-
|
|
30
|
+
/** in ms == 5 minutes by default */
|
|
31
31
|
timeout: 1000 * 60 * 5 }, networkOptions), { headers: {
|
|
32
|
-
'X-CHANNEL-CODE': '
|
|
32
|
+
'X-CHANNEL-API-CODE': 'hbnni',
|
|
33
33
|
'Content-Type': 'application/json',
|
|
34
34
|
locale: 'en-US',
|
|
35
35
|
} });
|
|
@@ -60,7 +60,7 @@ class BaseRestClient {
|
|
|
60
60
|
return this._call('DELETE', endpoint, params, false);
|
|
61
61
|
}
|
|
62
62
|
/**
|
|
63
|
-
* @private Make a HTTP request to a specific endpoint. Private
|
|
63
|
+
* @private Make a HTTP request to a specific endpoint. Private endpoint API calls are automatically signed.
|
|
64
64
|
*/
|
|
65
65
|
_call(method, endpoint, params, isPublicApi) {
|
|
66
66
|
return __awaiter(this, void 0, void 0, function* () {
|
|
@@ -73,11 +73,6 @@ class BaseRestClient {
|
|
|
73
73
|
return (0, axios_1.default)(options)
|
|
74
74
|
.then((response) => {
|
|
75
75
|
var _a, _b;
|
|
76
|
-
// console.log('response: ', response.data);
|
|
77
|
-
// console.error('res: ', response);
|
|
78
|
-
// if (response.data && response.data?.code !== API_ERROR_CODE.SUCCESS) {
|
|
79
|
-
// throw response.data;
|
|
80
|
-
// }
|
|
81
76
|
if (response.status == 200) {
|
|
82
77
|
if (typeof ((_a = response.data) === null || _a === void 0 ? void 0 : _a.code) === 'string' &&
|
|
83
78
|
((_b = response.data) === null || _b === void 0 ? void 0 : _b.code) !== '00000') {
|
|
@@ -97,7 +92,7 @@ class BaseRestClient {
|
|
|
97
92
|
if (this.options.parseExceptions === false) {
|
|
98
93
|
throw e;
|
|
99
94
|
}
|
|
100
|
-
// Something happened in setting up the request that triggered an
|
|
95
|
+
// Something happened in setting up the request that triggered an error
|
|
101
96
|
if (!e.response) {
|
|
102
97
|
if (!e.request) {
|
|
103
98
|
throw e.message;
|
|
@@ -114,7 +109,9 @@ class BaseRestClient {
|
|
|
114
109
|
message: response.statusText,
|
|
115
110
|
body: response.data,
|
|
116
111
|
headers: response.headers,
|
|
117
|
-
requestOptions: Object.assign(Object.assign({}, this.options), {
|
|
112
|
+
requestOptions: Object.assign(Object.assign({}, this.options), {
|
|
113
|
+
// Prevent credentials from leaking into error messages
|
|
114
|
+
apiPass: 'omittedFromError', apiSecret: 'omittedFromError' }),
|
|
118
115
|
};
|
|
119
116
|
}
|
|
120
117
|
/**
|
|
@@ -146,6 +143,7 @@ class BaseRestClient {
|
|
|
146
143
|
res.queryParamsWithSign = signRequestParams;
|
|
147
144
|
return res;
|
|
148
145
|
}
|
|
146
|
+
console.error(new Date(), (0, websocket_util_1.neverGuard)(signMethod, `Unhandled sign method: "${node_support_1.signMessage}"`));
|
|
149
147
|
return res;
|
|
150
148
|
});
|
|
151
149
|
}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"BaseRestClient.js","sourceRoot":"","sources":["../../src/util/BaseRestClient.ts"],"names":[],"mappings":";;;;;;;;;;;;;;AAAA,kDAAyE;
|
|
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,IACzB,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,0CAA0C;YAE1C,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;YAEjE,IAAI,UAAU,KAAK,QAAQ,EAAE;gBAC3B,MAAM,iBAAiB,GACrB,MAAM,KAAK,KAAK;oBACd,CAAC,CAAC,IAAA,8BAAe,EAAC,IAAI,EAAE,qBAAqB,EAAE,GAAG,CAAC;oBACnD,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,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE;gBACpB,OAAO,CAAC,OAAO,GAAG,EAAE,CAAC;aACtB;YACD,OAAO,CAAC,OAAO,CAAC,YAAY,CAAC,GAAG,IAAI,CAAC,MAAM,CAAC;YAC5C,OAAO,CAAC,OAAO,CAAC,mBAAmB,CAAC,GAAG,IAAI,CAAC,OAAO,CAAC;YACpD,OAAO,CAAC,OAAO,CAAC,kBAAkB,CAAC,GAAG,UAAU,CAAC,SAAS,CAAC;YAC3D,OAAO,CAAC,OAAO,CAAC,aAAa,CAAC,GAAG,UAAU,CAAC,IAAI,CAAC;YACjD,OAAO,CAAC,OAAO,CAAC,cAAc,CAAC,GAAG,kBAAkB,CAAC;YAErD,IAAI,MAAM,KAAK,KAAK,EAAE;gBACpB,uCACK,OAAO,KACV,GAAG,EAAE,OAAO,CAAC,GAAG,GAAG,UAAU,CAAC,mBAAmB,IACjD;aACH;YAED,uCACK,OAAO,KACV,IAAI,EAAE,MAAM,IACZ;QACJ,CAAC;KAAA;CACF;AA3SD,iCA2SC"}
|