sec-edgar-insider-api 1.0.0

package/README.md

@@ -0,0 +1,74 @@
+# SEC EDGAR Insider Trading API
+
+JavaScript client for the [SEC EDGAR Insider Trading Alerts API](https://rapidapi.com/lulzasaur9192/api/sec-insider-trades) on RapidAPI.
+
+Track insider trades, Form 4 filings, and executive buy/sell signals in real-time from SEC EDGAR.
+
+## Install
+
+```bash
+npm install sec-edgar-insider-api
+```
+
+## Quick Start
+
+```javascript
+const SECEdgarClient = require('sec-edgar-insider-api');
+
+const client = new SECEdgarClient('YOUR_RAPIDAPI_KEY');
+
+// Get recent insider trades
+const trades = await client.getRecentTrades({ days: 7, limit: 20 });
+console.log(trades);
+
+// Get trades for a specific ticker
+const applTrades = await client.getTradesByTicker('AAPL', { days: 30 });
+
+// Get full Form 4 filing details
+const filing = await client.getFiling('0001234567-26-000123');
+```
+
+## API Methods
+
+### `getRecentTrades(options?)`
+Get recent Form 4 insider trading filings.
+
+| Parameter | Type | Default | Description |
+|-----------|------|---------|-------------|
+| days | number | 3 | Lookback period (1-30) |
+| limit | number | 20 | Results per page (1-100) |
+| offset | number | 0 | Pagination offset |
+| ticker | string | - | Filter by company ticker |
+
+### `getTradesByTicker(ticker, options?)`
+Get all insider trades for a specific company.
+
+| Parameter | Type | Default | Description |
+|-----------|------|---------|-------------|
+| ticker | string | required | Company ticker (e.g. "AAPL") |
+| days | number | 30 | Lookback period (1-365) |
+| limit | number | 50 | Results per page (1-100) |
+
+### `getFiling(accession)`
+Get full parsed Form 4 details for a specific filing.
+
+| Parameter | Type | Description |
+|-----------|------|-------------|
+| accession | string | Accession number (format: XXXXXXXXXX-YY-ZZZZZZ) |
+
+## Get Your API Key
+
+1. Go to [SEC Insider Trades API on RapidAPI](https://rapidapi.com/lulzasaur9192/api/sec-insider-trades)
+2. Subscribe (free tier: 200 requests/month)
+3. Copy your API key from the dashboard
+
+## Use Cases
+
+- **Quant Trading**: Track insider buy/sell patterns as trading signals
+- **Compliance**: Monitor executive trades for reporting requirements
+- **Research**: Analyze insider trading patterns by sector or company
+- **Alerts**: Build real-time notification systems for insider activity
+
+## License
+
+MIT

package/index.d.ts

@@ -0,0 +1,20 @@
+interface TradeOptions {
+  days?: number;
+  limit?: number;
+  offset?: number;
+  ticker?: string;
+}
+
+interface CompanyOptions {
+  days?: number;
+  limit?: number;
+}
+
+declare class SECEdgarClient {
+  constructor(apiKey: string);
+  getRecentTrades(options?: TradeOptions): Promise<any>;
+  getTradesByTicker(ticker: string, options?: CompanyOptions): Promise<any>;
+  getFiling(accession: string): Promise<any>;
+}
+
+export = SECEdgarClient;

package/index.js

@@ -0,0 +1,66 @@
+'use strict';
+
+const BASE_URL = 'https://sec-insider-trades.p.rapidapi.com';
+
+class SECEdgarClient {
+  /**
+   * @param {string} apiKey - Your RapidAPI key (get one at https://rapidapi.com/lulzasaur9192/api/sec-insider-trades)
+   */
+  constructor(apiKey) {
+    if (!apiKey) throw new Error('API key required — get one at https://rapidapi.com/lulzasaur9192/api/sec-insider-trades');
+    this.apiKey = apiKey;
+    this.headers = {
+      'x-rapidapi-key': apiKey,
+      'x-rapidapi-host': 'sec-insider-trades.p.rapidapi.com',
+    };
+  }
+
+  async _request(path, params = {}) {
+    const url = new URL(BASE_URL + path);
+    for (const [k, v] of Object.entries(params)) {
+      if (v !== undefined && v !== null) url.searchParams.set(k, String(v));
+    }
+    const res = await fetch(url.toString(), { headers: this.headers });
+    if (!res.ok) {
+      const body = await res.text().catch(() => '');
+      throw new Error(`SEC EDGAR API error ${res.status}: ${body}`);
+    }
+    return res.json();
+  }
+
+  /**
+   * Get recent Form 4 insider trading filings
+   * @param {Object} [options]
+   * @param {number} [options.days=3] - Lookback period (1-30)
+   * @param {number} [options.limit=20] - Results per page (1-100)
+   * @param {number} [options.offset=0] - Pagination offset
+   * @param {string} [options.ticker] - Filter by company ticker
+   * @returns {Promise<Object>}
+   */
+  async getRecentTrades(options = {}) {
+    return this._request('/sec/insider-trades', options);
+  }
+
+  /**
+   * Get all insider trades for a specific company
+   * @param {string} ticker - Company ticker symbol (e.g. "AAPL")
+   * @param {Object} [options]
+   * @param {number} [options.days=30] - Lookback period (1-365)
+   * @param {number} [options.limit=50] - Results per page (1-100)
+   * @returns {Promise<Object>}
+   */
+  async getTradesByTicker(ticker, options = {}) {
+    return this._request(`/sec/insider-trades/company/${encodeURIComponent(ticker)}`, options);
+  }
+
+  /**
+   * Get full parsed Form 4 filing details
+   * @param {string} accession - Accession number (format: XXXXXXXXXX-YY-ZZZZZZ)
+   * @returns {Promise<Object>}
+   */
+  async getFiling(accession) {
+    return this._request(`/sec/insider-trades/filing/${encodeURIComponent(accession)}`);
+  }
+}
+
+module.exports = SECEdgarClient;

package/package.json

@@ -0,0 +1,31 @@
+{
+  "name": "sec-edgar-insider-api",
+  "version": "1.0.0",
+  "description": "JavaScript client for SEC EDGAR Insider Trading Alerts API — real-time Form 4 filings, insider buy/sell signals, executive trade tracking via RapidAPI",
+  "keywords": [
+    "sec",
+    "edgar",
+    "insider-trading",
+    "form-4",
+    "finance",
+    "stock-market",
+    "api",
+    "rapidapi",
+    "insider-trades",
+    "executive-trades",
+    "stock-alerts",
+    "fintech"
+  ],
+  "main": "index.js",
+  "types": "index.d.ts",
+  "author": "lulzasaur9192",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/lulzasaur9192/sec-edgar-insider-api"
+  },
+  "homepage": "https://rapidapi.com/lulzasaur9192/api/sec-insider-trades",
+  "engines": {
+    "node": ">=14"
+  }
+}