bybit-api 3.10.5 → 3.10.6
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 +40 -22
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,21 +1,38 @@
|
|
|
1
1
|
# Node.js & JavaScript SDK for Bybit REST API & WebSockets
|
|
2
2
|
|
|
3
|
-
[][1]
|
|
3
|
+
[](https://github.com/tiagosiebler/bybit-api/actions/workflows/e2etest.yml)
|
|
4
|
+
[][1]
|
|
5
|
+
[][1]
|
|
6
|
+
[][1]
|
|
5
7
|
[][1]
|
|
6
8
|
[](https://www.codefactor.io/repository/github/tiagosiebler/bybit-api)
|
|
9
|
+
[](https://t.me/nodetraders)
|
|
7
10
|
|
|
8
|
-
|
|
11
|
+
<p align="center">
|
|
12
|
+
<a href="https://www.npmjs.com/package/bybit-api">
|
|
13
|
+
<picture>
|
|
14
|
+
<source media="(prefers-color-scheme: dark)" srcset="https://github.com/tiagosiebler/bybit-api/blob/master/docs/images/logoDarkMode2.svg?raw=true#gh-dark-mode-only">
|
|
15
|
+
<img alt="SDK Logo" src="https://github.com/tiagosiebler/bybit-api/blob/master/docs/images/logoBrightMode2.svg?raw=true#gh-light-mode-only">
|
|
16
|
+
</picture>
|
|
17
|
+
</a>
|
|
18
|
+
</p>
|
|
9
19
|
|
|
10
20
|
[1]: https://www.npmjs.com/package/bybit-api
|
|
11
21
|
|
|
12
22
|
Node.js & JavaScript SDK for the Bybit REST APIs and WebSockets:
|
|
13
23
|
|
|
14
24
|
- Complete integration with all Bybit REST APIs & WebSockets.
|
|
25
|
+
- Actively maintained with a modern, promise-driven interface.
|
|
15
26
|
- TypeScript support (with type declarations for most API requests & responses).
|
|
16
27
|
- Over 450 end-to-end tests making real API calls & WebSocket connections, validating any changes before they reach npm.
|
|
17
28
|
- Robust WebSocket integration with configurable connection heartbeats & automatic reconnect then resubscribe workflows.
|
|
18
|
-
-
|
|
29
|
+
- Event driven messaging.
|
|
30
|
+
- Smart websocket persistence
|
|
31
|
+
- Automatically handle silent websocket disconnections through timed heartbeats, including the scheduled 24hr disconnect.
|
|
32
|
+
- Automatically handle listenKey persistence and expiration/refresh.
|
|
33
|
+
- Emit `reconnected` event when dropped connection is restored.
|
|
34
|
+
- Proxy support via axios integration.
|
|
35
|
+
- Active community support & collaboration in telegram: [Node.js Algo Traders](https://t.me/nodetraders).
|
|
19
36
|
|
|
20
37
|
## Installation
|
|
21
38
|
|
|
@@ -28,19 +45,20 @@ Node.js & JavaScript SDK for the Bybit REST APIs and WebSockets:
|
|
|
28
45
|
|
|
29
46
|
## Related projects
|
|
30
47
|
|
|
31
|
-
Check out my related projects:
|
|
48
|
+
Check out my related JavaScript/TypeScript/Node.js projects:
|
|
32
49
|
|
|
33
|
-
- Try my
|
|
34
|
-
- [
|
|
35
|
-
- [
|
|
36
|
-
- [
|
|
37
|
-
- [
|
|
38
|
-
- [
|
|
50
|
+
- Try my REST API & WebSocket SDKs:
|
|
51
|
+
- [Bybit-api Node.js SDK](https://www.npmjs.com/package/bybit-api)
|
|
52
|
+
- [Binance Node.js SDK](https://www.npmjs.com/package/binance)
|
|
53
|
+
- [Okx-api Node.js SDK](https://www.npmjs.com/package/okx-api)
|
|
54
|
+
- [Gateio-api Node.js SDK](https://www.npmjs.com/package/gateio-api)
|
|
55
|
+
- [Bitget-api Node.js SDK](https://www.npmjs.com/package/bitget-api)
|
|
56
|
+
- [Bitmart-api Node.js SDK](https://www.npmjs.com/package/bitmart-api)
|
|
39
57
|
- Try my misc utilities:
|
|
40
|
-
- [
|
|
41
|
-
- [
|
|
58
|
+
- [OrderBooks Node.js](https://www.npmjs.com/package/orderbooks)
|
|
59
|
+
- [Crypto Exchange Account State Cache](https://www.npmjs.com/package/accountstate)
|
|
42
60
|
- Check out my examples:
|
|
43
|
-
- [awesome-crypto-examples](https://github.com/tiagosiebler/awesome-crypto-examples)
|
|
61
|
+
- [awesome-crypto-examples Node.js](https://github.com/tiagosiebler/awesome-crypto-examples)
|
|
44
62
|
|
|
45
63
|
## Documentation
|
|
46
64
|
|
|
@@ -406,15 +424,15 @@ The bundle can be found in `dist/`. Altough usage should be largely consistent,
|
|
|
406
424
|
|
|
407
425
|
#### tiagosiebler
|
|
408
426
|
|
|
409
|
-
|
|
427
|
+
Have my projects helped you? Share the love, there are many ways you can show your thanks:
|
|
410
428
|
|
|
411
|
-
-
|
|
412
|
-
-
|
|
429
|
+
- Star & share my projects.
|
|
430
|
+
- Are my projects useful? Sponsor me on Github and support my effort to maintain & improve them: https://github.com/sponsors/tiagosiebler
|
|
431
|
+
- Have an interesting project? Get in touch & invite me to it.
|
|
432
|
+
- Or buy me all the coffee:
|
|
433
|
+
- ETH(ERC20): `0xA3Bda8BecaB4DCdA539Dc16F9C54a592553Be06C` <!-- metamask -->
|
|
413
434
|
|
|
414
|
-
|
|
415
|
-
|
|
416
|
-
- BTC: `1C6GWZL1XW3jrjpPTS863XtZiXL1aTK7Jk`
|
|
417
|
-
- ETH (ERC20): `0xd773d8e6a50758e1ada699bb6c4f98bb4abf82da`
|
|
435
|
+
For more ways to give thanks & support my efforts, visit [Contributions & Thanks](https://github.com/tiagosiebler/awesome-crypto-examples/wiki/Contributions-&-Thanks)!
|
|
418
436
|
|
|
419
437
|
#### pixtron
|
|
420
438
|
|
|
@@ -430,4 +448,4 @@ Contributions are encouraged, I will review any incoming pull requests. See the
|
|
|
430
448
|
|
|
431
449
|
## Star History
|
|
432
450
|
|
|
433
|
-
[](https://star-history.com/#tiagosiebler/bybit-api&tiagosiebler/binance&tiagosiebler/orderbooks&tiagosiebler/okx-api&tiagosiebler/bitget-api&tiagosiebler/awesome-crypto-examples&tiagosiebler/bitmart-api&tiagosiebler/gateio-api&Date)
|
package/package.json
CHANGED