REST API

Developer

Structured JSON endpoints for filings, companies, watchlists, and earnings. All responses follow a consistent format with pagination metadata.

Base URLhttps://api.8kintel.com
AuthAuthorization: Bearer YOUR_API_KEY
Content-Typeapplication/json

Filings

GET/api/v1/filingsAuth

List filing events, paginated and filterable by ticker, index, category, and sentiment.

ParameterTypeDescription
limitintegerResults per page (1–100, default 20)
offsetintegerPagination offset (default 0)
tickerstringFilter by ticker symbol (e.g. AAPL). Mutually exclusive with index_id.
index_idstringFilter by market index (sp500, nasdaq100, djia). Mutually exclusive with ticker.
categorystringFiling category: earnings, mna, leadership, cyber, financial, governance, other
sentimentstringAI sentiment: bullish, bearish, neutral
Example response
{
  "data": [
    {
      "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "ticker": "AAPL",
      "company_name": "Apple Inc.",
      "accession_number": "0000320193-26-000042",
      "filing_url": "https://www.sec.gov/Archives/edgar/data/...",
      "filed_at": "2026-03-14T16:30:00Z",
      "items": ["2.02", "9.01"],
      "summary": {
        "headline": "Q1 2026 revenue beats estimates by 8%",
        "sentiment": "bullish",
        "bullet_1": "Revenue $124.3B vs $115.2B est.",
        "bullet_2": "Services segment hits all-time high at $26.1B",
        "bullet_3": "Guidance raised for Q2 2026",
        "guidance_change": "raised",
        "beat_miss": "beat",
        "exhibits": [
          { "type": "EX-99.1", "filename": "ex991.htm", "url": "https://..." }
        ]
      },
      "e2e_latency_ms": 38200,
      "created_at": "2026-03-14T16:30:38Z"
    }
  ],
  "meta": { "total": 1842, "limit": 20, "offset": 0 }
}
GET/api/v1/filings/{id}Auth

Get a single filing by UUID. Returns full detail including exhibit metadata and AI analysis.

ParameterTypeDescription
idrequiredstringFiling UUID
GET/api/v1/filings/watchlistAuth

List filings for tickers on the authenticated user's watchlist. Includes read/unread status.

ParameterTypeDescription
limitintegerResults per page (1–100, default 20)
offsetintegerPagination offset (default 0)
tickerstringFilter by ticker
categorystringFiling category filter
sentimentstringSentiment filter
readstringRead status: true or false
POST/api/v1/filings/{id}/readAuth

Mark a filing as read.

DELETE/api/v1/filings/{id}/readAuth

Mark a filing as unread.

POST/api/v1/filings/read-allAuth

Mark all watchlist filings as read. Returns count of newly marked filings.

POST/api/v1/filings/{id}/pinAuth

Pin a filing to your dashboard.

DELETE/api/v1/filings/{id}/pinAuth

Unpin a filing from your dashboard.

Companies

GET/api/v1/companies/search?q={query}Auth

Search companies by ticker or name using trigram fuzzy matching. Returns up to 50 results.

ParameterTypeDescription
qrequiredstringSearch query (ticker or company name)
limitintegerMax results (1–50, default 20)
GET/api/v1/companies/{ticker}Auth

Get company detail including indices, watchlist status, and recent filings.

ParameterTypeDescription
tickerrequiredstringStock ticker symbol
GET/api/v1/companies/trendingAuth

Trending companies by recent filing activity (last 48 hours).

ParameterTypeDescription
limitintegerMax results (1–50, default 10)

Watchlist

GET/api/v1/watchlistAuth

Get the authenticated user's watchlist with company names, latest filing info, and 30-day filing count.

POST/api/v1/watchlistAuth

Add a ticker to the watchlist.

ParameterTypeDescription
tickerrequiredstringTicker symbol to watch (e.g. AAPL)
DELETE/api/v1/watchlist/{ticker}Auth

Remove a ticker from the watchlist.

ParameterTypeDescription
tickerrequiredstringTicker to remove

Earnings

GET/api/v1/earnings/upcomingAuth

List upcoming earnings dates for SEC-filing companies.

ParameterTypeDescription
daysintegerLookahead window in days (1–90, default 14)
limitintegerResults per page (1–100, default 20)
offsetintegerPagination offset (default 0)
Earnings entry shape
{
  "id": "...",
  "ticker": "AAPL",
  "company_name": "Apple Inc.",
  "earnings_date": "2026-04-24",
  "earnings_time": "AMC",
  "fiscal_quarter": "Q2 2026",
  "eps_estimate": "1.62",
  "num_estimates": 38,
  "market_cap": "3.2T",
  "days_until": 41
}

Dashboard

GET/api/v1/dashboardAuth

Get dashboard overview: unread count, filing stats, risk filings, and pinned filings.

Devices

GET/api/v1/devicesAuth

List registered push notification devices (tokens masked).

POST/api/v1/devicesAuth

Register a device for push notifications.

ParameterTypeDescription
platformrequiredstringios or android
device_tokenrequiredstringAPNs or FCM device token
DELETE/api/v1/devices/{id}Auth

Remove a registered device.

Preferences

GET/api/v1/preferencesAuth

Get user notification preferences (per-category toggles).

PUT/api/v1/preferencesAuth

Update notification preferences.

Example body
{
  "real_time_alerts": true,
  "earnings": true,
  "mna": true,
  "leadership": false,
  "cyber": true,
  "financial": false
}

API Keys

POST/api/v1/api-keysAuth

Create a new API key. The full key is only returned once — store it securely.

ParameterTypeDescription
namerequiredstringFriendly name for the key (e.g. 'Trading Bot')
GET/api/v1/api-keysAuth

List your API keys (prefix only, not the full key).

GET/api/v1/api-keys/{id}/usageAuth

Get usage stats for a specific API key.

DELETE/api/v1/api-keys/{id}Auth

Revoke an API key. This action cannot be undone.

Error Responses

All errors return a consistent JSON shape:

{ "error": "description of what went wrong", "code": "ERROR_CODE" }
HTTPCodeMeaning
400BAD_REQUESTInvalid parameters or body
401UNAUTHENTICATEDMissing or invalid auth token
403TIER_REQUIREDFeature requires a higher subscription tier
404NOT_FOUNDResource does not exist
429RATE_LIMITEDRate limit exceeded — check Retry-After header