{ "openapi": "3.0.1", "info": { "title": "Hong Kong Government Tenders Scraper (GLD, ArchSD, HKMA)", "description": "Get Hong Kong government tender notices in English and Chinese from official DATA.GOV.HK open data: GLD e-Tender Box, Architectural Services Department and HKMA. Filter by keyword, department and date, and get only new or changed tenders since your last run. No personal contact data.", "version": "1.0", "x-build-id": "QRqDRHkFrvM9FQbbe" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/brazen_outcome_iye~hk-gov-tenders/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-brazen_outcome_iye-hk-gov-tenders", "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/brazen_outcome_iye~hk-gov-tenders/runs": { "post": { "operationId": "runs-sync-brazen_outcome_iye-hk-gov-tenders", "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/brazen_outcome_iye~hk-gov-tenders/run-sync": { "post": { "operationId": "run-sync-brazen_outcome_iye-hk-gov-tenders", "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": { "sources": { "title": "Tender sources", "type": "array", "description": "Which official open-data feeds to read. GLD_ETB = Government Logistics Department e-Tender Box (covers many bureaux/departments), ARCHSD = Architectural Services Department works tenders, HKMA = Hong Kong Monetary Authority tender invitations and award notices.", "items": { "type": "string", "enum": [ "GLD_ETB", "ARCHSD", "HKMA" ], "enumTitles": [ "GLD e-Tender Box (multi-department)", "Architectural Services Department (works)", "Hong Kong Monetary Authority" ] }, "default": [ "GLD_ETB", "ARCHSD", "HKMA" ] }, "keywords": { "title": "Keywords", "type": "array", "description": "Return only tenders whose subject, reference or remarks contain at least one keyword (case-insensitive, English or Chinese), e.g. \"cleaning\", \"IT\", \"系統\". Leave empty for all.", "items": { "type": "string" } }, "departments": { "title": "Departments", "type": "array", "description": "Return only tenders where the issuing or requisitioning bureau/department name contains one of these strings, e.g. \"Hospital\", \"Fire Services\", \"衞生署\". Leave empty for all.", "items": { "type": "string" } }, "mode": { "title": "Mode", "enum": [ "all", "newOrChanged" ], "type": "string", "description": "\"all\" returns every matching tender. \"newOrChanged\" returns only tenders that are new or whose content (closing date, status, subject, addendum flag...) changed since the previous run with the same state store name. Ideal for scheduled daily alerts.", "default": "all" }, "onlyOpen": { "title": "Only open tenders", "type": "boolean", "description": "Skip tenders whose closing date has passed, and cancelled or suspended tenders. Turn off to also get ArchSD historical notices (back to 2020).", "default": true }, "dateField": { "title": "Date filter applies to", "enum": [ "closingDate", "issueDate" ], "type": "string", "description": "Which date the date range filters on. Note: ArchSD notices have no issue date; HKMA notices have no closing date.", "default": "closingDate" }, "dateFrom": { "title": "Date from", "type": "string", "description": "Earliest date (YYYY-MM-DD, Hong Kong time) or relative, e.g. \"7 days\"." }, "dateTo": { "title": "Date to", "type": "string", "description": "Latest date (YYYY-MM-DD, Hong Kong time)." }, "stateStoreName": { "title": "State store name", "type": "string", "description": "Name of the key-value store that remembers what you have already seen (used by \"newOrChanged\" mode). Use a different name for each saved task/filter set.", "default": "hk-gov-tenders-state" }, "maxItems": { "title": "Max results", "minimum": 0, "type": "integer", "description": "Maximum number of tenders to return. 0 = no limit.", "default": 0 }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Not needed for these government feeds. Provided only in case a feed starts blocking datacenter IPs.", "default": { "useApifyProxy": false } } } }, "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 }, "PROXY_UNBLOCKER_UNITS": { "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 }, "PROXY_UNBLOCKER_UNITS": { "type": "integer", "example": 0 } } } } } } } } } }