{
  "openapi": "3.0.1",
  "info": {
    "title": "UK New Companies & Companies House Leads",
    "description": "Get UK companies incorporated or dissolved in any period from Companies House: filter by SIC code, location, type, status and name. Address, postcode, SIC, accounts and confirmation deadlines, directors. Daily new-company leads.",
    "version": "0.1",
    "x-build-id": "GS0ucUET4B1wHnPfy"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/surefeed~uk-companies-house-scraper/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-surefeed-uk-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/surefeed~uk-companies-house-scraper/runs": {
      "post": {
        "operationId": "runs-sync-surefeed-uk-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/surefeed~uk-companies-house-scraper/run-sync": {
      "post": {
        "operationId": "run-sync-surefeed-uk-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": {
          "incorporatedInLastDays": {
            "title": "Incorporated in the last N days",
            "minimum": 0,
            "maximum": 366,
            "type": "integer",
            "description": "New companies registered between N days ago and today. 2 = yesterday and today (good for a daily run). 0 = use the dates below or no incorporation filter.",
            "default": 0
          },
          "incorporatedFrom": {
            "title": "Incorporated from (date)",
            "type": "string",
            "description": "YYYY-MM-DD. Use instead of \"last N days\" for a fixed period."
          },
          "incorporatedTo": {
            "title": "Incorporated to (date)",
            "type": "string",
            "description": "YYYY-MM-DD, inclusive. Defaults to today."
          },
          "dissolvedInLastDays": {
            "title": "Dissolved in the last N days",
            "minimum": 0,
            "maximum": 366,
            "type": "integer",
            "description": "Companies dissolved between N days ago and today.",
            "default": 0
          },
          "dissolvedFrom": {
            "title": "Dissolved from (date)",
            "type": "string",
            "description": "YYYY-MM-DD."
          },
          "dissolvedTo": {
            "title": "Dissolved to (date)",
            "type": "string",
            "description": "YYYY-MM-DD, inclusive. Defaults to today."
          },
          "sicCodes": {
            "title": "SIC codes (industries)",
            "type": "array",
            "description": "UK SIC 2007 codes, e.g. 56101 restaurants, 62020 IT consultancy, 41202 construction, 47910 online retail. Any of them matches (one search per code).",
            "items": {
              "type": "string"
            }
          },
          "location": {
            "title": "Registered office location",
            "type": "string",
            "description": "Town, city, county or postcode district in the registered office address, e.g. Manchester, Kent, SW1."
          },
          "companyTypes": {
            "title": "Company types",
            "type": "array",
            "description": "Leave empty for all types.",
            "items": {
              "type": "string",
              "enum": [
                "ltd",
                "plc",
                "llp",
                "private-limited-guarant-nsc",
                "private-limited-guarant-nsc-limited-exemption",
                "private-unlimited",
                "limited-partnership",
                "scottish-partnership",
                "uk-establishment"
              ],
              "enumTitles": [
                "Private limited company (Ltd)",
                "Public limited company (PLC)",
                "Limited liability partnership (LLP)",
                "Limited by guarantee (no share capital)",
                "Limited by guarantee, 'Limited' exemption",
                "Private unlimited company",
                "Limited partnership",
                "Scottish qualifying partnership",
                "UK establishment (overseas company)"
              ]
            }
          },
          "companyStatuses": {
            "title": "Company statuses",
            "type": "array",
            "description": "Leave empty for all statuses.",
            "items": {
              "type": "string",
              "enum": [
                "active",
                "dissolved",
                "liquidation",
                "administration",
                "receivership",
                "converted-closed"
              ],
              "enumTitles": [
                "Active",
                "Dissolved",
                "Liquidation",
                "Administration",
                "Receivership",
                "Converted / closed"
              ]
            }
          },
          "nameIncludes": {
            "title": "Company name contains",
            "type": "string",
            "description": "Words that must appear in the company name, e.g. coffee, solar, consulting."
          },
          "includeDetails": {
            "title": "Include profile details",
            "type": "boolean",
            "description": "SIC descriptions plus next accounts and confirmation statement dates (made up to / due by). No extra charge; slower.",
            "default": false
          },
          "includeOfficers": {
            "title": "Include officers (directors)",
            "type": "boolean",
            "description": "Officer names, roles, status and appointment dates, plus a list of active directors. Charged as an extra event only when obtained. Dates of birth, nationality and addresses are not collected.",
            "default": false
          },
          "maxResults": {
            "title": "Max companies",
            "minimum": 0,
            "type": "integer",
            "description": "Stop the run after this many companies. 0 = no limit (large ranges are split by date automatically).",
            "default": 100
          },
          "maxRunSeconds": {
            "title": "Max run time (seconds)",
            "minimum": 0,
            "type": "integer",
            "description": "Soft time limit. 0 = no limit.",
            "default": 0
          },
          "onlyNewCompanies": {
            "title": "Daily leads: only companies not returned before",
            "type": "boolean",
            "description": "Remembers the companies earlier runs of the same filters returned (in your account) and skips them, so overlapping daily windows never repeat a lead. Schedule it daily with \"last 2 days\".",
            "default": false
          },
          "monitorKey": {
            "title": "Lead list name",
            "type": "string",
            "description": "Optional. Keep separate memories for the same filters (e.g. per client)."
          }
        }
      },
      "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}