{ "openapi": "3.0.1", "info": { "title": "SEC EDGAR Scraper - Filings, Form 4 Insider Trades & XBRL", "description": "SEC EDGAR scraper for any US-listed company: SEC filings (10-K, 10-Q, 8-K, S-1 and more), Form 4 insider trading transactions parsed into per-trade rows with insider role, shares, price and dollar value, and XBRL key financials - official SEC APIs, no key. From $0.50 per 1,000 filings.", "version": "0.1", "x-build-id": "eyG0vwj5QVahw0CMc" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/offgrid-labs~sec-edgar-filings-insider/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-offgrid-labs-sec-edgar-filings-insider", "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/offgrid-labs~sec-edgar-filings-insider/runs": { "post": { "operationId": "runs-sync-offgrid-labs-sec-edgar-filings-insider", "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/offgrid-labs~sec-edgar-filings-insider/run-sync": { "post": { "operationId": "run-sync-offgrid-labs-sec-edgar-filings-insider", "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": [ "companies" ], "properties": { "companies": { "title": "Companies (tickers or CIKs)", "type": "array", "description": "Required. One company per line: US stock ticker (AAPL, MSFT, BRK-B) or SEC CIK number (320193). Example: [\"AAPL\", \"NVDA\"]", "items": { "type": "string" } }, "userAgent": { "title": "SEC User-Agent (your name + email)", "type": "string", "description": "Your name or company plus a contact email, e.g. \"Acme Research jane.doe@acme.com\". SEC's fair-access policy requires every automated request to identify the requester; this is sent only in the request header to sec.gov. If empty on Apify, the actor owner's contact is used." }, "recordTypes": { "title": "What to collect", "type": "array", "description": "Record types to save; each record is one dataset row and is charged by type: filings ($0.50 per 1,000), insider_transactions (Form 3/4/5 rows, $3.00 per 1,000), company_facts (one XBRL key-financials row per company, $1.00 per 1,000). Default [\"filings\", \"insider_transactions\"].", "items": { "type": "string", "enum": [ "filings", "insider_transactions", "company_facts" ], "enumTitles": [ "Filings list (one row per filing)", "Insider transactions (Form 3/4/5, one row per transaction)", "Key financials from XBRL company facts (one row per company)" ] }, "default": [ "filings", "insider_transactions" ] }, "formTypes": { "title": "Form types", "type": "array", "description": "SEC form types to include, e.g. 10-K, 10-Q, 8-K, 4, S-1, 13D, DEF 14A, 20-F. Default [\"10-K\", \"10-Q\", \"8-K\", \"4\"]. Leave empty for all forms. Form 4 is added automatically when insider transactions are selected.", "default": [ "10-K", "10-Q", "8-K", "4" ], "items": { "type": "string" } }, "includeAmendments": { "title": "Include amendments (/A)", "type": "boolean", "description": "If true (default), also include amended forms such as 10-K/A and 4/A.", "default": true }, "filedWithinDays": { "title": "Filed within last N days", "minimum": 0, "type": "integer", "description": "Only filings from the last N days. Default 90. 0 = no date limit (full EDGAR history). Ignored when 'Filed on or after' is set. Example: 1 for a daily feed", "default": 90 }, "dateFrom": { "title": "Filed on or after (YYYY-MM-DD)", "type": "string", "description": "Optional fixed start date in YYYY-MM-DD format; overrides 'Filed within last N days'. Older filing history is loaded automatically when needed. Example: 2025-01-01" }, "maxFilingsPerCompany": { "title": "Max filings per company", "minimum": 0, "type": "integer", "description": "Maximum filings per company, newest first; insider transaction rows come from these filings (one Form 4 can produce several rows). Default 50. 0 = no limit. Example: 20", "default": 50 }, "transactionCodes": { "title": "Insider transaction codes", "type": "array", "description": "Optional. Keep only these Form 4 transaction codes: P = open-market purchase, S = open-market sale, A = grant/award, M = option exercise, F = tax withholding, G = gift. Leave empty for all. Example: [\"P\"]", "items": { "type": "string" } }, "minTransactionValue": { "title": "Minimum transaction value (USD)", "minimum": 0, "type": "integer", "description": "Optional. Keep only insider transactions where shares x price is at least this many US dollars. Rows without a price are excluded when set. Default 0 = no filter. Example: 100000", "default": 0 }, "includeDerivatives": { "title": "Include derivative transactions", "type": "boolean", "description": "If true (default), include Form 4 Table II rows: options, RSUs and other derivative securities.", "default": true }, "includeHoldings": { "title": "Include holdings rows", "type": "boolean", "description": "If true, also output holding-only rows with no transaction (e.g. Form 3 initial holdings). Charged as insider-transaction rows. Default false.", "default": false } } }, "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 }, "PROXY_UNBLOCKER_UNITS": { "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 }, "PROXY_UNBLOCKER_UNITS": { "type": "integer", "example": 0 } } } } } } } } } }