{
  "openapi": "3.0.1",
  "info": {
    "title": "UK Companies House Data — Enriched (Region, Size, Risk Signals)",
    "description": "Every live UK company (5.7M) from the official Companies House register, enriched at no extra cost: ONS region, council, ward & lat/long, industry section, size band, age, overdue/charge/strike-off risk signals and virtual-office detection. Optional live API check. No personal data. $1.50/1,000.",
    "version": "0.3",
    "x-build-id": "hBNkGrmTHFRuPCrFW"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/knobby_woodworker_aig~uk-companies-house-snapshot/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-knobby_woodworker_aig-uk-companies-house-snapshot",
        "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/knobby_woodworker_aig~uk-companies-house-snapshot/runs": {
      "post": {
        "operationId": "runs-sync-knobby_woodworker_aig-uk-companies-house-snapshot",
        "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/knobby_woodworker_aig~uk-companies-house-snapshot/run-sync": {
      "post": {
        "operationId": "run-sync-knobby_woodworker_aig-uk-companies-house-snapshot",
        "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": {
          "sicSections": {
            "title": "Industry sections (SIC 2007)",
            "type": "array",
            "description": "Optional. Broad industries — e.g. F = Construction, J = Information & communication, M = Professional services. A company matches if any of its SIC codes falls in a selected section. Use \"SIC codes\" below for finer detail.",
            "items": {
              "type": "string",
              "enum": [
                "A",
                "B",
                "C",
                "D",
                "E",
                "F",
                "G",
                "H",
                "I",
                "J",
                "K",
                "L",
                "M",
                "N",
                "O",
                "P",
                "Q",
                "R",
                "S",
                "T",
                "U"
              ],
              "enumTitles": [
                "A — Agriculture, forestry & fishing",
                "B — Mining & quarrying",
                "C — Manufacturing",
                "D — Electricity & gas supply",
                "E — Water, sewerage & waste",
                "F — Construction",
                "G — Wholesale & retail; vehicle repair",
                "H — Transport & storage",
                "I — Accommodation & food",
                "J — Information & communication",
                "K — Finance & insurance",
                "L — Real estate",
                "M — Professional, scientific & technical",
                "N — Administrative & support services",
                "O — Public administration & defence",
                "P — Education",
                "Q — Health & social work",
                "R — Arts, entertainment & recreation",
                "S — Other services",
                "T — Households as employers",
                "U — Extraterritorial organisations"
              ]
            }
          },
          "sicCodes": {
            "title": "SIC codes (prefix match)",
            "type": "array",
            "description": "Optional. UK SIC 2007 codes or prefixes, e.g. \"62012\" (business software), \"62\" (all IT), \"41\" (construction of buildings), \"43\" (specialised construction). A company matches if any of its up to 4 SIC codes starts with one of these. Empty = all.",
            "items": {
              "type": "string"
            }
          },
          "sizeBands": {
            "title": "Size band (from accounts filed)",
            "type": "array",
            "description": "Optional. Derived from the accounts category each company last filed with Companies House: micro, small, medium, large-or-group, subsidiary, dormant, no-accounts-yet (new companies), unknown.",
            "items": {
              "type": "string",
              "enum": [
                "micro",
                "small",
                "medium",
                "large-or-group",
                "subsidiary",
                "dormant",
                "no-accounts-yet",
                "unknown"
              ],
              "enumTitles": [
                "Micro entity",
                "Small",
                "Medium",
                "Large / group",
                "Subsidiary (exempt)",
                "Dormant",
                "No accounts filed yet (new)",
                "Unknown"
              ]
            }
          },
          "excludeDormant": {
            "title": "Exclude dormant companies",
            "type": "boolean",
            "description": "Drops companies filing dormant accounts or with SIC 99999 (Dormant Company).",
            "default": false
          },
          "incorporatedWithinDays": {
            "title": "Incorporated within the last N days",
            "minimum": 1,
            "maximum": 36500,
            "type": "integer",
            "description": "Optional rolling window, e.g. 90 = companies incorporated in the last 90 days (relative to run date). Combined with the absolute dates below, the later start date wins. Note: the snapshot is compiled to the end of the previous month."
          },
          "incorporatedFrom": {
            "title": "Incorporated from",
            "type": "string",
            "description": "Optional. Earliest incorporation date (YYYY-MM-DD)."
          },
          "incorporatedTo": {
            "title": "Incorporated to",
            "type": "string",
            "description": "Optional. Latest incorporation date (YYYY-MM-DD)."
          },
          "companyStatuses": {
            "title": "Company statuses",
            "type": "array",
            "description": "Optional, exact match (case-insensitive). The snapshot only contains live companies; common values: \"Active\", \"Active - Proposal to Strike off\", \"Liquidation\", \"In Administration\", \"Voluntary Arrangement\", \"Live but Receiver Manager on at least one charge\". Empty = all.",
            "items": {
              "type": "string"
            }
          },
          "companyCategories": {
            "title": "Company types",
            "type": "array",
            "description": "Optional, exact match (case-insensitive), e.g. \"Private Limited Company\", \"PRI/LTD BY GUAR/NSC (Private, limited by guarantee, no share capital)\", \"Public Limited Company\", \"Limited Liability Partnership\", \"Limited Partnership\", \"Community Interest Company\", \"Charitable Incorporated Organisation\". Empty = all.",
            "items": {
              "type": "string"
            }
          },
          "nameContains": {
            "title": "Company name contains",
            "type": "string",
            "description": "Optional case-insensitive substring of the company name, e.g. \"DRYWALL\"."
          },
          "regions": {
            "title": "Regions",
            "type": "array",
            "description": "Optional. ONS region / nation of the registered office, resolved from the postcode via the ONS postcode directory. Works even when the register's own address country/county is blank.",
            "items": {
              "type": "string",
              "enum": [
                "North East",
                "North West",
                "Yorkshire and The Humber",
                "East Midlands",
                "West Midlands",
                "East of England",
                "London",
                "South East",
                "South West",
                "Wales",
                "Scotland",
                "Northern Ireland",
                "Channel Islands",
                "Isle of Man"
              ]
            }
          },
          "localAuthorities": {
            "title": "Local authorities (councils)",
            "type": "array",
            "description": "Optional. ONS local authority district names, e.g. \"Manchester\", \"Leeds\", \"Bristol, City of\", \"Westminster\", \"Glasgow City\", \"Belfast\". Exact per-postcode check.",
            "items": {
              "type": "string"
            }
          },
          "postcodePrefixes": {
            "title": "Registered office postcode prefixes",
            "type": "array",
            "description": "Optional. Matches the start of the registered office postcode, e.g. \"BS\", \"EC1A\", \"M1\". Without a space, \"M1\" also matches M11–M19; add a space after the outward code to be exact (\"M1 \" or \"M1 1\"). Empty = all.",
            "items": {
              "type": "string"
            }
          },
          "excludeSharedOffices": {
            "title": "Exclude formation-agent / virtual-office addresses",
            "type": "boolean",
            "description": "Drops companies whose registered office postcode hosts 250+ companies on the register (formation agents, accountants' and virtual-office addresses, e.g. EC1V 2NX hosts ~72k). Useful when you want companies that actually operate locally.",
            "default": false
          },
          "overdueFilter": {
            "title": "Filing compliance",
            "enum": [
              "any",
              "accounts",
              "confirmationStatement",
              "either",
              "none"
            ],
            "type": "string",
            "description": "Optional. Keep only companies whose accounts and/or confirmation statement were overdue at the snapshot date — or only those fully up to date.",
            "default": "any"
          },
          "chargesFilter": {
            "title": "Secured charges (mortgages)",
            "enum": [
              "any",
              "outstanding",
              "none"
            ],
            "type": "string",
            "description": "Optional. Filter on outstanding or part-satisfied charges registered against the company.",
            "default": "any"
          },
          "maxItems": {
            "title": "Max companies",
            "minimum": 1,
            "maximum": 1000000,
            "type": "integer",
            "description": "Stop after this many matching companies. Keeps runs cheap. The full register is ~5.8M rows; a run that scans all of it takes several minutes even if few rows match.",
            "default": 100
          },
          "onlyNew": {
            "title": "Only companies not delivered before",
            "type": "boolean",
            "description": "When on, skips companies this Actor already returned for the same filter set in earlier runs (state kept in a named key-value store). Turn on for monthly schedules; leave off for one-off pulls.",
            "default": false
          },
          "geoEnrich": {
            "title": "Add exact ONS geography",
            "type": "boolean",
            "description": "Adds region, local authority (+ GSS code), ward, parliamentary constituency, rural/urban class and latitude/longitude for each output row from the ONS postcode directory (free, ~100 postcodes per request). Turn off only if you want the fastest possible raw export — the outcode-level region is still filled.",
            "default": true
          },
          "companiesHouseApiKey": {
            "title": "Companies House API key (optional live check)",
            "type": "string",
            "description": "Optional. Your own free key from developer.company-information.service.gov.uk. When set, the first N output rows are re-checked against the live official register: current status, insolvency history, charges, overdue flags, disputed/undeliverable office, last accounts and the latest filing. Company-level endpoints only — no officers or PSC."
          },
          "liveCheckMaxItems": {
            "title": "Live-check at most N companies",
            "minimum": 0,
            "maximum": 100000,
            "type": "integer",
            "description": "Cap on live API checks per run (2 calls per company, throttled under the 600 requests / 5 min limit ≈ 4.5 min per 250 companies).",
            "default": 100
          },
          "stateStoreName": {
            "title": "State store name (for onlyNew)",
            "type": "string",
            "description": "Named key-value store that remembers delivered company numbers. Change it to keep separate histories.",
            "default": "uk-ch-snapshot-state"
          },
          "maxPartsToScan": {
            "title": "Max part files to scan",
            "minimum": 0,
            "type": "integer",
            "description": "Advanced/testing. The official snapshot is split into ~7 ZIP parts ordered alphabetically by company name. 0 = all parts.",
            "default": 0
          }
        }
      },
      "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}