$ man xbrl-financials
/xbrl-financials(1)
PRICE / CALL
$0.05
USDC · base mainnet · scheme: exact
METHOD
POST
CLUSTER
edgefinanceCATEGORY
uncategorized
STATUS
● live
NAME
xbrl-financials — sec xbrl financials
SYNOPSIS
POST https://x402.org/v1/xbrl-financials
Content-Type: application/json
X-PAYMENT: <signed-transferWithAuthorization>
{ ... }↳ first call →
402 Payment Required. Sign USDCtransferWithAuthorization, retry with theX-PAYMENT header.DESCRIPTION
SEC XBRL financials. Returns structured financial line items (revenue, net income, EPS, total assets, cash, etc.) for a US-listed ticker. Federal public XBRL data — Bloomberg-killer for fundamentals.
INPUT — request schema
| property | type | description | req? |
|---|---|---|---|
| ticker | string | US-listed ticker (e.g. 'AAPL', 'MSFT'). Either ticker or cik is required. | optional |
| cik | string | SEC CIK (zero-padded or numeric, e.g. '0000320193'). Use when ticker is ambiguous or unavailable. | optional |
| metrics | array | Aliases of financial metrics to return, e.g. ['revenue', 'net_income', 'eps_diluted', 'total_assets', 'cash']. See available_metric_aliases in response. Default: a curated set. | optional |
| unit | string | Filter values to one unit. Default 'any'. enum: USD · USD/shares · shares · any | optional |
| limit_per_metric | number | Max datapoints returned per metric. 1-50. Default 10 (most-recent-first). | optional |
| fy_only | boolean | If true, only fiscal-year (10-K) values are returned, skipping quarterly 10-Q data. Default false. | optional |
OUTPUT — response shape
| field | type | description |
|---|---|---|
| ticker | string | Stock ticker symbol of the US-listed company the financials belong to (e.g. AAPL, MSFT). |
| company_name | string | Registered company name from the SEC filing matching the requested ticker. |
| series | string | Reporting period series (e.g. annual 10-K or quarterly 10-Q) for the returned line items. |
EXAMPLES — two ways to call
EXAMPLE 1 · curl
curl -X POST https://x402.org/v1/xbrl-financials \
-H 'Content-Type: application/json' \
-d '{ }'first response =
402 Payment Required with payment requirements; sign + retry with X-PAYMENT.EXAMPLE 2 · mcp
# install once claude mcp add x402 --command "npx x402-deployer-mcp" # then ask Claude Code: # "use the xbrl-financials tool to ..."
MCP server handles payment automatically — your coding agent just calls the tool by name.
METADATA
- tags
- edge-financesec-filingsxbrlfundamentalsfinancial-statementsticker-lookupearnings-dataxbrl-financials
- methods
- POST
- cluster
- edgefinance
- price
- $0.05 USDC per call
ADJACENT — other endpoints in edgefinance
| endpoint | description | price |
|---|---|---|
| 13f-deltas | 13F-HR position-delta computation — diff the two most recent 13F-HR filings for an institutional CIK. | $0.05 |
| patent-search | USPTO patent search. | $0.05 |
| fec-political-contributions | FEC political contributions search via api.open.fec.gov. | $0.04 |
| earnings-calendar | Earnings calendar derived from SEC 8-K Item 2.02, 10-Q, 10-K, NT 10-Q, NT 10-K filings. | $0.03 |
| earnings-call-transcribe | Earnings call transcriber. | $0.03 |
| earnings-transcript | Earnings call transcript generator. | $0.03 |
| fda-calendar | FDA Advisory Committee meeting calendar. | $0.03 |
| trademark-search | Trademark search / USPTO trademark lookup / TSDR / federal trademark database. | $0.03 |
SEE ALSO