# GOV.UK Search & Content Scraper (`moving_beacon-owner1/gov-uk-search-content-scraper`) Actor Scrape GOV.UK search results and page content via the official APIs. Search by keywords or URLs, filter by organisation, and extract metadata, publication dates, links, and full page text with automatic pagination. - **URL**: https://apify.com/moving\_beacon-owner1/gov-uk-search-content-scraper.md - **Developed by:** [Jamshaid Arif](https://apify.com/moving_beacon-owner1) (community) - **Categories:** Developer tools, Automation, Other - **Stats:** 2 total users, 1 monthly users, 100.0% runs succeeded, 0 bookmarks - **User rating**: No ratings yet ## Pricing from $9.99 / 1,000 results This Actor is paid per event. You are not charged for the Apify platform usage, but only a fixed price for specific events. Learn more: https://docs.apify.com/platform/actors/running/actors-in-store#pay-per-event ## What's an Apify Actor? Actors are web data automations that power AI and operations. They run on the Apify platform to scrape websites, process data, connect APIs, and automate workflows. In Batch mode, an Actor accepts a well-defined JSON input, performs an action which can take anything from a few seconds to a few hours, and optionally produces a well-defined JSON output, datasets with results, or files in key-value store. In Standby mode, an Actor provides a web server which can be used as a website, API, or an MCP server. Actors are written with capital "A". ## How to integrate an Actor? If asked about integration, you help developers integrate Actors into their projects. You adapt to their stack and deliver integrations that are safe, well-documented, and production-ready. The best way to integrate Actors is as follows. In JavaScript/TypeScript projects, use official [JavaScript/TypeScript client](https://docs.apify.com/api/client/js/docs.md): ```bash npm install apify-client ``` In Python projects, use official [Python client library](https://docs.apify.com/api/client/python/docs.md): ```bash pip install apify-client ``` In shell scripts, use [Apify CLI](https://docs.apify.com/cli/docs.md): ````bash # MacOS / Linux curl -fsSL https://apify.com/install-cli.sh | bash # Windows irm https://apify.com/install-cli.ps1 | iex ```bash In AI frameworks, you might use the [Apify MCP server](https://docs.apify.com/integrations/mcp.md). If your project is in a different language, use the [REST API](https://docs.apify.com/api/v2.md). For usage examples, see the [API](#api) section below. For more details, see Apify documentation as [Markdown index](https://docs.apify.com/llms.txt) and [Markdown full-text](https://docs.apify.com/llms-full.txt). # README ## GOV.UK Search & Content Scraper Apify actor for GOV.UK's ### Example input ```json { "queries": [ "insolvency rules", "https://www.gov.uk/government/organisations/companies-house", "/vat-rates" ], "maxResultsPerSearch": 100, "order": "newest", "organisation": "hm-revenue-customs", "fetchContentForResults": true, "maxBodyChars": 20000 } ```` - **Pagination** — up to 1000 results per search query, fetched in pages of 100 automatically. - **`order`** — `relevance` (default), `newest`, `oldest`. - **`organisation`** — restrict to one publisher by slug (`companies-house`, `home-office`, ...). - **`fetchContentForResults`** — enrich every search hit with its full Content API record (body text, dates, links, organisations); one extra request per hit, deduplicated. ### Output items **search\_result:** title, path/url, description, format, organisations, `public_timestamp`, popularity, `search_query`. **content:** title, description, `document_type`, `schema_name`, locale, `first_published_at`, `public_updated_at`, organisations, extracted `body_text` (handles plain bodies, multi-format bodies, and multi-part guides; truncated to `maxBodyChars`, 0 = unlimited), and a `links` map of related base paths (parent, children, taxons...). Search totals and per-query errors are saved under key `SUMMARY`. # Actor input Schema ## `queries` (type: `array`): Auto-routed: search keywords (`insolvency rules`) hit the Search API; gov.uk URLs or `/paths` (`/government/organisations/companies-house`) fetch structured content. ## `maxResultsPerSearch` (type: `integer`): Results to collect per keyword query (paginated automatically, up to 1000). ## `order` (type: `string`): How the Search API orders results. ## `organisation` (type: `string`): GOV.UK organisation slug, e.g. `companies-house`, `hm-revenue-customs`, `home-office`. Empty = all organisations. ## `fetchContentForResults` (type: `boolean`): After each search, also fetch the structured Content API record (full body text, links, dates) for every hit. One extra request per result. ## `maxBodyChars` (type: `integer`): Truncate extracted body text of content pages to this many characters. 0 = no limit. ## `proxyConfiguration` (type: `object`): GOV.UK's APIs are open; a proxy is essentially never needed. ## Actor input object example ```json { "queries": [ "insolvency" ], "maxResultsPerSearch": 20, "order": "relevance", "organisation": "", "fetchContentForResults": false, "maxBodyChars": 20000, "proxyConfiguration": { "useApifyProxy": false } } ``` # API You can run this Actor programmatically using our API. Below are code examples in JavaScript, Python, and CLI, as well as the OpenAPI specification and MCP server setup. ## JavaScript example ```javascript import { ApifyClient } from 'apify-client'; // Initialize the ApifyClient with your Apify API token // Replace the '' with your token const client = new ApifyClient({ token: '', }); // Prepare Actor input const input = { "queries": [ "insolvency" ] }; // Run the Actor and wait for it to finish const run = await client.actor("moving_beacon-owner1/gov-uk-search-content-scraper").call(input); // Fetch and print Actor results from the run's dataset (if any) console.log('Results from dataset'); console.log(`💾 Check your data here: https://console.apify.com/storage/datasets/${run.defaultDatasetId}`); const { items } = await client.dataset(run.defaultDatasetId).listItems(); items.forEach((item) => { console.dir(item); }); // 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/js/docs ``` ## Python example ```python from apify_client import ApifyClient # Initialize the ApifyClient with your Apify API token # Replace '' with your token. client = ApifyClient("") # Prepare the Actor input run_input = { "queries": ["insolvency"] } # Run the Actor and wait for it to finish run = client.actor("moving_beacon-owner1/gov-uk-search-content-scraper").call(run_input=run_input) # Fetch and print Actor results from the run's dataset (if there are any) print("💾 Check your data here: https://console.apify.com/storage/datasets/" + run["defaultDatasetId"]) for item in client.dataset(run["defaultDatasetId"]).iterate_items(): print(item) # 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/python/docs/quick-start ``` ## CLI example ```bash echo '{ "queries": [ "insolvency" ] }' | apify call moving_beacon-owner1/gov-uk-search-content-scraper --silent --output-dataset ``` ## MCP server setup ```json { "mcpServers": { "apify": { "command": "npx", "args": [ "mcp-remote", "https://mcp.apify.com/?tools=moving_beacon-owner1/gov-uk-search-content-scraper", "--header", "Authorization: Bearer " ] } } } ``` ## OpenAPI specification ```json { "openapi": "3.0.1", "info": { "title": "GOV.UK Search & Content Scraper", "description": "Scrape GOV.UK search results and page content via the official APIs. Search by keywords or URLs, filter by organisation, and extract metadata, publication dates, links, and full page text with automatic pagination.", "version": "0.0", "x-build-id": "hYme17IphKhbS1mdE" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/moving_beacon-owner1~gov-uk-search-content-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-moving_beacon-owner1-gov-uk-search-content-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/moving_beacon-owner1~gov-uk-search-content-scraper/runs": { "post": { "operationId": "runs-sync-moving_beacon-owner1-gov-uk-search-content-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/moving_beacon-owner1~gov-uk-search-content-scraper/run-sync": { "post": { "operationId": "run-sync-moving_beacon-owner1-gov-uk-search-content-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", "required": [ "queries" ], "properties": { "queries": { "title": "Queries (keywords, URLs, or paths)", "type": "array", "description": "Auto-routed: search keywords (`insolvency rules`) hit the Search API; gov.uk URLs or `/paths` (`/government/organisations/companies-house`) fetch structured content.", "default": [ "insolvency" ], "items": { "type": "string" } }, "maxResultsPerSearch": { "title": "Max results per search", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Results to collect per keyword query (paginated automatically, up to 1000).", "default": 20 }, "order": { "title": "Search sort order", "enum": [ "relevance", "newest", "oldest" ], "type": "string", "description": "How the Search API orders results.", "default": "relevance" }, "organisation": { "title": "Filter by organisation (optional)", "type": "string", "description": "GOV.UK organisation slug, e.g. `companies-house`, `hm-revenue-customs`, `home-office`. Empty = all organisations.", "default": "" }, "fetchContentForResults": { "title": "Fetch full content for each search result", "type": "boolean", "description": "After each search, also fetch the structured Content API record (full body text, links, dates) for every hit. One extra request per result.", "default": false }, "maxBodyChars": { "title": "Max body text characters", "minimum": 0, "type": "integer", "description": "Truncate extracted body text of content pages to this many characters. 0 = no limit.", "default": 20000 }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "GOV.UK's APIs are open; a proxy is essentially never needed.", "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 } } }, "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 } } } } } } } } } } ```