编程

Scavio Sec Edgar

试用

Resolve a ticker to a CIK, then pull SEC EDGAR filer profiles, filings, XBRL financial concepts and full-text search across 2001-today. 6 endpoints, 1 credit each, structured JSON.

它能做什么

Resolve a ticker to a CIK, then pull SEC EDGAR filer profiles, filings, XBRL financial concepts and full-text search across 2001-today. 6 endpoints, 1 credit each, structured JSON.

技能文档

SEC EDGAR via Scavio

Resolve a ticker or company name to its CIK, then read the filer's profile, page its filings, pull the full reported history of any XBRL concept, list every concept it reports, and run EDGAR full-text search back to 2001. All six endpoints return structured JSON.

When to trigger

Use this skill when the user asks to:

  • Find a company's CIK from a ticker or name
  • List a company's SEC filings, filtered by form type or date
  • Pull a reported financial number over time (revenue, net income, EPS) straight from XBRL
  • Discover which financial concepts a filer actually reports
  • Search the full text of SEC filings for a phrase, a risk factor, or a named party
  • Check a filer's SIC industry, EIN, LEI, state of incorporation or fiscal year end
  • Build investment research, fundamentals datasets, or filing-monitoring pipelines

Setup

Get a free API key at scavio.dev (50 free credits to get started, no card required):

export SCAVIO_API_KEY=sk_live_your_key

Every request is a POST with a JSON body and:

Authorization: Bearer $SCAVIO_API_KEY

Endpoints

Base URL: https://api.scavio.dev. All paths are under /api/v1/sec. Every endpoint costs 1 credit.

EndpointCreditsWhat it returns
POST /api/v1/sec/lookup1Start here. Ticker or name to CIK, with the listing exchange
POST /api/v1/sec/company1Filer profile: names, SIC, EIN, LEI, addresses, tickers, filing habits
POST /api/v1/sec/filings1A page of filings with direct document links
POST /api/v1/sec/concept1Every value a filer reported for one XBRL concept
POST /api/v1/sec/facts1The index of every XBRL concept a filer reports
POST /api/v1/sec/search1EDGAR full-text search, 2001-today, with facets

This runs on the SEC's own free JSON API, so the data is first-party.

Workflow

Look up first. Callers hold a ticker (AAPL); EDGAR is keyed by CIK (0000320193).

  1. Resolve: call /sec/lookup with query - a ticker, a company name, or a fragment. Each row carries its match tier as match, plus ready-made submissions, company-facts and EDGAR URLs.
  2. Profile: call /sec/company with the cik (or a ticker - both fields accept either spelling, which softens the lookup step but does not remove it).
  3. Filings: call /sec/filings with cik or ticker, filtered by form and dates.
  4. Financials, in two steps: call /sec/facts to discover which XBRL tags the filer actually reports, then /sec/concept with one of those tags to pull its full reported history.
  5. Full text: call /sec/search to find the documents that mention a phrase, across all filers.

/sec/lookup, /sec/company, /sec/concept and /sec/facts do not paginate. /sec/filings and /sec/search do.

Pagination

  • /sec/filings - page (1-based) with limit (1-500, default 50).
  • /sec/search - page, capped at 100, 100 documents per page. The index refuses a result window past 10,000, which is where the cap comes from.
  • limit on /lookup, /concept and /facts sizes the response. It is not a page parameter and there is no second page.

Parameters

Lookup (/lookup)

ParameterTypeDefaultDescription
querystringrequiredTicker, company name, or a fragment (1-200 chars)
limitinteger101-100. Sizes the response; not a page param.
exchangestring--NASDAQ, NYSE, OTC, CBOE, matched case-insensitively

Filers the SEC lists with no exchange at all are excluded by any exchange value - omit it if you might be chasing an OTC or unlisted filer.

Company (/company)

ParameterTypeDefaultDescription
cikstringone of320193, 0000320193 or CIK0000320193 (1-20 chars). A ticker is accepted here too.
tickerstringone ofDotted or dashed (BRK.B / BRK-B). Wins over cik when both are given.

cik or ticker is required.

Filings (/filings)

ParameterTypeDefaultDescription
cikstringone ofSee above
tickerstringone ofSee above
formstring or array--"10-K", ["10-K","10-Q"] or "10-K,8-K" (up to 25). Matched against the form and its root form.
date_fromstring--YYYY-MM-DD
date_tostring--YYYY-MM-DD
pageinteger--1-based
limitinteger501-500
include_historybooleanfalseReach past the "recent" block into up to 10 archived shards. Still 1 credit.

