{ "openapi": "3.0.1", "info": { "title": "πŸ‡ΏπŸ‡¦ JSE South Africa Stock Screener β€” Top 40 Quotes", "description": "JSE Johannesburg Stock Exchange screener API β€” Top 40 / All Share live quotes, market cap (ZAR), P/E, P/B, dividend yield, ROE, sector. Naspers, Anglo American, Standard Bank, MTN universe. Bloomberg / FactSet / Refinitiv Eikon alternative for SA / Africa data. Pay-per-result.", "version": "0.0", "x-build-id": "K69UxSw4Xt1nowvPW" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/nexgendata~jse-southafrica-stock-screener/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-nexgendata-jse-southafrica-stock-screener", "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/nexgendata~jse-southafrica-stock-screener/runs": { "post": { "operationId": "runs-sync-nexgendata-jse-southafrica-stock-screener", "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/nexgendata~jse-southafrica-stock-screener/run-sync": { "post": { "operationId": "run-sync-nexgendata-jse-southafrica-stock-screener", "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": { "index": { "title": "Index / Market", "enum": [ "Top40", "JSE-all" ], "type": "string", "description": "Which JSE market scope to screen: Top40 (FTSE/JSE Top 40 large-cap constituents β€” Naspers NPN, Prosus PRX, BHP BHG, Anglo American AGL, Standard Bank SBK, Sasol SOL, FirstRand FSR, Gold Fields GFI, AngloGold ANG, MTN MTN, Capitec CPI, Discovery DSY, Anheuser-Busch ANH, BAT BTI, Richemont CFR, etc.) or JSE-all (entire JSE main-board universe β€” ~250 listed companies). Top40 is the headline South African blue-chip benchmark; JSE-all gives you the full Johannesburg listed universe.", "default": "Top40" }, "limit": { "title": "Limit (stocks returned)", "minimum": 1, "maximum": 2000, "type": "integer", "description": "Maximum number of JSE-listed stocks to return. Stocks are returned in descending market-cap order. Use 10 for a quick smoke test, 40 for the FTSE/JSE Top 40 blue-chip basket, 100 for the broad large-and-mid-cap universe, 250+ to pull the entire JSE main-board universe. The Johannesburg Stock Exchange has roughly 250+ listed companies.", "default": 40 }, "min_market_cap_zar_billion": { "title": "Min market cap (billion ZAR)", "minimum": 0, "maximum": 10000, "type": "integer", "description": "Filter to stocks with market cap above this threshold, in BILLIONS of South African Rand (ZAR). Examples: 10 = R10B (mid-cap floor), 100 = R100B (Top 40 heavy-weight), 500 = R500B (top 10 JSE mega-caps like Naspers, Prosus, BHP, Anglo American, Anheuser-Busch, Richemont, BAT), 1000 = R1T (top 5 JSE mega-caps). Leave at 0 for no filter. Note: 1 USD β‰ˆ 18.5 ZAR (rand is free-floating, fluctuates).", "default": 0 }, "sector": { "title": "Sector / industry / name keyword", "type": "string", "description": "Optional case-insensitive substring filter applied to sector, industry, and company name. Examples: 'bank' (Standard Bank, FirstRand, Absa, Nedbank, Capitec), 'mining' or 'gold' (Gold Fields, AngloGold, Harmony, Sibanye-Stillwater), 'retail' (Shoprite, Woolworths, Pick n Pay, Mr Price), 'telecom' (MTN, Vodacom, Telkom), 'tobacco' (BAT, Richemont), 'tech' (Naspers, Prosus), 'insurance' (Discovery, Sanlam, Old Mutual), 'platinum' (Anglo Platinum, Impala, Northam). Leave blank for no filter. Note: sector matching requires enrich_fundamentals=true." }, "enrich_fundamentals": { "title": "Enrich with fundamentals (slower)", "type": "boolean", "description": "If true, fetch each stock's detail page on stockanalysis.com to extract P/E ratio, forward P/E, EPS, dividend yield, shares outstanding, beta, RSI, 52-week range, sector and industry classification, and earnings dates. Adds ~1 HTTP request per stock and roughly doubles runtime. Required if you want to filter by sector.", "default": false }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Apify proxy configuration. Defaults to Apify datacenter proxy for reliable global access to stockanalysis.com. Switch to RESIDENTIAL group only if you hit rate limits β€” the JSE listing page is lightweight and rarely throttles.", "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 } } } } } } } } } }