{
  "openapi": "3.0.1",
  "info": {
    "title": "UK Companies House Scraper – New Companies by SIC & Profiles",
    "description": "UK Companies House scraper, no API key: daily lead feed of newly incorporated companies by SIC code, date, location, status and type, with 'only new since last run' mode. Plus company name search, profiles (accounts due, overdue flags) and filing history with PDF links.",
    "version": "1.0",
    "x-build-id": "iubMm5vDLYGT69gEx"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/openharvest~uk-companies-house/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-openharvest-uk-companies-house",
        "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/openharvest~uk-companies-house/runs": {
      "post": {
        "operationId": "runs-sync-openharvest-uk-companies-house",
        "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/openharvest~uk-companies-house/run-sync": {
      "post": {
        "operationId": "run-sync-openharvest-uk-companies-house",
        "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": {
          "mode": {
            "title": "Mode",
            "enum": [
              "newCompanies",
              "search",
              "lookup"
            ],
            "type": "string",
            "description": "<b>newCompanies</b>: lead feed of companies incorporated in a date range, filtered by SIC code, location, status and type (Companies House Advanced Search). <b>search</b>: find companies by name. <b>lookup</b>: full profiles for a list of company numbers.",
            "default": "newCompanies"
          },
          "sicCodes": {
            "title": "SIC codes (industry)",
            "type": "array",
            "description": "Mode newCompanies. UK SIC 2007 codes, one per line. Use a 5-digit code (<code>62012</code> = software development, <code>56101</code> = licensed restaurants, <code>68100</code> = buying and selling own real estate) or a prefix to include a whole group (<code>6201</code>, <code>62</code>). Leave empty for all industries.",
            "items": {
              "type": "string"
            }
          },
          "incorporatedFrom": {
            "title": "Incorporated from",
            "type": "string",
            "description": "Mode newCompanies. Earliest incorporation date: an absolute date (<code>2026-09-01</code>) or a relative period (<code>7 days</code>, <code>2 weeks</code>, <code>3 months</code>). Empty = last 7 days. For all years enter <code>1850-01-01</code>."
          },
          "incorporatedTo": {
            "title": "Incorporated to",
            "type": "string",
            "description": "Mode newCompanies. Latest incorporation date (absolute or relative). Empty = today."
          },
          "location": {
            "title": "Registered office location",
            "type": "string",
            "description": "Mode newCompanies. Full or partial registered office address: a town (<code>Manchester</code>), a postcode or postcode district (<code>M1</code>, <code>EC2A</code>) or a street. Empty = whole UK."
          },
          "companyStatus": {
            "title": "Company status",
            "type": "array",
            "description": "Mode newCompanies. Only companies with these statuses. Empty = any status.",
            "items": {
              "type": "string",
              "enum": [
                "active",
                "dissolved",
                "liquidation",
                "administration",
                "receivership",
                "voluntary-arrangement",
                "insolvency-proceedings",
                "open",
                "closed",
                "converted-closed",
                "removed"
              ],
              "enumTitles": [
                "Active",
                "Dissolved",
                "Liquidation",
                "Administration",
                "Receivership",
                "Voluntary arrangement",
                "Insolvency proceedings",
                "Open (overseas entities)",
                "Closed",
                "Converted / closed",
                "Removed"
              ]
            },
            "default": [
              "active"
            ]
          },
          "companyTypes": {
            "title": "Company types",
            "type": "array",
            "description": "Mode newCompanies. Only these company types. Empty = all types.",
            "items": {
              "type": "string",
              "enum": [
                "ltd",
                "plc",
                "llp",
                "limited-partnership",
                "private-limited-guarant-nsc",
                "private-limited-guarant-nsc-limited-exemption",
                "private-unlimited",
                "community-interest-company",
                "charitable-incorporated-organisation",
                "scottish-partnership",
                "registered-overseas-entity",
                "uk-establishment",
                "oversea-company"
              ],
              "enumTitles": [
                "Private limited company (Ltd)",
                "Public limited company (PLC)",
                "Limited liability partnership (LLP)",
                "Limited partnership",
                "Private limited by guarantee",
                "Private limited by guarantee (exempt from 'Limited')",
                "Private unlimited company",
                "Community interest company (CIC)",
                "Charitable incorporated organisation",
                "Scottish partnership",
                "Registered overseas entity",
                "UK establishment of an overseas company",
                "Overseas company"
              ]
            }
          },
          "nameContains": {
            "title": "Company name contains",
            "type": "string",
            "description": "Mode newCompanies. Only companies whose name contains this word (e.g. <code>bakery</code>)."
          },
          "nameExcludes": {
            "title": "Company name excludes",
            "type": "string",
            "description": "Mode newCompanies. Skip companies whose name contains this word (e.g. <code>holdings</code>)."
          },
          "onlyNewSinceLastRun": {
            "title": "Only companies not delivered in earlier runs",
            "type": "boolean",
            "description": "Mode newCompanies. Remembers which companies this feed already returned (in the key-value store 'uk-companies-house-state' of your account) and returns only new ones. Use it with a daily schedule so you never pay twice for the same company.",
            "default": false
          },
          "stateKey": {
            "title": "Feed name (for 'only new')",
            "type": "string",
            "description": "Optional name of the remembered feed, e.g. <code>london-restaurants</code>. Empty = derived from the filters, so changing filters starts a fresh feed."
          },
          "searchQueries": {
            "title": "Search queries (company names)",
            "type": "array",
            "description": "Mode search. Company names or words to search for, one per line (same as the Companies House search box). Results are ranked by Companies House relevance.",
            "items": {
              "type": "string"
            }
          },
          "companyNumbers": {
            "title": "Company numbers",
            "type": "array",
            "description": "Mode lookup. Companies House numbers or company page URLs, one per line: <code>00445790</code>, <code>SC123456</code>, <code>OC301234</code>. Short numbers are zero-padded (<code>445790</code> becomes <code>00445790</code>).",
            "items": {
              "type": "string"
            }
          },
          "includeProfile": {
            "title": "Include full profile",
            "type": "boolean",
            "description": "Modes newCompanies and search. Also open each company page to add accounts and confirmation statement dates (next due, last made up to, overdue flags), SIC codes (search mode), status details and previous names. One extra request per company, same price. Always on in lookup mode.",
            "default": false
          },
          "includeOfficerCounts": {
            "title": "Include officer counts",
            "type": "boolean",
            "description": "Add the number of active and resigned officers (counts only, no names or personal data). One extra request per company, same price.",
            "default": false
          },
          "includeFilings": {
            "title": "Include filing history",
            "type": "boolean",
            "description": "Add the company's filing history as separate items (date, form type, category, description, PDF document link). Charged per filing row.",
            "default": false
          },
          "maxFilingsPerCompany": {
            "title": "Max filings per company",
            "minimum": 0,
            "type": "integer",
            "description": "Newest first. 0 = all filings.",
            "default": 25
          },
          "filingCategories": {
            "title": "Filing categories",
            "type": "array",
            "description": "Only filings of these categories. Empty = all.",
            "items": {
              "type": "string",
              "enum": [
                "accounts",
                "confirmation-statement",
                "officers",
                "persons-with-significant-control",
                "capital",
                "mortgage",
                "incorporation",
                "address",
                "resolution",
                "change-of-name",
                "dissolution",
                "insolvency",
                "other"
              ],
              "enumTitles": [
                "Accounts",
                "Confirmation statement / annual return",
                "Officers",
                "Persons with significant control",
                "Capital / shares",
                "Mortgages and charges",
                "Incorporation",
                "Registered office address",
                "Resolutions",
                "Change of name",
                "Dissolution / gazette",
                "Insolvency",
                "Other"
              ]
            }
          },
          "maxItems": {
            "title": "Max companies",
            "minimum": 0,
            "type": "integer",
            "description": "Maximum number of companies saved in this run (filings not counted). 0 = no limit. You pay per company, so this also caps your cost.",
            "default": 100
          },
          "proxyConfiguration": {
            "title": "Proxy configuration",
            "type": "object",
            "description": "Optional. Not needed: Companies House is a public service that works without a proxy."
          }
        }
      },
      "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}