bumping axios dep

replaced socketio with websocket client

Author: janlukasschroeder

.gitignore

@@ -1,4 +1,5 @@
 .idea
 .env
 node_modules
-.deploy
+deploy.sh
+.npmrc

README.md

@@ -205,11 +205,29 @@ const filings = await fullTextSearchApi.getFilings(rawQuery);
 The Stream API provides a real-time feed of the latest filings submitted to the SEC EDGAR database via a WebSocket connection. This push-based technology ensures immediate delivery of metadata for each new filing as it becomes publicly available.
 
 ```js
-const { streamApi } = require('sec-api');
-
-streamApi.connect('YOUR_API_KEY');
-
-streamApi.on('filing', (filing) => console.log(filing));
+const WebSocket = require('ws');
+
+const API_KEY = 'YOUR_API'; // replace this with your actual API key
+const STREAM_API_URL = 'wss://stream.sec-api.io?apiKey=' + API_KEY;
+
+const ws = new WebSocket(STREAM_API_URL);
+
+ws.on('open', () => console.log('✅ Connected to:', STREAM_API_URL));
+ws.on('close', () => console.log('Connection closed'));
+ws.on('error', (err) => console.log('Error:', err.message));
+
+ws.on('message', (message) => {
+  const filings = JSON.parse(message.toString());
+  filings.forEach((filing) => {
+    console.log(
+      filing.id,
+      filing.cik,
+      filing.formType,
+      filing.filedAt,
+      filing.linkToFilingDetails,
+    );
+  });
+});
 ```
 
 > See the documentation for more details: https://sec-api.io/docs/stream-api
@@ -298,8 +316,9 @@ const xbrlJson3 = await xbrlApi.xbrlToJson({
 });
 ```
 
-### Example Response
-
+<details>
+  <summary>Example Response</summary>
+  
 ```json
 {
   "CoverPage": {
@@ -398,6 +417,8 @@ const xbrlJson3 = await xbrlApi.xbrlToJson({
 }
 ```
 
+</details>
+
 > See the documentation for more details: https://sec-api.io/docs/xbrl-to-json-converter-api
 
 ## 10-K/10-Q/8-K Section Extractor API

example.js

@@ -85,7 +85,7 @@ const renderApiExample = async () => {
 /**
  * Stream API
  */
-const { streamApi } = secApi;
+// const { streamApi } = secApi;
 
 // uncomment
 // streamApi.connect(yourApiKey);

index.js

@@ -1,8 +1,8 @@
 #!/usr/bin/env node
 
-const io = require('socket.io-client');
+// const io = require('socket.io-client');
 const config = require('./config');
-const events = require('events');
+// const events = require('events');
 const axios = require('axios');
 
 const store = { apiKey: '' };
@@ -14,44 +14,44 @@ const setApiKey = (apiKey) => {
 /*
  * Stream API
  */
-const streamApiStore = {};
-
-const initSocket = (apiKey) => {
-  const uri = config.io.server + '/' + config.io.namespace.allFilings;
-  const params = {
-    query: { apiKey },
-    transports: ['websocket'], // ensure traffic goes through load balancer
-  };
-  streamApiStore.socket = io(uri, params);
-  streamApiStore.socket.on('connect', () =>
-    console.log('Socket connected to', uri),
-  );
-  streamApiStore.socket.on('filing', handleNewFiling);
-  streamApiStore.socket.on('filings', handleNewFilings);
-  streamApiStore.socket.on('error', console.error);
-};
-
-const handleNewFiling = (filing) => {
-  streamApiStore.eventEmitter.emit('filing', filing);
-};
-
-const handleNewFilings = (filings) => {
-  streamApiStore.eventEmitter.emit('filings', filings);
-};
-
-const close = () => {
-  if (streamApiStore.socket.close) {
-    streamApiStore.socket.close();
-  }
-};
-
-const connect = (apiKey) => {
-  setApiKey(apiKey);
-  initSocket(apiKey);
-  streamApiStore.eventEmitter = new events.EventEmitter();
-  modules.streamApi.on = streamApiStore.eventEmitter.on;
-  return streamApiStore.eventEmitter;
-};
+// const streamApiStore = {};
+
+// const initSocket = (apiKey) => {
+//   const uri = config.io.server + '/' + config.io.namespace.allFilings;
+//   const params = {
+//     query: { apiKey },
+//     transports: ['websocket'], // ensure traffic goes through load balancer
+//   };
+//   streamApiStore.socket = io(uri, params);
+//   streamApiStore.socket.on('connect', () =>
+//     console.log('Socket connected to', uri),
+//   );
+//   streamApiStore.socket.on('filing', handleNewFiling);
+//   streamApiStore.socket.on('filings', handleNewFilings);
+//   streamApiStore.socket.on('error', console.error);
+// };
+
+// const handleNewFiling = (filing) => {
+//   streamApiStore.eventEmitter.emit('filing', filing);
+// };
+
+// const handleNewFilings = (filings) => {
+//   streamApiStore.eventEmitter.emit('filings', filings);
+// };
+
+// const close = () => {
+//   if (streamApiStore.socket.close) {
+//     streamApiStore.socket.close();
+//   }
+// };
+
+// const connect = (apiKey) => {
+//   setApiKey(apiKey);
+//   initSocket(apiKey);
+//   streamApiStore.eventEmitter = new events.EventEmitter();
+//   modules.streamApi.on = streamApiStore.eventEmitter.on;
+//   return streamApiStore.eventEmitter;
+// };
 
 /*
  * Query API
@@ -228,11 +228,11 @@ const getSection = async (filingUrl, section = '1A', returnType = 'text') => {
  */
 const modules = {
   setApiKey,
-  streamApi: {
-    setApiKey,
-    connect,
-    close,
-  },
+  // streamApi: {
+  //   setApiKey,
+  //   connect,
+  //   close,
+  // },
   queryApi: {
     setApiKey,
     getFilings: getFilingsQuery,
@@ -265,13 +265,15 @@ module.exports = modules;
  * Command Line Execution - Stream API
  */
 if (require.main === module) {
-  const apiKey = process.argv[2];
-  const emitter = connect(apiKey);
-  let messageCounter = 0;
-
-  emitter.on('filing', (filing) => {
-    // console.log(JSON.stringify(filing, null, 1))
-    messageCounter++;
-    console.log(filing.id, filing.formType, filing.filedAt, messageCounter);
-  });
+  // const apiKey = process.argv[2];
+  // const emitter = connect(apiKey);
+  // let messageCounter = 0;
+  // emitter.on('filing', (filing) => {
+  //   // console.log(JSON.stringify(filing, null, 1))
+  //   messageCounter++;
+  //   console.log(filing.id, filing.formType, filing.filedAt, messageCounter);
+  // });
+  console.log(
+    'sec-api npm package working. Please import the package and use the provided methods to interact with the API.',
+  );
 }