{ "openapi": "3.0.1", "info": { "title": "Short Interest, Short Volume & SEC Filings Scraper", "description": "Track short selling and SEC filings from three official sources: Nasdaq bi-monthly short interest, FINRA daily short-sale volume for every US symbol, and SEC EDGAR filing history plus full-text search. Tickers or CIKs in, clean rows out. No API key.", "version": "0.0", "x-build-id": "lcIBAab7GAEjDCeVK" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/fanndev~short-interest-filings-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-fanndev-short-interest-filings-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/fanndev~short-interest-filings-scraper/runs": { "post": { "operationId": "runs-sync-fanndev-short-interest-filings-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/fanndev~short-interest-filings-scraper/run-sync": { "post": { "operationId": "run-sync-fanndev-short-interest-filings-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": "Mode", "enum": [ "short-interest", "short-volume", "filings", "filing-search", "company", "reference" ], "type": "string", "description": "short-interest = Nasdaq's bi-monthly short interest history per ticker. short-volume = FINRA's daily short-sale volume for every US symbol. filings = a company's SEC filing history. filing-search = full-text search across all EDGAR filings. company = SEC company profile. reference = check all sources live, including the newest FINRA date available.", "default": "short-interest" }, "symbol": { "title": "Ticker or CIK", "type": "string", "description": "A single ticker (TSLA) or, for SEC modes, a CIK number. Case does not matter and a leading $ is ignored." }, "symbols": { "title": "Tickers or CIKs", "type": "array", "description": "Several tickers (or CIKs for SEC modes) in one run. In short-volume mode this filters the daily file down to the symbols you list; leave it empty to get every symbol.", "items": { "type": "string" } }, "date": { "title": "Date (short-volume mode)", "type": "string", "description": "Trading day in YYYY-MM-DD. Leave empty to use the newest file FINRA has published - it runs 1-2 days behind and never publishes on weekends or market holidays." }, "dates": { "title": "Dates (short-volume mode)", "type": "array", "description": "Several trading days in YYYY-MM-DD to pull in one run.", "items": { "type": "string" } }, "venue": { "title": "Venue (short-volume mode)", "enum": [ "consolidated", "nasdaq-carteret", "nasdaq-chicago", "nyse", "finra-adf" ], "type": "string", "description": "Which FINRA file to read. 'consolidated' covers all venues and is what most analyses want; the others isolate a single reporting facility.", "default": "consolidated" }, "forms": { "title": "Form types (filings and filing-search modes)", "type": "array", "description": "Filter to specific SEC form types, e.g. 8-K, 10-Q, 10-K, 4, SC 13D. Leave empty for every form.", "items": { "type": "string" } }, "since": { "title": "Filed since (filings mode)", "type": "string", "description": "Only return filings on or after this date, in YYYY-MM-DD." }, "query": { "title": "Search query (filing-search mode)", "type": "string", "description": "Full-text query across EDGAR documents. Wrap a phrase in double quotes for an exact match, e.g. \"reverse stock split\"." }, "startDate": { "title": "Start date (filing-search mode)", "type": "string", "description": "Earliest filing date to search, in YYYY-MM-DD." }, "endDate": { "title": "End date (filing-search mode)", "type": "string", "description": "Latest filing date to search, in YYYY-MM-DD." }, "assetClass": { "title": "Asset class (short-interest mode)", "enum": [ "stocks", "etf" ], "type": "string", "description": "Nasdaq's asset class for the symbol: stocks or etf.", "default": "stocks" }, "includeSymbolInfo": { "title": "Include exchange info (short-interest mode)", "type": "boolean", "description": "Adds company name, exchange and listing status to every short interest row. Costs one extra request per ticker.", "default": true }, "maxItems": { "title": "Max items", "minimum": 1, "type": "integer", "description": "Maximum records per run. A single FINRA day holds about 12,300 symbols, so raise this when pulling a whole file.", "default": 500 }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Optional. All three sources answered every request without a proxy.", "default": { "useApifyProxy": 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 } } }, "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 } } } } } } } } } }