{ "openapi": "3.0.1", "info": { "title": "πŸ‡­πŸ‡° HKEX Hang Seng Screener Β· ζΈ―δΊ€ζ‰€ζ’η”ŸζŒ‡ζ•ΈιΈθ‚‘", "description": "HKEX Hang Seng stock screener API β€” Hang Seng + HSCEI live quotes, market cap (HKD), P/E, P/B, dividend yield, ROE, sector. Tencent, HSBC, AIA, Alibaba, Meituan universe. Bloomberg Terminal / FactSet / Refinitiv Eikon alternative for hedge funds, quants, family offices. Pay-per-result.", "version": "0.0", "x-build-id": "LuHDZco2EGhrWWA4i" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/nexgendata~hkex-hang-seng-stock-screener/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-nexgendata-hkex-hang-seng-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~hkex-hang-seng-stock-screener/runs": { "post": { "operationId": "runs-sync-nexgendata-hkex-hang-seng-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~hkex-hang-seng-stock-screener/run-sync": { "post": { "operationId": "run-sync-nexgendata-hkex-hang-seng-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": { "market": { "title": "Market / index", "enum": [ "HSI", "HKEX-all" ], "type": "string", "description": "Which Hong Kong universe to screen: HSI (Hang Seng Index constituents β€” the ~85 blue-chip stocks including 0700 Tencent, 0005 HSBC, 9988 Alibaba), or HKEX-all (the full top-500 HKEX universe by market cap from main board + GEM).", "default": "HSI" }, "limit": { "title": "Limit", "minimum": 1, "maximum": 500, "type": "integer", "description": "Maximum number of stocks to return, sorted by market cap descending. For HSI this caps at ~85 constituents. For HKEX-all the cap is 500 stocks (top-500 by market cap).", "default": 50 }, "min_market_cap_hkd": { "title": "Min market cap (HKD)", "minimum": 0, "maximum": 100000000000000, "type": "integer", "description": "Filter to stocks with market cap above this threshold in Hong Kong Dollars. Examples: 100000000000 = HK$100 billion (mid/large-cap floor), 500000000000 = HK$500 billion (mega-cap floor). 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: 'finance', 'tech', 'property', 'utilities', 'tencent', 'bank'. Leave blank for no filter. Note: sector matching requires enrich_fundamentals=true (for the HSI sub-index assignments and detail-page sectors)." }, "enrich_fundamentals": { "title": "Enrich with P/E, P/B, dividend yield, sector (slower)", "type": "boolean", "description": "If true, fetch each stock's detail page on Stockanalysis.com to extract PE ratio, forward PE, dividend yield, beta, 52-week range, and sector classification. 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 residential proxy for reliable access to HK financial data from outside the Hong Kong region.", "default": { "useApifyProxy": true, "apifyProxyGroups": [ "RESIDENTIAL" ] } } } }, "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 } } } } } } } } } }