{ "openapi": "3.0.1", "info": { "title": "UK Tenders Scraper: Find a Tender & Contracts Finder API", "description": "Scrape UK government tenders and public sector contracts from Find a Tender and Contracts Finder. Filter by keyword, CPV code, region and value; contract awards with winning suppliers and Companies House numbers; daily new-tender alerts.", "version": "0.1", "x-build-id": "kGpP6P9bWGF58xtnm" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/datatoolsuk~uk-government-tenders-feed/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-datatoolsuk-uk-government-tenders-feed", "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/datatoolsuk~uk-government-tenders-feed/runs": { "post": { "operationId": "runs-sync-datatoolsuk-uk-government-tenders-feed", "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/datatoolsuk~uk-government-tenders-feed/run-sync": { "post": { "operationId": "run-sync-datatoolsuk-uk-government-tenders-feed", "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": "Return notices whose title, description or buyer contains ANY of these words (case-insensitive). Leave empty for everything.", "items": { "type": "string" } }, "cpvCodes": { "title": "CPV codes", "type": "array", "description": "CPV codes or prefixes, e.g. 72000000 (IT services) matches every 72xxxxxx code; 45 matches all construction work.", "items": { "type": "string" } }, "regions": { "title": "Regions", "type": "array", "description": "UK regions by name (London, South East, Scotland, Wales, North West...) or ITL/NUTS code (UKI, UKJ, UKM...). Matches buyer or delivery region.", "items": { "type": "string" } }, "valueMin": { "title": "Minimum value (£)", "minimum": 0, "type": "integer", "description": "Skip notices below this estimated or awarded value. Notices with no value are skipped when set." }, "valueMax": { "title": "Maximum value (£)", "minimum": 0, "type": "integer", "description": "Skip notices above this value." }, "noticeTypes": { "title": "Notice types", "type": "array", "description": "Which stages to return.", "items": { "type": "string", "enum": [ "tender", "award", "planning" ], "enumTitles": [ "Open tenders / opportunities", "Contract awards", "Planning / pipeline / pre-market" ] }, "default": [ "tender" ] }, "publishedSince": { "title": "Published since", "type": "string", "description": "Only notices published or updated on/after this date (YYYY-MM-DD). Overrides 'Days back'." }, "daysBack": { "title": "Days back", "minimum": 1, "maximum": 365, "type": "integer", "description": "Look back this many days when 'Published since' is empty.", "default": 7 }, "onlyNew": { "title": "Only new since last run (alerts mode)", "type": "boolean", "description": "Remembers notice IDs already returned for the same filters (in the named key-value store 'uk-tenders-feed-state') and outputs only new ones. Schedule it daily for tender alerts.", "default": false }, "stateKey": { "title": "Alert name (optional)", "type": "string", "description": "Name for the 'only new' memory. Defaults to a hash of your filters, so different searches never mix." }, "sources": { "title": "Sources", "type": "array", "description": "Find a Tender is the main UK service; Contracts Finder adds older and below-threshold notices.", "items": { "type": "string", "enum": [ "findATender", "contractsFinder" ], "enumTitles": [ "Find a Tender (all new UK notices since Feb 2025)", "Contracts Finder (older / below-threshold England)" ] }, "default": [ "findATender", "contractsFinder" ] }, "maxResults": { "title": "Max results", "minimum": 1, "type": "integer", "description": "Stop after this many records.", "default": 100 }, "maxPagesPerQuery": { "title": "Max pages per source and stage", "minimum": 1, "type": "integer", "description": "Safety cap: 100 notices per page are scanned before filtering.", "default": 30 }, "companiesHouseApiKey": { "title": "Companies House API key (optional)", "type": "string", "description": "Free key from developer.company-information.service.gov.uk. When given, buyers and winning suppliers are matched to a company number. Without it, only company numbers printed in the notice are used." }, "maxRetries": { "title": "Max retries per request", "minimum": 0, "maximum": 10, "type": "integer", "description": "Retries with backoff on rate limits and server errors.", "default": 6 } } }, "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 } } } } } } } } } }