{ "openapi": "3.0.1", "info": { "title": "US Short Interest Scraper: NYSE, Nasdaq and OTC via FINRA Data", "description": "Extract official FINRA short interest for any US security: NYSE, Nasdaq, Arca and OTC. Short interest, days to cover, period change, plus a look-ahead-safe knowable date for backtests. History to 2017. Export to Google Sheets, Slack or Zapier. $2 per 1,000 rows.", "version": "0.0", "x-build-id": "Tz6RKHQWzCBmA65dD" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/getascraper~short-interest-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-getascraper-short-interest-scraper", "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/getascraper~short-interest-scraper/runs": { "post": { "operationId": "runs-sync-getascraper-short-interest-scraper", "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/getascraper~short-interest-scraper/run-sync": { "post": { "operationId": "run-sync-getascraper-short-interest-scraper", "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": "Tickers to fetch, e.g. TSLA, GME, IBM, SPY. Works for NYSE, Nasdaq, NYSE Arca and OTC. Leave empty to pull every reported security for the selected period (see Max rows before you do).", "default": [ "TSLA", "GME", "AMC" ], "items": { "type": "string" } }, "market": { "title": "Market", "enum": [ "exchange", "otc", "both" ], "type": "string", "description": "\"Exchange-listed\" covers NYSE, Nasdaq and NYSE Arca. \"OTC\" covers over-the-counter securities. \"Both\" queries each in turn.", "default": "exchange" }, "latestOnly": { "title": "Latest settlement period only", "type": "boolean", "description": "Return only the most recently published settlement period. Turn this off to pull a historical range, which returns far more rows.", "default": true }, "settlementDateFrom": { "title": "Settlement date from", "type": "string", "description": "Start of the settlement-date range, as YYYY-MM-DD. Only used when \"Latest settlement period only\" is off. Leave empty to start from the oldest period available." }, "settlementDateTo": { "title": "Settlement date to", "type": "string", "description": "End of the settlement-date range, as YYYY-MM-DD. Only used when \"Latest settlement period only\" is off. Leave empty to run through the newest period." }, "monitorMode": { "title": "Monitor mode (only new periods)", "type": "boolean", "description": "Remembers the last settlement period collected and returns nothing until a newer one is published. Pair it with a schedule to get a clean feed with no duplicates.", "default": false }, "maxItems": { "title": "Max rows", "minimum": 1, "maximum": 100000, "type": "integer", "description": "Stop after this many rows. Raise it for whole-market pulls, where a single settlement period covers thousands of securities.", "default": 25 }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Proxy settings. Datacenter is the default and is all this Actor needs, since the data comes from an official public source with no blocking.", "default": { "useApifyProxy": true } } } }, "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 } } } } } } } } } }