cik or ticker is required.

Concept (/concept)

ParameterTypeDefaultDescription
conceptstringrequiredCase-sensitive XBRL tag, e.g. NetIncomeLoss (1-120 chars, ^[A-Za-z][A-Za-z0-9]*$)
cikstringone ofSee above
tickerstringone ofSee above
taxonomystringus-gaapus-gaap, dei, ifrs-full, srt
unitstring--e.g. USD vs USD/shares
formstring--Exact match here - 10-K excludes 10-K/A
limitinteger2501-2000. Sizes the response.

cik or ticker is required.

Facts (/facts)

ParameterTypeDefaultDescription
cikstringone ofSee above
tickerstringone ofSee above
taxonomystring--Restrict to one taxonomy
querystring--Case-insensitive substring against tag name and label (1-200 chars)
limitinteger2501-2000

cik or ticker is required.

ParameterTypeDefaultDescription
querystring--Quoted phrase for exact, bare words for a bag of terms (1-500 chars). Optional.
cikstring or array--Up to 25. Tickers accepted here too.
tickerstring or array--Up to 25
formstring or array--Up to 25
date_fromstring--YYYY-MM-DD. Coverage starts 2001.
date_tostring--YYYY-MM-DD
locationstring or array--EDGAR's own two-character codes: CA, NY, and alphanumeric codes for foreign jurisdictions
sortstringrelevancerelevance, newest, oldest
pageinteger--1-100, 100 documents per page

/search accepts no query at all - a cik, ticker, form or date filter on its own is a valid search.

Examples

import requests

BASE = "https://api.scavio.dev"
# Your key from https://scavio.dev. Load it from your environment or secret
# store in real code - keep it out of source control.
API_KEY = "sk_your_key_here"
HEADERS = {"Authorization": f"Bearer {API_KEY}"}

# 1. Resolve the ticker to a CIK - always start here
hits = requests.post(f"{BASE}/api/v1/sec/lookup", headers=HEADERS,
    json={"query": "AAPL"}).json()

# 2. Filer profile
company = requests.post(f"{BASE}/api/v1/sec/company", headers=HEADERS,
    json={"ticker": "AAPL"}).json()

# 3. Annual reports only - note this also brings back 10-K/A amendments
filings = requests.post(f"{BASE}/api/v1/sec/filings", headers=HEADERS,
    json={"ticker": "AAPL", "form": "10-K", "date_from": "2015-01-01", "limit": 100}).json()

# 4. Financials in two steps: discover the tag, then pull its history
facts = requests.post(f"{BASE}/api/v1/sec/facts", headers=HEADERS,
    json={"ticker": "AAPL", "query": "revenue"}).json()

revenue = requests.post(f"{BASE}/api/v1/sec/concept", headers=HEADERS,
    json={"ticker": "AAPL", "concept": "RevenueFromContractWithCustomerExcludingAssessedTax",
          "taxonomy": "us-gaap", "unit": "USD"}).json()

# 5. Full-text search across all filers, 2001-today
mentions = requests.post(f"{BASE}/api/v1/sec/search", headers=HEADERS,
    json={"query": "\"material weakness\"", "form": "8-K",
          "date_from": "2024-01-01", "sort": "newest", "page": 1}).json()

Response shapes

Every response uses the envelope { data, response_time, credits_used, credits_remaining }.

  • lookup - matching filers with symbol, listing exchange, and ready-made submissions / company-facts / EDGAR URLs, tiered by match quality; each row carries its tier as match.
  • company - legal and former names, SIC industry, filer category, EIN, LEI, state of incorporation, fiscal year end, business and mailing addresses, every ticker with its exchange, which forms it files and how often, plus a preview of its 10 most recent filings.
  • filings - accession number, form and root form, filing and period dates, 8-K item codes, direct links to the primary document, the filing index and the attachment directory. history_truncated is set when include_history hit the 10-shard cap.
  • concept - every value the filer reported for that concept, newest period first, with the form and filing each number came from. Restatements are kept, not collapsed, and latest disambiguates a quarter from its year-to-date twin using the SEC's comparability flag.
  • facts - every XBRL concept the filer reports: tag, label, description, units and most recent value, across us-gaap, dei and any other taxonomy it uses.
  • search - each hit is the matching document with its URL, form, filing date and filer identity, plus facets breaking the whole result set down by company, form, industry and state.

