@stoqey/ib 1.5.0 → 1.5.1
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 +27 -0
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -4,10 +4,12 @@
|
|
|
4
4
|
<h1 align="center">Typescript API</h1>
|
|
5
5
|
</p>
|
|
6
6
|
<div style="display: flex;justify-content:center;">
|
|
7
|
+
<a href="https://discord.gg/T4VjBrqGtK" aria-label="Join Stoqey #welcome"><img src="https://img.shields.io/badge/discord-join%20chat-blue.svg" alt="Join Stoqey #welcome"></a>
|
|
7
8
|
<img src="https://img.shields.io/github/package-json/v/stoqey/ib"></img>
|
|
8
9
|
<img src="https://circleci.com/gh/stoqey/ib.svg?style=svg"></img>
|
|
9
10
|
<img src="https://img.shields.io/badge/License-MIT-blue.svg"/>
|
|
10
11
|
<img src="https://img.shields.io/npm/dt/@stoqey/ib.svg"></img>
|
|
12
|
+
|
|
11
13
|
</div>
|
|
12
14
|
</div>
|
|
13
15
|
|
|
@@ -17,6 +19,19 @@ Refer to [IBKRCampus](https://ibkrcampus.com/campus/ibkr-api-page/twsapi-doc/) f
|
|
|
17
19
|
|
|
18
20
|
The module makes a socket connection to TWS (or IB Gateway) using the [net](http://nodejs.org/api/net.html) module and all messages are entirely processed in Typescript. It uses [EventEmitter](http://nodejs.org/api/events.html) to pass the result back to user.
|
|
19
21
|
|
|
22
|
+
## Simpler Alternative
|
|
23
|
+
|
|
24
|
+
If you're looking for a more straightforward implementation with ready-to-use examples, check out [@stoqey/ibkr](https://github.com/stoqey/ibkr). This wrapper library provides:
|
|
25
|
+
|
|
26
|
+
- 🚀 Simplified API interface
|
|
27
|
+
- 📝 Full working examples for common operations
|
|
28
|
+
- 🔄 Built-in connection management
|
|
29
|
+
- 📊 Easy market data handling
|
|
30
|
+
- 💼 Streamlined portfolio management
|
|
31
|
+
- 🤖 Trading automation helpers
|
|
32
|
+
|
|
33
|
+
The wrapper is built on top of this library but offers a more developer-friendly experience for common use cases.
|
|
34
|
+
|
|
20
35
|
## Installation
|
|
21
36
|
|
|
22
37
|
$ npm install @stoqey/ib
|
|
@@ -257,3 +272,15 @@ In addition to that, a little demo / example app would be nice, to demonstrate A
|
|
|
257
272
|
Any kind of bugfixes are welcome as well.
|
|
258
273
|
|
|
259
274
|
If you want to contribute, read the [Developer Guide](https://github.com/stoqey/ib/wiki/Developer-Guide) and start coding.
|
|
275
|
+
|
|
276
|
+
## Community
|
|
277
|
+
|
|
278
|
+
Join our Discord community to get help, share ideas, and connect with other developers:
|
|
279
|
+
|
|
280
|
+
[](https://discord.gg/T4VjBrqGtK)
|
|
281
|
+
|
|
282
|
+
- Get help with implementation
|
|
283
|
+
- Share your projects
|
|
284
|
+
- Connect with other developers
|
|
285
|
+
- Stay updated on new releases
|
|
286
|
+
- Contribute to discussions
|