{
  "openapi": "3.0.1",
  "info": {
    "title": "SiteVerdict — UK New Companies Feed (Companies House)",
    "description": "Daily feed of brand-new UK companies from the official Companies House API (your free key): filter by industry/SIC, region, postcode, name and officer count. Only new since last run, CSV and HubSpot export, Slack digest. Company data only; director names off by default.",
    "version": "1.1",
    "x-build-id": "nT5eGhN3eBcYeglQ3"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/siteverdict~siteverdict-uk-new-companies-feed/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-siteverdict-siteverdict-uk-new-companies-feed",
        "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-uk-new-companies-feed/runs": {
      "post": {
        "operationId": "runs-sync-siteverdict-siteverdict-uk-new-companies-feed",
        "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-uk-new-companies-feed/run-sync": {
      "post": {
        "operationId": "run-sync-siteverdict-siteverdict-uk-new-companies-feed",
        "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": {
          "apiKey": {
            "title": "Companies House REST API key (yours, free)",
            "type": "string",
            "description": "Create one in ~5 minutes at developer.company-information.service.gov.uk (Your applications > Create an application > REST key). Stored encrypted, never logged or output."
          },
          "source": {
            "title": "Source",
            "enum": [
              "advanced-search",
              "stream"
            ],
            "type": "string",
            "description": "<b>Advanced search</b> (recommended): companies incorporated in a date range. <b>Streaming API</b>: listens to the live Companies House change stream for a few minutes and picks out brand-new incorporations (needs a separate free stream key).",
            "default": "advanced-search"
          },
          "streamKey": {
            "title": "Companies House STREAM key",
            "type": "string",
            "description": "Only for the Streaming API source (create a 'Streaming' key in the same developer hub). Stored encrypted."
          },
          "sampleMode": {
            "title": "Sample mode (fictional companies, no charge)",
            "type": "boolean",
            "description": "Switched on automatically when no key is given.",
            "default": false
          },
          "incorporatedLastDays": {
            "title": "Incorporated in the last N days",
            "minimum": 1,
            "maximum": 3650,
            "type": "integer",
            "description": "1 = today only. Used when no explicit dates are given.",
            "default": 7
          },
          "incorporatedFrom": {
            "title": "Incorporated from (YYYY-MM-DD)",
            "pattern": "^(\\d{4}-\\d{2}-\\d{2})?$",
            "type": "string",
            "description": "Optional; overrides 'last N days'."
          },
          "incorporatedTo": {
            "title": "Incorporated to (YYYY-MM-DD)",
            "pattern": "^(\\d{4}-\\d{2}-\\d{2})?$",
            "type": "string",
            "description": "Optional; default today."
          },
          "sicKeywords": {
            "title": "Industry keywords (auto SIC lookup)",
            "type": "array",
            "description": "Plain English, e.g. travel, software, restaurant, accountant, construction. Resolved to SIC 2007 codes (shown in the log).",
            "items": {
              "type": "string"
            }
          },
          "sicCodes": {
            "title": "SIC 2007 codes",
            "type": "array",
            "description": "Exact 5-digit codes, e.g. 62012.",
            "items": {
              "type": "string"
            }
          },
          "regions": {
            "title": "UK regions / nations",
            "type": "array",
            "description": "Any of: London, South East, South West, East of England, East Midlands, West Midlands, North East, North West, Yorkshire and The Humber, Wales, Scotland, Northern Ireland. Based on the registered-office postcode.",
            "items": {
              "type": "string"
            }
          },
          "postcodeAreas": {
            "title": "Postcode areas / districts",
            "type": "array",
            "description": "e.g. PL (area) or PL1 / EC1A (district).",
            "items": {
              "type": "string"
            }
          },
          "nameKeywords": {
            "title": "Name contains any of",
            "type": "array",
            "description": "Case-insensitive, e.g. travel, tours, holidays.",
            "items": {
              "type": "string"
            }
          },
          "excludeNameKeywords": {
            "title": "Name excludes",
            "type": "array",
            "description": "e.g. holdings, property.",
            "items": {
              "type": "string"
            }
          },
          "companyTypes": {
            "title": "Company types",
            "type": "array",
            "description": "Companies House type codes: ltd, plc, llp, private-limited-guarant-nsc... Empty = all.",
            "default": [
              "ltd"
            ],
            "items": {
              "type": "string"
            }
          },
          "companyStatus": {
            "title": "Company status",
            "type": "array",
            "description": "Usually active.",
            "default": [
              "active"
            ],
            "items": {
              "type": "string"
            }
          },
          "minOfficers": {
            "title": "Minimum active officers",
            "minimum": 0,
            "maximum": 100,
            "type": "integer",
            "description": "Optional. Needs 1 extra API request per company (your key's rate limit, not money)."
          },
          "maxOfficers": {
            "title": "Maximum active officers",
            "minimum": 0,
            "maximum": 100,
            "type": "integer",
            "description": "Optional, e.g. 1 = sole-director companies."
          },
          "includeOfficerCount": {
            "title": "Add active officer count",
            "type": "boolean",
            "description": "Adds activeOfficerCount (1 extra request per company).",
            "default": false
          },
          "includeDirectorNames": {
            "title": "Include director names (personal data)",
            "type": "boolean",
            "description": "OFF by default. Adds active officers' names, role and appointment date exactly as published on the public register. Never dates of birth, nationality, addresses or contact details. See the UK GDPR/PECR note in the README.",
            "default": false
          },
          "onlyNewSinceLastRun": {
            "title": "Daily delta: skip companies delivered in earlier runs",
            "type": "boolean",
            "description": "Remembers delivered company numbers (and the stream timepoint) in a named key-value store so a daily schedule only returns new companies.",
            "default": true
          },
          "stateName": {
            "title": "Feed state name",
            "type": "string",
            "description": "Use one name per feed (stored as siteverdict-ukfeed-<name>).",
            "default": "default"
          },
          "maxItems": {
            "title": "Max companies per run",
            "minimum": 1,
            "maximum": 50000,
            "type": "integer",
            "description": "Max companies per run.",
            "default": 500
          },
          "hubspotPush": {
            "title": "Create companies in HubSpot",
            "type": "boolean",
            "description": "OFF by default. Creates each new company in your HubSpot CRM (name, address, city, postcode, region, description). A HubSpot import CSV is always saved anyway.",
            "default": false
          },
          "hubspotToken": {
            "title": "HubSpot private app token",
            "type": "string",
            "description": "Private app with crm.objects.companies.write scope. Stored encrypted, never logged."
          },
          "slackWebhookUrl": {
            "title": "Slack incoming webhook URL",
            "type": "string",
            "description": "Optional daily digest of new matches."
          },
          "webhookUrl": {
            "title": "Webhook URL (JSON POST)",
            "type": "string",
            "description": "Optional HTTPS endpoint (Zapier, Make, n8n)."
          },
          "streamListenSeconds": {
            "title": "Stream: listen for (seconds)",
            "minimum": 10,
            "maximum": 600,
            "type": "integer",
            "description": "Stream: listen for (seconds).",
            "default": 120
          },
          "requestsPer5Min": {
            "title": "Requests per 5 minutes (your key)",
            "minimum": 10,
            "maximum": 6000,
            "type": "integer",
            "description": "Companies House allows 600 per 5 minutes per key.",
            "default": 550
          },
          "maxConcurrency": {
            "title": "Parallel requests",
            "minimum": 1,
            "maximum": 10,
            "type": "integer",
            "description": "Reserved: requests are currently made one at a time (rate-limited per key), so this setting has no effect yet.",
            "default": 4
          }
        }
      },
      "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}