{ "openapi": "3.0.1", "info": { "title": "Short Interest & Fails-to-Deliver API — SEC FTD + FINRA", "description": "Short interest & fails-to-deliver (FTD) API. Merges SEC FTD and FINRA short-interest disclosures into one per-ticker time series with change and spike flags. Keyless official sources. Market-structure DATA, not investment advice.", "version": "1.0", "x-build-id": "Rurpbc7YLJ9vgfQ3e" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/malonestar~short-interest-ftd-monitor/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-malonestar-short-interest-ftd-monitor", "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/malonestar~short-interest-ftd-monitor/runs": { "post": { "operationId": "runs-sync-malonestar-short-interest-ftd-monitor", "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/malonestar~short-interest-ftd-monitor/run-sync": { "post": { "operationId": "run-sync-malonestar-short-interest-ftd-monitor", "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", "type": "array", "description": "Stock ticker symbols to include (case-insensitive; matched client-side after uppercasing), e.g. [\"GME\", \"AMC\", \"AAPL\"]. Leave empty to return every symbol in the fetched files, capped by Max results.", "items": { "type": "string" } }, "sinceDate": { "title": "Since date (YYYY-MM-DD)", "type": "string", "description": "Only return records whose SEC settlement date is on or after this date. Applied after the time series is built, so the first returned period still shows its true change vs the prior period. Empty = no lower bound." }, "lookbackPeriods": { "title": "Lookback periods (SEC semi-monthly files)", "minimum": 1, "maximum": 48, "type": "integer", "description": "How many SEC Fails-to-Deliver semi-monthly files to pull, newest first. SEC publishes two files per month (first half / second half), so 6 covers roughly the last three months. Larger windows give longer time series and steadier trailing averages.", "default": 6 }, "spikeMultiplier": { "title": "Spike multiplier", "minimum": 1, "maximum": 100, "type": "integer", "description": "A record is flagged fails_spike = true when its fails_quantity exceeds this multiple of the ticker's trailing average fails (over the prior lookback periods). Default 3 (a 3x jump). Lower = more sensitive.", "default": 3 }, "includeShortInterest": { "title": "Include FINRA short interest", "type": "boolean", "description": "Also fetch and merge FINRA consolidated (OTC-market) short-interest disclosures, adding short_interest, days_to_cover, and their deltas. Requires Short interest dates below. NOTE: the FINRA CDN biweekly file covers OTC equities; exchange-listed short interest is not in this file, so some tickers may have FTD data but no short-interest row.", "default": false }, "shortInterestDates": { "title": "FINRA short-interest settlement dates (YYYY-MM-DD)", "type": "array", "description": "FINRA bi-monthly settlement dates to fetch when Include FINRA short interest is on, e.g. [\"2026-04-15\", \"2026-03-31\"]. These are the dates FINRA publishes files for (mid-month and month-end). Each maps to https://cdn.finra.org/equity/otcmarket/biweekly/shrt{YYYYMMDD}.csv.", "items": { "type": "string" } }, "maxResults": { "title": "Max results", "minimum": 1, "maximum": 200000, "type": "integer", "description": "Maximum number of merged per-ticker records to return after filtering. Each record is one (ticker, settlement date) row and is one billable result.", "default": 5000 }, "monitor": { "title": "Delta mode (only new settlement dates)", "type": "boolean", "description": "When scheduled, emit only (ticker, settlement date) records not seen in previous runs — a recurring new-data alert. State is kept in the actor's key-value store.", "default": 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 } } } } } } } } } }