尚未收集仓库信息。
尚未检测到更新。GitHub 发布版本后会显示在这里。
Point-in-time SEC fundamentals for AI agents and quants: 120.5M+ standardized facts from 12M+ filings, 19,000+ US companies since 1993, each traced to its filing. Docs and examples for the Python SDK, API and MCP; delisted companies included on paid tiers.
翻译准备中
取自仓库 README
正在加载完整 README。
查看完整 README ↗Point-in-time, survivorship-free SEC fundamentals — built for AI agents, safe enough for institutions that fear AI. Every number is born in a filing and carries a
fact_id; the model never mints a digit. Streamed as Parquet, queried with DuckDB or natural language, reproducible run to run.
This repository is the public home and discovery hub for the Valuein data platform. It hosts the documentation, examples, notebooks, and the MCP registry manifest used by AI agents to find us. Source code for the SDK, MCP server, and data pipeline lives in dedicated repositories — this is the front door.
pip install "valuein-sdk>=7.1.0" # data for code
# or add this URL to any MCP-capable AI client:
# https://mcp.valuein.biz/mcp # data for agents
| You want to… | Go to |
|---|---|
| Try the SDK in 30 seconds without a token | Quickstart |
| See every channel we ship through | Distribution channels |
| Check pricing and what each plan unlocks | Plans & access |
| See why AI agents are first-class citizens here | Built for AI agents |
| Connect an AI agent (Claude, Copilot, ChatGPT, Cursor…) | MCP for AI agents |
| Set up the Workspace by role (analyst, PM, quant, creator) | docs/WORKSPACE_GUIDE.md |
| Read the data model | Data model |
| Find a quick recipe by role | Recipes by role |
| Run end-to-end Python examples | examples/python/ |
| Run interactive notebooks (Colab) | examples/notebooks/ |
| Read the methodology / SLA / compliance | Documentation |
Survivorship-bias-free, point-in-time US fundamentals sourced directly from SEC EDGAR.
standard_concept names plus materialized financial ratios (FY + TTM); unmapped tags are exposed under 'Other' rather than droppedfiling_date and millisecond-precision accepted_atCounts move with every snapshot, so this page does not copy them; read them live. client.manifest() returns the snapshot id, last_updated and your plan's tables; curl -s https://data.valuein.biz/v1/sample/manifest.json | jq .schema_version prints the live schema version; https://data.valuein.biz/v1/plans gives each plan's universe size and history window; docs/data_catalog.md lists the canonical concepts and ratios.
| Property | What it means for you |
|---|---|
| 🕒 Point-in-time | filing_date <= trade_date removes look-ahead bias. accepted_at gives intraday resolution for same-day signals. |
| ⚖️ Survivorship-bias free | Delisted, bankrupt, and acquired companies remain in every snapshot — your backtest sees the universe the market saw. |
| 📊 Standardized concepts | Both the raw XBRL tag (fact.concept) and the canonical name (fact.standard_concept) are on every row. No hidden mapping table. |
| 🔍 CPA-verified catalog | Every standard_concept carries a review_confidence — 1.0 once an accountant has signed off on its name, statement and rule (then it's locked; the pipeline only ever adds new concepts, never mutates a verified one), 0.7 while provisional. Filter review_confidence >= 1.0 for the labels analysts, quants and AI models can agree on and train against. |
| 🚀 DuckDB-native | Millisecond analytics over remote Parquet via httpfs. Zero database provisioning. |
| 🔁 Append-only restatements | A 10-K/A adds a new row — the original stays. Reconstruct the as-reported view of any historical date. |
| 🧾 Measured, published accuracy | Mathematical consistency checked against published, cited accounting identities — CI-gated, and re-derivable yourself with one DuckDB command. The current measured figure lives in docs/accuracy/baseline.json. |
| 🔐 One token, every channel | The same Bearer token authenticates the SDK, MCP server, and bulk-data API. |
Valuein is MCP-first and agent-agnostic: the same typed tool surface works in Claude, Copilot, ChatGPT, Perplexity, Gemini, Grok, Cursor, or your own LangGraph / CrewAI agent. The design goal is simple — the model never mints a number. Numbers are born in tools, carried as provenance-tagged facts, and the model is only allowed to arrange words around figures it was handed.
| Guarantee | How it's enforced |
|---|---|
| Fact-level lineage | Every figure a tool returns carries a fact_id and its source filing; verify_fact_lineage round-trips any fact_id back to the exact SEC filing URL in one call. |
| Zero look-ahead | Every time-series tool accepts as_of_date and reconstructs the information set as of that date — the same PIT discipline the Parquet layer enforces for backtests. |
| Reproducible runs | Deterministic, idempotent tools: same inputs, same output. No rolling windows, no hidden "latest". Agents can cache, retry, and replay; you can reproduce a run later. |
| Agent-agnostic state | Theses, claims, watchlists, signals, and reports persist server-side across sessions and across clients — save a thesis from Claude today, list it from Cursor tomorrow. |
| Human-on-the-loop (HOTL) | Mutating and outward-facing tool actions go through a staged-action approval ledger: the agent proposes, a human approves, and the decision lands in an immutable audit entry. Read-only tools never stage. |
| Governed managed runs | Server-side managed agent runs execute at temperature 0 with a model allow-list and destructive-tool stripping — reproducible research, not improvisation. |
| Graded track records | Saved theses and claims are scored against subsequent fundamentals and prices; publishing builds a public, verifiable track record — your agent keeps score. |
The full tool reference is in docs/MCP_TOOLS.md; agent-facing runtime instructions are in AGENTS.md.
The same dataset, delivered four ways so it lands where you already work.
| Channel | Audience | Endpoint / install |
|---|---|---|
| Python SDK | Quants, engineers, data scientists | pip install valuein-sdk · PyPI |
| MCP server | AI agents (Claude, Copilot, ChatGPT, Cursor, custom) | https://mcp.valuein.biz/mcp · server.json |
| Web dashboard | Retail, executives, non-technical users | valuein.biz |
| Bulk data API | B2B partners, fintech platforms | https://data.valuein.biz · contact us |
A single Stripe-issued token unlocks every channel at your tier — no per-channel billing.
Pricing and feature scope are mirrored from valuein.biz/pricing — the website is the source of truth and our checkout flow routes to the correct Stripe product.
| Plan | Universe | History | Get it |
|---|---|---|---|
| Sample | Large-cap US benchmark universe | Recent years | Free, no signup: pip install "valuein-sdk>=7.1.0" |
| Benchmark | Large-cap US benchmark universe | Full history | Free, register |
| Pro | Full active + delisted US universe, fundamentals dataset | Rolling point-in-time window | Subscribe |
| Institutional | Same universe + smart-money dataset (insider transactions on Forms 3/4/5/144 + institutional ownership on Forms 13F/13D/13G) | Full history back to 1993 | Subscribe |
| Enterprise | Organisations and teams, by Enterprise Agreement: the whole dataset, multi-seat · display in your own products and client deliverables, with attribution, where the Order Form says so · dedicated infrastructure · negotiated scope | Custom | [email protected] |
Redistribution, resale and white-label are not part of any plan, Enterprise included: data vendors and platforms sign a separate Redistribution Licence ([email protected]).
Prices, universe sizes, history windows and rate limits are served live; read them instead of a copy:
curl -s https://data.valuein.biz/v1/plans \
| jq '.plans[] | {displayName, priceUsd, universeSize, earliestYear, perMinute, perHour}'
Each tier removes a different buyer objection — Pro removes the universe + history limits on the fundamentals dataset; Institutional adds the smart-money dataset (insider transactions + institutional ownership), unlimited history back to 1993, filing-event webhooks, and a single-seat internal-use licence (no redistribution); Enterprise is for organisations and teams: an Enterprise Agreement for multi-seat use and, where the Order Form says so, display in your own products and client deliverables with attribution, plus dedicated infrastructure, service levels and bespoke contracts. Redistribution, resale and white-label need a separate Redistribution Licence, which no plan includes.
Subscribe for the data. Pay only for the AI you use.
Autonomous AI agents that hit a rate or tier limit can pay per request using Stripe card tokens — no human checkout loop. Payment uses the Machine Payment Protocol. The agent quotes a price, charges a card Shared Payment Token, then retries the MCP call with the confirmed token.
Payment is card-only today. Fetch https://api.valuein.biz/api/mpp/well-known to see which networks are live before paying.
| Category | Examples | Billed |
|---|---|---|
| Provenance / schema | describe_schema, verify_fact_lineage | Free |
| Discovery | search_companies, get_sec_filing_links | per entity |
| Fundamentals | get_company_fundamentals, get_financial_ratios | per entity |
| Analytics | get_valuation_metrics, get_peer_comparables, compare_periods, get_capital_allocation_profile | per entity |
| Compute | compute_dcf, forensic_audit, generate_dcf_xlsx, generate_research_brief_docx, generate_comps_xlsx | per call |
| Screens / universe | screen_universe, get_pit_universe | per call |
| Smart money (Institutional dataset) | get_insider_transactions, get_insider_sentiment, get_institutional_holdings, get_manager_portfolio, get_blockholders, get_top_holders, get_smart_money_flow | per entity |
Live prices: curl -s https://data.valuein.biz/v1/plans | jq '.paygRates, .toolToMeter' (the meter each tool bills to, and its USD rate); a 402 quotes the exact price before anything is authorized. A Valuein token holder pays 50% less per call, except smart-money calls. Per call, PAYG costs more than a subscription, so steady-state agent usage is almost always cheaper on a Pro or Institutional subscription. See AGENTS.md for the full three-step MPP flow.
The whole pattern — an agent that buys its own data, safely — is written up as a reference implementation in docs/AGENT_ECONOMY_RAIL.md: the two live consent models (a human-authorized bounded budget that auto-charges and serves inline; or per-call MPP for wallet-holding agents), why it's the safe default, and a runnable demo — examples/python/agent_buys_its_own_data.py — that discovers the rail and reads back a live quote for free.
Rate limits per tier are the perMinute / perHour fields of https://data.valuein.biz/v1/plans (the jq command under Plans & access prints them).
Pick whichever Python workflow you already use — both work in any virtual environment, and both run the same code below:
# Option A — pip (universal, ships with Python)
python -m venv .venv && source .venv/bin/activate
pip install "valuein-sdk>=7.1.0"
# Option B — uv (10–100× faster; install from https://docs.astral.sh/uv/)
uv venv && source .venv/bin/activate
uv pip install "valuein-sdk>=7.1.0"
Zero-friction by design. No
VALUEIN_API_KEY? No problem. The SDK detects the missing token and falls back to the SAMPLE dataset (S&P 500, last 5 years); the edge gateway does the same —GET /v1/{sp500,pro,full}/:tablewith noAuthorizationheader automatically 302-redirects to/v1/sample/:table. The snippet below runs as-is.
from valuein_sdk import ValueinClient
with ValueinClient() as client:
print(client.me()) # {plan, status, email, createdAt}
print(client.manifest()) # snapshot id, last_updated, tables
print(client.tables()) # tables your plan can read (they load on first use)
df = client.run_query("""
SELECT r.symbol, r.name, r.sector
FROM "references" r
JOIN index_membership im ON im.cik = r.cik
WHERE im.index_name = 'SP500'
AND im.removal_date IS NULL
AND r.is_active = TRUE
ORDER BY r.name
LIMIT 10
""")
print(df)
That's a real query against the live S&P 500 sample. Add a token only when you need full universe or full history:
# optional — the sample tier works without a key
export VALUEIN_API_KEY="your_token_here" # or add this line to a .env file
The same code now reads from your tier — no other changes. ValueinClient() reads VALUEIN_API_KEY from the environment, or from the first .env it finds walking up from the working directory; ValueinClient(api_key="") forces the free sample whatever the environment holds. The curl and DuckDB examples in this repo keep the same token in $VALUEIN_TOKEN: it is the same token under a shell-variable name, and the SDK does not read that one.
from valuein_sdk import (
ValueinClient,
ValueinAuthError,
ValueinPlanError,
ValueinRateLimitError,
ValueinAPIError,
ValueinError,
)
# Two-level try/except is intentional:
# outer = init errors raised by ValueinClient.__enter__ (auth, manifest, 503)
# inner = per-query errors raised by run_query / run_template (rate-limit,
# plan denial, bad SQL). Each level dispatches by exception type so
# you can act on the right cause — exit on auth, sleep on rate-limit,
# upsell on plan, log + skip on a single bad row.
try:
with ValueinClient() as client:
try:
# 1) Build & run a raw SQL query → pandas DataFrame
sql = "SELECT COUNT(cik) FROM entity"
result = client.run_query(sql)
print(result)
# 2) Run a named SQL template with kwargs (the SDK quotes safely)
df = client.run_template(
"fundamentals_by_ticker",
ticker="AAPL",
start_date="2020-01-01",
end_date="2024-12-31",
form_types=["10-K", "10-Q"],
metrics=["TotalRevenue", "NetIncome", "OperatingCashFlow"],
)
print(df.head())
except ValueinPlanError:
print("This query needs a higher plan — see valuein.biz/pricing.")
except ValueinRateLimitError as e:
print(f"Rate limited; retry in {e.retry_after}s.")
except ValueinError as ve:
# Catch-all for any other per-query failure (validation, bad SQL, etc.)
print(f"Query failed: {ve}")
except ValueinAuthError:
raise SystemExit("Token missing or expired — set VALUEIN_API_KEY.")
except ValueinAPIError as e:
print(f"Gateway error during init (HTTP {e.status_code}).")
except Exception as e:
print(f"Initialization failed: {e}")
The SDK ships named SQL templates for the most common screens, ratios, and PIT backtests. List the ones your installed version carries:
from valuein_sdk import ValueinClient
with ValueinClient() as c:
print(c.list_templates())
from valuein_sdk import ValueinClient
with ValueinClient() as client: # no token: free sample tier
fin = client.financials("AAPL") # income, balance sheet, cash flow as known at as_of
print(fin.income)
print(fin.lineage.head()) # each number's fact_id, filing accession and acceptance time
screen = client.screen("2024-06-28", universe="SP500").where("return_on_equity > 0.15")
print(screen.top(10, by="gpoa").to_pandas().summary()) # members on that date, delisted included
| You want… | Call | Plan |
|---|---|---|
| Raw SQL over point-in-time views | client.run_query(sql), client.duckdb() | all |
| Statements as known on a date | client.financials("AAPL", freq="FY") ("Q", "TTM"; .as_filed()) | all |
| Index members on a past date (delisted included) | client.universe(dates=[...]), client.pit_universe("2022-06-30") | all |
| Ratios known on those dates | client.signal_panel(members, ratios=[...], include_price=False) | all |
| A point-in-time screen | client.screen("2024-06-28").where("return_on_equity > 0.15") | all (price fields: Pro) |
| A two-stage DCF with traced inputs | client.dcf("MSFT", stage1_growth_rate=0.08) | all |
| Peers and restatements | client.peers("MSFT", n=5), client.restatements(ticker="MPWR") | all |
| Quantile backtest, vintages, trial counting | client.factor_backtest(...), client.restatement_impact(...), client.study(...) | daily bars: Pro and Institutional |
| Mirror or pin the data | client.sync(path), ValueinClient.from_bundle(path) | plan-limited |
from valuein_sdk import ValueinClient
client = ValueinClient() # reads VALUEIN_API_KEY; no key = free sample
# S&P 500 members on a past date, later-removed companies included
members = client.universe(dates=["2022-06-30"])
# Return on equity as it was known on that date
panel = client.signal_panel(members, ratios=["return_on_equity"], include_price=False)
print(panel.head())
# A DCF with your growth assumption; every input traced to its filing
dcf = client.dcf("MSFT", stage1_growth_rate=0.08)
print(dcf.value_per_share, dcf.price, dcf.upside)
# Numbers a later filing changed, with both filings
print(client.restatements(ticker="MPWR").head())
The same client runs factor backtests with tear sheets, compares a factor on point-in-time, as-filed and restated numbers, counts your trials (deflated Sharpe), and mirrors or pins a data snapshot: docs/SDK_USE_CASES.md.
Reference: docs/QUERY_COOKBOOK.md (DuckDB recipes) · docs/data_catalog.md (canonical concepts) · PyPI README (SDK quickstart).
Every link below points to a runnable script in examples/python/; most pair with a notebook in examples/notebooks/. The Sample tier runs every example except the Institutional smart-money screen — no token, no signup.
| You are a… | Start with | What you'll see |
|---|---|---|
| Financial analyst | financial_analysis.py | Revenue trend, margin walk, peer comparison from one ticker |
| Quant / researcher | factor_backtest.py | Point-in-time, survivorship-free quantile backtest with costs and IC |
| Portfolio manager | entity_screening.py | Screen the S&P 500 as it stood on a past date, including later-removed members |
| Forensic analyst | restatement_radar.py | Every restated number, how it was disclosed, both filings to verify |
| Asset manager | survivorship_bias.py | Quantify how survivorship bias inflates returns |
| Valuation modeler | dcf_inputs.py | client.dcf(): a two-stage DCF with your assumptions, every input traced to its filing |
| Auditor / compliance | filing_provenance.py | Click-through SEC EDGAR links per filing — open the iXBRL viewer on the exact source document behind a number |
| Data engineer |
Run any of them:
# Sample tier — works without a token
python examples/python/getting_started.py
# Paid tier
VALUEIN_API_KEY=xxx python examples/python/factor_backtest.py
Full schema in docs/schema.json (machine-readable) and docs/data_catalog.md (canonical concept names). Every tier reads the core tables below (including industry_classification, the point-in-time SIC classification, filing_registrant and restatement_events); the Institutional tier adds the smart-money tables (insider_party / insider_filing / insider_transaction / insider_ownership / insider_footnote / insider_ownership_purpose / institutional_filing / institutional_holding / institutional_other_manager) and the Form ADV adviser tables (investment_adviser, investment_adviser_private_fund). client.tables() lists what your plan reads; curl -s https://data.valuein.biz/v1/sample/manifest.json | jq .schema_version prints the live schema version.
| Table | What it is | Why it matters |
|---|---|---|
references | Start here. Flat join of entity + security. One row per security with cik, is_active, sector, exchange, FIGI. For membership, JOIN index_membership on cik = cik. | One scan for cross-company metadata; index membership stays in its own table so historical entry/exit is preserved. |
entity | Company metadata — CIK, name, sector, SIC, status, fiscal year end | The legal entity dimension. |
security | Ticker history (SCD Type 2 with valid_from / valid_to) | Resolve historical tickers, share classes, exchanges. |
filing | Filing metadata — accession_id, filing_date, report_date, form type, amendment flag | The "what was filed when" dimension. |
fact | Standardized financial facts — both raw concept and canonical standard_concept on every row | The numbers. PIT-safe via accepted_at. |
filing_registrant | Every registrant of an accession (every tier, sample included) | filing keeps one row per accession_id, so a combined co-registrant filing appears under one CIK only. Join filing_registrant to filing on accession_id to list a company's filings including the combined ones. |
ratio | Pipeline-computed financial ratios per filing | Skip the SQL — margins, returns, leverage, efficiency pre-calculated. |
taxonomy_guide | The US GAAP taxonomy guide | Definitions for every standard_concept. |
index_membership | Index constituents keyed on cik, with effective_date / removal_date half-open windows. SP500 membership history starts in 1996 — entry/exit spells including long-delisted registrants. It is a reconstruction: before about 2007 it holds fewer members than the index had, and fewer than half of each year's members are . (, ) — reconstructed from the publicly disclosed portfolio holdings of large funds tracking each index, so a fund proxies rather than defines the index, and a join or leave date is only as precise as the interval between observations (roughly one to four a year through 2006, monthly from 2007). No Russell data before 2000-09-30, and no holdings observation between 2016-12-30 and 2017-07-31. |
Tables are plain Parquet over HTTPS. The free sample needs no token and no file extension; paid tiers send the Bearer token. A request without a token to a paid route redirects (302) to the sample copy.
# Free sample — no token, no card
curl -sL https://data.valuein.biz/v1/sample/entity -o entity.parquet
# Paid tiers: sp500 | pro | full — the same Bearer token as the SDK, kept here in $VALUEIN_TOKEN
curl -sL -H "Authorization: Bearer $VALUEIN_TOKEN" https://data.valuein.biz/v1/pro/references -o references.parquet
# One company's partition of a large table (10-digit CIK)
curl -sL -H "Authorization: Bearer $VALUEIN_TOKEN" https://data.valuein.biz/v1/pro/fact/0000320193.parquet -o aapl_fact.parquet
https://data.valuein.biz/v1/sample/manifest.json lists the tables and the schema version of the sample.
| Column | Table | Use for |
|---|---|---|
report_date / period_end | filing / fact | Aligning to the fiscal calendar |
filing_date | filing | PIT backtest filter — when the SEC received it |
accepted_at | fact, filing, ratio (+ smart-money and price tables) | Millisecond-precision PIT for intraday research |
For any cross-company backtest, always filter by
filing_date <= trade_date. Filtering byreport_dateintroduces look-ahead bias.
1. Start from references (one join for cross-company filters; membership is in index_membership):
SELECT r.symbol, r.name, r.sector
FROM "references" r
JOIN index_membership im ON im.cik = r.cik
WHERE im.index_name = 'SP500'
AND im.removal_date IS NULL -- current member
AND r.is_active = TRUE
AND r.sector ILIKE '%technology%'
2. LATERAL for the latest filing per company (an excerpt: add this join to pattern 1's query, which defines r):
JOIN LATERAL (
SELECT accession_id, filing_date FROM filing
WHERE entity_id = r.cik AND form_type = '10-K'
ORDER BY filing_date DESC LIMIT 1
) f ON TRUE
3. Pivot multiple concepts in one fact scan:
SELECT
MAX(CASE WHEN standard_concept = 'TotalRevenue' THEN numeric_value END) AS revenue,
MAX(CASE WHEN standard_concept = 'StockholdersEquity' THEN numeric_value END) AS equity
FROM fact
WHERE standard_concept IN ('TotalRevenue', 'StockholdersEquity')
GROUP BY accession_id
Quarterly cash flows: use
COALESCE(derived_quarterly_value, numeric_value)— Q2/Q3 10-Qs report YTD; this column isolates the single quarter. CAPEX sign varies by filer — alwaysABS(capex).
The full cookbook — recipes, anti-patterns, an end-to-end factor screen — lives in docs/QUERY_COOKBOOK.md.
Query fact.standard_concept with canonical names like 'TotalRevenue', 'NetIncome', 'OperatingCashFlow', 'CAPEX', 'StockholdersEquity' — not raw XBRL tags ('Revenues', 'NetIncomeLoss', 'Assets'). The full list lives in docs/data_catalog.md and the machine-readable form is in docs/data_catalog.json.
Valuein ships a remote, protocol-native Model Context Protocol server so any MCP-capable agent (Claude, Copilot, ChatGPT, Cursor, custom) can answer fundamentals questions — and keep persistent, auditable research state — without writing code.
https://mcp.valuein.biz/mcp (Streamable HTTP, MCP spec 2025-11-25)Authorization: Bearer <your_api_token> — same token as the SDK and bulk-data APIserver.json — published to registry.modelcontextprotocol.io as io.github.valuein/mcp-sec-edgardocs/MCP_TOOLS.md — every tool, every input, every tier gate, and how errors and paged results read (generated from the live manifest)The server exposes 109 live tools, plus 30 agentic SOP prompts (two flagship cross-persona briefs — equity_research_brief and screen_and_shortlist — plus specialised chains for analyst, PM, quant, ratio, smart-money, and workflow personas) and 3 data resources (schema://{table}, reference://sp500, pricing://current). Tier gating happens at the data layer — the free Sample (no token, from 2020) and Benchmark (the large-cap US benchmark universe, current constituents, from 1993) tiers see their slices; Pro sees the full universe of 28,000+ active and delisted companies with a 15-year point-in-time window (2011 → present); Institutional unlocks the smart-money tools (insider transactions on Forms 3 / 4 / 5 / 144 + institutional ownership on Forms 13F / 13D / 13G), Form ADV, unlimited history back to 1993 and filing-event webhooks, for single-seat internal use. Enterprise (an Enterprise Agreement for organisations and teams) adds multi-seat use and, where the Order Form says so, display in your own products and client deliverables with attribution. Redistribution, resale and white-label need a separate Redistribution Licence, which no plan includes.
Discovery & schema
| Tool | What it does |
|---|---|
search_companies | Look up tickers, names, CIKs; filter by sector, S&P 500, active status |
describe_schema | Return columns, types, and descriptions for any table |
get_pit_universe | Survivorship-free membership (S&P 500, Russell 1000 / 2000 / 3000, a sector, or the whole universe) on any historical as_of_date, paged |
Fundamentals & ratios
| Tool | What it does |
|---|---|
get_company_fundamentals | Income statement, balance sheet, cash flow per ticker per period |
get_financial_ratios | Margins, returns, leverage, efficiency, FCF yield (per category) |
get_valuation_metrics | What a company trades at, plus parameter-free reference points; intrinsic value comes from compute_dcf with assumptions you state |
get_capital_allocation_profile | CapEx intensity, buyback yield, dividend history |
Filings & lineage
| Tool | What it does |
|---|---|
get_sec_filing_links | Direct EDGAR URLs for 10-K / 10-Q / 8-K / 20-F / 40-F |
verify_fact_lineage | Trace any number back to the exact filing + accession ID it came from |
Comparison & analytics
| Tool | What it does |
|---|---|
compare_periods | Side-by-side comparison across periods with material-change flags |
get_peer_comparables | Peer set + comparable metrics by sector |
screen_universe | Multi-factor screen across the universe |
Bulk data
| Tool | What it does |
|---|---|
get_compute_ready_stream | Issue signed, expiring download URLs for direct Parquet streaming (skip the gateway) |
Smart money — Institutional tier and above
The smart-money bundle replaces Bloomberg's INSIDER<GO> / OWNER<GO> / HDS<GO> screens with a single Valuein token. Each tool reads a per-CIK Parquet partition and returns structured rows with the lineage envelope for one-click SEC verification.
| Tool | What it does |
|---|---|
get_insider_transactions | Form 3 / 4 / 5 / 144 line items per issuer — joined to insider_party for name + role |
get_institutional_holdings | Form 13F top holders for one issuer with HHI concentration + 13F-lag staleness flag |
get_manager_portfolio | Form 13F filer's full portfolio with QoQ deltas (new / increased / decreased / exited) |
get_blockholders | SC 13D / 13G with the first-class going_active flag (13G→13D = control-change signal) |
get_insider_sentiment · get_top_holders · get_smart_money_flow | Aggregated insider buy/sell signal, largest holders, and net institutional flow per issuer |
Persistent, agent-agnostic research state (all MCP clients)
Research objects live server-side, keyed to your token — save from one AI client, read from another, score later.
| Family | Tools (representative) | What it does |
|---|---|---|
| Theses & claims | save_thesis, save_claim, score_thesis_outcome, score_claim | Time-stamped calls with provenance-bound claims, auto-graded against subsequent fundamentals and prices |
| Watchlists & signals | save_watchlist, create_signal, list_signal_inbox | Standing monitors on price moves, fundamental changes, and filings — delivered to email, webhook, dashboard inbox, or an agent_run that fires a standing agent team |
| Reports | create_report, render_report, save_freeform_report | Durable, versioned research artifacts with branded md/docx export |
| Deferral & rules | schedule_task, create_rule, test_rule | "Re-check AAPL margins in 30 days" → a real scheduled re-run; trigger→action rules (signal fired, inbox item, task wake, schedule tick) |
| Approvals (HOTL) | stage_action, list_pending_approvals, approve_staged_action | Mutating/destructive actions stage for human approval with an immutable audit entry |
| Backtesting | run_backtest, get_pit_valuation_ratios, get_price_history | Bounded PIT factor grids and backtest-safe valuation multiples on any historical date |
| Briefing | get_morning_brief, list_agent_runs | Read your daily brief and managed-run history from any MCP client |
Public publishing — free reputation building (any signed-in plan)
Publish your saved research to a public @handle profile — free to build a public track record and reputation. Reports become a shareable /r/[slug] page discoverable via keyword catalog search (no semantic search yet); theses and claims get the same free publish / unpublish visibility toggle. This is publishing, not selling.
| Tool | What it does |
|---|---|
publish_report | Publish a saved report to your public profile (@handle) as a shareable /r/[slug] page |
unpublish_report | Take a previously published report private again |
search_reports | Search the public report catalog by ticker, author, or keyword (keyword catalog search) |
publish_thesis / unpublish_thesis | Toggle a saved thesis public / private on your profile — parity with publish_report |
publish_claim / unpublish_claim | Toggle a saved claim public / private on your profile — parity with publish_report |
Add to claude_desktop_config.json:
{
"mcpServers": {
"valuein": {
"url": "https://mcp.valuein.biz/mcp",
"headers": { "Authorization": "Bearer YOUR_VALUEIN_API_KEY" }
}
}
}
Same URL + Bearer token works for any MCP client that supports Streamable HTTP remotes — Copilot, ChatGPT, Cursor, your own LangGraph / CrewAI agent.
Every script and notebook works against the SDK published on PyPI. The Sample tier runs without a token; add VALUEIN_API_KEY to use a paid tier.
The full learning path, with who each item is for and the plan it needs: examples/README.md.
examples/python/)| Script | Level | What it shows |
|---|---|---|
getting_started.py | Beginner | Plan, snapshot, ticker → CIK, annual revenue and net income |
financial_analysis.py | Beginner | Income statement and margins, single-quarter cash flow, peer ratios |
pit_backtest.py | Intermediate | The same query at two as_of dates gives two answers (a real restatement) |
entity_screening.py | Intermediate | Screen the S&P 500 as it stood on a past date |
survivorship_bias.py | Intermediate | Honest vs survivor-only equal-weight return |
factor_backtest.py | Advanced | Universe → signal → forward returns → quantile backtest with costs |
pit_factor_dataset.py | Advanced | Point-in-time, survivorship-free factor file to Parquet and CSV |
price_total_return.py | Intermediate | Split and dividend effects on returns; daily helpers on Pro |
examples/notebooks/)Executed on the free sample tier and committed with their output.
| Notebook | Open in Colab |
|---|---|
| Quickstart | |
| Fundamentals as of a date | |
| Survivorship-free screening | |
| Point-in-time factor backtest | |
| Prices and total return | |
| Restatements | |
| Smart money (Institutional) |
Everything in docs/ is kept in sync with the production data and the SDK on PyPI.
| Document | What's in it |
|---|---|
docs/WORKSPACE_GUIDE.md | Workspace welcome guide — 15-minute setup + daily/weekly/monthly playbooks per role (analyst, PM, quant, creator) |
docs/METHODOLOGY.md | Sourcing, PIT architecture, restatement handling, XBRL normalization, the DCF model |
docs/accuracy/ | Accuracy proof — measured source of truth is docs/accuracy/baseline.json (current snapshot: see baseline.json for the latest figure on modern-era ≥2010 S&P 500 FY filings), citable to FactSet PIT / FASB ASC / Penman, reproducible via duckdb -c ".read scripts/accuracy/accuracy_check.sql" |
docs/QUERY_COOKBOOK.md | Copy-pasteable DuckDB recipes — LATERAL, pivots, PIT, factor screens |
docs/SDK_USE_CASES.md | The most common SDK use cases, easiest → advanced, each linked to a notebook executed on the free tier |
docs/MCP_TOOLS.md | Reference for every MCP tool — inputs, output fields, tier gates, errors and paging (generated from the live manifest) |
docs/data_catalog.md | Canonical standard_concept names and definitions |
GitHub Issues is the primary support channel. Use the right template — it routes correctly and gets faster triage.
| I want to… | Open |
|---|---|
| Report incorrect or suspicious data | Data Quality Report |
| Request a feature, concept, or dataset | Feature Request |
| Report an outage or degraded service | Service Outage |
| Ask a general question | Q&A |
| Report a security issue privately | See SECURITY.md |
| Get general help | See SUPPORT.md |
For private or contractual matters (DPAs, procurement, DDQs, enterprise SLAs): [email protected].
Contributions — examples, notebook improvements, documentation fixes, query recipes — are very welcome. See CONTRIBUTING.md for the workflow and CODE_OF_CONDUCT.md for community standards.
S&P 500® is a registered trademark of Standard & Poor's Financial Services LLC; Russell® indexes are trademarks of FTSE Russell; Nasdaq-100® is a trademark of Nasdaq, Inc. Valuein is not affiliated with, sponsored, endorsed or licensed by any index provider. Index membership is reconstructed independently by Valuein from public information: SEC filings, the portfolio holdings disclosed by funds that track each index, publicly available constituent lists and public reports of index changes; never from an index provider's licensed constituent data.
The code and documentation in this repository are licensed under Apache 2.0. See NOTICE for attribution.
Valuein data, in every tier including the free sample, is licensed separately under the Valuein Data Licence: internal use and research, small excerpts with credit; redistribution and resale need a separate Redistribution Licence, and model training a signed agreement that expressly permits it.
This repository is provided for research and educational purposes. It is not investment advice. No warranty of fitness for any particular trading, investment, or regulatory purpose is implied.
| Report a data error or request a feature | Support & community |
| Contribute an example or notebook | CONTRIBUTING.md |
production_service.py |
| Scheduled point-in-time extract to Parquet: limits, logging, exit codes |
| First-time user | getting_started.py | Plan check, ticker → CIK, first fundamentals query |
| Building an AI agent | MCP for AI agents | Use natural language — no SDK required |
confidence='high'confidence='medium'source='fund_holdings'Reconstruct the S&P 500 or a Russell index on a historical date. Branch on confidence — medium means approximate, not authoritative. JOIN references.cik = index_membership.cik for company metadata. |
industry_classification | Point-in-time SEC SIC classification: one row per company and SIC spell, with the 4-digit sic_code (sub-industry), sic_industry_group, sic_major_group, sic_division, sector and industry. valid_from is the SEC acceptance time of the first filing that showed the code; valid_to is exclusive, NULL = current. Taken from the SIC in each filing's SEC header. Every tier, same companies as references. No GICS (licensed): 4-digit SIC is the finest level published. | references.sector / industry / sic_code are the current values, stamped on all history. For "what industry was this company in on date t", filter valid_from <= t AND (valid_to IS NULL OR t < valid_to). No rows before a company's first evidence. |
restatement_events | Restatement Radar feed — one row per fact a later filing changed by more than 0.5% (original vs current value, delta, severity, both accessions for filing lineage) and a disclosure_class of non_reliance, amended or undisclosed (every tier, sample included) | Find restated numbers and trace each to the two filings; MCP list_restatements. |
standard_concept | The canonical concept catalog itself — names, statements, mapping rules, review status | The ground truth behind fact.standard_concept. |
stock_price | Coarse price series per entity — one close per fiscal period-end and per month-end, with total_return_index on every row (every tier) | Value-vs-price overlays and monthly-rebalanced backtests on any tier: tri_b / tri_a - 1 between two month-end rows is the holder's total return for that span, dividends included. |
insider_footnote · insider_ownership_purpose · institutional_other_manager | Institutional only — Form 3/4/5 footnotes (the receipt behind a 10b5-1 plan or a weighted-average price), the verbatim Item 4 "Purpose of Transaction" of a Schedule 13D, and the 13F manager lists | The text behind a transaction, a stake or a combined 13F; join insider_footnote and insider_ownership_purpose to insider_filing, and institutional_other_manager to institutional_filing, on accession_id. |
stock_price_daily | Institutional and Pro only — full daily OHLCV bar series per listing, with total_return_index and the raw corporate-action factors (div_cash, split_factor) | Backtest-safe price legs — pair with fundamentals for PIT valuation multiples. Use total_return_index for total return: it is forward-compounded, so unlike a back-adjusted series a later split never restates it. adjusted_close is a vendor passthrough and is null on the large majority of bars. Grain is one row per security per day — add WHERE is_primary_listing for one row per company. Prices are licensed market data, not EDGAR, so they do NOT share the 1993 fundamentals floor: no bars exist in 1993 and the earliest bar differs per security, 1994 onward. |
| Intermediate |
| Disclosure mix, one verified revision, recent Item 4.02 revisions |
smart_money_screen.py | Intermediate | Insider trades, 13F holders, blockholders (Institutional) |
filing_provenance.py | Beginner | A number, its recomputed fact_id, and links to its SEC filing |
dcf_inputs.py | Intermediate | client.dcf() with traced inputs, value per share, implied growth |
production_service.py | Advanced | Scheduled point-in-time extract to Parquet with limits, logging, exit codes |
agent_buys_its_own_data.py | Advanced | An agent discovers the payment rail and reads a live price quote |
| Verify a number |
| Use it from an AI assistant |
| DCF valuation |
| Piotroski F-score screen |
| Earnings quality |
| Sector comparison |
| Restatement alpha |
| Capital allocation |
| Filing delay |
docs/DATA_CATALOG.xlsx| Same catalog as a workbook — columns, types, sample values |
docs/data_catalog.json | Machine-readable catalog (used by SDK metadata + docs sites) |
docs/schema.json | Machine-readable table + column schema |
docs/COMPLIANCE_AND_DDQ.md | Data provenance, MNPI policy, PIT integrity, security, SLA summary |
docs/SLA.md | Uptime targets, data freshness, support response times, SLA credits |