{
  "openapi": "3.0.1",
  "info": {
    "title": "UK Companies House: New Company Leads, Officers and Filings",
    "description": "Find new UK companies on the official Companies House register by SIC code, postcode and incorporation date. Registered address, accounts dates and optional officers and filings. No API key needed for company leads. $2 per 1,000.",
    "version": "0.1",
    "x-build-id": "E5MYuhB8D91Bo4WSR"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/dedicated_crest~uk-companies-house-leads/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-dedicated_crest-uk-companies-house-leads",
        "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/dedicated_crest~uk-companies-house-leads/runs": {
      "post": {
        "operationId": "runs-sync-dedicated_crest-uk-companies-house-leads",
        "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/dedicated_crest~uk-companies-house-leads/run-sync": {
      "post": {
        "operationId": "run-sync-dedicated_crest-uk-companies-house-leads",
        "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": {
          "sicCodes": {
            "title": "SIC codes or industry text",
            "type": "array",
            "description": "Keep companies whose Standard Industrial Classification matches. Use a code or prefix (62 or 62012) or a word from the official SIC text (software). A company matches if any of its up to four SIC codes match. Leave empty for all industries.",
            "items": {
              "type": "string"
            }
          },
          "incorporatedWithinDays": {
            "title": "Incorporated within days",
            "minimum": 1,
            "maximum": 36500,
            "type": "integer",
            "description": "Keep companies incorporated in the last N days of the snapshot. The free snapshot is compiled to the end of the previous month (for example the 1 Nov 2026 file goes through 31 Oct 2026), so this is measured from that date, not from today. Prefill 31 covers the latest full month in the snapshot."
          },
          "incorporatedAfter": {
            "title": "Incorporated on or after",
            "type": "string",
            "description": "Optional start date (YYYY-MM-DD). Combined with 'Incorporated within days' when both are set (the later date wins). The snapshot has no companies incorporated after its compilation date."
          },
          "incorporatedBefore": {
            "title": "Incorporated on or before",
            "type": "string",
            "description": "Optional end date (YYYY-MM-DD)."
          },
          "postcodes": {
            "title": "Postcodes or areas",
            "type": "array",
            "description": "Registered office postcodes. A full postcode (M1 1AE) matches exactly, an outward code (M1, EC1A) matches that district, and letters only (M, EC, SW) match the postcode area. Area 'M' does not match ME or ML.",
            "items": {
              "type": "string"
            }
          },
          "postTowns": {
            "title": "Post towns",
            "type": "array",
            "description": "Registered office post towns, for example London, Manchester, Edinburgh. Case-insensitive; a company matches if the town equals one of these.",
            "items": {
              "type": "string"
            }
          },
          "nameContains": {
            "title": "Company name contains",
            "type": "string",
            "description": "Optional text that must appear in the current registered name or a previous name, for example HOLDINGS or CONSULTING."
          },
          "companyNumbers": {
            "title": "Company numbers (lookup)",
            "type": "array",
            "description": "Look up specific Companies House numbers, for example 14021076 or SC123456. When this is the only filter and you also provide an API key, the Actor uses the live API instead of the monthly snapshot.",
            "items": {
              "type": "string"
            }
          },
          "companyStatus": {
            "title": "Company status",
            "enum": [
              "active",
              "active_or_strike_off",
              "any"
            ],
            "type": "string",
            "description": "The free snapshot lists live companies on the register, including some in liquidation or with a proposal to strike off. Default: Active only.",
            "default": "active"
          },
          "companyTypes": {
            "title": "Company type",
            "type": "array",
            "description": "Optional company types. Leave empty for all types.",
            "items": {
              "type": "string",
              "enum": [
                "private_limited",
                "llp",
                "plc",
                "cic",
                "nonprofit"
              ],
              "enumTitles": [
                "Private limited company",
                "Limited liability partnership (LLP)",
                "Public limited company (PLC)",
                "Community interest company (CIC)",
                "Nonprofit / charity / guarantee"
              ]
            }
          },
          "excludeDormant": {
            "title": "Exclude dormant companies",
            "type": "boolean",
            "description": "Skip companies whose accounts category is DORMANT or whose SIC code is 99999 (Dormant Company). Turn off to include shells and dormant companies.",
            "default": true
          },
          "companiesHouseApiKey": {
            "title": "Companies House API key (optional)",
            "type": "string",
            "description": "Optional. A free key from https://developer.company-information.service.gov.uk/, used only if you turn on officers or filing history, or for a live lookup of specific company numbers. Leave empty to use the free monthly snapshot, which needs no key. The key is stored as a secret and is not written to the dataset."
          },
          "includeOfficers": {
            "title": "Include officers (directors and secretaries)",
            "type": "boolean",
            "description": "Add appointed officers from the official Companies House API. Requires the API key above. Resigned officers are omitted unless you turn on the next option.",
            "default": false
          },
          "includeResignedOfficers": {
            "title": "Include resigned officers",
            "type": "boolean",
            "description": "When including officers, also keep people who have resigned. Default: active officers only.",
            "default": false
          },
          "includeFilings": {
            "title": "Include recent filing history",
            "type": "boolean",
            "description": "Add recent filing history (accounts, confirmation statements, incorporations) from the official API. Requires the API key above. Does not download PDFs.",
            "default": false
          },
          "maxFilings": {
            "title": "Max filings per company",
            "minimum": 1,
            "maximum": 100,
            "type": "integer",
            "description": "How many of the most recent filings to save for each company when filing history is turned on.",
            "default": 25
          },
          "maxItems": {
            "title": "Max companies to save",
            "minimum": 1,
            "maximum": 10000,
            "type": "integer",
            "description": "Stop after saving this many companies, keeping the most recently incorporated matches. You pay only for saved companies. Maximum 10,000.",
            "default": 50
          }
        }
      },
      "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}