{ "openapi": "3.0.1", "info": { "title": "SEC Comment Letter Scraper", "description": "SEC comment letters from EDGAR: staff letters and company responses by ticker, CIK or keyword. Topics, comment count, linked filings. No API key.", "version": "0.0", "x-build-id": "jBMb841x9JtyR124L" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/goldenrod_serrano~sec-comment-letters/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-goldenrod_serrano-sec-comment-letters", "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/goldenrod_serrano~sec-comment-letters/runs": { "post": { "operationId": "runs-sync-goldenrod_serrano-sec-comment-letters", "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/goldenrod_serrano~sec-comment-letters/run-sync": { "post": { "operationId": "run-sync-goldenrod_serrano-sec-comment-letters", "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": { "sampleMode": { "title": "Free sample mode (not charged)", "type": "boolean", "description": "Turn on for a free preview: 5 letters released by the SEC in the last 7 days (operating companies). All other settings are ignored and nothing is charged. Leave off for a normal run (each pushed letter = one 'letter' event).", "default": false }, "companies": { "title": "Companies (tickers or CIKs, optional)", "type": "array", "description": "Only letters for these companies, e.g. AAPL, TSLA, 320193. Uses the SEC submissions API. With Companies set, the date range is the letter's EDGAR filing date (default: last 365 days). Leave empty to get every company.", "items": { "type": "string" } }, "keywords": { "title": "Full-text keywords (optional)", "type": "array", "description": "Search the text of UPLOAD/CORRESP letters with SEC EDGAR full-text search, e.g. non-GAAP, \"key performance indicators\", crypto, \"variable interest entity\". Phrases with spaces are searched as exact phrases. Date range = filing date (default last 365 days). Combine with Companies to search one company's letters.", "items": { "type": "string" } }, "forms": { "title": "Letter forms", "type": "array", "description": "UPLOAD = letters from SEC staff to the company (comments, 'review complete'). CORRESP = letters from the company to the SEC (responses, acceleration requests).", "items": { "type": "string", "enum": [ "UPLOAD", "CORRESP" ], "enumTitles": [ "UPLOAD — SEC staff letters", "CORRESP — company letters to the SEC" ] }, "default": [ "UPLOAD", "CORRESP" ] }, "letterTypes": { "title": "Letter types", "type": "array", "description": "Rule-based type from the letter text. Acceleration requests (short 'please declare our S-1 effective' letters) are excluded by default.", "items": { "type": "string", "enum": [ "sec_staff_comment", "sec_review_complete", "sec_letter_other", "company_response", "acceleration_request", "company_letter_other" ], "enumTitles": [ "SEC staff comments", "SEC 'review complete' / no further comments", "Other SEC staff letter", "Company response to comments", "Acceleration request", "Other company letter" ] }, "default": [ "sec_staff_comment", "sec_review_complete", "sec_letter_other", "company_response", "company_letter_other" ] }, "topics": { "title": "Topics (optional)", "type": "array", "description": "Keep only letters that mention at least one of these topics (rule-based keyword dictionary, no AI). Empty = all.", "items": { "type": "string", "enum": [ "non_gaap_measures", "revenue_recognition", "segment_reporting", "mdna_results_trends", "liquidity_capital_resources", "going_concern", "goodwill_impairment", "critical_accounting_estimates", "income_taxes", "business_combination_ma", "spac", "china_hk_vie", "crypto_digital_assets", "cybersecurity", "climate_esg", "risk_factors", "executive_compensation", "related_party", "internal_controls", "legal_contingencies", "fair_value_derivatives_warrants", "leases", "stock_compensation", "kpis_operating_metrics", "oil_gas_mining_reserves", "auditor_pcaob", "offering_terms_dilution", "going_private_deregistration", "artificial_intelligence", "tariffs_trade", "fund_prospectus" ] } }, "minComments": { "title": "Minimum numbered comments", "minimum": 0, "type": "integer", "description": "Keep only letters with at least this many numbered comments (0 = no filter).", "default": 0 }, "daysBack": { "title": "Days back", "minimum": 1, "maximum": 3660, "type": "integer", "description": "Window size in calendar days, ending today. Default mode (no companies/keywords): days the SEC *released* letters on EDGAR (max 120). Company or keyword mode: letter filing date (default 365, max 3660). Ignored if Start date is set." }, "startDate": { "title": "Start date (optional)", "pattern": "^(\\d{4}-\\d{2}-\\d{2})?$", "type": "string", "description": "YYYY-MM-DD. Leave empty to use Days back." }, "endDate": { "title": "End date (optional)", "pattern": "^(\\d{4}-\\d{2}-\\d{2})?$", "type": "string", "description": "YYYY-MM-DD. Defaults to today." }, "skipFundFilers": { "title": "Skip funds, trusts and insurance separate accounts", "type": "boolean", "description": "Most CORRESP volume is mutual-fund / ETF / annuity prospectus correspondence. On by default (ignored when you list Companies).", "default": true }, "maxResults": { "title": "Max letters to output", "minimum": 1, "maximum": 5000, "type": "integer", "description": "Stop after this many matching letters (each one is one charged 'letter' event).", "default": 100 }, "maxLettersToScan": { "title": "Max letters to scan", "minimum": 1, "maximum": 5000, "type": "integer", "description": "Safety cap on how many candidate letters are downloaded and read in one run (never charged).", "default": 500 }, "changeTracking": { "title": "Change tracking (only new letters)", "type": "boolean", "description": "Remember every letter this task has already seen (named key-value store 'sec-comment-letters-state'). Next runs output only letters not seen before, so schedules never pay twice. Rows get is_new_company / previous_letter_date.", "default": false }, "stateKey": { "title": "State key", "type": "string", "description": "Separate change-tracking memory per watchlist (e.g. 'law-firm-bd', 'my-portfolio').", "default": "default" }, "linkReferencedFilings": { "title": "Link referenced filings", "type": "boolean", "description": "Look up the company on data.sec.gov (one cached request per company) to add ticker, SIC, exchanges and the accession/URL of the 10-K / S-1 / proxy the letter is about.", "default": true }, "requestsPerSecond": { "title": "Requests per second", "minimum": 1, "maximum": 9, "type": "integer", "description": "SEC fair-access limit is 10/s; capped at 9. Default 5.", "default": 5 }, "userAgent": { "title": "User-Agent (optional)", "type": "string", "description": "SEC asks automated tools to declare who they are, e.g. 'Your Company your@email.com'. Leave empty to use the Actor's default declared agent." } } }, "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 } } } } } } } } } }