Update API documentation with SEC filings endpoints

Add SEC Filings section to root HTML docs, example requests, key features,
and OpenAPI tags for Swagger UI / ReDoc visibility.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
main
I Luk Kim 5 months ago
parent d0f1a9a7d0
commit 93d8018746

@ -152,6 +152,13 @@ async def root_documentation():
<li><code>GET /news/{{ticker}}/social-only</code> - Social media posts only</li> <li><code>GET /news/{{ticker}}/social-only</code> - Social media posts only</li>
</ul> </ul>
<h3>SEC Filings <span class="new-badge">NEW</span></h3>
<ul>
<li><code>GET /filings/search/{{ticker}}</code> - Search SEC filings (8-K, 6-K, 20-F, 40-F, 10-K, 10-Q)</li>
<li><code>GET /filings/documents/{{accession_number}}</code> - List all documents in a filing</li>
<li><code>GET /filings/exhibit/{{accession_number}}</code> - Extract exhibit content (e.g., EX-99.1 press releases)</li>
</ul>
<h3>ETF Holdings</h3> <h3>ETF Holdings</h3>
<ul> <ul>
<li><code>GET /etf/holdings/{{ticker}}</code> - ETF holdings at date or most recent</li> <li><code>GET /etf/holdings/{{ticker}}</code> - ETF holdings at date or most recent</li>
@ -192,6 +199,20 @@ curl "http://localhost:18001/api/v1/price/intraday/AAPL?interval=1m&period=1d"
# Today's OHLC (daily if available; otherwise 1m aggregate) # Today's OHLC (daily if available; otherwise 1m aggregate)
curl "http://localhost:18001/api/v1/price/today/AAPL"</code></pre> curl "http://localhost:18001/api/v1/price/today/AAPL"</code></pre>
<h3>SEC Filings <span class="new-badge">NEW</span></h3>
<pre><code># Search AAPL 8-K filings (earnings announcements, material events)
curl "http://localhost:18001/api/v1/filings/search/AAPL?form_type=8-K&limit=5"
# Search foreign issuer filings
curl "http://localhost:18001/api/v1/filings/search/TSM?form_type=20-F"
curl "http://localhost:18001/api/v1/filings/search/SAP?form_type=6-K"
# List all documents in a filing
curl "http://localhost:18001/api/v1/filings/documents/0000320193-26-000005"
# Extract press release (Exhibit 99.1) from an 8-K
curl "http://localhost:18001/api/v1/filings/exhibit/0000320193-26-000005?exhibit_type=EX-99.1"</code></pre>
<h3>ETF Holdings</h3> <h3>ETF Holdings</h3>
<pre><code>curl "http://localhost:18001/api/v1/etf/holdings/QQQ"</code></pre> <pre><code>curl "http://localhost:18001/api/v1/etf/holdings/QQQ"</code></pre>
@ -212,7 +233,8 @@ news = client.get_news_social_data("AAPL", days_back=7)</code></pre>
<h2>📈 Key Features</h2> <h2>📈 Key Features</h2>
<ul> <ul>
<li><strong>SEC EDGAR Data</strong> - Official company filings (10-K, 10-Q)</li> <li><strong>SEC EDGAR Data</strong> - Official company filings (10-K, 10-Q) with XBRL financial data</li>
<li><strong>SEC Filings Search</strong> - Index and search 8-K, 6-K, 20-F, 40-F filings with exhibit extraction</li>
<li><strong>Real-time News</strong> - Yahoo Finance + NewsAPI integration</li> <li><strong>Real-time News</strong> - Yahoo Finance + NewsAPI integration</li>
<li><strong>Social Sentiment</strong> - Reddit discussions and sentiment analysis</li> <li><strong>Social Sentiment</strong> - Reddit discussions and sentiment analysis</li>
<li><strong>ETF Holdings</strong> - Complete ETF portfolio analysis via N-PORT</li> <li><strong>ETF Holdings</strong> - Complete ETF portfolio analysis via N-PORT</li>
@ -265,6 +287,10 @@ app.openapi_tags = [
"name": "metadata", "name": "metadata",
"description": "Data catalog and metadata endpoints" "description": "Data catalog and metadata endpoints"
}, },
{
"name": "filings",
"description": "SEC filings search, document listing, and exhibit extraction (8-K, 6-K, 20-F, 40-F)"
},
{ {
"name": "etf", "name": "etf",
"description": "ETF holdings endpoints" "description": "ETF holdings endpoints"

Loading…
Cancel
Save