Guardrails

  • Every call is 1 credit, including include_history, which can buy up to 10 upstream fetches for that one credit. Use it rather than paging blindly into the past.
  • XBRL tags are case-sensitive. netincomeloss is a 404 upstream, not a fuzzy match. Never guess a tag - call /sec/facts and use one it actually reports.
  • form behaves differently on two endpoints. On /filings it matches the form and its root form, so 10-K also returns 10-K/A amendments (ask for 10-K/A to get amendments only). On /concept it is an exact match, so 10-K excludes 10-K/A. Do not carry an assumption from one to the other.
  • EDGAR's "recent" block is not a fixed window - it can be a decade for a quiet filer and about a year for a prolific one. Never tell the user "this is everything" from a default /filings call; set include_history and check history_truncated.
  • Full-text search coverage starts in 2001. A phrase absent from /search results is not proof it was never filed.
  • Restatements are preserved in /concept. If you report a single number for a period, say which filing it came from.
  • ticker wins over cik when both are sent - do not send a mismatched pair and expect the CIK to be honoured.
  • Never fabricate CIKs, accession numbers, filing dates or reported figures. Only return API data, and cite the filing behind any number you quote.
  • This is public regulatory data, not investment advice. Do not present a figure as a recommendation.

Failure handling

  • 400 means an invalid or missing parameter - e.g. neither cik nor ticker, or a malformed date. Fix and retry.
  • 401 means the API key is invalid or missing. Check SCAVIO_API_KEY.
  • 404 usually means the CIK, the concept tag or the taxonomy does not exist upstream. Re-resolve with /lookup or /facts rather than retrying the same value.
  • 429 means rate or usage limit exceeded. Wait before retrying. See rate limits.
  • 502 / 503 mean upstream is temporarily unavailable - wait a few seconds and retry.
  • If /search returns nothing, remember coverage starts in 2001 and try a looser phrase or a wider date range.
  • If SCAVIO_API_KEY is not set, prompt the user to export it before continuing.

Python SDK

langchain-scavio has no SEC EDGAR tool - use the Scavio SDK directly:

pip install scavio==0.15.0
from scavio import ScavioClient

client = ScavioClient()  # reads SCAVIO_API_KEY

hits = client.sec.lookup("AAPL")
company = client.sec.company(ticker="AAPL")
filings = client.sec.filings(ticker="AAPL", form=["10-K", "10-Q"], include_history=True)
facts = client.sec.facts(ticker="AAPL", query="revenue")
history = client.sec.concept("NetIncomeLoss", ticker="AAPL", taxonomy="us-gaap")
docs = client.sec.search(query='"material weakness"', form="8-K", sort="newest")

JavaScript / TypeScript:

npm install scavio@0.15.0
import { Scavio } from "scavio";

const scavio = new Scavio(); // reads SCAVIO_API_KEY
const hits = await scavio.sec.lookup({ query: "AAPL" });
const history = await scavio.sec.concept({ ticker: "AAPL", concept: "NetIncomeLoss" });

相关技能

Company profiles and recent SEC filings from EDGAR via Edgrapi.com. Resolve a US-listed ticker to its CIK, industry, fiscal-year end, and exchange, and list...

1 次安装

Clean company financials from SEC EDGAR via Edgrapi.com. Four tools — pull normalized income/balance/cash-flow fundamentals, computed ratios, company profile...

1 次安装

SEC filings, insider trades & company financials for AI agents — pull SEC EDGAR filings, 8-K material events, Form 4 insider transactions, headline financial...

2 次安装

Researches stocks, crypto, SEC filings, insider/congressional trading, and private-market (VC/PE) profiles via the Crawlora API — Yahoo Finance quotes/financials/history/options, SEC EDGAR filings and financial statements, congressional stock disclosures, CoinGecko crypto markets, and PitchBook company/fund/investor teasers — returning clean JSON. Use when the user asks about a ticker's price/financials/news, a company's SEC filings or insider trades, what a member of Congress traded, a crypto coin's market data, or a private company/fund/investor profile.

3 次安装

Normalized company financial statements and computed ratios from SEC EDGAR via Edgrapi.com. Pull clean income/balance/cash-flow figures and margin/return/lev...

1 次安装

Extract management guidance and forward-looking statements from SEC filings (10-K/10-Q, and 20-F/40-F/6-K for foreign private issuers). Self-contained by default (fetches from EDGAR, in-memory BM25, Claude/OpenAI). Optional heavy mode delegates to a local RAG pipeline.

1 次安装