{ "openapi": "3.0.1", "info": { "title": "Short Squeeze Radar - Short Interest, FTD & Reg SHO Score", "description": "Short squeeze screener on official data: FINRA short interest and days to cover, short interest % of shares, daily short volume, SEC fails-to-deliver and the Reg SHO list, in one transparent 0-100 score per ticker. Pay per result.", "version": "0.1", "x-build-id": "4a2d7OYriAIidL1Hy" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/smartmoney-data~short-squeeze-radar/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-smartmoney-data-short-squeeze-radar", "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/smartmoney-data~short-squeeze-radar/runs": { "post": { "operationId": "runs-sync-smartmoney-data-short-squeeze-radar", "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/smartmoney-data~short-squeeze-radar/run-sync": { "post": { "operationId": "run-sync-smartmoney-data-short-squeeze-radar", "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": { "tickers": { "title": "Tickers (watchlist)", "type": "array", "description": "US tickers to profile (e.g. GME, AMC). Leave empty to scan the market: the largest short positions are ranked and the top ones are profiled.", "items": { "type": "string" } }, "scanUniverse": { "title": "Scan universe (market scan)", "minimum": 100, "maximum": 20000, "type": "integer", "description": "Market scan only: how many of the largest short positions (by shares short) to rank before profiling the top ones.", "default": 2000 }, "maxResults": { "title": "Max tickers profiled (market scan)", "minimum": 1, "maximum": 500, "type": "integer", "description": "Market scan only: how many of the highest-ranked tickers to fully profile and return.", "default": 50 }, "minDaysToCover": { "title": "Minimum days to cover (market scan)", "minimum": 0, "type": "number", "description": "Market scan only: skip tickers whose short interest is less than this many days of average volume.", "default": 0 }, "minScore": { "title": "Minimum squeeze score", "minimum": 0, "maximum": 100, "type": "integer", "description": "Only return tickers scoring at least this (0-100).", "default": 0 }, "includeOtc": { "title": "Include OTC stocks (market scan)", "type": "boolean", "description": "Market scan only: OTC names are excluded by default because thin volume inflates days to cover.", "default": false }, "shortVolumeDays": { "title": "Daily short volume: trading days", "minimum": 0, "maximum": 20, "type": "integer", "description": "Average the share of volume sold short over this many recent trading days (FINRA Reg SHO daily files). 0 skips it.", "default": 5 }, "ftdPeriods": { "title": "Fails-to-deliver: half-month periods", "minimum": 0, "maximum": 6, "type": "integer", "description": "How many of the latest half-monthly SEC fails-to-deliver files to include (2 = about a month). 0 skips it.", "default": 2 }, "thresholdDays": { "title": "Reg SHO threshold list: trading days", "minimum": 0, "maximum": 20, "type": "integer", "description": "How many recent daily Nasdaq threshold lists to check, to see how long a ticker has been on it. 0 skips it.", "default": 10 }, "includeSharesOutstanding": { "title": "Short interest as % of shares outstanding", "type": "boolean", "description": "Look up shares outstanding from each company's latest SEC filing cover page (one extra request per ticker).", "default": true }, "secUserAgent": { "title": "SEC User-Agent contact", "type": "string", "description": "The SEC asks automated clients to identify themselves as 'Company Name email@domain.com'. Put your own contact here for heavy use.", "default": "SmartMoney Data Short Squeeze Radar smartmoney-data@googlegroups.com" } } }, "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 } } } } } } } } } }