{ "openapi": "3.0.1", "info": { "title": "Tickertape India Stocks Scraper – Fundamentals & Screener", "description": "Indian stock data from Tickertape as JSON: quotes, key ratios, scorecard, 10-year financials, quarterly results, promoter/FII/DII/MF shareholding history, dividends, corporate actions, analyst forecasts, MF holders, peers, NIFTY index constituents and a full screener. No login, pay per stock.", "version": "0.1", "x-build-id": "agQHdp43zygqYjcUg" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/data_daemon~tickertape-stocks-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-data_daemon-tickertape-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/data_daemon~tickertape-stocks-scraper/runs": { "post": { "operationId": "runs-sync-data_daemon-tickertape-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/data_daemon~tickertape-stocks-scraper/run-sync": { "post": { "operationId": "run-sync-data_daemon-tickertape-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", "properties": { "mode": { "title": "Mode", "enum": [ "stocks", "index", "screener" ], "type": "string", "description": "`stocks`: profiles for a list of tickers. `index`: all constituents of an index (NIFTY 50, NIFTY BANK, NIFTY 500 …). `screener`: run a stock screen with custom filters.", "default": "stocks" }, "stocks": { "title": "Stocks", "type": "array", "description": "NSE tickers, company names or Tickertape URLs, e.g. `RELIANCE`, `TCS`, `Infosys`, `https://www.tickertape.in/stocks/hdfc-bank-HDBK`.", "default": [ "RELIANCE", "TCS", "HDFCBANK" ], "items": { "type": "string" } }, "indexSid": { "title": "Index", "type": "string", "description": "For `index` mode. Accepts names (`NIFTY 50`, `NIFTY BANK`, `NIFTY 100`, `NIFTY 500`, `SENSEX`) or Tickertape index ids such as `.NSEI`, `.NSEBANK`.", "default": "NIFTY 50" }, "screenerMatch": { "title": "Screener filters", "type": "object", "description": "For `screener` mode. Tickertape filter object, e.g. `{\"mrktCapf\": {\"g\": 1000}, \"apef\": {\"l\": 20}, \"divYield\": {\"g\": 2}}` (g = greater than, l = less than). Common fields: mrktCapf (market cap ₹Cr), apef (P/E), pbr (P/B), divYield, roe, pr1y (1-year return %), 4wpct, beta, sector." }, "screenerSortBy": { "title": "Screener sort field", "type": "string", "description": "Field to sort screener results by (default `mrktCapf`).", "default": "mrktCapf" }, "screenerSortDesc": { "title": "Sort descending", "type": "boolean", "description": "Sort screener results descending (default) or ascending.", "default": true }, "screenerFields": { "title": "Extra screener fields", "type": "array", "description": "Additional ratio fields to return per screener row (added to the defaults: subindustry, mrktCapf, lastPrice, apef, pbr, divYield, pr1w, pr1y, 4wpct, 52whigh, 52wlow, roe, beta).", "items": { "type": "string" } }, "fullProfile": { "title": "Full stock profile", "type": "boolean", "description": "Fetch the complete profile for every stock: quote, key ratios, scorecard, 10-year income statement, balance sheet, cash flow, quarterly results, shareholding history, dividends, corporate actions, announcements, analyst forecasts, mutual-fund holders, peers and checklist. Off = lightweight quote/ratio rows only. Defaults to on in `stocks` mode and off in `index`/`screener` mode." }, "maxItems": { "title": "Maximum records", "minimum": 0, "type": "integer", "description": "Stop after this many records (0 = no limit).", "default": 0 }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Optional. Not needed by default." } } }, "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 } } } } } } } } } }