underlying-exchange-tokens-india 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 +9 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -2,6 +2,12 @@
|
|
|
2
2
|
|
|
3
3
|
A comprehensive mapping of exchange tokens for underlying instruments across different Indian brokers.
|
|
4
4
|
|
|
5
|
+
## Purpose
|
|
6
|
+
|
|
7
|
+
This npm package was created out of necessity when developing a trading platform that supports multiple brokers. In such platforms, an exchange token is required for LTP (Last Traded Price) via WebSocket subscription. While exchange tokens should ideally be common for all trading symbols, they are only consistent for call, put, futures, and equity trading symbols.
|
|
8
|
+
|
|
9
|
+
However, when selecting underlying instruments like NIFTY or BANKNIFTY (master symbols), these symbols have their own exchange tokens that vary across different broker types. The reason for this inconsistency is unclear. Therefore, this package was developed to return the underlying symbol token based on the broker type.
|
|
10
|
+
|
|
5
11
|
## Installation
|
|
6
12
|
|
|
7
13
|
```bash
|
|
@@ -36,7 +42,9 @@ console.log(getAvailableSymbols()); // ['NIFTY', 'BANKNIFTY', 'FINNIFTY', ...]
|
|
|
36
42
|
- NIFTY
|
|
37
43
|
- BANKNIFTY
|
|
38
44
|
- FINNIFTY
|
|
39
|
-
-
|
|
45
|
+
- MIDCPNIFTY
|
|
46
|
+
- SENSEX
|
|
47
|
+
- BANKEX
|
|
40
48
|
|
|
41
49
|
## Contributing
|
|
42
50
|
|
package/package.json
CHANGED