underlying-exchange-tokens-india 1.0.0

package/README.md

@@ -0,0 +1,47 @@
+# Underlying Exchange Tokens India
+
+A comprehensive mapping of exchange tokens for underlying instruments across different Indian brokers.
+
+## Installation
+
+```bash
+npm install underlying-exchange-tokens-india
+```
+
+## Usage
+
+```typescript
+import {
+  getExchangeToken,
+  isSymbolSupported,
+  getAvailableSymbols,
+} from "underlying-exchange-tokens-india";
+// Get token for NIFTY on Zerodha
+const niftyToken = getExchangeToken("NIFTY", "Zerodha");
+console.log(niftyToken); // '1001'
+// Check if symbol is supported
+console.log(isSymbolSupported("NIFTY")); // true
+// Get all available symbols
+console.log(getAvailableSymbols()); // ['NIFTY', 'BANKNIFTY', 'FINNIFTY', ...]
+```
+
+## Supported Brokers
+
+- Zerodha
+- Flattrade
+- Shoonya
+
+## Supported Symbols
+
+- NIFTY
+- BANKNIFTY
+- FINNIFTY
+- (and more...)
+
+## Contributing
+
+Contributions are welcome! Please feel free to submit a Pull Request.
+
+## License
+
+MIT

package/dist/constants.d.ts

@@ -0,0 +1,2 @@
+import type { UnderlyingTokenMap } from "./types";
+export declare const UNDERLYING_TOKEN_MAP: UnderlyingTokenMap;

package/dist/constants.js

@@ -0,0 +1,21 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.UNDERLYING_TOKEN_MAP = void 0;
+exports.UNDERLYING_TOKEN_MAP = {
+    NIFTY: {
+        Flattrade: "26000",
+        Shoonya: "26000",
+        Zerodha: "1001",
+    },
+    BANKNIFTY: {
+        Flattrade: "26009",
+        Shoonya: "26009",
+        Zerodha: "1016",
+    },
+    FINNIFTY: {
+        Flattrade: "26037",
+        Shoonya: "26037",
+        Zerodha: "1020",
+    },
+    // Add more symbols as needed
+};

package/dist/index.d.ts

@@ -0,0 +1,20 @@
+export * from "./types";
+export * from "./constants";
+/**
+ * Get the exchange token for a given symbol and broker
+ * @param symbol The underlying symbol (e.g., 'NIFTY')
+ * @param broker The broker type (e.g., 'Zerodha')
+ * @returns The exchange token or null if not found
+ */
+export declare function getExchangeToken(symbol: string, broker: string): string | null;
+/**
+ * Get all available symbols
+ * @returns Array of available symbols
+ */
+export declare function getAvailableSymbols(): string[];
+/**
+ * Check if a symbol is supported
+ * @param symbol The symbol to check
+ * @returns boolean indicating if the symbol is supported
+ */
+export declare function isSymbolSupported(symbol: string): boolean;

package/dist/index.js

@@ -0,0 +1,49 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getExchangeToken = getExchangeToken;
+exports.getAvailableSymbols = getAvailableSymbols;
+exports.isSymbolSupported = isSymbolSupported;
+__exportStar(require("./types"), exports);
+__exportStar(require("./constants"), exports);
+const constants_1 = require("./constants");
+/**
+ * Get the exchange token for a given symbol and broker
+ * @param symbol The underlying symbol (e.g., 'NIFTY')
+ * @param broker The broker type (e.g., 'Zerodha')
+ * @returns The exchange token or null if not found
+ */
+function getExchangeToken(symbol, broker) {
+    if (!(symbol in constants_1.UNDERLYING_TOKEN_MAP)) {
+        return null;
+    }
+    return constants_1.UNDERLYING_TOKEN_MAP[symbol][broker] || null;
+}
+/**
+ * Get all available symbols
+ * @returns Array of available symbols
+ */
+function getAvailableSymbols() {
+    return Object.keys(constants_1.UNDERLYING_TOKEN_MAP);
+}
+/**
+ * Check if a symbol is supported
+ * @param symbol The symbol to check
+ * @returns boolean indicating if the symbol is supported
+ */
+function isSymbolSupported(symbol) {
+    return symbol in constants_1.UNDERLYING_TOKEN_MAP;
+}

package/dist/types.d.ts

@@ -0,0 +1,7 @@
+export type BrokerType = "Flattrade" | "Shoonya" | "Zerodha";
+export type TokenMapping = {
+    [K in BrokerType]: string;
+};
+export interface UnderlyingTokenMap {
+    [symbol: string]: TokenMapping;
+}

package/dist/types.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/package.json

@@ -0,0 +1,41 @@
+{
+  "name": "underlying-exchange-tokens-india",
+  "version": "1.0.0",
+  "description": "Exchange tokens mapping for underlying instruments across different Indian brokers",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "build": "tsc",
+    "prepare": "npm run build",
+    "test": "jest",
+    "test:watch": "jest --watch",
+    "test:coverage": "jest --coverage",
+    "prepublishOnly": "npm test",
+    "clean": "rm -rf dist"
+  },
+  "keywords": [
+    "india",
+    "stock-market",
+    "exchange-tokens",
+    "zerodha",
+    "flattrade",
+    "shoonya",
+    "nse",
+    "trading"
+  ],
+  "author": "Narendra Krishna Ram",
+  "license": "MIT",
+  "devDependencies": {
+    "@types/jest": "^29.5.14",
+    "jest": "^29.7.0",
+    "ts-jest": "^29.2.5",
+    "typescript": "^5.7.2"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/narenkram/underlying-exchange-tokens-india.git"
+  }
+}