# SEC XBRL Frames — One Financial Concept Across All Companies (`alaudinburki/sec-xbrl-frames`) Actor

Every US company's reported value for one accounting concept in one period, as flat rows — company, CIK, value, period and accession. Free public SEC API, no key.

- **URL**: https://apify.com/alaudinburki/sec-xbrl-frames.md
- **Developed by:** [alaudin burki](https://apify.com/alaudinburki) (community)
- **Categories:** Business, Developer tools
- **Stats:** 2 total users, 1 monthly users, 100.0% runs succeeded, 0 bookmarks
- **User rating**: No ratings yet

## Pricing

from $1.00 / 1,000 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 XBRL Frames — One Financial Concept Across All Companies

Every US company's reported value for **one accounting concept in one period**, as flat rows —
company, CIK, value, period and accession. Free SEC API, no key.

This is a *frame*: the same figure for thousands of companies side by side, which is exactly what a
comparison needs and what a single filing cannot give.

### What you get

`company`, `cik`, `value`, `start`, `end`, `location`, `accession`.

### Sample output

```json
{ "company": "Apple Inc.", "cik": 320193, "value": 383285000000,
  "start": "2023-01-01", "end": "2023-12-31" }
```

### Limitations

- **Only as good as the filer's tagging.** A company that tagged the concept differently, or not at
  all, is simply **absent** — a missing company is not a missing number.
- **Fiscal years do not align.** `CY2023` groups by the calendar period as filed, so a company with a
  non-calendar year end appears with different `start`/`end` dates.
- `value` carries **no unit in the row** — the unit is part of your request (`USD`, `shares`, `pure`),
  so mixing units in one sweep would be meaningless.
- The SEC requires an identifying user-agent and rate-limits; this Actor sends one and paces itself.

### Pricing

Pay per result.

### Fields

| Field | Type | What it holds |
|---|---|---|
| `company` | string | Company name as the source writes it. |
| `cik` | string | Central Index Key, the SEC's identifier for a filer. |
| `value` | number | The measured value for this row. Units are in the README and sometimes in a sibling field. |
| `start` | string | Start of the period the record covers, as the source writes it. |
| `end` | string | End of the period the record covers, as the source writes it. |
| `location` | string | Location as the source writes it. |
| `accession` | string | Accession number assigned by the holding collection. |

# Actor input Schema

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

US-GAAP tag, e.g. Revenues, Assets, NetIncomeLoss, CashAndCashEquivalentsAtCarryingValue.

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

CY2023, CY2023Q1 (quarter), or CY2023Q1I (instant).

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

USD, shares, pure, etc.

## `maxItems` (type: `integer`):

Stop after this many rows.

## `maxPages` (type: `integer`):

Stop after this many pages.

## Actor input object example

```json
{
  "maxItems": 500,
  "maxPages": 5
}
```

# Actor output Schema

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

One row per item, with the 7 fields listed under Views.

# 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 = {
    "maxItems": 500,
    "maxPages": 5
};

// Run the Actor and wait for it to finish
const run = await client.actor("alaudinburki/sec-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 = {
    "maxItems": 500,
    "maxPages": 5,
}

# Run the Actor and wait for it to finish
run = client.actor("alaudinburki/sec-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 '{
  "maxItems": 500,
  "maxPages": 5
}' |
apify call alaudinburki/sec-xbrl-frames --silent --output-dataset

```

## MCP server setup

```json
{
    "mcpServers": {
        "apify": {
            "type": "http",
            "url": "https://mcp.apify.com/?tools=fetch-actor-details,alaudinburki/sec-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/FsXcSgvFra5HnkTck/builds/KthwkCPNbWbdPKnst/openapi.json