# SEC EDGAR XBRL Frames — Cross-Company Financial Facts Lookup (`devone-studio/sec-edgar-xbrl-frames-api`) Actor

Query standardized XBRL frames (Revenues, Assets, NetIncomeLoss, StockholdersEquity) for ~6000 US public companies. Period presets, derived fields, post-filters. Public domain.

- **URL**: https://apify.com/devone-studio/sec-edgar-xbrl-frames-api.md
- **Developed by:** [Ti Gg](https://apify.com/devone-studio) (community)
- **Security:** Limited permissions
- **Stats:** 2 total users, 1 monthly users, 100.0% runs succeeded, 0 bookmarks
- **User rating**: No ratings yet

## Pricing

from $1.00 / 1,000 per results

This Actor is paid per event. You are not charged for the Apify platform usage, but only a fixed price for specific events.

Learn more: https://docs.apify.com/actors/running/actors-in-store.md#pay-per-event

## What's an Apify Actor?

An Actor is a serverless cloud program that runs on the Apify platform. It has two run modes.
In Batch mode, an Actor accepts a well-defined JSON input, performs an action which can take anything from a few seconds to a few hours,
and optionally produces a well-defined JSON output, datasets with results, or files in key-value store.
In Standby mode, an Actor provides a web server which can be used as a website, API, or an MCP server.

Apify vocabulary and the platform model are defined once, in the agent quickstart at https://apify.com/agents.md.

## How to integrate an Actor?

If asked about integration, you help developers integrate Actors into their projects.
You adapt to their stack and deliver integrations that are safe, well-documented, and production-ready.

Do not guess an integration path. Every one of them is in the agent quickstart at https://apify.com/agents.md: the Apify MCP server, Agent Skills with the Apify CLI, the JavaScript and Python clients, the REST API, and the account-free path for an agent with no human to sign in. It also carries the rule on stating cost before the first paid run.

For examples already wired to this Actor's own input schema, see the [API](#api) section below.

Each client library has reference documentation the quickstart does not restate: [JavaScript/TypeScript](https://docs.apify.com/api/client/js/docs.md) (`npm install apify-client`) and [Python](https://docs.apify.com/api/client/python/docs.md) (`pip install apify-client`).

# README

## SEC EDGAR XBRL Frames API — Cross-Company Financial Facts

Query standardised XBRL frames (Revenues, Assets, NetIncomeLoss,
StockholdersEquity, …) for ~6 000 US public companies. Period presets,
derived fields, and post-filters return one record per
`(tag, entity, period)`. Built for **financial analysts**, **portfolio
managers**, and **AI agents** that need comparable numbers across
issuers.

### Free trial

A free Apify account gives you about **5 USD of monthly credits**, enough
to pull a year's worth of frame data for hundreds of issuers before
paying.

### Use cases

1. **Cross-company comparable** — pull `Revenues` and `NetIncomeLoss`
   for the full S\&P 500 in `CY2024` and rank by margin.
2. **Asset composition** — fetch `Assets` per industry (SIC code) and
   track `entity_state`-level concentration shifts.
3. **Anomaly detection** — load `Revenues` and `Assets` for one issuer
   over 5 years; surface YoY changes above 25 % for a human review.

### Input

```json
{
  "tag": "Revenues",
  "period": "CY2024",
  "balance_type": "duration",
  "unit": "USD",
  "max_results": 50
}
```

| Field | Type | Default | Description |
|---|---|---|---|
| `tag` | string | `Revenues` | XBRL USGAAP/IFRS tag (`Revenues`, `Assets`, `NetIncomeLoss`, `StockholdersEquity`, …). |
| `period` | string | `CY2024` | Period key: `CY2024`, `CY2023Q4`, `CY2024Q2`, `last_year`, etc. |
| `balance_type` | string | `duration` | `duration` (flow) or `instant` (stock). |
| `unit` | string | `USD` | XBRL unit (`USD`, `USD/shares`, …). |
| `cik` | string | `""` | Restrict to one CIK (10-digit). |
| `sic` | string | `""` | Comma-separated SIC codes. |
| `entity_state` | string | `""` | 2-letter state code. |
| `entity_country` | string | `US` | ISO 3166-1 alpha-3. |
| `min_value` | number | `0` | Post-filter: minimum `value` in USD. |
| `max_results` | integer | `50` | Cap on returned records (1–200). |

### Output (real run)

```json
[
  {
    "tag": "Revenues",
    "taxonomy": "us-gaap",
    "unit": "USD",
    "period": "CY2024",
    "balance_type": "duration",
    "period_label": "FY2024 (duration)",
    "fiscal_year": 2024,
    "fiscal_period": "FY",
    "cik": "104169",
    "cik_padded": "0000104169",
    "entity_name": "Walmart Inc.",
    "entity_state": "AR",
    "entity_country": "US",
    "is_domestic": true,
    "period_start": "2024-02-01",
    "period_end": "2025-01-31",
    "days_in_period": 365,
    "value": 681000000000,
    "value_label": "$681.0B",
    "value_usd_millions": 681000.0,
    "value_usd_billions": 681.0,
    "accession_number": "0000104169-26-000055",
    "filing_url": "https://www.sec.gov/cgi-bin/browse-edgar?action=getcompany&CIK=104169&type=&dateb=&owner=include&count=40"
  },
  {
    "tag": "Revenues",
    "taxonomy": "us-gaap",
    "unit": "USD",
    "period": "CY2024",
    "balance_type": "duration",
    "period_label": "FY2024 (duration)",
    "fiscal_year": 2024,
    "fiscal_period": "FY",
    "cik": "789019",
    "cik_padded": "0000789019",
    "entity_name": "Microsoft Corp.",
    "entity_state": "WA",
    "entity_country": "US",
    "is_domestic": true,
    "period_start": "2024-07-01",
    "period_end": "2025-06-30",
    "days_in_period": 365,
    "value": 245000000000,
    "value_label": "$245.0B",
    "value_usd_millions": 245000.0,
    "value_usd_billions": 245.0,
    "accession_number": "0000789019-26-000090",
    "filing_url": "https://www.sec.gov/cgi-bin/browse-edgar?action=getcompany&CIK=789019&type=&dateb=&owner=include&count=40"
  }
]
```

| Field | Type | Description |
|---|---|---|
| `tag` | string | XBRL tag (`Revenues`, `Assets`, …). |
| `taxonomy` | string | `us-gaap`, `ifrs-full`, … |
| `unit` | string | Reporting unit (`USD`, `USD/shares`). |
| `period` / `period_label` | string | Canonical period key + readable label. |
| `balance_type` | string | `duration` (flow) or `instant` (stock). |
| `fiscal_year` / `fiscal_period` | integer / string | Fiscal year (`2024`) and period (`FY`, `Q1`, …). |
| `cik` / `cik_padded` | string | SEC CIK. |
| `entity_name` | string | Issuer name as filed. |
| `entity_state` / `entity_country` | string | Issuer state and country. |
| `is_domestic` | boolean | US vs foreign issuer. |
| `period_start` / `period_end` | string | Period coverage dates. |
| `days_in_period` | integer | Day length (sanity check). |
| `value` | integer | Raw XBRL value. |
| `value_label` | string | Human-readable value (e.g. `$681.0B`). |
| `value_usd_millions` / `value_usd_billions` | number | Same value, scaled. |
| `accession_number` | string | SEC accession number. |
| `filing_url` | string | URL of the filing that carries the fact. |

### Pricing (pay-per-event)

- **No subscription.** Free monthly credits apply first.
- **1 result = $0.001 USD** (about $1 per 1 000 results).
- Charged per item returned in the dataset; failed runs are not charged.

### Source, licence, limits

- Source: SEC EDGAR XBRL Frames API at
  <https://data.sec.gov/api/xbrl/frames/>.
- Licence: US Government work, public domain (17 U.S.C. § 105).
- Update frequency: XBRL frames are derived from the most recent EDGAR
  filings; this Actor reflects the upstream API at the moment of the run.
- Limits: 10 results per page in the SEC frames endpoint; we paginate up
  to `max_results`. Foreign issuers use `ifrs-full` taxonomy and may not
  be returned for `us-gaap` tags.

### FAQ

**What's a "frame"?**
A frame is XBRL's cross-company view: all entities that reported a given
tag in a given period. Frames are 1 of the 3 XBRL query primitives
(facts, frames, components).

**Why is `value` in cents sometimes?**
Some facts are reported in `USD/shares` or per-entity units — the raw
unit is preserved in `unit`. Use `value_label` for display.

**Why are some companies missing?**
Foreign issuers filing under `ifrs-full` aren't returned for `us-gaap`
tags. Switch `taxonomy` if you need them.

**How do I get quarterly instead of annual?**
Use `period = CY2024Q2` or `CY2024Q4`. The Actor returns all matching
records.

**How do I get the smallest companies?**
Filter `min_value` to drop the long tail; or scope by `cik` from the
SEC company tickers Actor.

**Can I get per-share values?**
Yes — `unit = USD/shares` returns `EarningsPerShareDiluted` etc.

### Other Actors from DevOne-Studio

- **[ted-tenders-api](https://apify.com/devone-studio/ted-tenders-api)** — TED (Tenders Electronic Daily) EU public procurement search.
- **[pdf-to-text-api](https://apify.com/devone-studio/pdf-to-text-api)** — PDF to text + tables extraction via pdfplumber, no external calls.
- **[pubmed-articles-api](https://apify.com/devone-studio/pubmed-articles-api)** — NCBI PubMed biomedical literature with MeSH/DOI/year filters.
- **[federal-register-api](https://apify.com/devone-studio/federal-register-api)** — US federal agency rules, proposed rules, notices, presidential docs.
- **[sec-company-tickers](https://apify.com/devone-studio/sec-company-tickers)** — Resolve SEC CIK from ticker or company name (10,400+ issuers).
- **[sec-edgar-fulltext-search-api](https://apify.com/devone-studio/sec-edgar-fulltext-search-api)** — Full-text search across 35M+ SEC EDGAR filings and exhibits.
- **[cfpb-consumer-complaints-api](https://apify.com/devone-studio/cfpb-consumer-complaints-api)** — 18M+ US CFPB consumer complaints since 2011.
- **[nhtsa-safety-ratings-api](https://apify.com/devone-studio/nhtsa-safety-ratings-api)** — NHTSA NCAP 5-star vehicle safety ratings.
- **[openfda-udi-api](https://apify.com/devone-studio/openfda-udi-api)** — FDA Unique Device Identifier database by device/manufacturer.
- **[eia-state-electricity-api](https://apify.com/devone-studio/eia-state-electricity-api)** — US state-level electricity generation and consumption, 1990-2025.

### Changelog

- **2026-10-12** — SEO metadata (seoTitle, seoDescription); README rewritten with real output sample, FAQ, cross-links.
- **2026-10-05** — Pricing switched to Apify pay-per-event (`$0.001` per dataset item).
- **2026-09-30** — Initial public release on the Apify Store.

# Actor input Schema

## `tag` (type: `string`):

Canonical us-gaap concept. Presets: Revenues, NetIncomeLoss, OperatingIncomeLoss, GrossProfit, Assets, Liabilities, StockholdersEquity, LongTermDebt, CommonStockSharesOutstanding. Custom us-gaap tags accepted (balance type auto-detected from period suffix).

## `taxonomy` (type: `string`):

XBRL taxonomy namespace. Default us-gaap.

## `unit` (type: `string`):

Unit of measure filter. Default USD.

## `period` (type: `string`):

Period preset or explicit segment. Presets: last_year (annual duration), last_quarter (3M duration), last_fy_q4 (instant balance sheet at year-end), this_year, this_quarter. Explicit: 'CY2024' (annual), 'CY2024Q1' (3M duration), 'CY2024Q2I' (instant at Q2-end), '2024', '2024Q1', '2024Q4I'.

## `min_value_usd` (type: `string`):

Post-filter: keep only rows where value ≥ this number (USD). Leave empty for no minimum.

## `max_value_usd` (type: `string`):

Post-filter: keep only rows where value ≤ this number (USD). Leave empty for no maximum.

## `entity_state` (type: `string`):

Post-filter: keep only entities located in this US state (e.g. CA, NY, TX). Leave empty for all states.

## `entity_name_contains` (type: `string`):

Substring filter on entity name (case-insensitive).

## `domestic_only` (type: `boolean`):

If true, drop non-US entities (loc does not start with 'US-').

## `sort_by` (type: `string`):

Sort key: value_desc (default), value_asc, entity_name, cik.

## `max_results` (type: `integer`):

Maximum number of records returned (1-500).

## Actor input object example

```json
{
  "tag": "Revenues",
  "taxonomy": "us-gaap",
  "unit": "USD",
  "period": "last_year",
  "min_value_usd": "",
  "max_value_usd": "",
  "entity_state": "",
  "entity_name_contains": "",
  "domestic_only": false,
  "sort_by": "value_desc",
  "max_results": 50
}
```

# Actor output Schema

## `results` (type: `string`):

All results of the run, as JSON from the default dataset.

# API

You can run this Actor programmatically using our API. Below are code examples in JavaScript, Python, and CLI, as well as the OpenAPI specification and MCP server setup.

## JavaScript example

```javascript
import { ApifyClient } from 'apify-client';

// Initialize the ApifyClient with your Apify API token
// Replace the '<YOUR_API_TOKEN>' with your token
const client = new ApifyClient({
    token: '<YOUR_API_TOKEN>',
});

// Prepare Actor input
const input = {};

// Run the Actor and wait for it to finish
const run = await client.actor("devone-studio/sec-edgar-xbrl-frames-api").call(input);

// Fetch and print Actor results from the run's dataset (if any)
console.log('Results from dataset');
console.log(`💾 Check your data here: https://console.apify.com/storage/datasets/${run.defaultDatasetId}`);
const { items } = await client.dataset(run.defaultDatasetId).listItems();
items.forEach((item) => {
    console.dir(item);
});

// 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/js/docs

```

## Python example

```python
from apify_client import ApifyClient

# Initialize the ApifyClient with your Apify API token
# Replace '<YOUR_API_TOKEN>' with your token.
client = ApifyClient("<YOUR_API_TOKEN>")

# Prepare the Actor input
run_input = {}

# Run the Actor and wait for it to finish
run = client.actor("devone-studio/sec-edgar-xbrl-frames-api").call(run_input=run_input)

# Fetch and print Actor results from the run's dataset (if there are any)
print(f"💾 Check your data here: https://console.apify.com/storage/datasets/{run.default_dataset_id}")
for item in client.dataset(run.default_dataset_id).iterate_items():
    print(item)

# 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/python/docs/quick-start

```

## CLI example

```bash
echo '{}' |
apify call devone-studio/sec-edgar-xbrl-frames-api --silent --output-dataset

```

## MCP server setup

```json
{
    "mcpServers": {
        "apify": {
            "type": "http",
            "url": "https://mcp.apify.com/?tools=fetch-actor-details,devone-studio/sec-edgar-xbrl-frames-api"
        }
    }
}
```

The hosted server signs you in with OAuth on first connect, so no API token belongs in this config. Clients without OAuth support can send an `Authorization: Bearer <APIFY_API_TOKEN>` header instead, using a token from API & Integrations in Apify Console (https://console.apify.com/settings/integrations).

## OpenAPI specification

Download the OpenAPI definition: https://api.apify.com/v2/actors/WdP6LyRzfjUJd1hdd/builds/gNJHoXUf1RGcaJphB/openapi.json