{ "openapi": "3.0.1", "info": { "title": "US SEC EDGAR Filings Scraper", "description": "Scrape SEC EDGAR filings (10-K, 10-Q, 8-K, Form 4) for any US public company. Search by ticker, CIK, or company name. Optional XBRL enrichment extracts revenue, net income, total assets, and EPS. Fully compliant with SEC rate limits. Output as JSON.", "version": "0.1", "x-build-id": "unZqJ65YHcibRzeSo" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/ivosandoval~us-sec-edgar-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-ivosandoval-us-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/ivosandoval~us-sec-edgar-scraper/runs": { "post": { "operationId": "runs-sync-ivosandoval-us-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/ivosandoval~us-sec-edgar-scraper/run-sync": { "post": { "operationId": "run-sync-ivosandoval-us-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", "properties": { "search_query": { "title": "Company Name Search", "type": "string", "description": "Company name or keyword to search in EDGAR (e.g. 'Apple', 'Tesla Motors')" }, "ticker": { "title": "Stock Ticker", "type": "string", "description": "Stock ticker symbol (e.g. AAPL, TSLA, MSFT, GOOGL)" }, "cik": { "title": "CIK Number", "type": "string", "description": "SEC Central Index Key (e.g. 0000320193 for Apple). Will be zero-padded automatically." }, "form_types": { "title": "Form Types", "type": "array", "description": "Filing form types to fetch. Common: 10-K (annual), 10-Q (quarterly), 8-K (current events), 4 (insider trading)", "default": [ "10-K", "10-Q", "8-K" ] }, "date_from": { "title": "Date From", "type": "string", "description": "Start date for filing search (YYYY-MM-DD)" }, "date_to": { "title": "Date To", "type": "string", "description": "End date for filing search (YYYY-MM-DD)" }, "include_xbrl": { "title": "Include XBRL Financial Data", "type": "boolean", "description": "Fetch structured financial data (revenue, net income, total assets, EPS) for 10-K and 10-Q filings via XBRL API", "default": false }, "include_form_data": { "title": "Include Form-Specific Data", "type": "boolean", "description": "Parse form documents: Form 4 insider trades (owner, transactions), 13F institutional holdings (top 50 positions), 8-K item sections", "default": false }, "include_ai_summary": { "title": "Include AI Summary", "type": "boolean", "description": "Generate AI-powered 2-3 sentence summary of each filing. Requires OpenAI API key (set below or via OPENAI_API_KEY env var)", "default": false }, "openai_api_key": { "title": "OpenAI API Key (for AI summaries)", "type": "string", "description": "Your OpenAI API key. Only needed if 'Include AI Summary' is enabled. Alternatively set OPENAI_API_KEY environment variable." }, "max_results": { "title": "Max Results", "maximum": 10000, "type": "integer", "description": "Maximum number of filings to return", "default": 100 }, "database_url": { "title": "Database URL (optional)", "type": "string", "description": "PostgreSQL connection string to persist results. Format: postgresql+asyncpg://user:pass@host:port/dbname" }, "proxy_configuration": { "title": "Proxy Configuration", "type": "object", "description": "Apify proxy configuration" } } }, "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 } } } } } } } } } }