{ "openapi": "3.0.1", "info": { "title": "FINRA Short Interest Data", "description": "Official FINRA consolidated short interest per ticker: short position, prior position, change, average daily volume, and days to cover. Latest or any settlement date; filter by ticker, market, size, or days to cover.", "version": "0.1", "x-build-id": "imAI27aVF2YO6Blvq" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/darthdimus~finra-short-interest/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-darthdimus-finra-short-interest", "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/darthdimus~finra-short-interest/runs": { "post": { "operationId": "runs-sync-darthdimus-finra-short-interest", "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/darthdimus~finra-short-interest/run-sync": { "post": { "operationId": "run-sync-darthdimus-finra-short-interest", "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": { "settlementDate": { "title": "Settlement date", "type": "string", "description": "Optional. YYYY-MM-DD or YYYYMMDD (FINRA reports twice a month, mid-month and month-end). Empty = latest published date. With 'Periods' > 1 this is the most recent period of the range." }, "periods": { "title": "Periods", "minimum": 1, "maximum": 12, "type": "integer", "description": "How many published settlement dates to include, walking back from the date (1-12).", "default": 1 }, "symbols": { "title": "Symbols", "type": "string", "description": "Optional. Comma-separated tickers to keep, e.g. TSLA,GME,AMC. Empty = all tickers (~22,000 per date)." }, "market": { "title": "Market", "enum": [ "", "NNM", "NCM", "NYSE", "AMEX", "ARCA", "BATS", "OTC" ], "type": "string", "description": "Optional market class filter.", "default": "" }, "minShortPosition": { "title": "Minimum short position (shares)", "minimum": 0, "type": "integer", "description": "Optional. Keep rows whose current short position is at least this many shares." }, "minAverageDailyVolume": { "title": "Minimum average daily volume", "minimum": 0, "type": "integer", "description": "Optional. Keep rows whose average daily volume is at least this many shares (filters illiquid names)." }, "minDaysToCover": { "title": "Minimum days to cover", "minimum": 0, "type": "integer", "description": "Optional. Keep rows whose days to cover (short position / average daily volume) is at least this." }, "sortBy": { "title": "Sort by", "enum": [ "shortPosition", "daysToCover", "changePercent", "changeShares", "symbol" ], "type": "string", "description": "Row order before the limit is applied.", "default": "shortPosition" }, "maxRows": { "title": "Max rows", "minimum": 1, "maximum": 5000, "type": "integer", "description": "Maximum rows to push per settlement date (1-5000).", "default": 100 } } }, "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 } } } } } } } } } }