finance.company-facts
Curated XBRL financial metrics for a US public company by stock ticker. Pulls SEC EDGAR's companyfacts JSON (per-CIK XBRL filings) and extracts a top-line set of ~15 financial metrics with their most recent annual + quarterly values. Each metric returns: end date, start date (or null for balance-sheet snapshots), value, fiscal year/period, originating form (10-K/10-Q), and filed date. Available metric keys (pass any comma-separated subset via the metrics param, or omit to get all): revenue, grossProfit, operatingIncome, netIncome, eps, epsDiluted, rdExpense, totalAssets, totalLiabilities, stockholdersEquity, cash, longTermDebt, operatingCashFlow, capex, sharesOutstanding. Backed by SEC.gov; underlying data is public-domain US government records.
/api/finance/company-factsPAYMENT-SIGNATURE.Parameters
| Name | Type | Description |
|---|---|---|
tickerrequired | string | US stock ticker (case-insensitive). Examples: AAPL, GOOGL, BRK.B. min 1 chars · max 10 chars · match ^[A-Za-z][A-Za-z0-9.-]{0,9}$ |
metrics | string | Comma-separated subset of metric keys to return. Available: revenue, grossProfit, operatingIncome, netIncome, eps, epsDiluted, rdExpense, totalAssets, totalLiabilities, stockholdersEquity, cash, longTermDebt, operatingCashFlow, capex, sharesOutstanding. Omit to get all ~15. min 1 chars · max 500 chars · match ^[a-zA-Z]+(,[a-zA-Z]+)*$ |
annualLimit | integer | Max annual (FY) values per metric, most recent first. Default 4, max 20. min 1 · max 20 |
quarterlyLimit | integer | Max quarterly (Q1-Q4) values per metric, most recent first. Default 4, max 20. Pass 0 to skip quarterly entirely. min 0 · max 20 |
Code samples
# 1. Probe with no auth → 402 envelope with PaymentRequirements curl -sS 'https://2s.io/api/finance/company-facts?ticker=example&metrics=example&annualLimit=4&quarterlyLimit=4' # 2. Sign + retry with PAYMENT-SIGNATURE: curl -sS 'https://2s.io/api/finance/company-facts?ticker=example&metrics=example&annualLimit=4&quarterlyLimit=4' \ -H 'PAYMENT-SIGNATURE: <base64-json-payload>' # Or use the canonical runner (handles probe → sign → retry): # EVM_PRIVATE_KEY=0x... node --env-file=.env.local \ # --experimental-strip-types scripts/x402-pay.ts \ # 'https://2s.io/api/finance/company-facts?ticker=example&metrics=example&annualLimit=4&quarterlyLimit=4'
import { TwoS } from '@2sio/sdk'
const client = new TwoS({
privateKey: process.env.EVM_PRIVATE_KEY as `0x${string}`,
})
const result = await client.finance.companyFacts({
"ticker": "example",
"metrics": "example",
"annualLimit": 4,
"quarterlyLimit": 4
})
console.log('endpoint:', result.endpoint)
console.log('cost:', result.costUsd, 'USDC')
console.log('tx:', result.settlement?.txHash)
console.log('data:', result.data)import os
from twosio import TwoS
client = TwoS(private_key=os.environ["EVM_PRIVATE_KEY"])
result = client.finance.company_facts(ticker="example", metrics="example", annualLimit=4, quarterlyLimit=4)
print("endpoint:", result.endpoint)
print("cost:", result.cost_usd, "USDC")
print("tx:", (result.settlement or {}).get("tx_hash"))
print("data:", result.data)// 1. Add @2sio/mcp to your MCP host config (Claude Desktop example below).
// EVM_PRIVATE_KEY funds x402 payments per call.
// claude_desktop_config.json
{
"mcpServers": {
"2sio": {
"command": "npx",
"args": ["-y", "@2sio/mcp"],
"env": { "EVM_PRIVATE_KEY": "0x..." }
}
}
}
// 2. Once the server is running, agents call this tool via standard MCP:
{
"jsonrpc": "2.0",
"id": 1,
"method": "tools/call",
"params": {
"name": "finance.company-facts",
"arguments": {
"ticker": "example",
"metrics": "example",
"annualLimit": 4,
"quarterlyLimit": 4
}
}
}Response
| Field | Type | Description |
|---|---|---|
query | object | |
cik | string | |
ticker | string | |
entityName | string | |
returned | integer | |
metrics | array | |
source | object |
{
"query": {
"ticker": "example",
"metrics": "example",
"annualLimit": 1,
"quarterlyLimit": 1
},
"cik": "example",
"ticker": "example",
"entityName": "example",
"returned": 1,
"metrics": [
{
"key": "example",
"concept": "example",
"label": "example",
"namespace": "example",
"unit": "example",
"annual": [
{
"end": "example",
"start": "example",
"val": 1,
"fiscalYear": 1,
"fiscalPeriod": "example",
"form": "example",
"filed": "example"
}
],
"quarterly": [
{
"end": "example",
"start": "example",
"val": 1,
"fiscalYear": 1,
"fiscalPeriod": "example",
"form": "example",
"filed": "example"
}
]
}
],
"source": {
"provider": "example",
"url": "https://example.com",
"license": "example"
}
}Discovery
- /api/directory — full catalog of every endpoint
- /openapi.json — OpenAPI 3.1 spec (per-op x-payment-info, x402Payment security)
- /.well-known/x402 — machine-readable service descriptor for x402-aware crawlers
- /.well-known/mcp/server-card.json — MCP SEP-1649 server card
- /llms.txt — plain-text manifest for LLM ingestion