EDGAR XBRL frame (cross-company snapshot)

All US public companies that reported a given XBRL tag for a given period, in one call. Send GET /api/edgar-xbrl-frame with the required fields tag, unit and period and pay $0.005 per call over x402 or MPP (there is no free tier). It returns a JSON object with taxonomy, tag, ccp, uom, label and 4 more.

Killer endpoint for cross-sectional screens: 'every issuer's Revenues for CY2023Q1' or 'every issuer's Assets as of CY2023Q4I (instantaneous)'. Period format: CY{YYYY} (annual), CY{YYYY}Q{1-4} (quarterly), or CY{YYYY}Q{1-4}I (instantaneous balance-sheet items). Source: data.sec.gov/api/xbrl/frames. ?taxonomy=us-gaap&tag=Revenues&unit=USD&period=CY2023Q1

Category: Live public data · Tags: edgar sec xbrl frames screen cross-section fundamentals financials

TRY IN PLAYGROUND →

Parameters

Example request

curl -i "https://agent402.tools/api/edgar-xbrl-frame?taxonomy=us-gaap&tag=Revenues&unit=USD&period=CY2023Q1"

Without payment this returns HTTP 402 Payment Required with the exact price for edgar-xbrl-frame; any x402 v2 or MPP client pays it and retries.

Example response

{
  "taxonomy": "us-gaap",
  "tag": "Revenues",
  "ccp": "CY2023Q1",
  "uom": "USD",
  "label": "Revenues",
  "totalCompanies": 1872,
  "returned": 1,
  "truncated": true,
  "data": [
    {
      "accn": "0000320193-23-000064",
      "cik": 320193,
      "entityName": "Apple Inc.",
      "loc": "US-CA",
      "end": "2023-04-01",
      "val": 94836000000
    }
  ]
}

From an MCP client

catalog.call {
  "slug": "edgar-xbrl-frame",
  "params": {
    "taxonomy": "us-gaap",
    "tag": "Revenues",
    "unit": "USD",
    "period": "CY2023Q1"
  }
}

The hosted connector at https://agent402.tools/mcp needs a payment for edgar-xbrl-frame; the stdio package pays it from a wallet or from AGENT402_CREDITS_KEY. Local install: npx -y agent402-mcp.

Errors and behavior

• tag, unit and period are required. An input the tool rejects returns an HTTP 4xx whose body carries error, tool, expected, required and example, so the caller can correct it.
• A paid call that ends in any status of 400 or above is not charged over x402, MPP or a prepaid credits key: settlement is cancelled when the tool fails. The exception is a Tempo push credential, a transfer the buyer sent before the call: it settles before the tool runs, so if the tool then fails the payment is recorded as a refund owed to the paying wallet.
• Wallet-only: this tool reaches the network or stored state, so it has no proof-of-work tier. A prepaid card-credits key issued earlier (Authorization: Bearer a402_...) also pays it.
• A POST with a JSON body to /api/edgar-xbrl-frame is served as this GET, with the body as the input.
• An Idempotency-Key header makes a retried paid call replay the first 200 instead of charging again (an answer larger than 1 MB is not replayed).

Paid call (JavaScript agent)

import { wrapFetchWithPayment } from "@x402/fetch";
import { x402Client } from "@x402/core/client";
import { registerExactEvmScheme } from "@x402/evm/exact/client";
import { privateKeyToAccount } from "viem/accounts";

const client = new x402Client();
client.setSpendControls?.(false); // keep your own spending ceiling in code
registerExactEvmScheme(client, { signer: privateKeyToAccount(KEY) });
const payFetch = wrapFetchWithPayment(fetch, client);

const res = await payFetch("https://agent402.tools/api/edgar-xbrl-frame?taxonomy=us-gaap&tag=Revenues&unit=USD&period=CY2023Q1");

Related tools