API to retrieve the live intraday short-interest estimate snapshot for a given ticker on a given exchange.
Returns a single current record combining the daily short-interest estimate baseline (daily SI shares and % of free float), the live short-interest estimate (live SI shares, % of free float, and the change vs the daily baseline in shares and percent), and the live cost to borrow (liveCtbAverage -- the ORTEX composite, seeded from the daily ORTEX CTB and kept live through the trading day, converging to the daily value by close; null when not yet set). Timestamps are UTC, second precision.
Returns 404 when the stock has no live record currently available.
Try it out! You can test the API with the trial key TEST. Simply include it in your request headers; either here, or add the header "Ortex-Api-Key": "TEST" to your http request.
Trial key restrictions: A list of randomly selected rows will be returned
Get full access! Get a key at app.ortex.com/apis
# OpenAPI definition ```json { "openapi": "3.0.3", "info": { "title": "ORTEX APIs", "version": "1.0", "description": "A revolutionary global equity analytics platform which identifies and analyses relevant data for your stocks." }, "paths": { "/api/v1/stock/{exchange_symbol}/{ticker}/short_interest_live": { "get": { "operationId": "stock_short_interest_live_retrieve", "description": "API to retrieve the live intraday short-interest estimate snapshot for a given ticker on a given exchange.
\nReturns a single current record combining the daily short-interest estimate baseline (daily SI shares and % of free float), the live short-interest estimate (live SI shares, % of free float, and the change vs the daily baseline in shares and percent), and the live cost to borrow (liveCtbAverage -- the ORTEX composite, seeded from the daily ORTEX CTB and kept live through the trading day, converging to the daily value by close; null when not yet set). Timestamps are UTC, second precision.
Returns 404 when the stock has no live record currently available.
\n\nTry it out! You can test the API with the trial key TEST. Simply include it in your request headers; either here, or add the header \"Ortex-Api-Key\": \"TEST\" to your http request.
\nTrial key restrictions: A list of randomly selected rows will be returned
\nGet full access! Get a key at app.ortex.com/apis
\n", "summary": "Live Short Interest", "parameters": [ { "in": "header", "name": "accept", "schema": { "type": "string", "enum": [ "*/*" ] } }, { "in": "path", "name": "exchange_symbol", "schema": { "type": "string" }, "description": "Exchange symbol (e.g. \"nyse\", \"nasdaq\"), MIC code (e.g. \"xnys\", \"xnas\") or two character ISO country code (e.g \"us\", \"ca\" for ALL country exchanges)", "required": true, "examples": { "NewYorkStockExchangeSymbol": { "value": "nyse", "summary": "New York Stock Exchange symbol" }, "NASDAQSymbol": { "value": "nasdaq", "summary": "NASDAQ symbol" }, "NewYorkStockExchangeMICCode": { "value": "xnys", "summary": "New York Stock Exchange MIC code" }, "NASDAQMICCode": { "value": "xnas", "summary": "NASDAQ MIC code" }, "AllUSExchanges": { "value": "us", "summary": "All US exchanges" }, "AllCanadianExchanges": { "value": "ca", "summary": "All Canadian exchanges" } } }, { "in": "path", "name": "ticker", "schema": { "type": "string" }, "description": "Ticker symbol", "required": true } ], "tags": [ "Short Interest" ], "security": [ { "ApiKeyAuth": [] } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShortInterestLive" } } }, "description": "" }, "400": { "description": "Invalid request parameters" }, "403": { "description": "Not authorized" }, "404": { "description": "Data not found" }, "429": { "description": "Rate limit exceeded" }, "500": { "description": "Internal server error" } } } } }, "components": { "schemas": { "ShortInterestLive": { "type": "object", "description": "Live intraday short-interest estimate snapshot for a single stock.\n\nExposes only ORTEX-derived values: the daily and live short-interest\nestimates (shares, % of free float, and the live change vs the daily\nbaseline) plus the live composite cost-to-borrow. The raw FIS\nsecurities-lending position quantities (shares on loan, borrows/returns) are\nintentionally not exposed. Timestamps are second-precision ISO-8601 (UTC);\n``None`` when not yet set.", "properties": { "ticker": { "type": "string" }, "exchangeSymbol": { "type": "string", "nullable": true }, "companyName": { "type": "string", "nullable": true }, "marketCapUsd": { "type": "number", "format": "double", "nullable": true }, "dailySiDate": { "type": "string", "format": "date", "nullable": true }, "dailySiShares": { "type": "integer", "nullable": true }, "dailySiPcFreeFloat": { "type": "number", "format": "double", "nullable": true }, "liveSiTime": { "type": "string", "format": "date-time", "nullable": true }, "liveSiShares": { "type": "integer", "nullable": true }, "liveSiPcFreeFloat": { "type": "number", "format": "double", "nullable": true }, "liveSiChangeShares": { "type": "integer", "nullable": true }, "liveSiChangePercent": { "type": "number", "format": "double", "nullable": true }, "liveCtbAverage": { "type": "number", "format": "double", "nullable": true }, "note": { "type": "string", "nullable": true } }, "required": [ "companyName", "dailySiDate", "dailySiPcFreeFloat", "dailySiShares", "exchangeSymbol", "liveCtbAverage", "liveSiChangePercent", "liveSiChangeShares", "liveSiPcFreeFloat", "liveSiShares", "liveSiTime", "marketCapUsd", "note", "ticker" ] } }, "securitySchemes": { "ApiKeyAuth": { "type": "apiKey", "in": "header", "name": "Ortex-Api-Key", "description": "Use test API key: `TEST` to get a limited result." } } }, "servers": [ { "url": "https://api.ortex.com/", "description": "Production" } ] } ```