{ "openapi": "3.0.1", "info": { "title": "GOV.UK Publications Search", "description": "Search every publication on GOV.UK (guidance, news, consultations, statistics) by words, organisation, type and date. One clean row per document, paid per row.", "version": "0.1", "x-build-id": "2NNtMyOxzWsSPDhKE" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/zeiphr~govuk-search/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-zeiphr-govuk-search", "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/zeiphr~govuk-search/runs": { "post": { "operationId": "runs-sync-zeiphr-govuk-search", "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/zeiphr~govuk-search/run-sync": { "post": { "operationId": "run-sync-zeiphr-govuk-search", "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": { "query": { "title": "Words to search for (optional)", "type": "string", "description": "Words or a phrase to look for, for example flood warning or energy bills. Leave empty to get everything that matches your other choices." }, "organisation": { "title": "Government organisation (optional)", "type": "string", "description": "Only return documents from one government body. Use its short web name: open the organisation's page on GOV.UK and copy the last part of the address. For example https://www.gov.uk/government/organisations/hm-revenue-customs gives hm-revenue-customs." }, "documentType": { "title": "Type of document (optional)", "type": "string", "description": "Only return one kind of document. Common choices: guidance, press_release, news_story, consultation, statistics, policy_paper, research, transparency. Leave empty for all types." }, "dateFrom": { "title": "From date (optional)", "type": "string", "description": "Earliest date to include, written YYYY-MM-DD (for example 2026-10-01). If you set this, 'Days to look back' is ignored." }, "dateTo": { "title": "To date (optional)", "type": "string", "description": "Latest date to include, written YYYY-MM-DD (for example 2026-10-31). Leave empty to mean today." }, "days": { "title": "Days to look back", "minimum": 1, "maximum": 36500, "type": "integer", "description": "How many days back from today to look, based on the date each document was last updated. Ignored if you fill in 'From date'. If you give no words, organisation or type, this must be 31 or less so the run stays a sensible size.", "default": 7 }, "sort": { "title": "Order of results", "enum": [ "newest", "relevance" ], "type": "string", "description": "newest puts the most recently updated documents first. relevance puts the best word matches first (only useful when you enter words to search for).", "default": "newest" }, "maxResults": { "title": "Maximum documents to return", "minimum": 1, "maximum": 10000, "type": "integer", "description": "The most documents you want back. You are charged per document returned, so this also caps your cost.", "default": 100 } } }, "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 } } } } } } } } } }