{
"openapi": "3.0.1",
"info": {
"title": "SEC EDGAR Scraper — Filings, Financials & Companies",
"description": "Scrape SEC EDGAR: full-text search every filing (10-K, 10-Q, 8-K, S-1, Form 4, Form D…), pull any company's profile, recent filings & document links, and structured XBRL financials (revenue, net income, assets, EPS). Search by ticker, CIK, name, form or date. Monitoring mode. No API key.",
"version": "0.1",
"x-build-id": "8y11TUQ6xtUyebBaI"
},
"servers": [
{
"url": "https://api.apify.com/v2"
}
],
"paths": {
"/acts/scrapesage~sec-edgar-scraper/run-sync-get-dataset-items": {
"post": {
"operationId": "run-sync-get-dataset-items-scrapesage-sec-edgar-scraper",
"x-openai-isConsequential": false,
"summary": "Executes an Actor, waits for its completion, and returns Actor's dataset items in response.",
"tags": [
"Run Actor"
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/inputSchema"
}
}
}
},
"parameters": [
{
"name": "token",
"in": "query",
"required": true,
"schema": {
"type": "string"
},
"description": "Enter your Apify token here"
}
],
"responses": {
"200": {
"description": "OK"
}
}
}
},
"/acts/scrapesage~sec-edgar-scraper/runs": {
"post": {
"operationId": "runs-sync-scrapesage-sec-edgar-scraper",
"x-openai-isConsequential": false,
"summary": "Executes an Actor and returns information about the initiated run in response.",
"tags": [
"Run Actor"
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/inputSchema"
}
}
}
},
"parameters": [
{
"name": "token",
"in": "query",
"required": true,
"schema": {
"type": "string"
},
"description": "Enter your Apify token here"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/runsResponseSchema"
}
}
}
}
}
}
},
"/acts/scrapesage~sec-edgar-scraper/run-sync": {
"post": {
"operationId": "run-sync-scrapesage-sec-edgar-scraper",
"x-openai-isConsequential": false,
"summary": "Executes an Actor, waits for completion, and returns the OUTPUT from Key-value store in response.",
"tags": [
"Run Actor"
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/inputSchema"
}
}
}
},
"parameters": [
{
"name": "token",
"in": "query",
"required": true,
"schema": {
"type": "string"
},
"description": "Enter your Apify token here"
}
],
"responses": {
"200": {
"description": "OK"
}
}
}
}
},
"components": {
"schemas": {
"inputSchema": {
"type": "object",
"required": [
"mode"
],
"properties": {
"mode": {
"title": "What to scrape",
"enum": [
"companyFilings",
"financials",
"search"
],
"type": "string",
"description": "Pick a job. Company filings pulls a company's profile + recent filings. Financials returns structured XBRL financial metrics. Search runs an EDGAR full-text search across every filing.",
"default": "companyFilings"
},
"companies": {
"title": "Companies (tickers, CIKs or names)",
"type": "array",
"description": "Companies to scrape, as stock tickers (AAPL), CIK numbers (320193 or 0000320193) or names (Tesla). Used by Company filings & Financials; optional in Search to scope results to these filers.",
"items": {
"type": "string"
}
},
"searchQuery": {
"title": "Search query",
"type": "string",
"description": "Full-text search phrase across all EDGAR filings, e.g. \"artificial intelligence\" or cybersecurity breach. (Mode: Full-text search.)"
},
"forms": {
"title": "Form types (search filter)",
"type": "array",
"description": "Restrict the full-text search to these form types, e.g. 10-K, 8-K, S-1, 4, D. Leave empty for all forms. (Mode: Full-text search.)",
"items": {
"type": "string"
}
},
"startDate": {
"title": "Start date",
"type": "string",
"description": "Only filings on or after this date (YYYY-MM-DD). (Mode: Full-text search.)"
},
"endDate": {
"title": "End date",
"type": "string",
"description": "Only filings on or before this date (YYYY-MM-DD). (Mode: Full-text search.)"
},
"formTypes": {
"title": "Filter filings by form type",
"type": "array",
"description": "In Company filings mode, only return filings of these form types, e.g. 10-K, 10-Q, 8-K, 4. Leave empty for all forms.",
"items": {
"type": "string"
}
},
"includeProfile": {
"title": "Include company profile",
"type": "boolean",
"description": "Emit one company profile record per company (name, tickers, exchanges, SIC/industry, address, phone, website, fiscal year, former names).",
"default": true
},
"includeFilings": {
"title": "Include filing list",
"type": "boolean",
"description": "Emit the company's recent filings (form, date, document links, XBRL flags).",
"default": true
},
"maxFilingsPerCompany": {
"title": "Max filings per company",
"minimum": 1,
"maximum": 1000,
"type": "integer",
"description": "Cap the number of recent filings returned per company (EDGAR exposes up to 1000).",
"default": 50
},
"maxResults": {
"title": "Max search results",
"minimum": 1,
"maximum": 1000,
"type": "integer",
"description": "Cap the number of filings returned by the full-text search (EDGAR exposes up to 10,000; this actor fetches up to 1,000 per run).",
"default": 100
},
"monitorMode": {
"title": "Monitoring mode — only new filings",
"type": "boolean",
"description": "Remember filings already returned and emit ONLY filings not seen in previous runs — ideal for scheduled runs that alert on new 10-Ks, 8-Ks or insider Form 4s. Works alongside Apify Schedules.",
"default": false
},
"monitorStoreName": {
"title": "Monitor store name",
"type": "string",
"description": "Named key-value store that holds the 'already seen' accession numbers for monitoring mode. Use a different name per tracked target to keep histories separate.",
"default": "sec-edgar-monitor"
},
"userAgent": {
"title": "User-Agent (your name & email)",
"type": "string",
"description": "The SEC's fair-access policy asks every client to identify itself. Optionally set your own Name email@domain.com. A working default is used if left blank.",
"default": ""
},
"maxConcurrency": {
"title": "Max concurrency",
"minimum": 1,
"maximum": 10,
"type": "integer",
"description": "Maximum parallel requests. The SEC rate-limits ~10 requests/second per IP, so keep this at 5 or below.",
"default": 5
},
"proxyConfiguration": {
"title": "Proxy configuration",
"type": "object",
"description": "Proxy settings. EDGAR is public US-government data with no anti-bot, so the default Apify proxy is plenty.",
"default": {
"useApifyProxy": true
}
}
}
},
"runsResponseSchema": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"actId": {
"type": "string"
},
"userId": {
"type": "string"
},
"startedAt": {
"type": "string",
"format": "date-time",
"example": "2025-01-08T00:00:00.000Z"
},
"finishedAt": {
"type": "string",
"format": "date-time",
"example": "2025-01-08T00:00:00.000Z"
},
"status": {
"type": "string",
"example": "READY"
},
"meta": {
"type": "object",
"properties": {
"origin": {
"type": "string",
"example": "API"
},
"userAgent": {
"type": "string"
}
}
},
"stats": {
"type": "object",
"properties": {
"inputBodyLen": {
"type": "integer",
"example": 2000
},
"rebootCount": {
"type": "integer",
"example": 0
},
"restartCount": {
"type": "integer",
"example": 0
},
"resurrectCount": {
"type": "integer",
"example": 0
},
"computeUnits": {
"type": "integer",
"example": 0
}
}
},
"options": {
"type": "object",
"properties": {
"build": {
"type": "string",
"example": "latest"
},
"timeoutSecs": {
"type": "integer",
"example": 300
},
"memoryMbytes": {
"type": "integer",
"example": 1024
},
"diskMbytes": {
"type": "integer",
"example": 2048
}
}
},
"buildId": {
"type": "string"
},
"defaultKeyValueStoreId": {
"type": "string"
},
"defaultDatasetId": {
"type": "string"
},
"defaultRequestQueueId": {
"type": "string"
},
"buildNumber": {
"type": "string",
"example": "1.0.0"
},
"containerUrl": {
"type": "string"
},
"usage": {
"type": "object",
"properties": {
"ACTOR_COMPUTE_UNITS": {
"type": "integer",
"example": 0
},
"DATASET_READS": {
"type": "integer",
"example": 0
},
"DATASET_WRITES": {
"type": "integer",
"example": 0
},
"KEY_VALUE_STORE_READS": {
"type": "integer",
"example": 0
},
"KEY_VALUE_STORE_WRITES": {
"type": "integer",
"example": 1
},
"KEY_VALUE_STORE_LISTS": {
"type": "integer",
"example": 0
},
"REQUEST_QUEUE_READS": {
"type": "integer",
"example": 0
},
"REQUEST_QUEUE_WRITES": {
"type": "integer",
"example": 0
},
"DATA_TRANSFER_INTERNAL_GBYTES": {
"type": "integer",
"example": 0
},
"DATA_TRANSFER_EXTERNAL_GBYTES": {
"type": "integer",
"example": 0
},
"PROXY_RESIDENTIAL_TRANSFER_GBYTES": {
"type": "integer",
"example": 0
},
"PROXY_SERPS": {
"type": "integer",
"example": 0
}
}
},
"usageTotalUsd": {
"type": "number",
"example": 0.00005
},
"usageUsd": {
"type": "object",
"properties": {
"ACTOR_COMPUTE_UNITS": {
"type": "integer",
"example": 0
},
"DATASET_READS": {
"type": "integer",
"example": 0
},
"DATASET_WRITES": {
"type": "integer",
"example": 0
},
"KEY_VALUE_STORE_READS": {
"type": "integer",
"example": 0
},
"KEY_VALUE_STORE_WRITES": {
"type": "number",
"example": 0.00005
},
"KEY_VALUE_STORE_LISTS": {
"type": "integer",
"example": 0
},
"REQUEST_QUEUE_READS": {
"type": "integer",
"example": 0
},
"REQUEST_QUEUE_WRITES": {
"type": "integer",
"example": 0
},
"DATA_TRANSFER_INTERNAL_GBYTES": {
"type": "integer",
"example": 0
},
"DATA_TRANSFER_EXTERNAL_GBYTES": {
"type": "integer",
"example": 0
},
"PROXY_RESIDENTIAL_TRANSFER_GBYTES": {
"type": "integer",
"example": 0
},
"PROXY_SERPS": {
"type": "integer",
"example": 0
}
}
}
}
}
}
}
}
}
}