# SEC EDGAR XBRL Frames (`darthdimus/sec-edgar-xbrl-frames`) Actor

Screen all companies reporting an SEC XBRL concept (e.g. us-gaap Assets) for a calendar period via public data.sec.gov frames.

- **URL**: https://apify.com/darthdimus/sec-edgar-xbrl-frames.md
- **Developed by:** [Dmitry Ostrovsky](https://apify.com/darthdimus) (community)
- **Categories:** Business
- **Stats:** 2 total users, 1 monthly users, 0.0% runs succeeded, 0 bookmarks
- **User rating**: No ratings yet

## Pricing

Pay per usage

This Actor is paid per platform usage. The Actor is free to use, and you only pay for the Apify platform usage, which gets cheaper the higher subscription plan you have.

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

## What's an Apify Actor?

Actors are web data automations that power AI and operations. They run on the Apify platform to scrape websites, process data, connect APIs, and automate workflows.
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.
Actors are written with capital "A".

## 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.
The best way to integrate Actors is as follows.

- **AI agents and MCP clients** — the [Apify MCP server](https://docs.apify.com/integrations/mcp.md) at `https://mcp.apify.com` (remote, streamable HTTP, OAuth on first use).
- **Agentic workflows and local Actor development** — [Agent Skills](https://apify.com/.well-known/agent-skills/index.json) with the [Apify CLI](https://docs.apify.com/cli/docs.md): `npm install -g apify-cli`, then `apify login`.
- **JavaScript/TypeScript projects** — the official [JS/TS client](https://docs.apify.com/api/client/js/docs.md): `npm install apify-client`.
- **Python projects** — the official [Python client](https://docs.apify.com/api/client/python/docs.md): `pip install apify-client`.
- **Any other language** — the [REST API](https://docs.apify.com/api/v2.md).

For usage examples, see the [API](#api) section below.

For more details, see Apify documentation as [Markdown index](https://docs.apify.com/llms.txt) and [Markdown full-text](https://docs.apify.com/llms-full.txt).

# README

## SEC EDGAR XBRL Frames

Apify Actor that fetches industry-wide XBRL frame data from the public SEC EDGAR frames API:
`https://data.sec.gov/api/xbrl/frames/{taxonomy}/{tag}/{unit}/{period}.json`

Example: all companies reporting us-gaap Assets in USD for CY2024Q4I.

Distinct from:

- SEC EDGAR Recent Filings (per-company form lists)
- SEC EDGAR Company Facts (per-company concept time series)
- SEC EDGAR Insider Transactions (Form 4)
- SEC EDGAR 13F Holdings (institutional holdings)

Legal public data only. No Playwright. Limited-permission Actor. Standby is off.

### Input

- taxonomy (string, default us-gaap): e.g. us-gaap, dei, ifrs-full
- tag (string, required): XBRL concept tag (e.g. Assets)
- unit (string, default USD)
- period (string, required): frame period like CY2024, CY2024Q4, CY2024Q4I. Instant concepts (balance sheet) usually need the `I` suffix (e.g. CY2024Q4I).
- maxResults (integer, default 500, max 5000): cap dataset rows

### Output

One dataset item per frame `data[]` row with taxonomy, tag, unit, period, frameLabel/ccp, cik, entityName, location, end, val, accn, fy, fp, form, filed, frame (when present).

### SEC User-Agent

SEC fair-access rules require a User-Agent with a contact. This Actor reads SEC\_USER\_AGENT and defaults to sec-edgar-xbrl-frames (dostrovsky@gmail.com).

Docs: https://www.sec.gov/os/accessing-edgar-data

# Actor input Schema

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

XBRL taxonomy, e.g. us-gaap, dei, ifrs-full.

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

XBRL concept tag (e.g. Assets, Revenues, NetIncomeLoss).

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

Unit of measure (e.g. USD, USD/shares, shares).

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

Frame period like CY2024, CY2024Q4, CY2024Q4I. Instant concepts (Assets) usually need the I suffix.

## `maxResults` (type: `integer`):

Cap dataset rows pushed from the frame.

## Actor input object example

```json
{
  "taxonomy": "us-gaap",
  "tag": "Assets",
  "unit": "USD",
  "period": "CY2024Q4",
  "maxResults": 500
}
```

# Actor output Schema

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

No description

# 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 = {
    "tag": "Assets",
    "period": "CY2024Q4"
};

// Run the Actor and wait for it to finish
const run = await client.actor("darthdimus/sec-edgar-xbrl-frames").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 = {
    "tag": "Assets",
    "period": "CY2024Q4",
}

# Run the Actor and wait for it to finish
run = client.actor("darthdimus/sec-edgar-xbrl-frames").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 '{
  "tag": "Assets",
  "period": "CY2024Q4"
}' |
apify call darthdimus/sec-edgar-xbrl-frames --silent --output-dataset

```

## MCP server setup

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

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/h9WoTNeDpcNkQVk47/builds/rce2rHUkgkhx0ZrUN/openapi.json