{
  "openapi": "3.0.1",
  "info": {
    "title": "UK Companies House Scraper",
    "description": "Look up UK companies by company number or Companies House URL, or search the register by name, SIC code, status, address text and incorporation date. Returns company profiles, registered office, accounts dates, directors and PSC beneficial owners from the official API. No API key needed to start.",
    "version": "1.0",
    "x-build-id": "hMVgjP7dZHoiToQRn"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/zapticx~uk-companies-house-scraper/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-zapticx-uk-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/zapticx~uk-companies-house-scraper/runs": {
      "post": {
        "operationId": "runs-sync-zapticx-uk-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/zapticx~uk-companies-house-scraper/run-sync": {
      "post": {
        "operationId": "run-sync-zapticx-uk-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": {
          "companyNumbers": {
            "title": "Company numbers",
            "type": "array",
            "description": "Companies House company numbers to look up, for example 00445790. Short numbers are padded automatically (123456 becomes 00123456) and Scottish (SC), Northern Irish (NI) and LLP (OC) prefixes are supported. Leave empty to search the register instead.",
            "default": [],
            "items": {
              "type": "string"
            }
          },
          "companyUrls": {
            "title": "Companies House URLs",
            "type": "array",
            "description": "Paste Companies House company pages, for example https://find-and-update.company-information.service.gov.uk/company/00445790. Anything after the company number in the link is ignored, so you can paste the page you were already looking at.",
            "default": [],
            "items": {
              "type": "string"
            }
          },
          "searchQuery": {
            "title": "Company name contains",
            "type": "string",
            "description": "Search the Companies House register for companies whose registered name contains this text. Combine it with the filters below, or leave it empty and search on those alone."
          },
          "excludeNameContains": {
            "title": "Company name does NOT contain",
            "type": "string",
            "description": "Exclude companies whose registered name contains this text - useful for stripping out holdings, dormant or trustee entities from a prospect list."
          },
          "companyStatus": {
            "title": "Company status",
            "type": "array",
            "description": "Only return companies with these statuses. Leave empty to include every status. Choose Active for live trading companies, or Dissolved / In liquidation / In administration for research and due diligence.",
            "items": {
              "type": "string",
              "enum": [
                "active",
                "dissolved",
                "liquidation",
                "receivership",
                "administration",
                "voluntary-arrangement",
                "converted-closed",
                "insolvency-proceedings",
                "registered",
                "removed",
                "closed",
                "open"
              ],
              "enumTitles": [
                "Active",
                "Dissolved",
                "In liquidation",
                "Receiver action",
                "In administration",
                "Voluntary arrangement",
                "Converted / closed",
                "Insolvency proceedings",
                "Registered",
                "Removed",
                "Closed",
                "Open"
              ]
            },
            "default": []
          },
          "companyType": {
            "title": "Company type (legal form)",
            "type": "array",
            "description": "Only return these legal forms, for example private limited company (Ltd), public limited company (PLC) or limited liability partnership (LLP). Leave empty for all types.",
            "items": {
              "type": "string",
              "enum": [
                "ltd",
                "plc",
                "llp",
                "private-unlimited",
                "private-limited-guarant-nsc",
                "private-limited-guarant-nsc-limited-exemption",
                "limited-partnership",
                "scottish-partnership",
                "old-public-company",
                "oversea-company",
                "uk-establishment",
                "registered-overseas-entity",
                "charitable-incorporated-organisation",
                "scottish-charitable-incorporated-organisation",
                "industrial-and-provident-society",
                "registered-society-non-jurisdictional",
                "royal-charter",
                "northern-ireland",
                "northern-ireland-other",
                "european-public-limited-liability-company-se",
                "unregistered-company",
                "other"
              ],
              "enumTitles": [
                "Private limited company (Ltd)",
                "Public limited company (PLC)",
                "Limited liability partnership (LLP)",
                "Private unlimited company",
                "Private limited by guarantee (no share capital)",
                "Private limited by guarantee (no share capital, exempt)",
                "Limited partnership",
                "Scottish partnership",
                "Old public company",
                "Overseas company",
                "UK establishment",
                "Registered overseas entity",
                "Charitable incorporated organisation",
                "Scottish charitable incorporated organisation",
                "Industrial and provident society",
                "Registered society",
                "Royal charter",
                "Northern Ireland company",
                "Northern Ireland other",
                "European public limited company (SE)",
                "Unregistered company",
                "Other"
              ]
            },
            "default": []
          },
          "sicCodes": {
            "title": "SIC codes (industry)",
            "type": "array",
            "description": "Five-digit UK SIC 2007 industry codes, for example 62012 for business and domestic software development. Add several to cover a whole sector. Full list: https://resources.companieshouse.gov.uk/sic/",
            "default": [],
            "items": {
              "type": "string"
            }
          },
          "location": {
            "title": "Registered office address contains",
            "type": "string",
            "description": "Matches the TEXT of the registered office address - this is not a map or radius search. 'Manchester' also matches a company on Manchester Road in London, and a Manchester business whose registered office is at its accountant in London will not match. Registered office is not the same as trading address."
          },
          "incorporatedFrom": {
            "title": "Incorporated on or after",
            "type": "string",
            "description": "Earliest incorporation date, as YYYY-MM-DD. Use this to find newly registered companies."
          },
          "incorporatedTo": {
            "title": "Incorporated on or before",
            "type": "string",
            "description": "Latest incorporation date, as YYYY-MM-DD. Combine with the field above for a date range."
          },
          "maxResults": {
            "title": "Maximum companies",
            "minimum": 1,
            "maximum": 10000,
            "type": "integer",
            "description": "How many companies to return. Without your own Companies House API key this is capped at 25 per run. With your own free key you can collect up to 10,000, which is the maximum Companies House Advanced Search returns for one set of filters.",
            "default": 25
          },
          "fetchFullProfile": {
            "title": "Full company profile",
            "type": "boolean",
            "description": "Adds accounts and confirmation-statement dates, overdue flags, previous names and jurisdiction. Costs one extra Companies House request per company. Always on when you look companies up by number or URL. Turn it off for fast, wide discovery runs.",
            "default": true
          },
          "includeOfficers": {
            "title": "Directors and officers",
            "type": "boolean",
            "description": "Adds every current and former director, secretary and LLP member, with role, appointment and resignation dates, nationality, country of residence and month/year of birth. Use the Officers view in the Output tab for one row per person.",
            "default": true
          },
          "includePsc": {
            "title": "Beneficial owners (PSC)",
            "type": "boolean",
            "description": "Adds Persons with Significant Control - who really owns or controls the company - with their natures of control in plain English, plus any PSC statements the company has filed. Companies exempt from the PSC regime correctly return an empty list.",
            "default": true
          },
          "includeFilingHistory": {
            "title": "Filing history",
            "type": "boolean",
            "description": "Adds the 25 most recent filings with readable descriptions. Off by default because most runs do not need it and it adds a request per company.",
            "default": false
          },
          "includeCharges": {
            "title": "Charges (mortgages)",
            "type": "boolean",
            "description": "Adds registered charges and who they are secured to. Skipped automatically, at no cost, for companies Companies House already says have none.",
            "default": false
          },
          "includeInsolvency": {
            "title": "Insolvency history",
            "type": "boolean",
            "description": "Adds insolvency cases and appointed practitioners. Skipped automatically, at no cost, for companies Companies House already says have none.",
            "default": false
          },
          "companiesHouseApiKey": {
            "title": "Your Companies House API key (optional)",
            "type": "string",
            "description": "OPTIONAL - you do not need this for normal small runs. Leave it empty to use the built-in key, which is capped at 25 companies per run. To run larger jobs, create your own free REST key at https://developer.company-information.service.gov.uk/ (choose a LIVE application and leave 'Restricted IPs' blank) and paste it here. It is stored as an encrypted secret and never appears in your results or logs. Your own key gives you a private request quota; Companies House's own rate limits still apply."
          }
        }
      },
      "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}