{ "openapi": "3.0.1", "info": { "title": "🇦🇺 ASX Australia Stock Screener — ASX 200 Quotes", "description": "ASX Australia stock screener API — ASX 200 / All Ordinaries live quotes, market cap (AUD), P/E, P/B, dividend yield (incl. franking), ROE, sector. BHP, CBA, CSL, Macquarie universe. Bloomberg Terminal / FactSet / Refinitiv Eikon alternative for hedge funds & quants. Pay-per-result.", "version": "0.0", "x-build-id": "glG6TAQMk1bucOHIN" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/nexgendata~asx-australia-stock-screener/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-nexgendata-asx-australia-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~asx-australia-stock-screener/runs": { "post": { "operationId": "runs-sync-nexgendata-asx-australia-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~asx-australia-stock-screener/run-sync": { "post": { "operationId": "run-sync-nexgendata-asx-australia-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": [ "ASX200", "ASX300", "all" ], "type": "string", "description": "Which Australian market scope to screen: ASX200 (S&P/ASX 200 constituents — Australia's premier blue-chip index, e.g. BHP Group BHP, Commonwealth Bank CBA, CSL Limited CSL, Westpac WBC, NAB, Macquarie MQG, Wesfarmers WES, Telstra TLS, Woolworths WOW, ANZ Banking Group ANZ, Rio Tinto RIO, Woodside WDS), ASX300 (S&P/ASX 300 — adds ~100 small-mid-cap names), or all (entire ASX main board, both ordinaries and ASX-listed trusts/REITs).", "default": "ASX200" }, "limit": { "title": "Limit (stocks returned)", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Maximum number of ASX-listed stocks to return. Stocks are returned in descending market-cap order. Use 10 for a quick smoke test, 200 for the full S&P/ASX 200 index, 300 for the S&P/ASX 300, 500+ for broader ASX main-board coverage.", "default": 200 }, "min_market_cap_aud": { "title": "Min market cap (billion AUD)", "minimum": 0, "maximum": 1000, "type": "integer", "description": "Filter to stocks with market cap above this threshold, in BILLIONS of AUD. Examples: 1 = AUD$1B (small-cap floor), 10 = AUD$10B (large-cap, ASX 200 typical floor is roughly AUD$1-3B but the top half sits above AUD$10B), 50 = AUD$50B (Australian mega-cap like BHP, CBA, CSL, Westpac, NAB, ANZ, Macquarie, Wesfarmers), 100 = AUD$100B (top 5 Australian companies — BHP, CBA, CSL). Leave at 0 for no filter.", "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' (Commonwealth Bank CBA, Westpac WBC, NAB, ANZ, Macquarie MQG, Bendigo BEN, Bank of Queensland BOQ), 'mining' or 'materials' (BHP, Rio Tinto RIO, Fortescue FMG, Newmont NEM, Pilbara PLS, Mineral Resources MIN, Northern Star NST, Evolution Mining EVN, IGO Limited IGO, South32 S32), 'iron' (BHP, Rio Tinto, Fortescue, MIN), 'gold' (Newcrest, Northern Star NST, Evolution EVN, Regis Resources RRL, Perseus PRU), 'energy' or 'oil' (Woodside WDS, Santos STO, Beach Energy BPT, Karoon KAR), 'lithium' (Pilbara PLS, IGO, Mineral Resources MIN, Liontown LTR, Allkem AKE, Core Lithium CXO), 'healthcare' (CSL, Cochlear COH, ResMed RMD, Sonic Healthcare SHL, Ramsay RHC, Pro Medicus PME), 'tech' (Xero XRO, WiseTech WTC, REA Group REA, Carsales CAR, Seek SEK, NEXTDC NXT, Computershare CPU), 'retail' (Wesfarmers WES, Woolworths WOW, Coles COL, JB Hi-Fi JBH, Harvey Norman HVN, Premier Investments PMV), 'reit' (Goodman Group GMG, Scentre SCG, Stockland SGP, Mirvac MGR, GPT Group GPT, Dexus DXS), 'telco' or 'telecom' (Telstra TLS, TPG Telecom TPG). Leave blank for no filter." }, "enrich_fundamentals": { "title": "Enrich with fundamentals (slower)", "type": "boolean", "description": "If true, fetch each stock's ASX detail page on stockanalysis.com to extract P/E ratio, EPS, dividend yield, shares outstanding, beta, RSI, 52-week range, sector and industry classification. Adds ~1 HTTP request per stock and roughly doubles runtime. Required if you want to filter by sector. Recommended ON for ASX200 (a full 200-stock pull takes ~60-90 seconds).", "default": true }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Apify proxy configuration. Defaults to Apify datacenter proxy for reliable access to stockanalysis.com. Use RESIDENTIAL group if you hit rate limits (typically not needed — stockanalysis.com tolerates 6 parallel requests per IP).", "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 } } } } } } } } } }