{
  "openapi": "3.0.1",
  "info": {
    "title": "Companies House Scraper | New UK Company Registrations Daily",
    "description": "Extract newly incorporated UK companies from the official Companies House API daily: name, number, incorporation date, SIC codes with descriptions, registered office, region, directors with roles, corporate owners. Filters by SIC, region, postcode, type. $2.00 per 1,000.",
    "version": "0.1",
    "x-build-id": "KT8HeLxBO7aiFNang"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/aurelix~companies-house-scraper/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-aurelix-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/aurelix~companies-house-scraper/runs": {
      "post": {
        "operationId": "runs-sync-aurelix-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/aurelix~companies-house-scraper/run-sync": {
      "post": {
        "operationId": "run-sync-aurelix-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": {
          "daysBack": {
            "title": "Incorporated in the last N days",
            "minimum": 0,
            "maximum": 30,
            "type": "integer",
            "description": "Companies incorporated today (UTC) and on the N days before. Example: 1 for a daily feed (today and yesterday), 7 for a weekly one. At most 30. About 2,000 to 4,000 UK companies are incorporated per working day.",
            "default": 1
          },
          "maxResults": {
            "title": "Max companies",
            "minimum": 1,
            "maximum": 20000,
            "type": "integer",
            "description": "Stop after this many companies, newest first. Example: 500. Each company with directors takes one Companies House request, about 2 per second on one API key.",
            "default": 200
          },
          "sicCodes": {
            "title": "SIC codes",
            "type": "array",
            "description": "Keep companies with at least one SIC code starting with one of these (2 to 5 digits). Example: ['62', '56101'] for IT services plus licensed restaurants. Empty = all.",
            "default": [],
            "items": {
              "type": "string"
            }
          },
          "industries": {
            "title": "Industries (SIC sections)",
            "type": "array",
            "description": "Keep companies with a SIC code in one of these sections. Example: ['construction', 'hospitality']. Empty = all.",
            "items": {
              "type": "string",
              "enum": [
                "agriculture",
                "mining",
                "manufacturing",
                "energy",
                "water-waste",
                "construction",
                "wholesale-retail",
                "transport",
                "hospitality",
                "information-communication",
                "finance-insurance",
                "real-estate",
                "professional-scientific",
                "administrative-support",
                "public-administration",
                "education",
                "health-social",
                "arts-recreation",
                "other-services",
                "households",
                "extraterritorial-dormant"
              ],
              "enumTitles": [
                "A: Agriculture, forestry and fishing",
                "B: Mining and quarrying",
                "C: Manufacturing",
                "D: Electricity, gas, steam and air conditioning supply",
                "E: Water supply, sewerage, waste management and remediation",
                "F: Construction",
                "G: Wholesale and retail trade; repair of motor vehicles",
                "H: Transportation and storage",
                "I: Accommodation and food service activities",
                "J: Information and communication",
                "K: Financial and insurance activities",
                "L: Real estate activities",
                "M: Professional, scientific and technical activities",
                "N: Administrative and support service activities",
                "O: Public administration and defence",
                "P: Education",
                "Q: Human health and social work activities",
                "R: Arts, entertainment and recreation",
                "S: Other service activities",
                "T: Activities of households as employers",
                "U: Extraterritorial organisations; dormant companies (99999)"
              ]
            },
            "default": []
          },
          "regions": {
            "title": "UK regions",
            "type": "array",
            "description": "Keep companies whose registered office postcode is in one of these regions (by postcode area). Example: ['london', 'north-west']. Empty = all.",
            "items": {
              "type": "string",
              "enum": [
                "london",
                "south-east",
                "east-of-england",
                "south-west",
                "west-midlands",
                "east-midlands",
                "yorkshire-and-the-humber",
                "north-west",
                "north-east",
                "wales",
                "scotland",
                "northern-ireland"
              ],
              "enumTitles": [
                "London",
                "South East",
                "East of England",
                "South West",
                "West Midlands",
                "East Midlands",
                "Yorkshire and the Humber",
                "North West",
                "North East",
                "Wales",
                "Scotland",
                "Northern Ireland"
              ]
            },
            "default": []
          },
          "postcodeAreas": {
            "title": "Postcode areas or districts",
            "type": "array",
            "description": "Keep companies whose registered office postcode starts with one of these: an area ('M' = Manchester, not ME), a district ('EC1', 'SW1A') or a full postcode. Example: ['M', 'EC1', 'LS1']. Empty = all.",
            "default": [],
            "items": {
              "type": "string"
            }
          },
          "companyTypes": {
            "title": "Company types",
            "type": "array",
            "description": "Keep only these company types. Example: ['ltd', 'llp']. Empty = all.",
            "items": {
              "type": "string",
              "enum": [
                "ltd",
                "plc",
                "llp",
                "private-limited-guarant-nsc",
                "private-limited-guarant-nsc-limited-exemption",
                "private-limited-shares-section-30-exemption",
                "private-unlimited",
                "private-unlimited-nsc",
                "limited-partnership",
                "scottish-partnership",
                "charitable-incorporated-organisation",
                "scottish-charitable-incorporated-organisation",
                "registered-society-non-jurisdictional",
                "uk-establishment",
                "registered-overseas-entity",
                "other"
              ],
              "enumTitles": [
                "Private limited company (Ltd)",
                "Public limited company (PLC)",
                "Limited liability partnership (LLP)",
                "Private company limited by guarantee",
                "Limited by guarantee, 'Limited' exemption",
                "Private limited by shares, 'Limited' exemption",
                "Private unlimited company",
                "Private unlimited without share capital",
                "Limited partnership",
                "Scottish partnership",
                "Charitable incorporated organisation (CIO)",
                "Scottish CIO",
                "Registered society",
                "UK establishment of an overseas company",
                "Registered overseas entity",
                "Any other type"
              ]
            },
            "default": []
          },
          "excludeDormant": {
            "title": "Exclude dormant companies",
            "type": "boolean",
            "description": "Drop companies registered with SIC 99999 (Dormant Company), which are not trading. Example: false to keep them.",
            "default": true
          },
          "includeOfficers": {
            "title": "Add directors and officers",
            "type": "boolean",
            "description": "Add each company's current directors, secretaries and LLP members as the register lists them: name, role, appointment date, occupation, birth month/year, nationality, residence and service address. One extra Companies House request per company. Example: false for company rows only, about twice as fast.",
            "default": true
          },
          "includeCorporatePsc": {
            "title": "Add owners (PSCs)",
            "type": "boolean",
            "description": "Add persons with significant control: companies and legal entities (name, registration number, nature of control) and individual owners as the register shows them (name, nature of control, birth month/year, nationality, address). One extra request per company. Example: true to see which new companies are subsidiaries.",
            "default": false
          },
          "findWebsite": {
            "title": "Find the company website",
            "type": "boolean",
            "description": "The register has no website field. Try the company name as a domain (.co.uk, .com, .uk, .io, .ai) and keep it only when the site shows the company number or registered postcode. Free; most brand-new companies have no site yet. Example: true.",
            "default": false
          },
          "enrichContacts": {
            "title": "Add website contacts",
            "type": "boolean",
            "description": "For each company with a confirmed website, read up to 5 pages (home, contact, about, team; robots.txt obeyed) and add business emails, phones, social links and named people with titles. Charged as a contact-result only when something is found. Example: true.",
            "default": false
          },
          "incremental": {
            "title": "Only new companies since last run",
            "type": "boolean",
            "description": "Return only companies not returned by a previous run with the same filters; repeats are skipped and not charged. Schedule daily with 'Incorporated in the last N days' = 1 or 2 for a new-companies feed.",
            "default": false
          },
          "apiKey": {
            "title": "Your Companies House API key (optional)",
            "type": "string",
            "description": "Leave empty to use our shared key. Paste your own free key (developer.company-information.service.gov.uk, about 2 minutes) for big or frequent runs: the 600-requests-per-5-minutes limit is per key. Example: 1a2b3c4d-..."
          },
          "slackWebhookUrl": {
            "title": "Slack webhook URL (optional)",
            "type": "string",
            "description": "Post a short digest (count + top 10) to this Slack incoming webhook after each run that found something. Example: https://hooks.slack.com/services/T000/B000/XXXX"
          },
          "webhookUrl": {
            "title": "Webhook URL (optional)",
            "type": "string",
            "description": "POST the same digest as JSON to this URL (Zapier, Make, n8n). Example: https://hooks.zapier.com/hooks/catch/123/abc"
          },
          "stateKey": {
            "title": "Incremental state name (optional)",
            "type": "string",
            "description": "Name for the 'new since last run' memory, e.g. 'london-tech-feed'. Leave empty to derive it from the filters."
          }
        }
      },
      "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}