{
  "openapi": "3.0.1",
  "info": {
    "title": "Companies House Scraper & API - UK Company Data, New Companies",
    "description": "Companies House scraper and API for UK company data: search by name, SIC code, town or postcode, status, type or incorporation date (new companies daily), past the 5,000 cap. One result = one company: number, name, status, address, postcode, SIC codes. No API key. $0.25 per 1,000, no start fee.",
    "version": "1.0",
    "x-build-id": "45vPW1GkGdx7dSIR9"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/rel8ble~companies-house-scraper/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-rel8ble-companies-house-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/rel8ble~companies-house-scraper/runs": {
      "post": {
        "operationId": "runs-sync-rel8ble-companies-house-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/rel8ble~companies-house-scraper/run-sync": {
      "post": {
        "operationId": "run-sync-rel8ble-companies-house-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": {
          "companyNames": {
            "title": "Company name contains",
            "type": "array",
            "description": "Optional. Words the company name must contain, one search per line, e.g. \"bakery\", \"consulting\", \"property\", \"Tesco\". Matches anywhere in the registered name (Companies House \"Company names that contain\"). Combine with any filter below. Leave empty to search by SIC code, location or incorporation date alone (e.g. all companies incorporated yesterday). Typical: 1-10 lines.",
            "items": {
              "type": "string"
            }
          },
          "excludeNameWords": {
            "title": "Exclude names containing",
            "type": "string",
            "description": "Optional. Leave out companies whose name contains this text, e.g. \"holdings\" or \"dormant\". One value, applied to every search."
          },
          "sicCodes": {
            "title": "SIC codes (nature of business)",
            "type": "array",
            "description": "Optional. UK SIC 2007 codes, 5 digits, one per line, e.g. \"10710\" (bakeries), \"62012\" (software development), \"41100\" (property development), \"56101\" (restaurants), \"68209\" (letting property). Each code is a separate search (Companies House filters one code at a time); results are merged without duplicates. Look codes up at resources.companieshouse.gov.uk/sic.",
            "items": {
              "type": "string"
            }
          },
          "locations": {
            "title": "Registered office address contains",
            "type": "array",
            "description": "Optional. Town, city, street or postcode the registered office address must contain, one search per line: \"Manchester\", \"Leeds\", \"SW1A\", \"EC2A 4NE\", \"BT1\". A postcode district (\"M1\", \"SW1A\") matches addresses that contain it. Every name x SIC code x location combination is one search. Note: this is the registered office, which is often an accountant's address rather than where the business trades.",
            "items": {
              "type": "string"
            }
          },
          "status": {
            "title": "Company status",
            "type": "array",
            "description": "Optional. Keep only companies with these statuses. Default [\"active\"]. Several values = any of them. Empty = every status, including dissolved companies. Use [\"liquidation\", \"administration\"] for insolvency leads, [\"dissolved\"] for closed companies.",
            "items": {
              "type": "string",
              "enum": [
                "active",
                "dissolved",
                "open",
                "closed",
                "converted-closed",
                "removed",
                "receivership",
                "liquidation",
                "administration",
                "insolvency-proceedings",
                "voluntary-arrangement"
              ],
              "enumTitles": [
                "Active",
                "Dissolved",
                "Open",
                "Closed",
                "Converted closed",
                "Removed",
                "Receivership",
                "Liquidation",
                "Administration",
                "Insolvency proceedings",
                "Voluntary arrangement"
              ]
            },
            "default": [
              "active"
            ]
          },
          "companyTypes": {
            "title": "Company types",
            "type": "array",
            "description": "Optional. Keep only these company types, e.g. [\"ltd\"] (private limited companies), [\"llp\"], [\"plc\"]. Several values = any of them. Empty = all types.",
            "items": {
              "type": "string",
              "enum": [
                "ltd",
                "plc",
                "llp",
                "limited-partnership",
                "private-limited-guarant-nsc",
                "private-limited-guarant-nsc-limited-exemption",
                "private-limited-shares-section-30-exemption",
                "private-unlimited",
                "private-unlimited-nsc",
                "old-public-company",
                "oversea-company",
                "registered-overseas-entity",
                "uk-establishment",
                "charitable-incorporated-organisation",
                "scottish-charitable-incorporated-organisation",
                "scottish-partnership",
                "registered-society-non-jurisdictional",
                "industrial-and-provident-society",
                "royal-charter",
                "protected-cell-company",
                "assurance-company",
                "icvc",
                "eeig",
                "european-public-limited-liability-company-se",
                "further-education-or-sixth-form-college-corporation",
                "unregistered-company",
                "converted-or-closed"
              ],
              "enumTitles": [
                "Private limited company",
                "Public limited company",
                "Limited liability partnership",
                "Limited partnership",
                "Private limited by guarantee without share capital",
                "Private limited company by guarantee without share capital, use of 'Limited' exemption",
                "Private limited company, use of 'Limited' exemption",
                "Private unlimited company",
                "Private unlimited company without share capital",
                "Old public company",
                "Overseas company",
                "Overseas entity",
                "UK establishment company",
                "Charitable incorporated organisation",
                "Scottish charitable incorporated organisation",
                "Scottish qualifying partnership",
                "Registered society",
                "Industrial and provident society",
                "Royal charter company",
                "Protected cell company",
                "Assurance company",
                "Investment company with variable capital",
                "European Economic Interest Grouping (EEIG)",
                "European public limited liability company (SE)",
                "Further education or sixth form college corporation",
                "Unregistered company",
                "Converted or closed"
              ]
            }
          },
          "companySubtypes": {
            "title": "Company subtypes",
            "type": "array",
            "description": "Optional. Keep only community interest companies (CIC) or private fund limited partnerships. Empty = no subtype filter.",
            "items": {
              "type": "string",
              "enum": [
                "community-interest-company",
                "private-fund-limited-partnership"
              ],
              "enumTitles": [
                "Community interest company (CIC)",
                "Private fund limited partnership"
              ]
            }
          },
          "incorporatedInLastDays": {
            "title": "Incorporated in the last N days",
            "minimum": 0,
            "maximum": 3650,
            "type": "integer",
            "description": "Optional. Newly incorporated companies: only companies incorporated from N days ago up to today, e.g. 7 for the last week. Best for daily or weekly scheduled lead runs. The UK registers about 2,500-3,000 new companies a working day. 0 or empty = use incorporatedFrom / incorporatedTo instead. Overrides those two when set."
          },
          "incorporatedFrom": {
            "title": "Incorporated from",
            "type": "string",
            "description": "Optional. Only companies incorporated on or after this date, \"YYYY-MM-DD\", e.g. \"2026-10-01\". Ignored when incorporatedInLastDays is set."
          },
          "incorporatedTo": {
            "title": "Incorporated to",
            "type": "string",
            "description": "Optional. Only companies incorporated on or before this date, \"YYYY-MM-DD\", e.g. \"2026-10-31\". Ignored when incorporatedInLastDays is set."
          },
          "companyNumbers": {
            "title": "Company numbers",
            "type": "array",
            "description": "Optional. Companies House company numbers to look up directly, one per line: \"00445790\", \"SC548639\", \"OC300001\" (leading zeros can be left out: \"445790\"). Each returns the full company profile (address, status, type, dates, SIC codes, accounts and confirmation statement due dates, previous names). Not limited by maxResults. Numbers not on the register are reported and not charged.",
            "items": {
              "type": "string"
            }
          },
          "startUrls": {
            "title": "Companies House URLs",
            "type": "array",
            "description": "Optional. URLs copied from find-and-update.company-information.service.gov.uk, one per line: a company page (\"https://find-and-update.company-information.service.gov.uk/company/00445790\") is looked up like a company number; an advanced search results URL (\".../advanced-search/get-results?companyNameIncludes=bakery&status=active\") is scraped with the filters in the URL (the filter fields above are not applied to it); a company search URL (\".../search/companies?q=bakery\") becomes a \"name contains\" search on all statuses.",
            "items": {
              "type": "string"
            }
          },
          "maxResults": {
            "title": "Max companies",
            "minimum": 0,
            "type": "integer",
            "description": "Optional. Maximum companies saved by the whole run across all searches, integer >= 0. Default 100; 0 = every company the searches match. You pay per company saved ($0.00025 each), so 1,000 companies = $0.25. Companies found by several searches are saved once.",
            "default": 100
          },
          "includeDetails": {
            "title": "Include company profile details",
            "type": "boolean",
            "description": "Optional. true = also open each company's Companies House page and add: full registered office address (with commas), status detail (e.g. \"Active proposal to strike off\"), SIC descriptions as filed, previous company names, next / last accounts dates and due dates, confirmation statement dates, overdue flags and overseas registration details. One extra request per company (about 4 companies a second), no extra charge. Default false = search data only (fast: up to 5,000 companies per request).",
            "default": false
          },
          "deepSearch": {
            "title": "Deep search past the 5,000 limit",
            "type": "boolean",
            "description": "Optional. Companies House exports at most 5,000 companies per search. With deepSearch on (default) and more wanted, the actor splits a bigger search into incorporation-date slices (and, for one very busy day, company types) and merges them without duplicates. Off = at most 5,000 per search.",
            "default": true
          },
          "maxConcurrency": {
            "title": "Max concurrency",
            "minimum": 1,
            "maximum": 10,
            "type": "integer",
            "description": "Optional, advanced. Number of parallel requests, integer 1-10. Default 3. Requests are also spaced at most 4 a second whatever this is set to, to stay polite to a public service. Leave unset.",
            "default": 3
          },
          "maxRequestRetries": {
            "title": "Max retries per request",
            "minimum": 0,
            "maximum": 20,
            "type": "integer",
            "description": "Optional, advanced. How many times a failed request is retried on a new session, integer 0-20. Default 8. Leave unset.",
            "default": 8
          },
          "proxyConfiguration": {
            "title": "Proxy configuration",
            "type": "object",
            "description": "Optional, advanced. Apify Proxy settings object. Default {\"useApifyProxy\": false}: Companies House answers direct requests, so no proxy is needed. Switch on datacenter proxy only if the run log shows repeated blocks. Leave unset.",
            "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
                  },
                  "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}