{ "openapi": "3.0.1", "info": { "title": "Contracts Finder UK Procurement Scraper", "description": "Find UK public procurement tenders and awards from Contracts Finder. Export buyers, values, CPV codes, deadlines, suppliers, and notice links.", "version": "0.1", "x-build-id": "q4oJVJPtsK8ogH4uF" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/automation-lab~contracts-finder-uk-procurement-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-automation-lab-contracts-finder-uk-procurement-scraper", "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/automation-lab~contracts-finder-uk-procurement-scraper/runs": { "post": { "operationId": "runs-sync-automation-lab-contracts-finder-uk-procurement-scraper", "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/automation-lab~contracts-finder-uk-procurement-scraper/run-sync": { "post": { "operationId": "run-sync-automation-lab-contracts-finder-uk-procurement-scraper", "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": { "keywords": { "title": "Keywords", "type": "array", "description": "Optional free-text terms. The public OCDS endpoint searches tender titles and descriptions. Leave empty to pull the newest notices in the date range.", "items": { "type": "string" } }, "publishedFrom": { "title": "Published from", "type": "string", "description": "Start date for notice publication in YYYY-MM-DD format. Defaults to the last 30 days when omitted." }, "publishedTo": { "title": "Published to", "type": "string", "description": "Optional end date for notice publication in YYYY-MM-DD format." }, "noticeTypes": { "title": "Notice types", "uniqueItems": true, "type": "array", "description": "Keep only selected OCDS release tags. Leave empty to include all returned notice types.", "items": { "type": "string", "enum": [ "planning", "tender", "award", "contract", "implementation" ], "enumTitles": [ "Planning", "Tender", "Award", "Contract", "Implementation" ] } }, "tenderStatuses": { "title": "Tender statuses", "uniqueItems": true, "type": "array", "description": "Keep only selected tender status values. Leave empty to include active, complete, cancelled, and other statuses.", "items": { "type": "string", "enum": [ "active", "complete", "cancelled", "planned", "unsuccessful" ], "enumTitles": [ "Active", "Complete", "Cancelled", "Planned", "Unsuccessful" ] } }, "cpvCodes": { "title": "CPV code prefixes", "type": "array", "description": "Optional Common Procurement Vocabulary code prefixes to keep after extraction, e.g. 72000000 for IT services or 45000000 for construction.", "items": { "type": "string" } }, "maxItems": { "title": "Maximum notices", "minimum": 1, "maximum": 10000, "type": "integer", "description": "Maximum number of procurement notices to save.", "default": 50 }, "pageSize": { "title": "API page size", "minimum": 1, "maximum": 100, "type": "integer", "description": "How many OCDS releases to request per page. Contracts Finder currently supports up to 100.", "default": 100 }, "includeRawOcds": { "title": "Include raw OCDS JSON", "type": "boolean", "description": "Attach the full source OCDS release to each dataset item for audits or custom transformations. This increases dataset size.", "default": 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 } } }, "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 } } } } } } } } } }