{ "openapi": "3.0.1", "info": { "title": "HK Centaline Property Index — 中原指數 API", "description": "Track the Hong Kong Centaline property price index (CCL). Clean JSON for analysts and AI agents.", "version": "0.0", "x-build-id": "2Uxf5SKFMNRPbNotC" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/nexgendata~hk-centaline-property-index/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-nexgendata-hk-centaline-property-index", "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~hk-centaline-property-index/runs": { "post": { "operationId": "runs-sync-nexgendata-hk-centaline-property-index", "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~hk-centaline-property-index/run-sync": { "post": { "operationId": "run-sync-nexgendata-hk-centaline-property-index", "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": { "regions": { "title": "Regions to scrape", "type": "array", "description": "Hong Kong districts to pull regional Centa-City Leading Index sub-indices for. Choose 'all' to get every region (HK Island, Kowloon, NT East, NT West) plus the headline CCL and segment cuts (CCL Mass, CCL Large, CCL Large Estates). HK_ISLAND covers Central / Wan Chai / Eastern / Southern; KOWLOON covers Yau Tsim Mong / Sham Shui Po / Kowloon City / Wong Tai Sin / Kwun Tong; NT_EAST covers Sha Tin / Tai Po / North / Sai Kung; NT_WEST covers Kwai Tsing / Tsuen Wan / Tuen Mun / Yuen Long / Islands.", "items": { "type": "string", "enum": [ "all", "HK_ISLAND", "KOWLOON", "NT_EAST", "NT_WEST" ], "enumTitles": [ "All regions (recommended)", "Hong Kong Island (港島)", "Kowloon (九龍)", "New Territories East (新界東)", "New Territories West (新界西)" ] }, "default": [ "all" ] }, "historicalDays": { "title": "Historical lookback (days)", "minimum": 0, "maximum": 20000, "type": "integer", "description": "How many days of historical weekly CCL data to include in the dataset. The Centa-City Leading Index is published weekly every Friday and the underlying series goes back to January 1994. Set 30 for the last ~4 weekly readings, 90 for the last quarter, 365 for the last year, 3650 for the last decade, or 20000 to pull the full 30+ year history. Set 0 to return the current week's snapshot only (no historical rows).", "default": 30 }, "includeHistory": { "title": "Include historical weekly series", "type": "boolean", "description": "When true (default), the actor also pushes one row per historical weekly CCL data point within the `historicalDays` window — useful for time-series analysis, charting, and back-testing buy/sell signals against Hong Kong's residential property cycle. When false, only the current-week snapshot rows (headline CCL + segment cuts + per-region) are pushed, which keeps the run cheap when you only need today's reading.", "default": 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 } } } } } } } } } }