{ "openapi": "3.0.1", "info": { "title": "IBKR Shortable Stocks Scraper", "description": "Scrape short borrow rates, fees, and shares-available data from Interactive Brokers across global stock exchanges including US, UK, Germany, Japan, and Hong Kong. For short sellers, quant traders, and AI agents. Export as JSON or CSV, run via API, schedule, or integrate with other tools.", "version": "0.0", "x-build-id": "B0SaOh9hVjMZikgV6" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/stdevi~ibkr-shortable-stocks-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-stdevi-ibkr-shortable-stocks-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/stdevi~ibkr-shortable-stocks-scraper/runs": { "post": { "operationId": "runs-sync-stdevi-ibkr-shortable-stocks-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/stdevi~ibkr-shortable-stocks-scraper/run-sync": { "post": { "operationId": "run-sync-stdevi-ibkr-shortable-stocks-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", "required": [ "countries" ], "properties": { "countries": { "title": "Countries", "uniqueItems": true, "type": "array", "description": "Stock exchanges to fetch from IBKR's Securities Lending & Borrowing feed. Defaults to United States if left empty.", "items": { "type": "string", "enum": [ "usa", "can", "mx", "gb", "de", "fr", "nl", "ch", "it", "se", "es", "be", "at", "aus", "jp", "hk", "in", "sg" ], "enumTitles": [ "United States", "Canada", "Mexico", "United Kingdom", "Germany", "France", "Netherlands", "Switzerland", "Italy", "Sweden", "Spain", "Belgium", "Austria", "Australia", "Japan", "Hong Kong", "India", "Singapore" ] }, "default": [ "usa" ] }, "symbols": { "title": "Symbols", "uniqueItems": true, "type": "array", "description": "If provided, only rows matching these tickers (or IBKR internal codes) are returned. Case-insensitive. Leave empty to return all stocks.", "items": { "type": "string" } }, "minAvailable": { "title": "Minimum shares available", "minimum": 0, "type": "integer", "description": "Filter out stocks with fewer shares available than this. For securities reported with a lower bound (e.g. \">10,000,000\"), the lower bound is used as the value." }, "maxFeeRate": { "title": "Maximum fee rate", "minimum": 0, "type": "number", "description": "Filter out stocks with borrow fees above this percentage. E.g. 5 keeps only stocks costing 5% APR or less to borrow." }, "forceRefresh": { "title": "Force refresh", "type": "boolean", "description": "Skip the cache and re-download every requested country, even if the published MD5 matches the cached version. Useful for debugging or when you want to audit IBKR's published file directly.", "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 } } } } } } } } } }