{ "openapi": "3.0.1", "info": { "title": "SEC EDGAR Full-Text Search: Filings by Keyword and Form", "description": "Search the full text of SEC EDGAR filings by keyword or phrase, form type and date. One row per filing with company, form, filing date and a link to the matching document, plus an alert mode that only returns new filings.", "version": "1.0", "x-build-id": "FceSe5XYUC1eXkldB" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/accountable_eel~sec-edgar-full-text-search-lookup/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-accountable_eel-sec-edgar-full-text-search-lookup", "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/accountable_eel~sec-edgar-full-text-search-lookup/runs": { "post": { "operationId": "runs-sync-accountable_eel-sec-edgar-full-text-search-lookup", "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/accountable_eel~sec-edgar-full-text-search-lookup/run-sync": { "post": { "operationId": "run-sync-accountable_eel-sec-edgar-full-text-search-lookup", "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": [ "queries" ], "properties": { "queries": { "title": "Search phrases (full text of the filing)", "type": "array", "description": "One word or phrase per line, matched against the full text of SEC filings and their exhibits. Put a phrase in double quotes for an exact match. Each line is a separate search; a filing that matches several is returned once. Accepted formats: going concern, \"material weakness\", \"cybersecurity incident\". You're only charged for the ones we actually find — a miss costs nothing.", "items": { "type": "string" } }, "forms": { "title": "Form types", "type": "array", "description": "Optional. Only filings of these form types, for example 10-K, 10-Q, 8-K, S-1, 20-F. Leave empty for every form.", "items": { "type": "string" } }, "testRun": { "title": "Try it first — only process the first 5", "type": "boolean", "description": "Turn this on to test your input on a small sample before running the full list. Turn it off to process everything.", "default": false }, "onlyFound": { "title": "Hide rows with no result", "type": "boolean", "description": "Only keep rows where something was actually found. Misses are always free, whether or not you show them here.", "default": false }, "includeKeywords": { "title": "Only keep rows containing", "type": "array", "description": "Optional. Only keep results that mention at least one of these words (e.g. a job title, a city, a product name). Leave empty to keep everything.", "items": { "type": "string" } }, "excludeKeywords": { "title": "Skip rows containing", "type": "array", "description": "Optional. Drop any result that mentions one of these words. Leave empty to skip nothing.", "items": { "type": "string" } }, "maxResults": { "title": "Max filings per run", "type": "integer", "description": "Up to 500. Caps how many filings you get (and pay for) in one run.", "default": 100 }, "sinceDays": { "title": "Filed in the last N days", "type": "integer", "description": "The search window ends today and starts this many days back. Ignored when you set a start date.", "default": 30 }, "startDate": { "title": "Start date (optional)", "type": "string", "description": "Optional, YYYY-MM-DD. Overrides the last-N-days window.", "default": "" }, "endDate": { "title": "End date (optional)", "type": "string", "description": "Optional, YYYY-MM-DD. Defaults to today.", "default": "" }, "onlyNewSinceLastRun": { "title": "Only return filings new since the last run (monitoring)", "type": "boolean", "description": "On: only filings not returned by your earlier runs are returned and charged for — run this on a schedule as a filing alert. Off: every matching filing is returned every time.", "default": false }, "deltaName": { "title": "Watchlist name (optional)", "type": "string", "description": "Optional. Name this search's monitoring memory so you can tell two schedules of this actor apart, or keep one memory across an input change. Leave empty to auto-derive one from your filters.", "default": "" }, "columns": { "title": "Which columns do you want?", "type": "array", "description": "Choose which pieces of information to include in each result row. All are included by default.", "items": { "type": "string", "enum": [ "searchSummary", "filingCount", "truncated", "monitorStatus", "filings", "accessionNumber", "companyName", "ticker", "cik", "form", "filedAt", "periodEnding", "documentType", "fileDescription", "sicCode", "businessLocation", "incorporationState", "matchedDocuments", "matchedQueries", "documentUrl", "filingIndexUrl", "isNew", "firstSeenAt" ], "enumTitles": [ "Search run", "Filings returned", "More results were available", "Monitoring status", "All filings (full list)", "Accession number", "Company", "Ticker", "CIK", "Form", "Filed on", "Period ending", "Matched document type", "Document description", "SIC code", "Business location", "State of incorporation", "Matching documents", "Matched phrases", "Filing document", "Filing index", "Is this filing new?", "First seen on a run" ] }, "default": [ "searchSummary", "filingCount", "truncated", "monitorStatus", "filings", "accessionNumber", "companyName", "ticker", "cik", "form", "filedAt", "periodEnding", "documentType", "fileDescription", "sicCode", "businessLocation", "incorporationState", "matchedDocuments", "matchedQueries", "documentUrl", "filingIndexUrl", "isNew", "firstSeenAt" ] }, "expandRows": { "title": "One row per filing (recommended) — turn off for one row per search instead", "type": "boolean", "description": "When on, each filing found gets its own row instead of being grouped under its search. You're still only charged once per search, no matter how many rows it produces.", "default": true }, "maxConcurrency": { "title": "Max concurrency", "minimum": 1, "maximum": 1, "type": "integer", "description": "Parallel requests. Keep conservative — this target has no browser fallback, so getting blocked costs more than slow-and-steady.", "default": 1 } } }, "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 } } } } } } } } } }