{ "openapi": "3.0.1", "info": { "title": "UK Tenders Scraper - Find a Tender & Contracts Finder", "description": "UK tenders scraper and API for Find a Tender and Contracts Finder: export public procurement notices (title, buyer, CPV, value, deadline, status, supplier) to JSON, CSV or Excel. Filter by keywords, CPV, buyer and dates. Track new tenders, changed deadlines and awards.", "version": "0.1", "x-build-id": "i5GhFOeaZpRfACiI6" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/compass_lab~uk-tenders-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-compass_lab-uk-tenders-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/compass_lab~uk-tenders-scraper/runs": { "post": { "operationId": "runs-sync-compass_lab-uk-tenders-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/compass_lab~uk-tenders-scraper/run-sync": { "post": { "operationId": "run-sync-compass_lab-uk-tenders-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": { "sources": { "title": "Sources", "type": "array", "description": "Find a Tender (above-threshold) and/or Contracts Finder (lower-value).", "items": { "type": "string", "enum": [ "Find a Tender", "Contracts Finder" ] }, "default": [ "Find a Tender", "Contracts Finder" ] }, "keywords": { "title": "Keywords", "type": "array", "description": "Keep notices whose title or description contains any of these words.", "items": { "type": "string" } }, "cpvCodes": { "title": "CPV codes", "type": "array", "description": "Keep notices with a CPV code starting with any of these, e.g. 72 (IT services) or 79410000.", "items": { "type": "string" } }, "buyer": { "title": "Buyer name", "type": "string", "description": "Words in the buyer's name, e.g. 'NHS' or 'council'." }, "minValue": { "title": "Minimum value", "minimum": 0, "type": "number", "description": "Keep notices whose value is at least this (GBP)." }, "publishedAfter": { "title": "Published or updated after", "pattern": "^\\d{4}-\\d{2}-\\d{2}$", "type": "string", "description": "YYYY-MM-DD. Default: the last 3 days." }, "deadlineAfter": { "title": "Deadline after", "pattern": "^\\d{4}-\\d{2}-\\d{2}$", "type": "string", "description": "YYYY-MM-DD: keep tenders still open to bids after this date." }, "onlyChanges": { "title": "Only changes since the last run", "type": "boolean", "description": "For scheduled runs: return (and pay for) only new and changed records, compared with the last run with the same input. The snapshot is kept in a named key-value store; delete it to start over.", "default": false }, "maxItems": { "title": "Max items", "minimum": 0, "type": "integer", "description": "Maximum number of items to return (0 = unlimited). You pay per result, so this also caps the cost.", "default": 50 }, "startUrls": { "title": "Start URLs", "type": "array", "description": "Optional: OCDS API URLs of either service (replace the default searches).", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "maxPages": { "title": "Max pages", "minimum": 1, "type": "integer", "description": "Maximum listing pages to follow per start URL (pagination).", "default": 5 }, "maxConcurrency": { "title": "Max concurrency", "minimum": 1, "maximum": 10, "type": "integer", "description": "Maximum parallel requests (politeness; 1-10).", "default": 2 }, "requestDelayMs": { "title": "Delay between requests (ms)", "minimum": 250, "type": "integer", "description": "Minimum delay between requests, in milliseconds (at least 250). Find a Tender allows about 12 requests per minute: keep at least 6000.", "default": 6000 }, "proxyType": { "title": "Proxy type", "enum": [ "datacenter", "residential", "none" ], "type": "string", "description": "none (direct connection), datacenter (Apify Proxy, cheapest) or residential (opt-in, billed per GB, fewer blocks). The actor never switches by itself.", "default": "none" }, "proxyCountry": { "title": "Proxy country", "type": "string", "description": "Two-letter country code for the proxy IP (optional)." }, "defaultCurrency": { "title": "Default currency", "pattern": "^[A-Z]{3}$", "type": "string", "description": "ISO 4217 code (e.g. USD) used when the page shows an ambiguous symbol such as $ or kr. Leave empty to detect it from the site." } } }, "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 } } } } } } } } } }