{
  "openapi": "3.0.1",
  "info": {
    "title": "UK Companies House Data & New Company Leads · SiteVerdict",
    "description": "New UK company leads and company data from the official Companies House API, using your own free key. Filter new incorporations by date, SIC, type and postcode; look up companies; monitor filings, status, charges and insolvency. Without a key it returns fictional sample data only.",
    "version": "1.0",
    "x-build-id": "v52RL6D7gSclKRh0Q"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/siteverdict~siteverdict-companies-house/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-siteverdict-siteverdict-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/siteverdict~siteverdict-companies-house/runs": {
      "post": {
        "operationId": "runs-sync-siteverdict-siteverdict-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/siteverdict~siteverdict-companies-house/run-sync": {
      "post": {
        "operationId": "run-sync-siteverdict-siteverdict-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": "What do you want to do?",
            "enum": [
              "new-companies",
              "lookup",
              "monitor",
              "sic-lookup"
            ],
            "type": "string",
            "description": "<b>New companies</b>: companies incorporated in a date range (lead lists). <b>Lookup</b>: full profiles for company numbers or names. <b>Monitor</b>: what changed since the last run for a watch list. <b>SIC lookup</b>: find SIC codes for a keyword (free, no key).",
            "default": "new-companies"
          },
          "apiKey": {
            "title": "Companies House API key (yours, free)",
            "type": "string",
            "description": "Your own REST API key from the Companies House Developer Hub (developer.company-information.service.gov.uk) - free, takes ~5 minutes; see the README for step-by-step instructions. Stored encrypted by Apify, never logged or written to output. Leave empty to try the actor with fictional sample data."
          },
          "sampleMode": {
            "title": "Sample mode (fictional data, no charge)",
            "type": "boolean",
            "description": "Run against built-in fictional fixture responses instead of the live API. Nothing is charged. Switched on automatically when no API key is given.",
            "default": false
          },
          "incorporatedLastDays": {
            "title": "Incorporated in the last N days",
            "minimum": 1,
            "maximum": 3650,
            "type": "integer",
            "description": "Used when 'Incorporated from' is empty. 7 = the last 7 days including today.",
            "default": 7
          },
          "incorporatedFrom": {
            "title": "Incorporated from (YYYY-MM-DD)",
            "pattern": "^(\\d{4}-\\d{2}-\\d{2})?$",
            "type": "string",
            "description": "Optional start date (inclusive). Overrides 'last N days'."
          },
          "incorporatedTo": {
            "title": "Incorporated to (YYYY-MM-DD)",
            "pattern": "^(\\d{4}-\\d{2}-\\d{2})?$",
            "type": "string",
            "description": "Optional end date (inclusive). Default: today."
          },
          "sicKeywords": {
            "title": "Industry keywords (auto SIC lookup)",
            "type": "array",
            "description": "Plain-English industries, e.g. 'travel' (-> 79110, 79120, 79901, 79909), 'software', 'restaurant', 'accountant'. Resolved codes are shown in the log and in OUTPUT. In 'SIC lookup' mode these are the keywords to look up.",
            "items": {
              "type": "string"
            }
          },
          "sicCodes": {
            "title": "SIC 2007 codes",
            "type": "array",
            "description": "Exact 5-digit SIC 2007 codes, e.g. 79110. Combined with codes found from the keywords.",
            "items": {
              "type": "string"
            }
          },
          "companyStatus": {
            "title": "Company status",
            "type": "array",
            "description": "Register status values, e.g. active, dissolved, liquidation, administration. Default: active.",
            "default": [
              "active"
            ],
            "items": {
              "type": "string"
            }
          },
          "companyTypes": {
            "title": "Company type",
            "type": "array",
            "description": "Register type codes, e.g. ltd (private limited), plc, llp, private-limited-guarant-nsc. Empty = all types.",
            "items": {
              "type": "string"
            }
          },
          "companySubtypes": {
            "title": "Company subtype",
            "type": "array",
            "description": "Optional, e.g. community-interest-company.",
            "items": {
              "type": "string"
            }
          },
          "location": {
            "title": "Location (API filter)",
            "type": "string",
            "description": "Free-text location matched by Companies House against the registered office, e.g. 'Plymouth' or 'Manchester'."
          },
          "postcodePrefixes": {
            "title": "Postcode area / district",
            "type": "array",
            "description": "Keep only registered offices in these postcode areas or districts, e.g. PL (area), PL1 (district), EC1A. Applied after the search.",
            "items": {
              "type": "string"
            }
          },
          "localities": {
            "title": "Town / locality contains",
            "type": "array",
            "description": "Keep only addresses whose locality/region/address lines contain one of these words.",
            "items": {
              "type": "string"
            }
          },
          "companyNameIncludes": {
            "title": "Company name includes",
            "type": "string",
            "description": "Passed to the Advanced Company Search filter."
          },
          "companyNameExcludes": {
            "title": "Company name excludes",
            "type": "string",
            "description": "Passed to the Advanced Company Search filter."
          },
          "sizeHints": {
            "title": "Size proxy (from last accounts type)",
            "type": "array",
            "description": "Keep only companies whose last filed accounts type suggests: micro, small, medium, large-or-group, dormant, not-yet-filed, unknown. A proxy only - not turnover or headcount.",
            "items": {
              "type": "string"
            }
          },
          "onlyWithSignals": {
            "title": "Only companies with these signals",
            "type": "array",
            "description": "e.g. newly-incorporated, accounts-overdue, confirmation-statement-overdue, dormant, proposal-to-strike-off, insolvency-history, has-secured-lending, first-accounts-not-yet-filed. See README for the full list.",
            "items": {
              "type": "string"
            }
          },
          "fetchProfiles": {
            "title": "Fetch full company profile",
            "type": "boolean",
            "description": "Adds accounts/confirmation dates, overdue flags, size proxy, previous names, charges/insolvency flags. Costs 1 extra API request per company (your key's rate limit, not money). Off = faster, search-level fields only.",
            "default": true
          },
          "maxItems": {
            "title": "Max companies (new-companies mode)",
            "minimum": 1,
            "maximum": 100000,
            "type": "integer",
            "description": "Stop after this many company records. Each record is one billable 'company' event.",
            "default": 100
          },
          "companyNumbers": {
            "title": "Company numbers",
            "type": "array",
            "description": "For Lookup and Monitor modes. 8 characters, e.g. 01234567, SC123456, NI123456, OC123456. Short numeric values are zero-padded.",
            "items": {
              "type": "string"
            }
          },
          "companyNames": {
            "title": "Company names (lookup mode)",
            "type": "array",
            "description": "Searched with the official company search; exact name matches are preferred.",
            "items": {
              "type": "string"
            }
          },
          "searchResultsPerName": {
            "title": "Results per name",
            "minimum": 1,
            "maximum": 20,
            "type": "integer",
            "description": "How many matching companies to return per name.",
            "default": 1
          },
          "monitorStateName": {
            "title": "Watch-list state name",
            "type": "string",
            "description": "Changes are detected against the snapshot saved under this name in a named key-value store (siteverdict-ch-monitor-<name>) in your Apify account. Use different names for different watch lists.",
            "default": "default"
          },
          "monitorChecks": {
            "title": "What to monitor",
            "type": "array",
            "description": "Any of: profile (status, name, address, SIC, overdue flags - always on), filings, charges, insolvency, officers (needs 'Include officers').",
            "default": [
              "profile",
              "filings",
              "charges",
              "insolvency"
            ],
            "items": {
              "type": "string"
            }
          },
          "onlyChanges": {
            "title": "Only output changed companies",
            "type": "boolean",
            "description": "Hide unchanged companies from the dataset. Every checked company is still one 'monitor-check' event.",
            "default": false
          },
          "includeOfficers": {
            "title": "Include officers (personal data)",
            "type": "boolean",
            "description": "OFF by default. Adds directors/secretaries exactly as published on the register: name, role, appointed/resigned dates, nationality, country of residence, month/year of birth. No addresses, no contact details - never inferred. You are the controller of this personal data: see the UK GDPR / PECR note in the README.",
            "default": false
          },
          "includePsc": {
            "title": "Include persons with significant control (personal data)",
            "type": "boolean",
            "description": "OFF by default. Adds PSCs as published: name, kind, natures of control, notified/ceased dates, nationality, country of residence, month/year of birth.",
            "default": false
          },
          "newlyIncorporatedDays": {
            "title": "'Newly incorporated' means up to N days old",
            "minimum": 1,
            "maximum": 3650,
            "type": "integer",
            "description": "Threshold for the newly-incorporated lead signal.",
            "default": 30
          },
          "websiteGuess": {
            "title": "Add unverified website guesses",
            "type": "boolean",
            "description": "OFF by default. Adds name-derived domain candidates (e.g. name.co.uk) clearly marked verified:false. Nothing is fetched or checked - treat them as guesses only.",
            "default": false
          },
          "maxConcurrency": {
            "title": "Parallel requests",
            "minimum": 1,
            "maximum": 10,
            "type": "integer",
            "description": "Concurrent workers. All of them share one rate limiter, so this never exceeds your key's limit.",
            "default": 4
          },
          "requestsPer5Min": {
            "title": "Requests per 5 minutes (your key's limit)",
            "minimum": 10,
            "maximum": 6000,
            "type": "integer",
            "description": "Companies House allows 600 per 5 minutes per key. Default 550 leaves headroom if you use the same key elsewhere. Only raise above 600 if Companies House has granted your key a higher limit.",
            "default": 550
          }
        }
      },
      "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}