{ "openapi": "3.0.1", "info": { "title": "GOV.UK Content Search Scraper", "description": "Scrape GOV.UK: search the entire UK government publications catalogue (policies, guidance, news, statistics). Filter by query, organisation, format or date. Returns titles, descriptions, URLs, organisations and publication dates.", "version": "0.0", "x-build-id": "w9KCwM0UG14UQgM5g" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/parseforge~govuk-content-search-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-parseforge-govuk-content-search-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/parseforge~govuk-content-search-scraper/runs": { "post": { "operationId": "runs-sync-parseforge-govuk-content-search-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/parseforge~govuk-content-search-scraper/run-sync": { "post": { "operationId": "run-sync-parseforge-govuk-content-search-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": { "query": { "title": "Search Query", "type": "string", "description": "Free-text search across the full GOV.UK catalogue (titles, descriptions, body). Leave empty to browse all pages of the chosen format / organisation.", "default": "" }, "format": { "title": "Document Format", "enum": [ "", "employment_tribunal_decision", "hmrc_manual_section", "news_story", "press_release", "research_for_development_output", "guidance", "official_statistics", "transparency", "statistics_announcement", "national_statistics", "research", "residential_property_tribunal_decision", "world_news_story", "corporate_report", "policy_paper", "armed_forces_covenant_business", "speech", "decision", "foi_release", "aaib_report", "detailed_guide", "correspondence", "consultation_outcome", "document_collection", "notice", "person", "protected_food_drink_name", "form", "independent_report", "product_safety_alert_report_recall", "manual_section", "cma_case", "employment_appeal_tribunal_decision", "case_study", "written_statement", "export_health_certificate", "utaac_decision", "impact_assessment", "international_treaty", "european_structural_investment_fund", "medical_safety_alert", "tax_tribunal_decision", "world_location_news_article", "statutory_guidance", "organisation", "statistical_data_set", "about", "closed_consultation", "maib_report", "ministerial_role", "oral_statement", "promotional", "policy_group", "drug_safety_update", "guide", "regulation", "answer", "government_response", "raib_report", "authored_article", "fatality_notice", "service_standard_report", "recommended-link", "call_for_evidence_outcome", "licence_transaction", "map", "worldwide_organisation", "flood_and_coastal_erosion_risk_management_research_report", "statutory_instrument", "animal_disease_case", "complaints_procedure", "recruitment", "hmrc_manual", "transaction", "world_location_news", "travel_advice", "taxon", "closed_call_for_evidence", "service_manual_guide", "manual", "traffic_commissioner_regulatory_decision", "mainstream_browse_page", "countryside_stewardship_grant", "topical_event", "our_governance", "personal_information_charter", "international_development_fund", "farming_grant", "algorithmic_transparency_record", "drcf_digital_markets_research", "veterans_support_organisation", "design_decision", "hmrc_contact", "local_transaction", "accessible_documents_policy", "marine_equipment_approved_recommendation", "publication_scheme", "asylum_support_decision", "business_finance_support_scheme", "ai_assurance_portfolio_technique", "media_enquiries", "procurement", "open_consultation", "equality_and_diversity", "standard", "finder", "social_media_use", "membership", "terms_of_reference", "step_by_step_nav", "life_saving_maritime_appliance_service_station", "simple_smart_answer", "statistics", "about_our_services", "data_ethics_guidance_document", "smart_answer", "sfo_case", "welsh_language_scheme", "modern_slavery_statement", "place", "access_and_opening", "our_energy_use", "open_call_for_evidence", "ukhsa_data_access_approval", "staff_update", "help_page", "inside-government-link", "service_manual_topic", "history", "operational_field", "world_location_news_page", "special_route", "calendar", "digital_markets_measure", "edition", "coronavirus_landing_page", "service_manual_service_toolkit", "travel_advice_index" ], "type": "string", "description": "Restrict to a single GOV.UK document format. The full GOV.UK list is available; pick one or leave empty for all formats.", "default": "" }, "organisation": { "title": "Organisation Slug", "enum": [ "", "cabinet-office", "hm-revenue-customs", "hm-treasury", "home-office", "ministry-of-defence", "ministry-of-justice", "department-for-transport", "department-for-education", "department-for-business-and-trade", "department-for-energy-security-and-net-zero", "department-for-environment-food-rural-affairs", "department-for-science-innovation-and-technology", "department-of-health-and-social-care", "department-for-work-pensions", "department-for-culture-media-and-sport", "department-for-levelling-up-housing-and-communities", "foreign-commonwealth-development-office", "attorney-generals-office", "office-of-the-secretary-of-state-for-scotland", "office-of-the-secretary-of-state-for-wales", "northern-ireland-office", "the-office-of-the-leader-of-the-house-of-commons", "the-office-of-the-leader-of-the-house-of-lords", "uk-export-finance", "office-for-national-statistics", "ofgem", "ofcom", "ofqual", "ofsted", "office-of-rail-and-road", "competition-and-markets-authority", "national-crime-agency", "environment-agency", "natural-england", "uk-health-security-agency", "medicines-and-healthcare-products-regulatory-agency", "nhs-business-services-authority", "uk-statistics-authority", "driver-and-vehicle-licensing-agency", "driver-and-vehicle-standards-agency", "highways-england", "national-highways", "hm-courts-and-tribunals-service", "hm-prison-and-probation-service", "land-registry", "companies-house", "charity-commission", "intellectual-property-office", "uk-space-agency", "civil-aviation-authority", "maritime-and-coastguard-agency", "rural-payments-agency", "valuation-office-agency", "the-pensions-regulator", "financial-conduct-authority", "bank-of-england", "office-for-budget-responsibility", "government-actuarys-department", "crown-prosecution-service", "serious-fraud-office", "uk-debt-management-office", "national-audit-office", "government-equalities-office", "geospatial-commission", "ofs", "uk-research-and-innovation", "innovate-uk", "british-business-bank" ], "type": "string", "description": "Restrict to a single UK government organisation by slug. Pick from the list (covers ministerial departments, non-ministerial departments, agencies and other public bodies). Leave empty for all organisations.", "default": "" }, "topicalEvent": { "title": "Topical Event Slug", "type": "string", "description": "Restrict to a single GOV.UK topical event by slug (e.g. 'spring-budget-2024'). Find slugs at gov.uk/government/topical-events. Leave empty to skip.", "default": "" }, "worldLocation": { "title": "World Location Slug", "type": "string", "description": "Restrict to a single foreign country / world location by slug (e.g. 'france', 'ukraine'). Find slugs at gov.uk/world. Leave empty to skip.", "default": "" }, "person": { "title": "Person Slug", "type": "string", "description": "Restrict to pages tagged with a specific person (e.g. minister) by slug (e.g. 'rishi-sunak'). Leave empty to skip.", "default": "" }, "taxon": { "title": "Taxon (Topic) Slug", "type": "string", "description": "Restrict to a single GOV.UK taxonomy topic by slug (e.g. 'business-and-industry'). Leave empty to skip.", "default": "" }, "partOfTaxonomyTree": { "title": "Part of Taxonomy Tree", "type": "string", "description": "Restrict to all descendants of a taxonomy node by content_id. Leave empty to skip.", "default": "" }, "manual": { "title": "Manual Slug", "type": "string", "description": "Restrict to sections of a single GOV.UK manual by slug (e.g. 'hmrc-internal-manuals/vat-supply-and-consideration'). Leave empty to skip.", "default": "" }, "publishedAfter": { "title": "Published After", "type": "string", "description": "Earliest publication date (inclusive). Format: YYYY-MM-DD." }, "publishedBefore": { "title": "Published Before", "type": "string", "description": "Latest publication date (inclusive). Format: YYYY-MM-DD." }, "orderBy": { "title": "Order By", "enum": [ "", "-public_timestamp", "public_timestamp", "title", "-popularity" ], "type": "string", "description": "Sort order. Default is GOV.UK relevance.", "default": "" }, "maxItems": { "title": "Max Items", "minimum": 1, "maximum": 1000000, "type": "integer", "description": "Free users: Limited to 10 items (preview). Paid users: Optional, max 1,000,000" } } }, "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 } } } } } } } } } }