{
  "openapi": "3.0.1",
  "info": {
    "title": "Short Interest & Short Volume: FINRA, All US Stocks",
    "description": "FINRA short interest for every US stock (NYSE, Nasdaq, Arca, Cboe, OTC): short interest, change, days to cover, average volume, plus daily short-sale volume and short ratio. By ticker with one year of history, or the whole market with filters.",
    "version": "0.1",
    "x-build-id": "KXvNJvTqHkfVJdRMe"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/tacps126~short-interest/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-tacps126-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/tacps126~short-interest/runs": {
      "post": {
        "operationId": "runs-sync-tacps126-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/tacps126~short-interest/run-sync": {
      "post": {
        "operationId": "run-sync-tacps126-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": {
          "dataset": {
            "title": "Data",
            "enum": [
              "shortInterest",
              "shortVolume"
            ],
            "type": "string",
            "description": "Short interest is the number of shares held short on a settlement date (the 15th and the month end). Daily short volume is the shares sold short each trading day.",
            "default": "shortInterest"
          },
          "symbols": {
            "title": "Tickers",
            "type": "array",
            "description": "Stock tickers, e.g. GME or BRK.A. Leave empty for the whole market (about 22,000 stocks; use the filters below).",
            "items": {
              "type": "string"
            }
          },
          "settlementDate": {
            "title": "Settlement date",
            "type": "string",
            "description": "Short interest settlement date as YYYY-MM-DD, e.g. 2026-10-15. Empty = the newest published."
          },
          "historyCycles": {
            "title": "Settlement dates per ticker",
            "minimum": 1,
            "maximum": 24,
            "type": "integer",
            "description": "For tickers: how many settlement dates back (24 = one year of history).",
            "default": 1
          },
          "addShortVolume": {
            "title": "Add short volume ratio",
            "type": "boolean",
            "description": "Add each stock's share of volume sold short over the trading days before the settlement date (`shortVolumeRatio`).",
            "default": false
          },
          "shortVolumeDays": {
            "title": "Trading days",
            "minimum": 1,
            "maximum": 60,
            "type": "integer",
            "description": "Daily short volume: how many trading days back. With \"Add short volume ratio\": how many days are averaged.",
            "default": 5
          },
          "markets": {
            "title": "Markets",
            "type": "array",
            "description": "Short interest only. Empty = every market.",
            "items": {
              "type": "string",
              "enum": [
                "Nasdaq",
                "NYSE",
                "ARCA",
                "AMEX",
                "BZX",
                "TXSE",
                "OTC"
              ],
              "enumTitles": [
                "Nasdaq",
                "NYSE",
                "NYSE Arca",
                "NYSE American",
                "Cboe BZX",
                "Texas Stock Exchange",
                "OTC"
              ]
            }
          },
          "minDaysToCover": {
            "title": "Min days to cover",
            "minimum": 0,
            "type": "number",
            "description": "Short interest divided by average daily volume, e.g. 5."
          },
          "minShortInterest": {
            "title": "Min short interest (shares)",
            "minimum": 0,
            "type": "integer",
            "description": "e.g. 1000000."
          },
          "minChangePercent": {
            "title": "Min change since the last date (%)",
            "type": "number",
            "description": "e.g. 20 for short interest up 20% or more; -100 keeps everything."
          },
          "minAvgDailyVolume": {
            "title": "Min average daily volume",
            "minimum": 0,
            "type": "integer",
            "description": "Leaves out thinly traded stocks, e.g. 100000."
          },
          "minShortRatio": {
            "title": "Min short volume ratio",
            "minimum": 0,
            "maximum": 1,
            "type": "number",
            "description": "Share of volume sold short, 0 to 1, e.g. 0.5."
          },
          "minTotalVolume": {
            "title": "Min daily volume",
            "minimum": 0,
            "type": "integer",
            "description": "Daily short volume only: leave out days with less volume."
          },
          "sortBy": {
            "title": "Sort by",
            "enum": [
              "daysToCover",
              "shortInterest",
              "changePercent",
              "shortRatio",
              "symbol"
            ],
            "type": "string",
            "description": "Newest date first, then this (highest first).",
            "default": "daysToCover"
          },
          "maxItems": {
            "title": "Max rows",
            "minimum": 1,
            "type": "integer",
            "description": "Most rows returned.",
            "default": 500
          },
          "onlyNew": {
            "title": "Only new rows",
            "type": "boolean",
            "description": "Schedule the Actor and each run returns only rows (ticker + date) that earlier runs did not deliver: each new settlement date or trading day once.",
            "default": false
          },
          "monitorName": {
            "title": "Monitor name",
            "type": "string",
            "description": "Optional name for the \"only new\" history, so several monitors can run side by side."
          },
          "tenantId": {
            "title": "Tenant ID",
            "type": "string",
            "description": "Optional label used to keep separate histories for different clients or teams."
          },
          "aiInsights": {
            "title": "AI insights",
            "type": "boolean",
            "description": "Add an `insight` to each row: what the short position says, the squeeze risk and what to watch; with a profile, how relevant it is to you.",
            "default": false
          },
          "aiProfile": {
            "title": "Your profile (for the fit score)",
            "type": "string",
            "description": "What you trade or watch, e.g. \"Small-cap biotech swing trader, looks for short squeezes with rising short interest\". Adds a fit score."
          },
          "aiLanguage": {
            "title": "Insight language",
            "type": "string",
            "description": "Insights are written in this language, whatever the source language.",
            "default": "English"
          },
          "maxInsights": {
            "title": "Max insights per run",
            "minimum": 1,
            "maximum": 500,
            "type": "integer",
            "description": "Insights are added to the first N rows (in the sort order).",
            "default": 25
          },
          "aiProvider": {
            "title": "AI provider",
            "enum": [
              "apify",
              "anthropic",
              "openai",
              "gemini",
              "openrouter",
              "groq",
              "mistral",
              "deepseek",
              "compatible"
            ],
            "type": "string",
            "description": "Which AI does the analysis. Apify needs no key: the model's tokens are billed to your Apify account by Apify's AI gateway (a fraction of a cent per call with the default model). Any other provider uses your own key and bills you there.",
            "default": "apify"
          },
          "aiApiKey": {
            "title": "AI API key",
            "type": "string",
            "description": "Your own key for the provider above (not needed for Apify). Sent only to that provider, never stored."
          },
          "aiModel": {
            "title": "AI model",
            "type": "string",
            "description": "Model name. Apify: an OpenRouter id like anthropic/claude-sonnet-... or google/gemini-... (default: the newest Claude Haiku listed, a light model since it runs once per result). Anthropic: default claude-opus-5-5. Others: required."
          },
          "aiBaseUrl": {
            "title": "API base URL",
            "type": "string",
            "description": "Only for \"Other OpenAI-compatible API\", e.g. http://localhost:11434/v1 for Ollama."
          },
          "debug": {
            "title": "Debug",
            "type": "boolean",
            "description": "Save extra diagnostics with the run (for support requests).",
            "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
                  },
                  "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}