{ "openapi": "3.1.0", "info": { "title": "FilingsPulse API", "description": "Global SEC/EDGAR and international filings intelligence API. AI-synthesized plain-language summaries of 10-K, 10-Q, 8-K, S-1/IPO filings. Insider ownership tracking, red flag detection, institutional holdings analysis, and international filing support (Companies House UK, SEDAR Canada, EDINET Japan, ASIC Australia, HKEx, BSE/NSE India). IBKR, eToro, and Tastytrade broker affiliate links included. Fundamental analysis tools (Simply Wall St, Finviz, TIKR) included. All endpoints support any language via ?lang=. Pricing: $0.08\u2013$0.20 USDC/call via x402 micropayment.", "version": "1.2.0", "contact": { "url": "https://filingspulse.vercel.app" } }, "servers": [ { "url": "https://filingspulse.vercel.app" } ], "components": { "securitySchemes": { "x402": { "type": "apiKey", "in": "header", "name": "PAYMENT-SIGNATURE", "description": "x402 payment signature. Call without header to receive 402 with payment requirements. Sign and retry." } } }, "security": [ { "x402": [] } ], "paths": { "/api/filings/exchange": { "get": { "summary": "Exchange-specific filing intelligence \u2014 any listed company worldwide", "description": "Explicitly route by exchange for companies listed outside the US. Supports 22 exchanges: LSE, Euronext, XETRA, SGX, KOSPI, KOSDAQ, B3, JSE, Tadawul, SET, Bursa, NZX, TASE, BMV, HKEX, BSE, NSE, ASX, TSX, EDINET, NYSE, NASDAQ. Uses exchange-specific regulatory source targeting. Returns financial snapshot, filing highlights, regulatory context, ADR/cross-listing notes, and broker links for the region. x-agent-use-case: on-demand when researching any non-US listed company.", "operationId": "exchange", "parameters": [ { "name": "company", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Company name or local ticker (e.g. LVMH, Samsung Electronics, Tata Consultancy Services)" }, { "name": "exchange", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "NYSE", "NASDAQ", "SEC", "LSE", "TSX", "ASX", "HKEX", "BSE", "NSE", "EURONEXT", "XETRA", "SGX", "KOSPI", "KOSDAQ", "B3", "JSE", "TADAWUL", "SET", "BURSA", "NZX", "TASE", "BMV", "EDINET" ] }, "description": "Exchange code \u2014 enables precise source targeting and jurisdiction-correct filing terminology" }, { "name": "query", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Optional focus topic (e.g. revenue growth, ESG, M&A)" }, { "name": "lang", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Company profile, financial snapshot, filing highlights, regulatory notes, cross-listing/ADR info, broker links" }, "402": { "description": "Payment required" } }, "x-price-usd": 0.12, "x-agent-use-case": "on-demand", "x-agent-chaining": "International exchange filing lookup \u2014 Companies House, EDINET, SEDAR, ASIC, HKEx; eToro IBKR links for intl access" } }, "/api/filings/summary": { "get": { "summary": "10-K / Annual Report plain-language summary", "description": "Translates any company's most recent annual or quarterly filing into plain-English investor intelligence. For US companies: uses SEC EDGAR XBRL financial facts + full-text search (no key needed). For international companies: auto-routes to Companies House, SEDAR, EDINET, ASIC, HKEx, or BSE/NSE and uses equivalent filing terms. Returns financial snapshot, business changes, key risks, management tone with evidence, red flags, guidance, investor takeaway, and broker links for the company's market. x-agent-use-case: on-demand when evaluating any public company.", "operationId": "summary", "parameters": [ { "name": "ticker", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Stock ticker (works for US; use company name for international)" }, { "name": "company", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Company name \u2014 works globally (e.g. Apple, HSBC, Toyota, Reliance Industries)" }, { "name": "form_type", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "10-K", "10-Q", "annual-report", "AIF" ], "default": "10-K" } }, { "name": "lang", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Financial snapshot, business changes, key risks, management tone, red flags, guidance, investor takeaway, broker links" }, "402": { "description": "Payment required" } }, "x-price-usd": 0.15, "x-agent-use-case": "on-demand", "x-agent-chaining": "Core 10-K/10-Q summary \u2014 broker + research tool affiliates auto-appended; chain to /api/filings/redflags for risk assessment" } }, "/api/filings/insider": { "get": { "summary": "Insider trading signal \u2014 Form 4 analysis", "description": "Analyzes insider buying and selling patterns for any public company. Returns overall signal (strong_buy to strong_sell), recent Form 4 transactions, cluster signals (multiple insiders buying simultaneously is the strongest signal), 10b5-1 plan context, and historical insider sentiment. Works for US companies via SEC EDGAR Form 4 data; international companies via news synthesis. x-agent-use-case: on-demand before an investment decision; also useful as a weekly scan for portfolio holdings.", "operationId": "insider", "parameters": [ { "name": "ticker", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "company", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "lang", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Insider signal, recent transactions, cluster analysis, 10b5-1 context, sentiment trend" }, "402": { "description": "Payment required" } }, "x-price-usd": 0.1, "x-agent-use-case": "on-demand", "x-agent-chaining": "Insider buying/selling analysis \u2014 pairs with /api/filings/summary for context; chain to /api/filings/ownership for 13D/G" } }, "/api/filings/ownership": { "get": { "summary": "Institutional ownership and 13F analysis", "description": "Tracks institutional ownership changes via SEC 13F filings. Returns ownership percentage, major holders (Vanguard, BlackRock, Fidelity, etc.), recent fund flow direction, smart money signal (accumulating vs distributing), and notable position changes by high-quality active managers. Works for US-listed companies; international via news synthesis. x-agent-use-case: on-demand; most useful quarterly after 13F filing deadlines.", "operationId": "ownership", "parameters": [ { "name": "ticker", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "company", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "lang", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Ownership %, major holders, fund flows, smart money signal" }, "402": { "description": "Payment required" } }, "x-price-usd": 0.1, "x-agent-use-case": "on-demand", "x-agent-chaining": "Institutional ownership (13F) \u2014 chain with /api/filings/insider for combined smart money view" } }, "/api/filings/ipo": { "get": { "summary": "IPO / S-1 prospectus deep dive", "description": "Comprehensive IPO analysis for any company filing an S-1 or equivalent prospectus globally. Returns business model assessment, TAM reality check, burn rate and cash runway, insider selling percentage, lockup period risk, comparable company valuations, and a definitive verdict (compelling/fairly_valued/expensive/avoid). Includes broker links for participating in the IPO. Works for US S-1s, UK prospectuses, HKEx listings, and global equivalents. x-agent-use-case: on-demand when a notable IPO is announced.", "operationId": "ipo", "parameters": [ { "name": "company", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "ticker", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "lang", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Business model, burn rate, insider selling %, lockup, comps, verdict, broker links" }, "402": { "description": "Payment required" } }, "x-price-usd": 0.15, "x-agent-use-case": "on-demand", "x-agent-chaining": "IPO/S-1 analysis \u2014 chain to /api/filings/summary for post-IPO 10-K baseline; pairs with WealthPulse for allocation strategy" } }, "/api/filings/8k": { "get": { "summary": "Material event analysis (8-K and equivalents)", "description": "Analyzes material event disclosures \u2014 earnings surprises, executive departures, M&A announcements, debt restructurings, restatements, cybersecurity incidents. Returns event type, market impact assessment (direction and magnitude), second-order effects on suppliers/competitors/sector, and what to watch in the next 30-90 days. Works for US 8-K filings and international equivalents (UK RNS, ASX announcements, HKEx notices). x-agent-use-case: on-demand when a material event is detected.", "operationId": "8k", "parameters": [ { "name": "ticker", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "company", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "event", "in": "query", "required": false, "schema": { "type": "string" }, "description": "earnings | executive_change | merger | restatement | debt | cybersecurity | guidance_change" }, { "name": "lang", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Event type, market impact, second-order effects, what to watch next" }, "402": { "description": "Payment required" } }, "x-price-usd": 0.08, "x-agent-use-case": "on-demand", "x-agent-chaining": "Real-time 8-K alerts \u2014 highest automation value; poll via agent workflow for M&A, earnings, leadership changes" } }, "/api/filings/redflags": { "get": { "summary": "Forensic accounting red flag scan", "description": "Deep forensic scan of a company's public filings for accounting red flags, governance failures, and fraud indicators. Checks for: going concern language, auditor changes, revenue recognition anomalies, related-party transaction patterns, off-balance-sheet liabilities, unusual cash flow vs earnings divergence, SEC investigation disclosures, and whistleblower activity. Returns risk score (critical/high/elevated/moderate/low) with specific evidence. Works globally \u2014 covers US SEC, UK FCA, international regulatory databases. x-agent-use-case: on-demand as part of due diligence before any significant investment.", "operationId": "redflags", "parameters": [ { "name": "ticker", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "company", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "lang", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Risk score, categorized red flags with evidence, accounting quality, governance concerns" }, "402": { "description": "Payment required" } }, "x-price-usd": 0.12, "x-agent-use-case": "on-demand", "x-agent-chaining": "Red flag detection \u2014 chain after /api/filings/summary; pairs with AlphaPulse for signal provider due diligence" } }, "/api/filings/compare": { "get": { "summary": "Side-by-side competitor comparison from filings", "description": "Compares two companies head-to-head using their public filings. Evaluates 8 categories: revenue growth, profitability, balance sheet strength, management quality, competitive moat, valuation, risk profile, and future outlook. Returns a decisive winner and explains when each company wins for different investor profiles (value vs growth, income vs capital appreciation). Works for any two publicly listed companies globally. x-agent-use-case: on-demand when choosing between two investment options in the same sector.", "operationId": "compare", "parameters": [ { "name": "ticker1", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "ticker2", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "company1", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "company2", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "lang", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "8-category head-to-head, decisive winner, investor profile matching" }, "402": { "description": "Payment required" } }, "x-price-usd": 0.15, "x-agent-use-case": "on-demand", "x-agent-chaining": "Multi-company fundamental comparison \u2014 chain after individual summaries; broker affiliate links included" } }, "/api/filings/search": { "get": { "summary": "Full-text filing search across all public databases", "description": "Search across SEC EDGAR full-text (all forms) and 20+ international filing databases simultaneously. Find what companies are disclosing about any topic: AI risk, supply chain China exposure, going concern, cybersecurity breach, climate risk, specific executive mentions, technology investments. Returns companies disclosing on the topic, common themes, notable outliers, and what is conspicuously NOT being disclosed. x-agent-use-case: on-demand for thematic research, sector-wide risk screening, or tracking a specific topic across many companies.", "operationId": "search", "parameters": [ { "name": "query", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Any topic, risk, disclosure theme, or specific language (e.g. 'artificial intelligence risk factors', 'going concern', 'China supply chain exposure')" }, { "name": "form_type", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "10-K", "10-Q", "8-K", "S-1", "13F" ] } }, { "name": "date_from", "in": "query", "required": false, "schema": { "type": "string" }, "description": "YYYY-MM-DD" }, { "name": "lang", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Key findings, company list, common themes, notable disclosures, what is not being disclosed" }, "402": { "description": "Payment required" } }, "x-price-usd": 0.08, "x-agent-use-case": "on-demand", "x-agent-chaining": "Full-text filing search \u2014 start here when looking for a specific disclosure; chain to /api/filings/summary" } } } }