{ "openapi": "3.0.1", "info": { "title": "FINRA Short Interest", "description": "Twice-monthly short interest for every US exchange-listed and OTC stock from FINRA's consolidated data. Shares short, change, days to cover and average daily volume. Screen the whole market or track tickers over time.", "version": "1.0", "x-build-id": "9JiKbCF2b3QQ93mZF" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/pushbuild~finra-short-interest/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-pushbuild-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/pushbuild~finra-short-interest/runs": { "post": { "operationId": "runs-sync-pushbuild-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/pushbuild~finra-short-interest/run-sync": { "post": { "operationId": "run-sync-pushbuild-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": { "symbols": { "title": "Ticker symbols", "type": "array", "description": "e.g. GME, AMC. Leave empty to screen the whole market for one or more settlement dates.", "items": { "type": "string" } }, "settlementDate": { "title": "Settlement date", "type": "string", "description": "YYYY-MM-DD, or 'latest'. Overrides the date range." }, "dateFrom": { "title": "From date", "type": "string", "description": "YYYY-MM-DD. Default: one year back with symbols; latest settlement date without. Market screens are limited to 92 days." }, "dateTo": { "title": "To date", "type": "string", "description": "YYYY-MM-DD. Default: today." }, "market": { "title": "Market", "enum": [ "all", "exchange", "otc" ], "type": "string", "description": "Listing market.", "default": "all" }, "minShortInterest": { "title": "Minimum shares short", "type": "integer", "description": "Only rows with at least this many shares short." }, "minDaysToCover": { "title": "Minimum days to cover", "type": "number", "description": "Shares short / average daily volume." }, "minAvgDailyVolume": { "title": "Minimum average daily volume", "type": "integer", "description": "Filters out thinly traded stocks." }, "minChangePercent": { "title": "Minimum change %", "type": "number", "description": "Change in shares short vs the previous settlement date, in percent." }, "maxChangePercent": { "title": "Maximum change %", "type": "number", "description": "Use a negative number to find short covering." }, "sortBy": { "title": "Sort by", "enum": [ "shortInterest", "daysToCover", "changePercent", "change", "symbol", "settlementDate" ], "type": "string", "description": "Default: settlement date with symbols, shares short without." }, "order": { "title": "Order", "enum": [ "desc", "asc" ], "type": "string", "description": "Sort direction.", "default": "desc" }, "maxItems": { "title": "Max results", "minimum": 1, "maximum": 500000, "type": "integer", "description": "Maximum rows returned.", "default": 1000 } } }, "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 } } } } } } } } } }